1.8.24.12 UARTx_ReceiverIsReady Function

C

/* x = UART instance number */

/* Blocking mode */

bool UARTx_ReceiverIsReady( void )

Summary

Returns the hardware status of the UART Receiver

Description

This function returns the hardware status associated with the Receive hardware FIFO of the given UART peripheral instance. When Receiver is ready, user can read the available data. This function is available only in blocking (non-interrupt) mode of operation. It can be used to achieve non-blocking behavior of UARTx_Read function even if the library is configured for blocking behavior. If this function returns true, calling the UARTx_Read function with a byte count of 1 will result in non-blocking behavior.

Precondition

UARTx_Initialize must have been called for the associated UART instance.

Parameters

None.

Returns

Example

char rxData;

if(UART1_ReceiverIsReady() == true)
{
    // At least one data is available in Receive FIFO, hence can read a byte
    UART1_Read(&rxData, 1);
}
else
{
    //Receiver is empty
}

Remarks

None