|
Detailed Description
Function Documentation
| IFX_EXTERN boolean IfxPsi5_Psi5_initChannel | ( | IfxPsi5_Psi5_Channel * | channel, |
| const IfxPsi5_Psi5_ChannelConfig * | config | ||
| ) |
Initialize the channel with the supplied configuration.
- Parameters
-
channel pointer to the PSI5 channel config pointer to the PSI5 channel configuration
- Returns
- TRUE on success & FALSE if configuration not valid
A coding example can be found in How to use the PSI5 PSI5 Interface driver?
Definition at line 119 of file IfxPsi5_Psi5.c.
| IFX_EXTERN void IfxPsi5_Psi5_initChannelConfig | ( | IfxPsi5_Psi5_ChannelConfig * | config, |
| IfxPsi5_Psi5 * | psi5 | ||
| ) |
Get the current channel configuration (e.g. sample settings)
- Parameters
-
config pointer to the PSI5 channel configuration psi5 pointer to the PSI5 module
- Returns
- None
A coding example can be found in How to use the PSI5 PSI5 Interface driver?
Definition at line 269 of file IfxPsi5_Psi5.c.
| IFX_EXTERN boolean IfxPsi5_Psi5_readChannelFrame | ( | IfxPsi5_Psi5_Channel * | channel, |
| IfxPsi5_Psi5_Frame * | frame | ||
| ) |
Gets the received psi5 frame for the channel.
- Parameters
-
channel pointer to the PSI5 channel frame pointer to the PSI5 frame buffer
- Returns
- TRUE if successful; FALSE if no frame available
A coding example can be found in How to use the PSI5 PSI5 Interface driver?
Definition at line 538 of file IfxPsi5_Psi5.c.
| IFX_EXTERN boolean IfxPsi5_Psi5_readChannelSerialMessage | ( | IfxPsi5_Psi5_Channel * | channel, |
| IfxPsi5_Slot | slot, | ||
| IfxPsi5_Psi5_SerialMessage * | message | ||
| ) |
Get the received serial message for the channel.
- Parameters
-
channel pointer to the PSI5 channel slot Slot Id message pointer to the PSI5 serial message buffer
- Returns
- TRUE if successful; FALSE if no serial message available
Definition at line 556 of file IfxPsi5_Psi5.c.
| IFX_EXTERN boolean IfxPsi5_Psi5_sendChannelData | ( | IfxPsi5_Psi5_Channel * | channel, |
| uint64 | data | ||
| ) |
Transmit the data through the channel.
- Parameters
-
channel pointer to the PSI5 channel data data to be sent
- Returns
- TRUE if successful; FALSE otherwise
A coding example can be found in How to use the PSI5 PSI5 Interface driver?
Definition at line 582 of file IfxPsi5_Psi5.c.
| IFX_INLINE boolean IfxPsi5_Psi5_startupChannel | ( | IfxPsi5_Psi5_Channel * | channel, |
| IfxPsi5_Psi5_StartupOptions * | options | ||
| ) |
start the channel with the selected options
- Parameters
-
channel pointer to the PSI5 channel options startup related options
- Returns
- TRUE if successful; FALSE otherwise
A coding example can be found in How to use the PSI5 PSI5 Interface driver?
Definition at line 459 of file IfxPsi5_Psi5.h.
