1.23.27.10 UARTx_WriteBufferSizeGet Function

C

/* x = UART instance number */

/* Ring buffer mode */
size_t UARTx_WriteBufferSizeGet(void)

Summary

Returns the size of the internal transmit ring buffer

Description

This function returns the size of the transmit ring buffer, which is same as the size of the transmit 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 transmit 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 transmit ring buffer.

Example

size_t txBufferSize;

txBufferSize = UART1_WriteBufferSizeGet();

// Set a threshold to get notification when the transmit ring buffer is empty
UART1_WriteThresholdSet(txBufferSize);

Remarks

None