sbgECom
1.11.920-stable
|
This file implements SbgECom commands related to interfaces. More...
#include "sbgEComCmdCommon.h"
Go to the source code of this file.
Data Structures | |
struct | _SbgEComInterfaceConf |
Typedefs | |
typedef enum _SbgEComPortId | SbgEComPortId |
typedef enum _SbgEComPortMode | SbgEComPortMode |
typedef struct _SbgEComInterfaceConf | SbgEComInterfaceConf |
typedef enum _SbgEComCanBitRate | SbgEComCanBitRate |
typedef enum _SbgEComCanMode | SbgEComCanMode |
Enumerations | |
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 } |
enum | _SbgEComPortMode { SBG_ECOM_UART_MODE_OFF = 0, SBG_ECOM_UART_MODE_232 = 1, SBG_ECOM_UART_MODE_422 = 2 } |
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 } |
enum | _SbgEComCanMode { SBG_ECOM_CAN_MODE_UNDEFINED = 0, SBG_ECOM_CAN_MODE_SPY = 1, SBG_ECOM_CAN_MODE_NORMAL = 2 } |
Functions | |
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) |
This file implements SbgECom commands related to interfaces.
Copyright (C) 2007-2013, SBG Systems SAS. All rights reserved.
This source code is intended for use only by SBG Systems SAS and those that have explicit written permission to use it from SBG Systems SAS.
THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
typedef enum _SbgEComPortId SbgEComPortId |
List of serial interfaces available.
typedef enum _SbgEComPortMode SbgEComPortMode |
List of serial modes available.
typedef struct _SbgEComInterfaceConf SbgEComInterfaceConf |
Helper structure to configure a serial interface
typedef enum _SbgEComCanBitRate SbgEComCanBitRate |
Enum containing the list of all available bit rates (in KB/s).
typedef enum _SbgEComCanMode SbgEComCanMode |
Enum containing the list of different CAN modes
enum _SbgEComPortId |
List of serial interfaces available.
enum _SbgEComPortMode |
enum _SbgEComCanBitRate |
Enum containing the list of all available bit rates (in KB/s).
enum _SbgEComCanMode |
SbgErrorCode sbgEComCmdInterfaceGetUartConf | ( | SbgEComHandle * | pHandle, |
SbgEComPortId | interfaceId, | ||
SbgEComInterfaceConf * | pConf | ||
) |
Retrieve the configuration of one of the interfaces.
[in] | pHandle | A valid sbgECom handle. |
[in] | interfaceId | The interface from which the configuration is to be retrieved. |
[out] | pConf | Pointer to a SbgEComInterfaceConf struct to hold configuration of the interface. |
SbgErrorCode sbgEComCmdInterfaceSetUartConf | ( | SbgEComHandle * | pHandle, |
SbgEComPortId | interfaceId, | ||
const SbgEComInterfaceConf * | pConf | ||
) |
Set the configuration of one of the interfaces.
[in] | pHandle | A valid sbgECom handle. |
[in] | interfaceId | The interface from which the configuration is to be retrieved. |
[in] | pConf | Pointer to a SbgEComInterfaceConf struct that holds the new configuration for the interface. |
SbgErrorCode sbgEComCmdInterfaceGetCanConf | ( | SbgEComHandle * | pHandle, |
SbgEComCanBitRate * | pBitrate, | ||
SbgEComCanMode * | pMode | ||
) |
Retrieve the configuration of the CAN interface.
[in] | pHandle | A valid sbgECom handle. |
[out] | pBitRate | The bitrate of the CAN interface. |
[out] | pCanMode | Mode of the CAN interface. |
SbgErrorCode sbgEComCmdInterfaceSetCanConf | ( | SbgEComHandle * | pHandle, |
SbgEComCanBitRate | bitrate, | ||
SbgEComCanMode | mode | ||
) |
Set the configuration of the CAN interface.
[in] | pHandle | A valid sbgECom handle. |
[in] | bitRate | The bitrate of the CAN interface. |
[in] | pCanMode | Mode of the CAN interface. |