4.22.2 SPI in MSSP

• struct SPI_INTERFACE

  SPI driver interface object.

• enum spi2_configuration_name_t { MSSP2_DEFAULT }

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

• void SPI2_Initialize (void)

  Initializes the SPI2 module.

• void SPI2_Deinitialize (void)

  Deinitializes the SPI2 module.

• bool SPI2_Open (uint8_t spiConfigIndex)

  Enables the SPI2 module with the configurations passed as the parameter. See spi2_config_names_t for the available configurations.

• void SPI2_Close (void)

  Closes the active configuration of the SPI2 module.

• void SPI2_BufferExchange (void *bufferData, size_t bufferSize)

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

• void SPI2_BufferWrite (void *bufferData, size_t bufferSize)

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

• void SPI2_BufferRead (void *bufferData, size_t bufferSize)

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

• uint8_t SPI2_ByteExchange (uint8_t byteData)

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

• void SPI2_ByteWrite (uint8_t byteData)

  Writes one byte to the SPI buffer.

• uint8_t SPI2_ByteRead (void)

  Reads one byte of data received in the the SPI buffer.

• bool SPI2_IsRxReady (void)

  Checks if the SPI2 module is ready to read data.

• bool SPI2_IsTxReady (void)

  Checks if the SPI2 module is ready to write data.

• void SPI2_RxCompleteCallbackRegister (void(*CallbackHandler)(void))

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

• void SPI2_ISR (void)

  Interrupt Service Routine (ISR) for the SPI2 module.

void SPI2_BufferExchange (void * bufferData, size_t bufferSize)

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

void SPI2_BufferRead (void * bufferData, size_t bufferSize)

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

void SPI2_BufferWrite (void * bufferData, size_t bufferSize)

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

uint8_t SPI2_ByteExchange (uint8_t byteData)

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

uint8_t SPI2_ByteRead (void )

Reads one byte of data received in the the SPI buffer.

void SPI2_ByteWrite (uint8_t byteData)

Writes one byte to the SPI buffer.

void SPI2_Close (void )

Closes the active configuration of the SPI2 module.

void SPI2_Deinitialize (void )

Deinitializes the SPI2 module.

void SPI2_Initialize (void )

Initializes the SPI2 module.

void SPI2_ISR (void )

Interrupt Service Routine (ISR) for the SPI2 module.

bool SPI2_IsRxReady (void )

Checks if the SPI2 module is ready to read data.

bool SPI2_IsTxReady (void )

Checks if the SPI2 module is ready to write data.

bool SPI2_Open (uint8_t spiConfigIndex)

Enables the SPI2 module with the configurations passed as the parameter. See spi2_config_names_t for the available configurations.

void SPI2_RxCompleteCallbackRegister (void(*)(void) CallbackHandler)

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

enum enum spi2_configuration_name_t

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

• struct SPI_INTERFACE

  SPI driver interface object.

• enum spi1_configuration_name_t { MSSP1_DEFAULT }

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

• void SPI1_Initialize (void)

  Initializes the SPI1 module.

• void SPI1_Deinitialize (void)

  Deinitializes the SPI1 module.

• bool SPI1_Open (uint8_t spiConfigIndex)

  Enables the SPI1 module with the configurations passed as the parameter. See spi1_config_names_t for the available configurations.

• void SPI1_Close (void)

  Closes the active configuration of the SPI1 module.

• void SPI1_BufferExchange (void *bufferData, size_t bufferSize)

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

• void SPI1_BufferWrite (void *bufferData, size_t bufferSize)

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

• void SPI1_BufferRead (void *bufferData, size_t bufferSize)

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

• uint8_t SPI1_ByteExchange (uint8_t byteData)

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

• void SPI1_ByteWrite (uint8_t byteData)

  Writes one byte to the SPI buffer.

• uint8_t SPI1_ByteRead (void)

  Reads one byte of data received in the the SPI buffer.

• bool SPI1_IsRxReady (void)

  Checks if the SPI1 module is ready to read data.

• bool SPI1_IsTxReady (void)

  Checks if the SPI1 module is ready to write data.

void SPI1_BufferExchange (void * bufferData, size_t bufferSize)

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

void SPI1_BufferRead (void * bufferData, size_t bufferSize)

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

void SPI1_BufferWrite (void * bufferData, size_t bufferSize)

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

uint8_t SPI1_ByteExchange (uint8_t byteData)

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

uint8_t SPI1_ByteRead (void )

Reads one byte of data received in the the SPI buffer.

void SPI1_ByteWrite (uint8_t byteData)

Writes one byte to the SPI buffer.

void SPI1_Close (void )

Closes the active configuration of the SPI1 module.

void SPI1_Deinitialize (void )

Deinitializes the SPI1 module.

void SPI1_Initialize (void )

Initializes the SPI1 module.

bool SPI1_IsRxReady (void )

Checks if the SPI1 module is ready to read data.

bool SPI1_IsTxReady (void )

Checks if the SPI1 module is ready to write data.

bool SPI1_Open (uint8_t spiConfigIndex)

Enables the SPI1 module with the configurations passed as the parameter. See spi1_config_names_t for the available configurations.

enum enum spi1_configuration_name_t

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

• struct SPI_INTERFACE

  SPI driver interface object.

• 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.

enum enum spi_status_t

Enumeration for the different states of the SPI module.

enum enum spi_transfer_type_t

Enumeration for the different transfer types of the SPI module.

uint8_t baud

uint8_t clock

uint8_t con1

uint8_t con3

uint8_t stat

uint8_t* buffer

size_t bufferLength

spi_status_t status

spi_transfer_type_t transferType

• void(* Initialize )(void)

• void(* Deinitialize )(void)

• bool(* Open )(uint8_t spiConfigIndex)

• void(* Close )(void)

• void(* BufferExchange )(void *bufferData, size_t bufferSize)

• void(* BufferRead )(void *bufferData, size_t bufferSize)

• void(* BufferWrite )(void *bufferData, size_t bufferSize)

• uint8_t(* ByteExchange )(uint8_t byteData)

• uint8_t(* ByteRead )(void)

• void(* ByteWrite )(uint8_t byteData)

• bool(* IsRxReady )(void)

• bool(* IsTxReady )(void)

• void(* RxCompleteCallbackRegister )(void(*callbackHandler)(void))

• void(* TxCompleteCallbackRegister )(void(*callbackHandler)(void))

void(* BufferExchange) (void *bufferData, size_t bufferSize)

void(* BufferRead) (void *bufferData, size_t bufferSize)

void(* BufferWrite) (void *bufferData, size_t bufferSize)

uint8_t(* ByteExchange) (uint8_t byteData)

uint8_t(* ByteRead) (void)

void(* ByteWrite) (uint8_t byteData)

void(* Close) (void)

void(* Deinitialize) (void)

void(* Initialize) (void)

bool(* IsRxReady) (void)

bool(* IsTxReady) (void)

bool(* Open) (uint8_t spiConfigIndex)

void(* RxCompleteCallbackRegister) (void(*callbackHandler)(void))

void(* TxCompleteCallbackRegister) (void(*callbackHandler)(void))

const struct SPI_INTERFACE SPI2

Initial value:

= {
    .Initialize = SPI2_Initialize,
    .Deinitialize = SPI2_Deinitialize,
    .Open = SPI2_Open,
    .Close = SPI2_Close,
    .BufferExchange = SPI2_BufferExchange,
    .BufferWrite = SPI2_BufferWrite,
    .BufferRead = SPI2_BufferRead,
    .ByteExchange = SPI2_ByteExchange,
    .ByteWrite = SPI2_ByteWrite,
    .ByteRead = SPI2_ByteRead,
    .IsRxReady = SPI2_IsRxReady,
    .IsTxReady = SPI2_IsTxReady,
    .RxCompleteCallbackRegister = SPI2_RxCompleteCallbackRegister,
    .TxCompleteCallbackRegister = NULL
}

const spi_configuration_t spi2_configuration[][static]

Initial value:

= {
    { 0x64, 0x4, 0x10, 0x0 }
}

spi_descriptor_t spi2_descriptor[static]

Initial value:

= {
    .buffer         = NULL,
    .bufferLength   = 0,
    .status         = SPI_RESET
}

void(* SPI2_RxCompleteCallback) (void)[static]

const struct SPI_INTERFACE SPI2

const struct SPI_INTERFACE SPI1

Initial value:

= {
    .Initialize = SPI1_Initialize,
    .Deinitialize = SPI1_Deinitialize,
    .Open = SPI1_Open,
    .Close = SPI1_Close,
    .BufferExchange = SPI1_BufferExchange,
    .BufferWrite = SPI1_BufferWrite,
    .BufferRead = SPI1_BufferRead,
    .ByteExchange = SPI1_ByteExchange,
    .ByteWrite = SPI1_ByteWrite,
    .ByteRead = SPI1_ByteRead,
    .IsRxReady = SPI1_IsRxReady,
    .IsTxReady = SPI1_IsTxReady,
    .RxCompleteCallbackRegister = NULL,
    .TxCompleteCallbackRegister = NULL
}

const spi_configuration_t spi1_configuration[][static]

Initial value:

= {
    { 0x64, 0x0, 0x10, 0x1 }
}

const struct SPI_INTERFACE SPI1