SPI HAL module driver. This file provides firmware functions to manage the following functionalities of the Serial Peripheral Interface (SPI) peripheral: More...

#include "stm32f4xx_hal.h"

Include dependency graph for stm32f4xx_hal_spi.c:

Macros
#define	SPI_DEFAULT_TIMEOUT 100U

#define	SPI_BSY_FLAG_WORKAROUND_TIMEOUT 1000U

Functions
static void	SPI_DMATransmitCplt (DMA_HandleTypeDef *hdma)
	DMA SPI transmit process complete callback.

static void	SPI_DMAReceiveCplt (DMA_HandleTypeDef *hdma)
	DMA SPI receive process complete callback.

static void	SPI_DMATransmitReceiveCplt (DMA_HandleTypeDef *hdma)
	DMA SPI transmit receive process complete callback.

static void	SPI_DMAHalfTransmitCplt (DMA_HandleTypeDef *hdma)
	DMA SPI half transmit process complete callback.

static void	SPI_DMAHalfReceiveCplt (DMA_HandleTypeDef *hdma)
	DMA SPI half receive process complete callback.

static void	SPI_DMAHalfTransmitReceiveCplt (DMA_HandleTypeDef *hdma)
	DMA SPI half transmit receive process complete callback.

static void	SPI_DMAError (DMA_HandleTypeDef *hdma)
	DMA SPI communication error callback.

static void	SPI_DMAAbortOnError (DMA_HandleTypeDef *hdma)
	DMA SPI communication abort callback, when initiated by HAL services on Error (To be called at end of DMA Abort procedure following error occurrence).

static void	SPI_DMATxAbortCallback (DMA_HandleTypeDef *hdma)
	DMA SPI Tx communication abort callback, when initiated by user (To be called at end of DMA Tx Abort procedure following user abort request).

static void	SPI_DMARxAbortCallback (DMA_HandleTypeDef *hdma)
	DMA SPI Rx communication abort callback, when initiated by user (To be called at end of DMA Rx Abort procedure following user abort request).

static HAL_StatusTypeDef	SPI_WaitFlagStateUntilTimeout (SPI_HandleTypeDef *hspi, uint32_t Flag, FlagStatus State, uint32_t Timeout, uint32_t Tickstart)
	Handle SPI Communication Timeout.

static void	SPI_TxISR_8BIT (struct __SPI_HandleTypeDef *hspi)
	Handle the data 8-bit transmit in Interrupt mode.

static void	SPI_TxISR_16BIT (struct __SPI_HandleTypeDef *hspi)
	Handle the data 16-bit transmit in Interrupt mode.

static void	SPI_RxISR_8BIT (struct __SPI_HandleTypeDef *hspi)
	Manage the receive 8-bit in Interrupt context.

static void	SPI_RxISR_16BIT (struct __SPI_HandleTypeDef *hspi)
	Manage the 16-bit receive in Interrupt context.

static void	SPI_2linesRxISR_8BIT (struct __SPI_HandleTypeDef *hspi)
	Rx 8-bit handler for Transmit and Receive in Interrupt mode.

static void	SPI_2linesTxISR_8BIT (struct __SPI_HandleTypeDef *hspi)
	Tx 8-bit handler for Transmit and Receive in Interrupt mode.

static void	SPI_2linesTxISR_16BIT (struct __SPI_HandleTypeDef *hspi)
	Tx 16-bit handler for Transmit and Receive in Interrupt mode.

static void	SPI_2linesRxISR_16BIT (struct __SPI_HandleTypeDef *hspi)
	Rx 16-bit handler for Transmit and Receive in Interrupt mode.

static void	SPI_AbortRx_ISR (SPI_HandleTypeDef *hspi)
	Handle abort a Rx transaction.

static void	SPI_AbortTx_ISR (SPI_HandleTypeDef *hspi)
	Handle abort a Tx or Rx/Tx transaction.

static void	SPI_CloseRxTx_ISR (SPI_HandleTypeDef *hspi)
	Handle the end of the RXTX transaction.

static void	SPI_CloseRx_ISR (SPI_HandleTypeDef *hspi)
	Handle the end of the RX transaction.

static void	SPI_CloseTx_ISR (SPI_HandleTypeDef *hspi)
	Handle the end of the TX transaction.

static HAL_StatusTypeDef	SPI_EndRxTransaction (SPI_HandleTypeDef *hspi, uint32_t Timeout, uint32_t Tickstart)
	Handle the check of the RX transaction complete.

static HAL_StatusTypeDef	SPI_EndRxTxTransaction (SPI_HandleTypeDef *hspi, uint32_t Timeout, uint32_t Tickstart)
	Handle the check of the RXTX or TX transaction complete.

HAL_StatusTypeDef	HAL_SPI_Init (SPI_HandleTypeDef *hspi)
	Initialize the SPI according to the specified parameters in the SPI_InitTypeDef and initialize the associated handle.

HAL_StatusTypeDef	HAL_SPI_DeInit (SPI_HandleTypeDef *hspi)
	De-Initialize the SPI peripheral.

void	HAL_SPI_MspInit (SPI_HandleTypeDef *hspi)
	Initialize the SPI MSP.

void	HAL_SPI_MspDeInit (SPI_HandleTypeDef *hspi)
	De-Initialize the SPI MSP.

HAL_StatusTypeDef	HAL_SPI_Transmit (SPI_HandleTypeDef hspi, const uint8_t pData, uint16_t Size, uint32_t Timeout)
	Transmit an amount of data in blocking mode.

HAL_StatusTypeDef	HAL_SPI_Receive (SPI_HandleTypeDef hspi, uint8_t pData, uint16_t Size, uint32_t Timeout)
	Receive an amount of data in blocking mode.

HAL_StatusTypeDef	HAL_SPI_TransmitReceive (SPI_HandleTypeDef hspi, const uint8_t pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout)
	Transmit and Receive an amount of data in blocking mode.

HAL_StatusTypeDef	HAL_SPI_Transmit_IT (SPI_HandleTypeDef hspi, const uint8_t pData, uint16_t Size)
	Transmit an amount of data in non-blocking mode with Interrupt.

HAL_StatusTypeDef	HAL_SPI_Receive_IT (SPI_HandleTypeDef hspi, uint8_t pData, uint16_t Size)
	Receive an amount of data in non-blocking mode with Interrupt.

HAL_StatusTypeDef	HAL_SPI_TransmitReceive_IT (SPI_HandleTypeDef hspi, const uint8_t pTxData, uint8_t *pRxData, uint16_t Size)
	Transmit and Receive an amount of data in non-blocking mode with Interrupt.

HAL_StatusTypeDef	HAL_SPI_Transmit_DMA (SPI_HandleTypeDef hspi, const uint8_t pData, uint16_t Size)
	Transmit an amount of data in non-blocking mode with DMA.

HAL_StatusTypeDef	HAL_SPI_Receive_DMA (SPI_HandleTypeDef hspi, uint8_t pData, uint16_t Size)
	Receive an amount of data in non-blocking mode with DMA.

HAL_StatusTypeDef	HAL_SPI_TransmitReceive_DMA (SPI_HandleTypeDef hspi, const uint8_t pTxData, uint8_t *pRxData, uint16_t Size)
	Transmit and Receive an amount of data in non-blocking mode with DMA.

HAL_StatusTypeDef	HAL_SPI_Abort (SPI_HandleTypeDef *hspi)
	Abort ongoing transfer (blocking mode).

HAL_StatusTypeDef	HAL_SPI_Abort_IT (SPI_HandleTypeDef *hspi)
	Abort ongoing transfer (Interrupt mode).

HAL_StatusTypeDef	HAL_SPI_DMAPause (SPI_HandleTypeDef *hspi)
	Pause the DMA Transfer.

HAL_StatusTypeDef	HAL_SPI_DMAResume (SPI_HandleTypeDef *hspi)
	Resume the DMA Transfer.

HAL_StatusTypeDef	HAL_SPI_DMAStop (SPI_HandleTypeDef *hspi)
	Stop the DMA Transfer.

void	HAL_SPI_IRQHandler (SPI_HandleTypeDef *hspi)
	Handle SPI interrupt request.

void	HAL_SPI_TxCpltCallback (SPI_HandleTypeDef *hspi)
	Tx Transfer completed callback.

void	HAL_SPI_RxCpltCallback (SPI_HandleTypeDef *hspi)
	Rx Transfer completed callback.

void	HAL_SPI_TxRxCpltCallback (SPI_HandleTypeDef *hspi)
	Tx and Rx Transfer completed callback.

void	HAL_SPI_TxHalfCpltCallback (SPI_HandleTypeDef *hspi)
	Tx Half Transfer completed callback.

void	HAL_SPI_RxHalfCpltCallback (SPI_HandleTypeDef *hspi)
	Rx Half Transfer completed callback.

void	HAL_SPI_TxRxHalfCpltCallback (SPI_HandleTypeDef *hspi)
	Tx and Rx Half Transfer callback.

void	HAL_SPI_ErrorCallback (SPI_HandleTypeDef *hspi)
	SPI error callback.

void	HAL_SPI_AbortCpltCallback (SPI_HandleTypeDef *hspi)
	SPI Abort Complete callback.

HAL_SPI_StateTypeDef	HAL_SPI_GetState (const SPI_HandleTypeDef *hspi)
	Return the SPI handle state.

uint32_t	HAL_SPI_GetError (const SPI_HandleTypeDef *hspi)
	Return the SPI error code.

Detailed Description

SPI HAL module driver. This file provides firmware functions to manage the following functionalities of the Serial Peripheral Interface (SPI) peripheral:

Author

MCD Application Team

Initialization and de-initialization functions
IO operation functions
Peripheral Control functions
Peripheral State functions

Attention

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

==============================================================================
                      ##### How to use this driver #####
==============================================================================
  [..]
    The SPI HAL driver can be used as follows:

    (#) Declare a SPI_HandleTypeDef handle structure, for example:
        SPI_HandleTypeDef  hspi;

    (#)Initialize the SPI low level resources by implementing the HAL_SPI_MspInit() API:
        (##) Enable the SPIx interface clock
        (##) SPI pins configuration
            (+++) Enable the clock for the SPI GPIOs
            (+++) Configure these SPI pins as alternate function push-pull
        (##) NVIC configuration if you need to use interrupt process
            (+++) Configure the SPIx interrupt priority
            (+++) Enable the NVIC SPI IRQ handle
        (##) DMA Configuration if you need to use DMA process
            (+++) Declare a DMA_HandleTypeDef handle structure for the transmit or receive Stream/Channel
            (+++) Enable the DMAx clock
            (+++) Configure the DMA handle parameters
            (+++) Configure the DMA Tx or Rx Stream/Channel
            (+++) Associate the initialized hdma_tx(or _rx)  handle to the hspi DMA Tx or Rx handle
            (+++) Configure the priority and enable the NVIC for the transfer complete interrupt on the DMA Tx or Rx Stream/Channel

    (#) Program the Mode, BidirectionalMode , Data size, Baudrate Prescaler, NSS
        management, Clock polarity and phase, FirstBit and CRC configuration in the hspi Init structure.

    (#) Initialize the SPI registers by calling the HAL_SPI_Init() API:
        (++) This API configures also the low level Hardware GPIO, CLOCK, CORTEX...etc)
            by calling the customized HAL_SPI_MspInit() API.
   [..]
     Circular mode restriction:
    (#) The DMA circular mode cannot be used when the SPI is configured in these modes:
        (##) Master 2Lines RxOnly
        (##) Master 1Line Rx
    (#) The CRC feature is not managed when the DMA circular mode is enabled
    (#) When the SPI DMA Pause/Stop features are used, we must use the following APIs
        the HAL_SPI_DMAPause()/ HAL_SPI_DMAStop() only under the SPI callbacks
   [..]
     Master Receive mode restriction:
    (#) In Master unidirectional receive-only mode (MSTR =1, BIDIMODE=0, RXONLY=1) or
        bidirectional receive mode (MSTR=1, BIDIMODE=1, BIDIOE=0), to ensure that the SPI
        does not initiate a new transfer the following procedure has to be respected:
        (##) HAL_SPI_DeInit()
        (##) HAL_SPI_Init()
   [..]
     Callback registration:

    (#) The compilation flag USE_HAL_SPI_REGISTER_CALLBACKS when set to 1U
        allows the user to configure dynamically the driver callbacks.
        Use Functions HAL_SPI_RegisterCallback() to register an interrupt callback.

        Function HAL_SPI_RegisterCallback() allows to register following callbacks:
          (++) TxCpltCallback        : SPI Tx Completed callback
          (++) RxCpltCallback        : SPI Rx Completed callback
          (++) TxRxCpltCallback      : SPI TxRx Completed callback
          (++) TxHalfCpltCallback    : SPI Tx Half Completed callback
          (++) RxHalfCpltCallback    : SPI Rx Half Completed callback
          (++) TxRxHalfCpltCallback  : SPI TxRx Half Completed callback
          (++) ErrorCallback         : SPI Error callback
          (++) AbortCpltCallback     : SPI Abort callback
          (++) MspInitCallback       : SPI Msp Init callback
          (++) MspDeInitCallback     : SPI Msp DeInit callback
        This function takes as parameters the HAL peripheral handle, the Callback ID
        and a pointer to the user callback function.


    (#) Use function HAL_SPI_UnRegisterCallback to reset a callback to the default
        weak function.
        HAL_SPI_UnRegisterCallback takes as parameters the HAL peripheral handle,
        and the Callback ID.
        This function allows to reset following callbacks:
          (++) TxCpltCallback        : SPI Tx Completed callback
          (++) RxCpltCallback        : SPI Rx Completed callback
          (++) TxRxCpltCallback      : SPI TxRx Completed callback
          (++) TxHalfCpltCallback    : SPI Tx Half Completed callback
          (++) RxHalfCpltCallback    : SPI Rx Half Completed callback
          (++) TxRxHalfCpltCallback  : SPI TxRx Half Completed callback
          (++) ErrorCallback         : SPI Error callback
          (++) AbortCpltCallback     : SPI Abort callback
          (++) MspInitCallback       : SPI Msp Init callback
          (++) MspDeInitCallback     : SPI Msp DeInit callback

     [..]
     By default, after the HAL_SPI_Init() and when the state is HAL_SPI_STATE_RESET
     all callbacks are set to the corresponding weak functions:
     examples HAL_SPI_MasterTxCpltCallback(), HAL_SPI_MasterRxCpltCallback().
     Exception done for MspInit and MspDeInit functions that are
     reset to the legacy weak functions in the HAL_SPI_Init()/ HAL_SPI_DeInit() only when
     these callbacks are null (not registered beforehand).
     If MspInit or MspDeInit are not null, the HAL_SPI_Init()/ HAL_SPI_DeInit()
     keep and use the user MspInit/MspDeInit callbacks (registered beforehand) whatever the state.

     [..]
     Callbacks can be registered/unregistered in HAL_SPI_STATE_READY state only.
     Exception done MspInit/MspDeInit functions that can be registered/unregistered
     in HAL_SPI_STATE_READY or HAL_SPI_STATE_RESET state,
     thus registered (user) MspInit/DeInit callbacks can be used during the Init/DeInit.
     Then, the user first registers the MspInit/MspDeInit user callbacks
     using HAL_SPI_RegisterCallback() before calling HAL_SPI_DeInit()
     or HAL_SPI_Init() function.

     [..]
     When the compilation define USE_HAL_PPP_REGISTER_CALLBACKS is set to 0 or
     not defined, the callback registering feature is not available
     and weak (surcharged) callbacks are used.

   [..]
     Using the HAL it is not possible to reach all supported SPI frequency with the different SPI Modes,
     the following table resume the max SPI frequency reached with data size 8bits/16bits,
       according to frequency of the APBx Peripheral Clock (fPCLK) used by the SPI instance.

Additional table :

 DataSize = SPI_DATASIZE_8BIT:
 +----------------------------------------------------------------------------------------------+
 |         |                | 2Lines Fullduplex   |     2Lines RxOnly    |         1Line        |
 | Process | Transfer mode  |---------------------|----------------------|----------------------|
 |         |                |  Master  |  Slave   |  Master   |  Slave   |  Master   |  Slave   |
 |==============================================================================================|
 |    T    |     Polling    | Fpclk/2  | Fpclk/2  |    NA     |    NA    |    NA     |   NA     |
 |    X    |----------------|----------|----------|-----------|----------|-----------|----------|
 |    /    |     Interrupt  | Fpclk/4  | Fpclk/8  |    NA     |    NA    |    NA     |   NA     |
 |    R    |----------------|----------|----------|-----------|----------|-----------|----------|
 |    X    |       DMA      | Fpclk/2  | Fpclk/2  |    NA     |    NA    |    NA     |   NA     |
 |=========|================|==========|==========|===========|==========|===========|==========|
 |         |     Polling    | Fpclk/2  | Fpclk/2  | Fpclk/64  | Fpclk/2  | Fpclk/64  | Fpclk/2  |
 |         |----------------|----------|----------|-----------|----------|-----------|----------|
 |    R    |     Interrupt  | Fpclk/8  | Fpclk/8  | Fpclk/64  | Fpclk/2  | Fpclk/64  | Fpclk/2  |
 |    X    |----------------|----------|----------|-----------|----------|-----------|----------|
 |         |       DMA      | Fpclk/2  | Fpclk/2  | Fpclk/64  | Fpclk/2  | Fpclk/128 | Fpclk/2  |
 |=========|================|==========|==========|===========|==========|===========|==========|
 |         |     Polling    | Fpclk/2  | Fpclk/4  |     NA    |    NA    | Fpclk/2   | Fpclk/64 |
 |         |----------------|----------|----------|-----------|----------|-----------|----------|
 |    T    |     Interrupt  | Fpclk/2  | Fpclk/4  |     NA    |    NA    | Fpclk/2   | Fpclk/64 |
 |    X    |----------------|----------|----------|-----------|----------|-----------|----------|
 |         |       DMA      | Fpclk/2  | Fpclk/2  |     NA    |    NA    | Fpclk/2   | Fpclk/128|
 +----------------------------------------------------------------------------------------------+

 DataSize = SPI_DATASIZE_16BIT:
 +----------------------------------------------------------------------------------------------+
 |         |                | 2Lines Fullduplex   |     2Lines RxOnly    |         1Line        |
 | Process | Transfer mode  |---------------------|----------------------|----------------------|
 |         |                |  Master  |  Slave   |  Master   |  Slave   |  Master   |  Slave   |
 |==============================================================================================|
 |    T    |     Polling    | Fpclk/2  | Fpclk/2  |    NA     |    NA    |    NA     |   NA     |
 |    X    |----------------|----------|----------|-----------|----------|-----------|----------|
 |    /    |     Interrupt  | Fpclk/4  | Fpclk/4  |    NA     |    NA    |    NA     |   NA     |
 |    R    |----------------|----------|----------|-----------|----------|-----------|----------|
 |    X    |       DMA      | Fpclk/2  | Fpclk/2  |    NA     |    NA    |    NA     |   NA     |
 |=========|================|==========|==========|===========|==========|===========|==========|
 |         |     Polling    | Fpclk/2  | Fpclk/2  | Fpclk/64  | Fpclk/2  | Fpclk/32  | Fpclk/2  |
 |         |----------------|----------|----------|-----------|----------|-----------|----------|
 |    R    |     Interrupt  | Fpclk/4  | Fpclk/4  | Fpclk/64  | Fpclk/2  | Fpclk/64  | Fpclk/2  |
 |    X    |----------------|----------|----------|-----------|----------|-----------|----------|
 |         |       DMA      | Fpclk/2  | Fpclk/2  | Fpclk/64  | Fpclk/2  | Fpclk/128 | Fpclk/2  |
 |=========|================|==========|==========|===========|==========|===========|==========|
 |         |     Polling    | Fpclk/2  | Fpclk/2  |     NA    |    NA    | Fpclk/2   | Fpclk/32 |
 |         |----------------|----------|----------|-----------|----------|-----------|----------|
 |    T    |     Interrupt  | Fpclk/2  | Fpclk/2  |     NA    |    NA    | Fpclk/2   | Fpclk/64 |
 |    X    |----------------|----------|----------|-----------|----------|-----------|----------|
 |         |       DMA      | Fpclk/2  | Fpclk/2  |     NA    |    NA    | Fpclk/2   | Fpclk/128|
 +----------------------------------------------------------------------------------------------+
 @note The max SPI frequency depend on SPI data size (8bits, 16bits),
       SPI mode(2 Lines fullduplex, 2 lines RxOnly, 1 line TX/RX) and Process mode (Polling, IT, DMA).
 @note
      (#) TX/RX processes are HAL_SPI_TransmitReceive(), HAL_SPI_TransmitReceive_IT() and HAL_SPI_TransmitReceive_DMA()
      (#) RX processes are HAL_SPI_Receive(), HAL_SPI_Receive_IT() and HAL_SPI_Receive_DMA()
      (#) TX processes are HAL_SPI_Transmit(), HAL_SPI_Transmit_IT() and HAL_SPI_Transmit_DMA()

Definition in file stm32f4xx_hal_spi.c.

Macros

Functions

Detailed Description