|
Detailed Description
Function Documentation
| IFX_INLINE boolean IfxEray_Eray_allowColdStart | ( | IfxEray_Eray * | eray) |
Allows node to enter the cold startup state.
- Parameters
-
eray pointer to ERAY Module handle.
- Returns
- TRUE if cold start successful otherwise FALSE.
For usage exapmle see : How to use the ERAY Interface driver?
Definition at line 1159 of file IfxEray_Eray.h.
| IFX_INLINE void IfxEray_Eray_bufferReconfig | ( | IfxEray_Eray * | eray, |
| IfxEray_Eray_BufferReconfig * | reconfigBuffer | ||
| ) |
Reconfiguring the buffer or changing the slot.
- Parameters
-
eray pointer to module handle. reconfigBuffer pointer reconfigurable buffer structure.
- Returns
- None
For usage exapmle see : How to use the ERAY Interface driver?
Definition at line 1165 of file IfxEray_Eray.h.
| IFX_INLINE boolean IfxEray_Eray_changePocState | ( | IfxEray_Eray * | eray, |
| IfxEray_PocCommand | PocCommand | ||
| ) |
Changes the POC state and return status.
- Parameters
-
eray pointer to module handle. PocCommand POC command to change state.
- Returns
- TRUE if command accepted.
Definition at line 1171 of file IfxEray_Eray.h.
| IFX_INLINE void IfxEray_Eray_readData | ( | IfxEray_Eray * | eray, |
| uint32 * | data, | ||
| uint8 | payloadLength | ||
| ) |
Reads the received data from output registers.
- Parameters
-
eray pointer to module handle. data pointer to received data buffer. payloadLength payload length received in a frame.
- Returns
- None
Definition at line 1241 of file IfxEray_Eray.h.
| IFX_INLINE void IfxEray_Eray_readFrame | ( | IfxEray_Eray * | eray, |
| IfxEray_Eray_ReceivedFrame * | frame, | ||
| Ifx_SizeT | maxPayloadLength | ||
| ) |
reads the frame received in a buffer.
- Parameters
-
eray pointer to module handle. frame received frame in a buffer. maxPayloadLength maximum payload length received in a frame.
- Returns
- None
For usage exapmle see : How to use the ERAY Interface driver?
Definition at line 1247 of file IfxEray_Eray.h.
| IFX_EXTERN void IfxEray_Eray_receiveFifoFrame | ( | IfxEray_Eray * | eray, |
| IfxEray_Eray_ReceiveControl * | config | ||
| ) |
Transfers frame from fifo in message RAM to Output buffer.
- Parameters
-
eray pointer to ERAY Module handle. config pointer to receive control structure.
- Returns
- None
For usage exapmle see : How to use the ERAY Interface driver?
Definition at line 518 of file IfxEray_Eray.c.
| IFX_EXTERN void IfxEray_Eray_receiveFrame | ( | IfxEray_Eray * | eray, |
| IfxEray_Eray_ReceiveControl * | config | ||
| ) |
Transfers header and data from message buffer to output buffer.
- Parameters
-
eray pointer to ERAY Module handle. config pointer to receive control structure.
- Returns
- None
For usage exapmle see : How to use the ERAY Interface driver?
Definition at line 554 of file IfxEray_Eray.c.
| IFX_INLINE boolean IfxEray_Eray_setPocAllSlots | ( | IfxEray_Eray * | eray) |
Sets the Controller state to ALL Slots mode.
- Parameters
-
eray pointer to module handle.
- Returns
- TRUE if All slots mode is successful otherwise FALSE.
For usage exapmle see : How to use the ERAY Interface driver?
Definition at line 1265 of file IfxEray_Eray.h.
| IFX_INLINE boolean IfxEray_Eray_startCommunication | ( | IfxEray_Eray * | eray) |
Runs the communication controller.
- Parameters
-
eray pointer to ERAY Module handle.
- Returns
- TRUE if communication started otherwise FALSE.
For usage exapmle see : How to use the ERAY Interface driver?
Definition at line 1271 of file IfxEray_Eray.h.
| IFX_EXTERN void IfxEray_Eray_transmitFrame | ( | IfxEray_Eray * | eray, |
| IfxEray_Eray_TransmitControl * | transmitControl | ||
| ) |
Transfers the frame in given slot.
- Parameters
-
eray pointer to module handle. transmitControl transmits frame in a given slot.
- Returns
- None
For usage exapmle see : How to use the ERAY Interface driver?
Definition at line 576 of file IfxEray_Eray.c.
| IFX_INLINE void IfxEray_Eray_wakeUpChannel | ( | IfxEray_Eray * | eray, |
| IfxEray_Channel | channel | ||
| ) |
Wakeups the channel in a cluster.
- Parameters
-
eray pointer to ERAY Module handle. channel wakeup channel Id.
- Returns
- None
For usage exapmle see : How to use the ERAY Interface driver?
Definition at line 1277 of file IfxEray_Eray.h.
| IFX_INLINE boolean IfxEray_Eray_wakeUpCluster | ( | IfxEray_Eray * | eray) |
Wakeups the node in a cluster.
- Parameters
-
eray pointer to ERAY Module handle.
- Returns
- TRUE if cluster is wakeup otherwise FALSE.
For usage exapmle see : How to use the ERAY Interface driver?
Definition at line 1290 of file IfxEray_Eray.h.
| IFX_INLINE void IfxEray_Eray_writeData | ( | IfxEray_Eray * | eray, |
| uint32 * | data, | ||
| uint8 | payloadLength | ||
| ) |
Writes data section of a frame to input data registers.
- Parameters
-
eray pointer to module handle. data data section in frame. payloadLength payload length configured for slot buffer.
- Returns
- None
For usage exapmle see : How to use the ERAY Interface driver?
Definition at line 1296 of file IfxEray_Eray.h.
