1.17.20.2 UARTx_AutoBaudQuery Function

C

/* x = UART instance number */

/* Blocking, non-blocking and ring buffer mode */

bool UARTx_AutoBaudQuery(void)

Summary

Returns the status of auto-baud operation.

Description

This API lets the application know if the auto-baud is complete or not. After enabling auto-baud, the hardware waits for a 0x55 character to determine the baud rate. Once complete, the API returns false.

Precondition

UARTx_Initialize must have been called for the associated UART instance and UARTx_AutoBaudSet( true ) must have been called to enable auto-baud detection.

Parameters

None

Returns

true - auto-baud operation is not complete

false - auto-baud operation is complete

Example

// Start up auto-baud sensing feature
UART1_AutoBaudSet(true);

while(UART1_AutoBaudQuery()==true);

Remarks

None