CO_LSS.h

Go to the documentation of this file.

 
#ifndef CO_LSS_H
#define CO_LSS_H
 
#include "301/CO_driver.h"
 
/* default configuration, see CO_config.h */
#ifndef CO_CONFIG_LSS
#define CO_CONFIG_LSS (CO_CONFIG_LSS_SLAVE)
#endif
 
#if ((CO_CONFIG_LSS) & (CO_CONFIG_LSS_SLAVE | CO_CONFIG_LSS_MASTER)) || defined CO_DOXYGEN
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    CO_LSS_SWITCH_STATE_GLOBAL      = 0x04U, 
    CO_LSS_SWITCH_STATE_SEL_VENDOR  = 0x40U, 
    CO_LSS_SWITCH_STATE_SEL_PRODUCT = 0x41U, 
    CO_LSS_SWITCH_STATE_SEL_REV     = 0x42U, 
    CO_LSS_SWITCH_STATE_SEL_SERIAL  = 0x43U, 
    CO_LSS_SWITCH_STATE_SEL         = 0x44U, 
    CO_LSS_CFG_NODE_ID              = 0x11U, 
    CO_LSS_CFG_BIT_TIMING           = 0x13U, 
    CO_LSS_CFG_ACTIVATE_BIT_TIMING  = 0x15U, 
    CO_LSS_CFG_STORE                = 0x17U, 
    CO_LSS_IDENT_SLAVE              = 0x4FU, 
    CO_LSS_IDENT_FASTSCAN           = 0x51U, 
    CO_LSS_INQUIRE_VENDOR           = 0x5AU, 
    CO_LSS_INQUIRE_PRODUCT          = 0x5BU, 
    CO_LSS_INQUIRE_REV              = 0x5CU, 
    CO_LSS_INQUIRE_SERIAL           = 0x5DU, 
    CO_LSS_INQUIRE_NODE_ID          = 0x5EU, 
} CO_LSS_cs_t;
 
typedef enum {
    CO_LSS_CFG_NODE_ID_OK           = 0x00U,
    CO_LSS_CFG_NODE_ID_OUT_OF_RANGE = 0x01U,
    CO_LSS_CFG_NODE_ID_MANUFACTURER = 0xFFU 
} CO_LSS_cfgNodeId_t;
 
typedef enum {
    CO_LSS_CFG_BIT_TIMING_OK           = 0x00U,
    CO_LSS_CFG_BIT_TIMING_OUT_OF_RANGE = 0x01U,
    CO_LSS_CFG_BIT_TIMING_MANUFACTURER = 0xFFU 
} CO_LSS_cfgBitTiming_t;
 
typedef enum {
    CO_LSS_CFG_STORE_OK            = 0x00U, 
    CO_LSS_CFG_STORE_NOT_SUPPORTED = 0x01U, 
    CO_LSS_CFG_STORE_FAILED        = 0x02U, 
    CO_LSS_CFG_STORE_MANUFACTURER  = 0xFFU  
} CO_LSS_cfgStore_t;
 
typedef enum {
    CO_LSS_FASTSCAN_BIT0    = 0x00U, 
    /* ... */
    CO_LSS_FASTSCAN_BIT31   = 0x1FU, 
    CO_LSS_FASTSCAN_CONFIRM = 0x80U  
} CO_LSS_fastscan_bitcheck;
 
#define CO_LSS_FASTSCAN_BITCHECK_VALID(bit) ((bit>=CO_LSS_FASTSCAN_BIT0 && bit<=CO_LSS_FASTSCAN_BIT31) || bit==CO_LSS_FASTSCAN_CONFIRM)
 
typedef enum {
    CO_LSS_FASTSCAN_VENDOR_ID = 0, 
    CO_LSS_FASTSCAN_PRODUCT   = 1, 
    CO_LSS_FASTSCAN_REV       = 2, 
    CO_LSS_FASTSCAN_SERIAL    = 3  
} CO_LSS_fastscan_lss_sub_next;
 
#define CO_LSS_FASTSCAN_LSS_SUB_NEXT_VALID(index) (index>=CO_LSS_FASTSCAN_VENDOR_ID && index<=CO_LSS_FASTSCAN_SERIAL)
 
typedef union {
    uint32_t addr[4];
    struct {
        uint32_t vendorID;
        uint32_t productCode;
        uint32_t revisionNumber;
        uint32_t serialNumber;
    } identity;
} CO_LSS_address_t;
 
typedef enum {
    CO_LSS_STATE_WAITING = 0,                
    CO_LSS_STATE_CONFIGURATION = 1,          
} CO_LSS_state_t;
 
typedef enum {
    CO_LSS_BIT_TIMING_1000 = 0,              
    CO_LSS_BIT_TIMING_800  = 1,              
    CO_LSS_BIT_TIMING_500  = 2,              
    CO_LSS_BIT_TIMING_250  = 3,              
    CO_LSS_BIT_TIMING_125  = 4,              
    /* reserved            = 5 */
    CO_LSS_BIT_TIMING_50   = 6,              
    CO_LSS_BIT_TIMING_20   = 7,              
    CO_LSS_BIT_TIMING_10   = 8,              
    CO_LSS_BIT_TIMING_AUTO = 9,              
} CO_LSS_bitTimingTable_t;
 
static const uint16_t CO_LSS_bitTimingTableLookup[]  = {
     1000,
     800,
     500,
     250,
     125,
     0,
     50,
     20,
     10,
     0
};
 
#define CO_LSS_BIT_TIMING_VALID(index) (index != 5 && (index >= CO_LSS_BIT_TIMING_1000 && index <= CO_LSS_BIT_TIMING_AUTO))
 
#define CO_LSS_NODE_ID_ASSIGNMENT 0xFFU
 
#define CO_LSS_NODE_ID_VALID(nid) ((nid >= 1 && nid <= 0x7F) || nid == CO_LSS_NODE_ID_ASSIGNMENT)
 
#define CO_LSS_ADDRESS_EQUAL(/*CO_LSS_address_t*/ a1, /*CO_LSS_address_t*/ a2) \
     (a1.identity.productCode == a2.identity.productCode &&         \
      a1.identity.revisionNumber == a2.identity.revisionNumber &&   \
      a1.identity.serialNumber == a2.identity.serialNumber &&       \
      a1.identity.vendorID == a2.identity.vendorID)
 /*@defgroup CO_LSS*/
 
#ifdef __cplusplus
}
#endif /*__cplusplus*/
 
#endif /* (CO_CONFIG_LSS) & (CO_CONFIG_LSS_SLAVE | CO_CONFIG_LSS_MASTER) */
 
#endif /*CO_LSS_H*/