|
Detailed Description
Function Documentation
| IFX_INLINE boolean IfxMultican_Can_MsgObj_cancelSend | ( | IfxMultican_Can_MsgObj * | msgObj) |
Cancel pending TX request by invalidating the request
Only when frame transmission has not been started.
- Parameters
-
msgObj pointer to the CAN message object handle
- Returns
- TRUE if cancellation was successfully executed
Definition at line 1201 of file IfxMultican_Can.h.
| IFX_INLINE void IfxMultican_Can_MsgObj_clearRxPending | ( | IfxMultican_Can_MsgObj * | msgObj) |
Clear the RX pending flag of a message object.
- Parameters
-
msgObj pointer to the CAN message object handle
- Returns
- None
A coding example can be found in How to use the CAN Interface driver?
Definition at line 1209 of file IfxMultican_Can.h.
| IFX_INLINE void IfxMultican_Can_MsgObj_clearTxPending | ( | IfxMultican_Can_MsgObj * | msgObj) |
Clear the TX pending flag of a message object.
- Parameters
-
msgObj pointer to the CAN message object handle
- Returns
- None
A coding example can be found in How to use the CAN Interface driver?
Definition at line 1217 of file IfxMultican_Can.h.
| IFX_INLINE void IfxMultican_Can_MsgObj_deinit | ( | IfxMultican_Can_MsgObj * | msgObj) |
Reset the message object
Append the message object to the end of idle list and reset message object registers.
- Parameters
-
msgObj pointer to the CAN message object handle
- Returns
- None
Definition at line 1225 of file IfxMultican_Can.h.
| IFX_EXTERN void IfxMultican_Can_MsgObj_getConfig | ( | IfxMultican_Can_MsgObj * | msgObj, |
| IfxMultican_Can_MsgObjConfig * | config | ||
| ) |
Get the actual message object configuration.
- Parameters
-
msgObj pointer to the CAN message object handle config Pointer to the RAM buffer. Filled by this function
- Returns
- None
Definition at line 35 of file IfxMultican_Can.c.
| IFX_INLINE IfxMultican_MsgObjId IfxMultican_Can_MsgObj_getPendingId | ( | IfxMultican_Can_MsgObj * | msgObj, |
| IfxMultican_MsgObjGroup | msgObjGroup | ||
| ) |
Get message object ID which has TX/RX pending flag from a message object group.
- Parameters
-
msgObj pointer to the CAN message object handle msgObjGroup Message object group
- Returns
- Message Object Id
Definition at line 1231 of file IfxMultican_Can.h.
| IFX_INLINE IfxMultican_MsgObjStat IfxMultican_Can_MsgObj_getStatus | ( | IfxMultican_Can_MsgObj * | msgObj) |
Get the message object status.
- Parameters
-
msgObj pointer to the CAN message object handle
- Returns
- IfxMultican_MsgObjStat bitfield
A coding example can be found in How to use the CAN Interface driver?
Definition at line 1237 of file IfxMultican_Can.h.
| IFX_EXTERN IfxMultican_Status IfxMultican_Can_MsgObj_init | ( | IfxMultican_Can_MsgObj * | msgObj, |
| const IfxMultican_Can_MsgObjConfig * | config | ||
| ) |
Initialize the message object.
- Parameters
-
msgObj pointer to the CAN message object handle config pointer to the CAN message object configuration
- Returns
- Status
A coding example can be found in How to use the CAN Interface driver?
Definition at line 68 of file IfxMultican_Can.c.
| IFX_EXTERN void IfxMultican_Can_MsgObj_initConfig | ( | IfxMultican_Can_MsgObjConfig * | config, |
| IfxMultican_Can_Node * | node | ||
| ) |
Initialise message config with default values and the given parameters.
- Parameters
-
config pointer to the CAN message object configuration node pointer to the CAN node handle to which the message object should be assigned
- Returns
- None
A coding example can be found in How to use the CAN Interface driver?
Definition at line 557 of file IfxMultican_Can.c.
| IFX_EXTERN boolean IfxMultican_Can_MsgObj_isRxPending | ( | IfxMultican_Can_MsgObj * | msgObj) |
Returns the RX pending flag of a message object.
- Parameters
-
msgObj pointer to the CAN message object handle
- Returns
- TRUE of the RX pending flag of a message object is set
Definition at line 596 of file IfxMultican_Can.c.
| IFX_EXTERN boolean IfxMultican_Can_MsgObj_isTransmitRequested | ( | IfxMultican_Can_MsgObj * | msgObj) |
Returns the TX Request flag of a message object.
- Parameters
-
msgObj pointer to the CAN message object handle
- Returns
- TRUE of the TX Request flag of a message object is set
Definition at line 611 of file IfxMultican_Can.c.
| IFX_EXTERN boolean IfxMultican_Can_MsgObj_isTxPending | ( | IfxMultican_Can_MsgObj * | msgObj) |
Returns the TX pending flag of a message object.
- Parameters
-
msgObj pointer to the CAN message object handle
- Returns
- TRUE of the TX pending flag of a message object is set
Definition at line 628 of file IfxMultican_Can.c.
| IFX_INLINE IfxMultican_Status IfxMultican_Can_MsgObj_readLongFrame | ( | IfxMultican_Can_MsgObj * | msgObj, |
| IfxMultican_Message * | msg, | ||
| uint32 * | data | ||
| ) |
Read a received CAN message.
- Parameters
-
msgObj pointer to the CAN message object handle msg This parameter is filled in by the function with the received message. Also when reading is not successful data Pointer to data (in words)
- Returns
- IfxMultican_Status_newData: if the operation was successful
IfxMultican_Status_newDataButMessageLost: if the one message lost and last new data is retrieved successfully
IfxMultican_Status_messageLost: if the message lost and new data is not yet ready
IfxMultican_Status_receiveEmpty: if no message is been received
A coding example can be found in How to use the CAN Interface driver?
Definition at line 1245 of file IfxMultican_Can.h.
| IFX_EXTERN IfxMultican_Status IfxMultican_Can_MsgObj_readMessage | ( | IfxMultican_Can_MsgObj * | msgObj, |
| IfxMultican_Message * | msg | ||
| ) |
Read a received CAN message.
- Parameters
-
msgObj pointer to the CAN message object handle msg This parameter is filled in by the function with the received message. Also when reading is not successful
- Returns
- IfxMultican_Status_newData: if the operation was successful
IfxMultican_Status_newDataButMessageLost: if the one message lost and last new data is retrieved successfully
IfxMultican_Status_messageLost: if the message lost and new data is not yet ready
IfxMultican_Status_receiveEmpty: if no message is been received
A coding example can be found in How to use the CAN Interface driver?
Definition at line 645 of file IfxMultican_Can.c.
| IFX_INLINE IfxMultican_Status IfxMultican_Can_MsgObj_sendLongFrame | ( | IfxMultican_Can_MsgObj * | msgObj, |
| IfxMultican_Message * | msg, | ||
| uint32 * | data | ||
| ) |
Read a received CAN message.
- Parameters
-
msgObj pointer to the CAN message object handle msg This parameter is filled in by the function with the received message. Also when reading is not successful data Pointer to data (in words)
- Returns
- IfxMultican_Status_ok: if the operation was successful IfxMultican_Status_notSentBusy: if the operation was unsuccessful due to hardware is busy
A coding example can be found in How to use the CAN Interface driver?
Definition at line 1251 of file IfxMultican_Can.h.
| IFX_EXTERN IfxMultican_Status IfxMultican_Can_MsgObj_sendMessage | ( | IfxMultican_Can_MsgObj * | msgObj, |
| const IfxMultican_Message * | msg | ||
| ) |
Send a CAN message.
- Parameters
-
msgObj pointer to the CAN message object handle msg Specifies the msg to be send
- Returns
- IfxMultican_Status_ok: if the operation was successful
IfxMultican_Status_notSentBusy: if the operation was unsuccessful due to hardware is busy
A coding example can be found in How to use the CAN Interface driver?
Definition at line 685 of file IfxMultican_Can.c.
