|
Detailed Description
Function Documentation
| IFX_EXTERN boolean IfxAsclin_Asc_canReadCount | ( | IfxAsclin_Asc * | asclin, |
| Ifx_SizeT | count, | ||
| Ifx_TickTime | timeout | ||
| ) |
- See Also
- IfxStdIf_DPipe_CanReadCount
- Parameters
-
asclin module handle count Count of data which should be checked (in bytes) timeout in system timer ticks
- Returns
- Returns TRUE if at least count bytes are available for read in the rx buffer, if not the Event is armed to be set when the buffer count is bigger or equal to the requested count.
Definition at line 56 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN boolean IfxAsclin_Asc_canWriteCount | ( | IfxAsclin_Asc * | asclin, |
| Ifx_SizeT | count, | ||
| Ifx_TickTime | timeout | ||
| ) |
- See Also
- IfxStdIf_DPipe_CanWriteCount
- Parameters
-
asclin module handle count Count of data which should be checked (in bytes) timeout in system timer ticks
- Returns
- Returns TRUE if at least count bytes can be written to the tx buffer, if not the Event is armed to be set when the buffer free count is bigger or equal to the requested count
Definition at line 62 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN void IfxAsclin_Asc_clearRx | ( | IfxAsclin_Asc * | asclin) |
- See Also
- IfxStdIf_DPipe_ClearRx
- Parameters
-
asclin module handle
- Returns
- None
Definition at line 68 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN void IfxAsclin_Asc_clearTx | ( | IfxAsclin_Asc * | asclin) |
- See Also
- IfxStdIf_DPipe_ClearTx
- Parameters
-
asclin module handle
- Returns
- None
Definition at line 75 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN boolean IfxAsclin_Asc_flushTx | ( | IfxAsclin_Asc * | asclin, |
| Ifx_TickTime | timeout | ||
| ) |
- See Also
- IfxStdIf_DPipe_FlushTx
- Parameters
-
asclin module handle timeout in system timer ticks
- Returns
- Returns TRUE if the FIFO is empty
Definition at line 92 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN sint32 IfxAsclin_Asc_getReadCount | ( | IfxAsclin_Asc * | asclin) |
- See Also
- IfxStdIf_DPipe_GetReadCount
- Parameters
-
asclin module handle
- Returns
- The number of bytes in the rx buffer
Definition at line 113 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN IfxStdIf_DPipe_ReadEvent IfxAsclin_Asc_getReadEvent | ( | IfxAsclin_Asc * | asclin) |
- See Also
- IIfxStdIf_DPipe_GetReadEvent
- Parameters
-
asclin module handle
- Returns
- Read event object
Definition at line 119 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN uint32 IfxAsclin_Asc_getSendCount | ( | IfxAsclin_Asc * | asclin) |
- See Also
- IfxStdIf_DPipe_GetSendCount
- Parameters
-
asclin module handle
- Returns
- number of bytes send
Definition at line 125 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN Ifx_TickTime IfxAsclin_Asc_getTxTimeStamp | ( | IfxAsclin_Asc * | asclin) |
- See Also
- IfxStdIf_DPipe_GetTxTimeStamp
- Parameters
-
asclin module handle
- Returns
- Time in ticks
Definition at line 131 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN sint32 IfxAsclin_Asc_getWriteCount | ( | IfxAsclin_Asc * | asclin) |
- See Also
- IfxStdIf_DPipe_GetWriteCount
- Parameters
-
asclin module handle
- Returns
- The number of free bytes in the tx buffer
Definition at line 137 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN IfxStdIf_DPipe_WriteEvent IfxAsclin_Asc_getWriteEvent | ( | IfxAsclin_Asc * | asclin) |
- See Also
- IIfxStdIf_DPipe_GetWriteEvent
- Parameters
-
asclin module handle
- Returns
- Write event object
Definition at line 143 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN boolean IfxAsclin_Asc_read | ( | IfxAsclin_Asc * | asclin, |
| void * | data, | ||
| Ifx_SizeT * | count, | ||
| Ifx_TickTime | timeout | ||
| ) |
- See Also
- IfxStdIf_DPipe_Read
- Parameters
-
asclin module handle data Pointer to the start of data count Pointer to the count of data (in bytes). timeout in system timer ticks
- Returns
- Returns TRUE if all items could be read
Returns FALSE if not all the items could be read
A coding example can be found in How to use the ASCLIN ASC Interface driver?
Definition at line 537 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_blockingRead(), and IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN void IfxAsclin_Asc_resetSendCount | ( | IfxAsclin_Asc * | asclin) |
- See Also
- IfxStdIf_DPipe_ResetSendCount
- Parameters
-
asclin module handle
- Returns
- None
Definition at line 547 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_stdIfDPipeInit().
| IFX_EXTERN boolean IfxAsclin_Asc_write | ( | IfxAsclin_Asc * | asclin, |
| void * | data, | ||
| Ifx_SizeT * | count, | ||
| Ifx_TickTime | timeout | ||
| ) |
- See Also
- IfxStdIf_DPipe_Write
- Parameters
-
asclin module handle data Pointer to the start of data count Pointer to the count of data (in bytes). timeout in system timer ticks
- Returns
- Returns TRUE if all items could be written
Returns FALSE if not all the items could be written
A coding example can be found in How to use the ASCLIN ASC Interface driver?
Definition at line 582 of file IfxAsclin_Asc.c.
Referenced by IfxAsclin_Asc_blockingWrite(), and IfxAsclin_Asc_stdIfDPipeInit().
