sbgEComCmdInterface.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_CMD_INTERFACE_H
#define SBG_ECOM_CMD_INTERFACE_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
 
// Project headers
#include <sbgECom.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Serial interface definitions                                       -//
//----------------------------------------------------------------------//
 
typedef enum _SbgEComPortId
{
    SBG_ECOM_IF_COM_A = 0,          
    SBG_ECOM_IF_COM_B = 1,          
    SBG_ECOM_IF_COM_C = 2,          
    SBG_ECOM_IF_COM_D = 3,          
    SBG_ECOM_IF_COM_E = 4,          
    SBG_ECOM_IF_ETH_0 = 10,         
    SBG_ECOM_IF_ETH_1 = 11,         
    SBG_ECOM_IF_ETH_2 = 12,         
    SBG_ECOM_IF_ETH_3 = 13,         
    SBG_ECOM_IF_ETH_4 = 14,         
    SBG_ECOM_IF_DATA_LOGGER = 20,   
} SbgEComPortId;
 
typedef enum _SbgEComPortMode
{
    SBG_ECOM_UART_MODE_OFF = 0,     
    SBG_ECOM_UART_MODE_232 = 1,     
    SBG_ECOM_UART_MODE_422 = 2,     
} SbgEComPortMode;
 
//----------------------------------------------------------------------//
//- Serial interface configuration                                     -//
//----------------------------------------------------------------------//
 
typedef struct _SbgEComInterfaceConf
{
    uint32_t            baudRate;   
    SbgEComPortMode     mode;       
} SbgEComInterfaceConf;
 
//----------------------------------------------------------------------//
//- CAN interface definitions                                          -//
//----------------------------------------------------------------------//
 
typedef enum _SbgEComCanBitRate
{
    SBG_ECOM_CAN_BITRATE_DISABLED   = 0,            
    SBG_ECOM_CAN_BITRATE_10         = 10,           
    SBG_ECOM_CAN_BITRATE_20         = 20,           
    SBG_ECOM_CAN_BITRATE_25         = 25,           
    SBG_ECOM_CAN_BITRATE_50         = 50,           
    SBG_ECOM_CAN_BITRATE_100        = 100,          
    SBG_ECOM_CAN_BITRATE_125        = 125,          
    SBG_ECOM_CAN_BITRATE_250        = 250,          
    SBG_ECOM_CAN_BITRATE_500        = 500,          
    SBG_ECOM_CAN_BITRATE_750        = 750,          
    SBG_ECOM_CAN_BITRATE_1000       = 1000,         
} SbgEComCanBitRate;
 
typedef enum _SbgEComCanMode
{
    SBG_ECOM_CAN_MODE_UNDEFINED     = 0,    
    SBG_ECOM_CAN_MODE_SPY           = 1,    
    SBG_ECOM_CAN_MODE_NORMAL        = 2,    
    SBG_ECOM_CAN_NR_MODE
} SbgEComCanMode;
 
//----------------------------------------------------------------------//
//- Public methods                                                     -//
//----------------------------------------------------------------------//
 
SbgErrorCode sbgEComCmdInterfaceGetUartConf(SbgEComHandle *pHandle, SbgEComPortId interfaceId, SbgEComInterfaceConf *pConf);
 
SbgErrorCode sbgEComCmdInterfaceSetUartConf(SbgEComHandle *pHandle, SbgEComPortId interfaceId, const SbgEComInterfaceConf *pConf);
 
SbgErrorCode sbgEComCmdInterfaceGetCanConf(SbgEComHandle *pHandle, SbgEComCanBitRate *pBitrate, SbgEComCanMode *pMode);
 
SbgErrorCode sbgEComCmdInterfaceSetCanConf(SbgEComHandle *pHandle, SbgEComCanBitRate bitRate, SbgEComCanMode mode);
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_CMD_INTERFACE_H