1.34.27.17 1.35.21.17 USARTx_ReadFreeBufferCountGet Function
C
/* x = USART instance number */
/* Ring buffer mode */
size_t USARTx_ReadFreeBufferCountGet(void)
Summary
Returns the number of bytes of free space available in the internal receive buffer
Description
This API returns the number of bytes of free space available in the internal receive buffer. This API can be used to determine how many bytes can be received before the receive buffer becomes full.
Precondition
USARTx_Initialize must have been called for the associated USART instance.
Parameters
None
Returns
The API returns the number of bytes of free space in the receive buffer. If 9-bit mode is enabled, then the return value indicates number of 9-bit data that can be copied into the internal receive buffer.
Example
size_t nRxFreeSpace; nRxFreeSpace = USART1_ReadFreeBufferCountGet();
Remarks
None