candev.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 OTA keys S.A.
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdlib.h>
 
#include "can/can.h"
#include "can/common.h"
#include "mutex.h"

typedef enum {
    CANDEV_EVENT_NOEVENT,          
    CANDEV_EVENT_ISR,              
    CANDEV_EVENT_WAKE_UP,          
    CANDEV_EVENT_TX_CONFIRMATION,  
    CANDEV_EVENT_TIMEOUT_TX_CONF,  
    CANDEV_EVENT_RX_INDICATION,    
    CANDEV_EVENT_TX_ERROR,         
    CANDEV_EVENT_RX_ERROR,         
    CANDEV_EVENT_BUS_OFF,          
    CANDEV_EVENT_ERROR_PASSIVE,    
    CANDEV_EVENT_ERROR_WARNING,    
    /* expand this list if needed */
} candev_event_t;

typedef struct candev candev_t;

typedef void (*candev_event_cb_t)(candev_t *dev, candev_event_t event, void *arg);

struct candev {
    const struct candev_driver *driver;    
    candev_event_cb_t event_callback;      
    void *isr_arg;                         
    struct can_bittiming bittiming;        
    enum can_state state;                  
#ifdef MODULE_FDCAN
    struct can_bittiming fd_data_bittiming;
    uint16_t loop_delay;                   
#endif
};

typedef struct candev_driver {
    int (*send)(candev_t *dev, const can_frame_t *frame);

    int (*abort)(candev_t *dev, const can_frame_t *frame);

    int (*init)(candev_t *dev);

    void (*isr)(candev_t *dev);

    int (*get)(candev_t *dev, canopt_t opt, void *value, size_t max_len);

    int (*set)(candev_t *dev, canopt_t opt, void *value, size_t value_len);

    int (*set_filter)(candev_t *dev, const struct can_filter *filter);

    int (*remove_filter)(candev_t *dev, const struct can_filter *filter);
} candev_driver_t;
 
#ifdef __cplusplus
}
#endif