4.13.1 SPI - Serial Peripheral Interface

This header file provides API prototypes for the SPI0 driver.

This header file provides API prototypes for the SPI module in Polling and Interrupt mode.

This header file provides type definitions for the SPI module operation in Polling mode.

This header file provides type definitions for the SPI module operation in Interrupt mode.

The SPI must be opened by calling <component_name>_open() before it can be used. After use, the SPI is closed by calling <component_name>_close(). A call to <component_name>_open() for a SPI which is already open will return a false value, indicating that the SPI is already busy on behalf of another process.

If several SPI hardware instances are available on the device, the user can select which SPI instance the driver shall use.

When in Host mode, the SPI generates the SCK clock. Data is driven out on the MOSI I/O pin according to the configured phase and polarity.

Here the Host sends bytes to the Micrcontroller running this code, acting as a client. When in Client mode, the SPI receives the SCK clock from the Host and uses this to sample data on the MOSI I/O pin. The phase and polarity must be configured according to the values used by the Host.

/* Required header files for example */
#include "/mcc_generated_files/spi/spi0.h"

typedef struct SPIdatas {
    uint8_t buffer[10];
    uint32_t count;
} SPIdata;

SPIdata SPI;

volatile uint8_t SPIFlag;

void SPITransferComplete(void) {
    IO_INTERRUPT_SetHigh();
    SPIFlag = 1;
    IO_INTERRUPT_SetLow();
}

int main(void) {
    SYSTEM_Initialize();
    SPI_Open(0); // Initialize SPI with configuration 0
    SPI_RegisterTransferDoneCallback(SPITransferComplete);
    SPI_BufferRead(SPI.buffer, 1); // set up transfer for new SPI block
    //   CPUINT_Initialize();
    ENABLE_INTERRUPTS();
    while (1) {
        if (SPIFlag == 1) {
            //      SPI.done = 1; // Deal with newly read SPI data
            IO_INTERRUPT_SetHigh();
            SPI_BufferRead(SPI.buffer, 1); // set up transfer for new SPI block
            SPIFlag = 0; // Deal with newly read SPI data
            SPI.count++;
            IO_INTERRUPT_SetLow();
        } else {
        }
    }
}

• uint8_t ctrla

• uint8_t ctrlb

The documentation for this struct was generated from the following files:

source/

spi_interrupt_types.h

source/

spi_polling_types.h

• uint8_t * buffer

• size_t bufferLength

• spi_transfer_type_t transferType

• spi_status_t status

The documentation for this struct was generated from the following file:

source/

spi_interrupt_types.h

SPI driver interface object.

SPI Driver prototypes struct.

#include <spi_interface_interrupt.h>

The documentation for this struct was generated from the following files:

source/

spi_interface_interrupt.h

source/

spi_interface_polling.h

• void SPI0_ISR (void)

• void SPI0_Initialize (void)

  Initializes the SPI0 module.

• void SPI0_Deinitialize (void)

  Deinitializes the SPI0 module.

• bool SPI0_Open (uint8_t spiConfigIndex)

  Enables the SPI0 module with the configurations passed as the parameter. See spi0_configuration_name_t for the available configurations.

• void SPI0_Close (void)

  Closes the active configuration of the SPI0 module.

• void SPI0_RxCompleteCallbackRegister (void(*CallbackHandler)(void))

  Sets the callback function to be executed at the completion of data transfer in Interrupt mode.

• uint8_t SPI0_ByteExchange (uint8_t byteData)

  Exchanges one byte using the SPI protocol. This function is blocking.

• void SPI0_BufferExchange (void *bufferData, size_t bufferSize)

  Exchanges the buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_BufferWrite (void *bufferData, size_t bufferSize)

  Writes a buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_BufferRead (void *bufferData, size_t bufferSize)

  Reads a buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_ByteWrite (uint8_t byteData)

  Writes one byte using the SPI protocol. This function is blocking in Polling mode.

• uint8_t SPI0_ByteRead (void)

  Receives one byte using SPI protocol. This function is blocking.

• bool SPI0_IsTxReady (void)

  Checks if the SPI0 module is ready to write data.

• bool SPI0_IsRxReady (void)

  Checks if the SPI0 module is ready to read data.

• ISR (SPI0_INT_vect)

• const struct SPI_INTERFACE SPI0_s

• static void(* SPI0_RxCompleteCallback )(void)

• static spi_descriptor_t spi0_descriptor

• static const spi_configuration_t spi0_configuration []

• void SPI0_Initialize (void)

  Initializes the SPI0 module.

• void SPI0_Deinitialize (void)

  Deinitializes the SPI0 module.

• bool SPI0_Open (uint8_t spiConfigIndex)

  Enables the SPI0 module with the configurations passed as the parameter. See spi0_configuration_name_t for the available configurations.

• void SPI0_Close (void)

  Closes the active configuration of the SPI0 module.

• uint8_t SPI0_ByteExchange (uint8_t byteData)

  Exchanges one byte using the SPI protocol. This function is blocking.

• void SPI0_BufferExchange (void *bufferData, size_t bufferSize)

  Exchanges the buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_BufferWrite (void *bufferData, size_t bufferSize)

  Writes a buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_BufferRead (void *bufferData, size_t bufferSize)

  Reads a buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_ByteWrite (uint8_t byteData)

  Writes one byte using the SPI protocol. This function is blocking in Polling mode.

• uint8_t SPI0_ByteRead (void)

  Receives one byte using SPI protocol. This function is blocking.

• bool SPI0_IsRxReady (void)

  Checks if the SPI0 module is ready to read data.

• bool SPI0_IsTxReady (void)

  Checks if the SPI0 module is ready to write data.

• void SPI0_RxCompleteCallbackRegister (void(*callbackHandler)(void))

  Sets the callback function to be executed at the completion of data transfer in Interrupt mode.

• enum SPI0_configuration_name_t { SPI0_DEFAULT, SPI0_DEFAULT }

  Enumeration for the different configurations supported by the driver. A configuration is specified as parameter to SPI0_Open() and is used by the function to set SPI parameters as specified by the configuration.

• const struct SPI_INTERFACE SPI0_s

• void SPI0_Initialize (void)

  Initializes the SPI0 module.

• void SPI0_Deinitialize (void)

  Deinitializes the SPI0 module.

• bool SPI0_Open (uint8_t spiConfigIndex)

  Enables the SPI0 module with the configurations passed as the parameter. See spi0_configuration_name_t for the available configurations.

• void SPI0_Close (void)

  Closes the active configuration of the SPI0 module.

• uint8_t SPI0_ByteExchange (uint8_t byteData)

  Exchanges one byte using the SPI protocol. This function is blocking.

• bool SPI0_IsTxReady (void)

  Checks if the SPI0 module is ready to write data.

• bool SPI0_IsRxReady (void)

  Checks if the SPI0 module is ready to read data.

• void SPI0_BufferExchange (void *bufferData, size_t bufferSize)

  Exchanges the buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_BufferWrite (void *bufferData, size_t bufferSize)

  Writes a buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_BufferRead (void *bufferData, size_t bufferSize)

  Reads a buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_ByteWrite (uint8_t byteData)

  Writes one byte using the SPI protocol. This function is blocking in Polling mode.

• uint8_t SPI0_ByteRead (void)

  Receives one byte using SPI protocol. This function is blocking.

• const struct SPI_INTERFACE SPI0_s

• static const spi_configuration_t spi0_configuration []

• void SPI0_Initialize (void)

  Initializes the SPI0 module.

• void SPI0_Deinitialize (void)

  Deinitializes the SPI0 module.

• bool SPI0_Open (uint8_t spiConfigIndex)

  Enables the SPI0 module with the configurations passed as the parameter. See spi0_configuration_name_t for the available configurations.

• void SPI0_Close (void)

  Closes the active configuration of the SPI0 module.

• uint8_t SPI0_ByteExchange (uint8_t byteData)

  Exchanges one byte using the SPI protocol. This function is blocking.

• void SPI0_BufferExchange (void *bufferData, size_t bufferSize)

  Exchanges the buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_BufferWrite (void *bufferData, size_t bufferSize)

  Writes a buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_BufferRead (void *bufferData, size_t bufferSize)

  Reads a buffer using the SPI protocol. This function is blocking in Polling mode.

• void SPI0_ByteWrite (uint8_t byteData)

  Writes one byte using the SPI protocol. This function is blocking in Polling mode.

• uint8_t SPI0_ByteRead (void)

  Receives one byte using SPI protocol. This function is blocking.

• bool SPI0_IsRxReady (void)

  Checks if the SPI0 module is ready to read data.

• bool SPI0_IsTxReady (void)

  Checks if the SPI0 module is ready to write data.

• enum SPI0_configuration_name_t { SPI0_DEFAULT, SPI0_DEFAULT }

• const struct SPI_INTERFACE SPI0_s

• struct SPI_INTERFACE

  SPI driver interface object.

• struct SPI_INTERFACE

  SPI driver interface object.

• struct spi_descriptor_t

• struct spi_configuration_t

• enum spi_status_t { SPI_RESET = 0x00U, SPI_IDLE = 0x81U, SPI_BUSY = 0x42U }

  Enumeration for the different states of the SPI module.

• enum spi_transfer_type_t { SPI_READ = 0x00U, SPI_WRITE = 0x81U, SPI_EXCHANGE = 0X42U }

  Enumeration for the different transfer types of the SPI module.

SPI Type Definitions Header File

• struct spi_configuration_t

SPI Type Definitions Header File