can_types.h

Go to the documentation of this file.

 
#ifndef __DRIVERS_CANBUS_CAN_TYPES__
#define __DRIVERS_CANBUS_CAN_TYPES__
 
#include <stdbool.h>
#include <stdint.h>
 
#include "../../openlcb/openlcb_defines.h"
#include "../../openlcb/openlcb_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
    // ************************ USER DEFINED VARIABLES *****************************
 
#ifndef USER_DEFINED_CAN_MSG_BUFFER_DEPTH
#define USER_DEFINED_CAN_MSG_BUFFER_DEPTH 10
#endif
 
    // *********************END USER DEFINED VARIABLES *****************************
 
#ifndef ALIAS_MAPPING_BUFFER_DEPTH
#define ALIAS_MAPPING_BUFFER_DEPTH USER_DEFINED_NODE_BUFFER_DEPTH
#endif
 
#define LEN_CAN_FIFO_BUFFER (USER_DEFINED_CAN_MSG_BUFFER_DEPTH + 1)
 
#define LEN_CAN_BYTE_ARRAY 8
 
#define OFFSET_CAN_WITHOUT_DEST_ADDRESS 0
 
#define OFFSET_CAN_WITH_DEST_ADDRESS 2
 
#define CAN_MTI_PCER_WITH_PAYLOAD_FIRST 0x0F16
 
#define CAN_MTI_PCER_WITH_PAYLOAD_MIDDLE 0x0F15
 
#define CAN_MTI_PCER_WITH_PAYLOAD_LAST 0x0F14
 
    typedef uint8_t payload_bytes_can_t[LEN_CAN_BYTE_ARRAY];
 
    typedef struct can_msg_state_struct {
        uint8_t allocated : 1; 
    } can_msg_state_t;
 
    typedef struct can_msg_struct {
        can_msg_state_t state;        
        uint32_t identifier;          
        uint8_t payload_count;        
        payload_bytes_can_t payload;  
    } can_msg_t;
 
    typedef can_msg_t can_msg_array_t[USER_DEFINED_CAN_MSG_BUFFER_DEPTH];
 
    typedef struct can_main_statemachine_struct {
        openlcb_statemachine_worker_t *openlcb_worker; 
    } can_main_statemachine_t;
 
    typedef struct can_statemachine_info_struct {
        openlcb_node_t *openlcb_node;            
        can_msg_t *login_outgoing_can_msg;        
        uint8_t login_outgoing_can_msg_valid : 1; 
        can_msg_t *outgoing_can_msg;              
        uint8_t enumerating : 1;                  
        uint8_t current_tick;                     
    } can_statemachine_info_t;
 
    typedef struct alias_mapping_struct {
        node_id_t node_id;       
        uint16_t alias;          
        uint8_t is_duplicate : 1; 
        uint8_t is_permitted : 1; 
    } alias_mapping_t;
 
    typedef struct alias_mapping_info_struct {
        alias_mapping_t list[ALIAS_MAPPING_BUFFER_DEPTH]; 
        bool has_duplicate_alias;                          
    } alias_mapping_info_t;
 
#define LISTENER_ALIAS_TABLE_DEPTH \
    (USER_DEFINED_MAX_LISTENERS_PER_TRAIN * USER_DEFINED_TRAIN_NODE_COUNT)
 
    typedef struct listener_alias_entry_struct {
 
        node_id_t node_id;          
        uint16_t alias;             
        uint16_t verify_ticks;      
        uint8_t verify_pending : 1; 
    } listener_alias_entry_t;
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __DRIVERS_CANBUS_CAN_TYPES__ */