CO_LSSmaster.h

Go to the documentation of this file.

 
#ifndef CO_LSSmaster_H
#define CO_LSSmaster_H
 
#include "305/CO_LSS.h"
 
#if (((CO_CONFIG_LSS)&CO_CONFIG_LSS_MASTER) != 0) || defined CO_DOXYGEN
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    CO_LSSmaster_SCAN_FINISHED = 2,          
    CO_LSSmaster_WAIT_SLAVE = 1,             
    CO_LSSmaster_OK = 0,                     
    CO_LSSmaster_TIMEOUT = -1,               
    CO_LSSmaster_ILLEGAL_ARGUMENT = -2,      
    CO_LSSmaster_INVALID_STATE = -3,         
    CO_LSSmaster_SCAN_NOACK = -4,            
    CO_LSSmaster_SCAN_FAILED = -5,           
    CO_LSSmaster_OK_ILLEGAL_ARGUMENT = -101, 
    CO_LSSmaster_OK_MANUFACTURER = -102,     
} CO_LSSmaster_return_t;
 
typedef struct {
    uint32_t timeout_us;     
    uint8_t state;           
    uint8_t command;         
    uint32_t timeoutTimer;   
    uint8_t fsState;         
    uint8_t fsLssSub;        
    uint8_t fsBitChecked;    
    uint32_t fsIdNumber;     
    volatile void* CANrxNew; 
    uint8_t CANrxData[8];    
#if (((CO_CONFIG_LSS)&CO_CONFIG_FLAG_CALLBACK_PRE) != 0) || defined CO_DOXYGEN
    void (*pFunctSignal)(void* object); 
    void* functSignalObject;            
#endif
    CO_CANmodule_t* CANdevTx; 
    CO_CANtx_t* TXbuff;       
} CO_LSSmaster_t;
 
#ifndef CO_LSSmaster_DEFAULT_TIMEOUT
#define CO_LSSmaster_DEFAULT_TIMEOUT 1000U /* ms */
#endif
 
CO_ReturnError_t CO_LSSmaster_init(CO_LSSmaster_t* LSSmaster, uint16_t timeout_ms, CO_CANmodule_t* CANdevRx,
                                   uint16_t CANdevRxIdx, uint16_t CANidLssSlave, CO_CANmodule_t* CANdevTx,
                                   uint16_t CANdevTxIdx, uint16_t CANidLssMaster);
 
void CO_LSSmaster_changeTimeout(CO_LSSmaster_t* LSSmaster, uint16_t timeout_ms);
 
#if (((CO_CONFIG_LSS)&CO_CONFIG_FLAG_CALLBACK_PRE) != 0) || defined CO_DOXYGEN
void CO_LSSmaster_initCallbackPre(CO_LSSmaster_t* LSSmaster, void* object, void (*pFunctSignal)(void* object));
#endif
 
CO_LSSmaster_return_t CO_LSSmaster_swStateSelect(CO_LSSmaster_t* LSSmaster, uint32_t timeDifference_us,
                                                 CO_LSS_address_t* lssAddress);
 
CO_LSSmaster_return_t CO_LSSmaster_swStateDeselect(CO_LSSmaster_t* LSSmaster);
 
CO_LSSmaster_return_t CO_LSSmaster_configureBitTiming(CO_LSSmaster_t* LSSmaster, uint32_t timeDifference_us,
                                                      uint16_t bit);
 
CO_LSSmaster_return_t CO_LSSmaster_configureNodeId(CO_LSSmaster_t* LSSmaster, uint32_t timeDifference_us,
                                                   uint8_t nodeId);
 
CO_LSSmaster_return_t CO_LSSmaster_configureStore(CO_LSSmaster_t* LSSmaster, uint32_t timeDifference_us);
 
CO_LSSmaster_return_t CO_LSSmaster_ActivateBit(CO_LSSmaster_t* LSSmaster, uint16_t switchDelay_ms);
 
CO_LSSmaster_return_t CO_LSSmaster_InquireLssAddress(CO_LSSmaster_t* LSSmaster, uint32_t timeDifference_us,
                                                     CO_LSS_address_t* lssAddress);
 
CO_LSSmaster_return_t CO_LSSmaster_Inquire(CO_LSSmaster_t* LSSmaster, uint32_t timeDifference_us, uint8_t lssInquireCs,
                                           uint32_t* value);
 
typedef enum {
    CO_LSSmaster_FS_SCAN = 0,  
    CO_LSSmaster_FS_SKIP = 1,  
    CO_LSSmaster_FS_MATCH = 2, 
} CO_LSSmaster_scantype_t;
 
typedef struct {
    CO_LSSmaster_scantype_t scan[4]; 
    CO_LSS_address_t match;          
    CO_LSS_address_t found;          
} CO_LSSmaster_fastscan_t;
 
CO_LSSmaster_return_t CO_LSSmaster_IdentifyFastscan(CO_LSSmaster_t* LSSmaster, uint32_t timeDifference_us,
                                                    CO_LSSmaster_fastscan_t* fastscan);
 
 /* @defgroup CO_LSSmaster */
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* (CO_CONFIG_LSS) & CO_CONFIG_LSS_MASTER */
 
#endif /* CO_LSSmaster_H */