1.30.18.45 SERCOMx_SPI_IsBusy Function

C

/* x = SERCOM instance number */

/* SPI master (non-blocking mode) and slave mode */

bool SERCOMx_SPI_IsBusy (void):		

Summary

Returns the busy status of SPI PLIB

Description

SPI master mode

In master mode, this function returns true if the SERCOM SPI module is busy with a transfer. The application can use the function to check if SERCOM SPI module is busy before calling any of the data transfer functions. The library does not allow a data transfer operation if another transfer operation is already in progress. This function can be used as an alternative to the callback function when the library is operating in interrupt mode thereby allowing the application to implement a synchronous interface to the library.

SPI slave mode

In slave mode, this function returns true if SPI slave is busy with a data transfer. The status is returned true when the SPI chip select is driven to active state by SPI master. The status is returned as false when the SPI chip select is driven inactive.

Precondition

The SERCOMx_SPI_Initialize() should have been called once. The module should have been configured for interrupt mode operation in MHC.

Parameters

None.

Returns

Example

SPI master (non-blocking mode) mode

// The following code example demonstrates the use of the
// SERCOMx_SPI_IsBusy() function. This example shows a blocking while
// loop. The function can also be called periodically.

uint8_t dataBuffer[20];

SERCOM0_SPI_Initialize();
SERCOM0_SPI_Write(dataBuffer, 20);

while (SERCOM0_SPI_IsBusy() == true)
{
    // Wait here till the transfer is done.
}

SPI slave mode

while (SERCOM0_SPI_IsBusy() == true)
{
    // Wait here till the chip select is asserted by the SPI master
}

Remarks

None