common.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016 OTA keys S.A.
 *
 * This file is subject to the terms and conditions of the GNU Lesser General
 * Public License v2.1. See the file LICENSE in the top level directory for more
 * details.
 */
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <sys/uio.h>
 
#include "timex.h"
#include "thread.h"
#ifdef MODULE_CAN_MBOX
#include "mbox.h"
#endif
 
#ifdef MODULE_FDCAN
#define DEFAULT_CAN_MAX_DLEN CANFD_MAX_DLEN
#else
#define DEFAULT_CAN_MAX_DLEN CAN_MAX_DLEN
#endif
 
typedef enum {
    CANOPT_BITTIMING,       
    CANOPT_RX_FILTERS,      
    CANOPT_TEC,             
    CANOPT_REC,             
    CANOPT_LEC,             
    CANOPT_CLOCK,           
    CANOPT_BITTIMING_CONST, 
    CANOPT_STATE,           
#ifdef MODULE_FDCAN
    CANOPT_FD_BITTIMING,    
    CANOPT_FD_BITTIMING_CONST, 
#endif
} canopt_t;
 
typedef enum {
    CANOPT_STATE_OFF,             
    CANOPT_STATE_SLEEP,           
    CANOPT_STATE_LISTEN_ONLY,     
    CANOPT_STATE_ON,              
    CANOPT_STATE_LOOPBACK,        
} canopt_state_t;
 
typedef struct {
    canopt_t opt;               
    uint16_t context;           
    void *data;                 
    uint16_t data_len;          
} can_opt_t;
 
enum can_msg {
    /* High level messages */
    CAN_MSG_ACK = 0x100,      
    CAN_MSG_SEND_FRAME,       
    CAN_MSG_ABORT_FRAME,      
    CAN_MSG_SET,              
    CAN_MSG_GET,              
    CAN_MSG_SET_FILTER,       
    CAN_MSG_REMOVE_FILTER,    
    CAN_MSG_POWER_UP,         
    CAN_MSG_POWER_DOWN,       
#if defined(MODULE_CAN_TRX) || defined(DOXYGEN)
    CAN_MSG_SET_TRX,          
#endif
    /* candev internal messages */
    CAN_MSG_EVENT = 0x200,    
    CAN_MSG_WAKE_UP,          
    CAN_MSG_TX_CONFIRMATION,  
    CAN_MSG_RX_INDICATION,    
    CAN_MSG_TX_ERROR,         
    CAN_MSG_RX_ERROR,         
    CAN_MSG_BUS_OFF,          
    CAN_MSG_ERROR_PASSIVE,    
    CAN_MSG_ERROR_WARNING,    
#if defined(MODULE_CAN_PM) || defined(DOXYGEN)
    CAN_MSG_PM,               
#endif
    /* isotp messages */
#if defined(MODULE_CAN_ISOTP) || defined(DOXYGEN)
    CAN_MSG_ISOTP_RX_TIMEOUT = 0x400,  
    CAN_MSG_ISOTP_TX_TIMEOUT,          
#endif
};
 
typedef struct can_rx_data {
    struct iovec data;    
    void *arg;            
} can_rx_data_t;
 
typedef enum {
    CAN_TYPE_DEFAULT = 0, 
#if defined(MODULE_CAN_MBOX) || defined(DOXYGEN)
    CAN_TYPE_MBOX,        
#endif
} can_reg_type_t;
 
typedef struct can_reg_entry {
    struct can_reg_entry *next; 
    int ifnum;                  
    union {
        kernel_pid_t pid;       
#if defined(MODULE_CAN_MBOX) || defined(DOXYGEN)
        mbox_t *mbox;           
#endif
    } target;                   
#if defined(MODULE_CAN_MBOX) || defined(DOXYGEN)
    can_reg_type_t type;        
#endif
} can_reg_entry_t;
 
#ifdef __cplusplus
}
#endif