1.40.20.3 SERCOMx_USART_WriteIsBusy Function

C

/* x = SERCOM instance number */

/* Non-blocking mode */

bool SERCOMx_USART_WriteIsBusy( void )

Summary

Returns the write request status associated with the given USART peripheral instance

Description

This function returns the write request status associated with the given USART peripheral instance. It can be used to check the completion status of the SERCOMx_USART_Write() function when the library is configured for non-blocking (interrupt) mode. In that, the function can be used as an alternative to using a callback function to check for completion.

Precondition

SERCOMx_USART_Initialize must have been called for the associated USART instance.

Parameters

None.

Returns

true - USART is busy in processing the previous write request.

false - USART is free and ready to accept a new write request.

Example

if(SERCOM0_USART_WriteIsBusy() == true)
{
    //USART is currently processing the previous write request.
    //Wait to submit new request.
}

Remarks

None