1.35.20.20 UARTx_ReadBufferSizeGet Function

C

/* x = UART instance number */

/* Ring buffer mode */

size_t UARTx_ReadBufferSizeGet(void)

Summary

Returns the size of the receive ring buffer

Description

This function returns the size of the receive ring buffer, which is same as the size of the receive ring buffer configured in MHC.

Precondition

UARTx_Initialize must have been called for the associated UART instance.

Parameters

None

Returns

The API returns the size of the receive ring buffer. If 9-bit mode is enabled, then the return value indicates the number of 9-bit data that can be copied to the internal receive ring buffer.

Example

size_t rxBufferSize;

rxBufferSize = UART1_ReadBufferSizeGet();

Remarks

None