![]() |
Infineon MOTIX™ MCU TLE988x/9x Device Family SDK
|
Go to the source code of this file.
Application interface declaration for Com layer.
Functions | |
void | Com_InitRx (void) |
This function initializes the RX path of the Com layer. More... | |
void | Com_InitTx (void) |
This function initializes the TX path of the Com layer. More... | |
void | Com_Init (void) |
Initialization of Com module. More... | |
void | Com_DeInit (void) |
This function shall be called only during shutdown routine. More... | |
void | Com_EnableTransmission (uint8 bEnable) |
enables/disables Tx path to hardware driver More... | |
void | Com_EnableReceptionDM (uint8 bEnable) |
enables/disables Rx frame deadline monitoring More... | |
void | Com_MainFunctionTx (void) |
Runnable of Com module (<call cycle>) More... | |
void | Com_MainFunctionRx (const uint8 taskMs) |
Runnable of Com module (<call cycle>) More... | |
uint8 | Com_SendSignal (tComSignalHandle TxSignalHdl, const void *const SignalDataPtr) |
Write a signal value to the transmit buffer. More... | |
uint8 | Com_SendSignalGroup (tComFrameHandle TxFrameHdl) |
Finalize sending signals by updating the frame buffer. More... | |
uint8 | Com_ReceiveSignal (tComSignalHandle RxSignalHdl, void *const SignalDataPtr) |
Read a signal value from the message receive buffer. More... | |
uint8 | Com_ReceiveSignalGroup (tComFrameHandle TxFrameHdl) |
Prepare receiving signals from the shadow buffer. More... | |
uint8 | Com_SendData (tComFrameHandle TxFrameHdl, const uint8 *DataPtr, uint8 Length) |
Copy a data string for transmission. More... | |
uint8 | Com_ReceiveData (tComFrameHandle RxFrameHdl, uint8 *DataPtr, uint8 Length) |
Receive data and copy to the application data array. More... | |
uint8 | Com_Transmit (tComFrameHandle TxFrameHdl) |
Trigger an explicit transmit request for a Tx frame. More... | |
void | Com_TxConfirmation (tComFrameHandle TxFrameHdl, uint8 Status) |
Confirm a successful transmission or a failed transmission attempt by the Can driver. More... | |
void | Com_RxIndication (const tComFrameHandle RxFrameHdl, const uint8 *DataPtr, const uint8 Length) |
Indicate a received frame by the Can driver. More... | |
void | Com_ControllerBusOff (uint8 Channel) |
Can driver notifying that a CAN controller has gone bus-off. More... | |
void Com_ControllerBusOff | ( | uint8 | Channel | ) |
Can driver notifying that a CAN controller has gone bus-off.
@function Com_ControllerBusOff
Channel | the channel index which has gone bus-off |
void |
void Com_DeInit | ( | void | ) |
This function shall be called only during shutdown routine.
@function Com_DeInit
void |
void |
void Com_EnableReceptionDM | ( | uint8 | bEnable | ) |
enables/disables Rx frame deadline monitoring
@function Com_EnableReceptionDM
bEnable | (STD_ON, STD_OFF) |
void |
void Com_EnableTransmission | ( | uint8 | bEnable | ) |
enables/disables Tx path to hardware driver
@function Com_EnableTransmission
bEnable | (STD_ON, STD_OFF) |
void |
void Com_Init | ( | void | ) |
Initialization of Com module.
@function Com_Init
void |
void |
void Com_InitRx | ( | void | ) |
This function initializes the RX path of the Com layer.
@function Com_InitRx
void |
void |
void Com_InitTx | ( | void | ) |
This function initializes the TX path of the Com layer.
@function Com_InitTx
void |
void |
void Com_MainFunctionRx | ( | const uint8 | taskMs | ) |
Runnable of Com module (<call cycle>)
@function Com_MainFunctionRx
void |
void |
void Com_MainFunctionTx | ( | void | ) |
Runnable of Com module (<call cycle>)
@function Com_MainFunctionTx
void |
void |
uint8 Com_ReceiveData | ( | tComFrameHandle | RxFrameHdl, |
uint8 * | DataPtr, | ||
uint8 | Length | ||
) |
Receive data and copy to the application data array.
@function Com_ReceiveData
RxFrameHdl | a handle index from the Rx frames list DataPtr: a pointer to the data destination array Length: number of bytes to be copied, limited to the size of the frame buffer. |
result | of operation: E_OK, E_NOT_OK, E_NOT_AVAILABLE, E_BUSY |
uint8 Com_ReceiveSignal | ( | tComSignalHandle | RxSignalHdl, |
void *const | SignalDataPtr | ||
) |
Read a signal value from the message receive buffer.
@function Com_ReceiveSignal
RxSignalHdl | a handle index from the Rx signals list SignalDataPtr: a void* to the destination variable. The type can be u8, i8, u16, i16, u32, i32. |
result | of operation: E_OK, E_NOT_OK, E_NOT_AVAILABLE, E_BUSY |
uint8 Com_ReceiveSignalGroup | ( | tComFrameHandle | TxFrameHdl | ) |
Prepare receiving signals from the shadow buffer.
@function Com_ReceiveSignalGroup
RxFrameHdl | a handle index from the Rx frames list |
result | of operation: E_OK, E_NOT_OK, E_NOT_AVAILABLE, E_BUSY |
void Com_RxIndication | ( | const tComFrameHandle | RxFrameHdl, |
const uint8 * | DataPtr, | ||
const uint8 | Length | ||
) |
Indicate a received frame by the Can driver.
@function Com_RxIndication
RxFrameHdl | a handle index from the Tx frames list DataPtr: pointer to received data in can hardware. Note: after returning from this function, the pointer becomes invalid as the message object is freed. So the RxIndication function must copy the data before returning. Length: length of received frame according to frame DLC (expanded to number of bytes if CAN-FD) |
void |
uint8 Com_SendData | ( | tComFrameHandle | TxFrameHdl, |
const uint8 * | DataPtr, | ||
uint8 | Length | ||
) |
Copy a data string for transmission.
@function Com_SendData
TxFrameHdl | a handle index from the Tx frames list DataPtr: a pointer to the data source array Length: number of bytes to be copied, limited to the size of the frame buffer. |
result | of operation: E_OK, E_NOT_OK, E_NOT_AVAILABLE, E_BUSY |
uint8 Com_SendSignal | ( | tComSignalHandle | TxSignalHdl, |
const void *const | SignalDataPtr | ||
) |
Write a signal value to the transmit buffer.
@function Com_SendSignal
TxSignalHdl | a handle index from the Tx signals list SignalDataPtr: a void* to the source value. The type can be u8, u16, u32, depending on the configuration for this signal |
result | of operation: E_OK, E_NOT_OK, E_NOT_AVAILABLE, E_BUSY |
uint8 Com_SendSignalGroup | ( | tComFrameHandle | TxFrameHdl | ) |
Finalize sending signals by updating the frame buffer.
@function Com_SendSignalGroup
TxFrameHdl | a handle index from the Tx frames list |
result | of operation: E_OK, E_NOT_OK, E_NOT_AVAILABLE, E_BUSY |
uint8 Com_Transmit | ( | tComFrameHandle | TxFrameHdl | ) |
Trigger an explicit transmit request for a Tx frame.
@function Com_Transmit
TxFrameHdl | a handle index from the Tx frames list |
result | of operation: E_OK, E_NOT_OK, E_NOT_AVAILABLE, E_BUSY |
void Com_TxConfirmation | ( | tComFrameHandle | TxFrameHdl, |
uint8 | Status | ||
) |
Confirm a successful transmission or a failed transmission attempt by the Can driver.
@function Com_TxConfirmation
TxFrameHdl | a handle index from the Tx frames list Status: result of the transmit request; E_OK = success, E_NOT_OK = failed |
void |