stm32l4xx_hal_spi.h File Reference

Header file of SPI HAL module. More...

Go to the source code of this file.

Data Structures
struct	SPI_InitTypeDef
	SPI Configuration Structure definition. More...
struct	__SPI_HandleTypeDef
	SPI handle Structure definition. More...

Typedefs
typedef struct __SPI_HandleTypeDef	SPI_HandleTypeDef
	SPI handle Structure definition. More...
typedef void(*	pSPI_CallbackTypeDef) (SPI_HandleTypeDef *hspi)
	HAL SPI Callback pointer definition. More...

Enumerations
enum	HAL_SPI_StateTypeDef {   HAL_SPI_STATE_RESET = 0x00U, HAL_SPI_STATE_READY = 0x01U, HAL_SPI_STATE_BUSY = 0x02U, HAL_SPI_STATE_BUSY_TX = 0x03U,   HAL_SPI_STATE_BUSY_RX = 0x04U, HAL_SPI_STATE_BUSY_TX_RX = 0x05U, HAL_SPI_STATE_ERROR = 0x06U, HAL_SPI_STATE_ABORT = 0x07U }
	HAL SPI State structure definition. More...
enum	HAL_SPI_CallbackIDTypeDef {   HAL_SPI_TX_COMPLETE_CB_ID = 0x00U, HAL_SPI_RX_COMPLETE_CB_ID = 0x01U, HAL_SPI_TX_RX_COMPLETE_CB_ID = 0x02U, HAL_SPI_TX_HALF_COMPLETE_CB_ID = 0x03U,   HAL_SPI_RX_HALF_COMPLETE_CB_ID = 0x04U, HAL_SPI_TX_RX_HALF_COMPLETE_CB_ID = 0x05U, HAL_SPI_ERROR_CB_ID = 0x06U, HAL_SPI_ABORT_CB_ID = 0x07U,   HAL_SPI_MSPINIT_CB_ID = 0x08U, HAL_SPI_MSPDEINIT_CB_ID = 0x09U }
	HAL SPI Callback ID enumeration definition. More...

Functions
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. More...
HAL_StatusTypeDef	HAL_SPI_DeInit (SPI_HandleTypeDef *hspi)
	De-Initialize the SPI peripheral. More...
void	HAL_SPI_MspInit (SPI_HandleTypeDef *hspi)
	Initialize the SPI MSP. More...
void	HAL_SPI_MspDeInit (SPI_HandleTypeDef *hspi)
	De-Initialize the SPI MSP. More...
HAL_StatusTypeDef	HAL_SPI_RegisterCallback (SPI_HandleTypeDef *hspi, HAL_SPI_CallbackIDTypeDef CallbackID, pSPI_CallbackTypeDef pCallback)
	Register a User SPI Callback To be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_SPI_UnRegisterCallback (SPI_HandleTypeDef *hspi, HAL_SPI_CallbackIDTypeDef CallbackID)
	Unregister an SPI Callback SPI callback is redirected to the weak predefined callback. More...
HAL_StatusTypeDef	HAL_SPI_Transmit (SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout)
	Transmit an amount of data in blocking mode. More...
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. More...
HAL_StatusTypeDef	HAL_SPI_TransmitReceive (SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout)
	Transmit and Receive an amount of data in blocking mode. More...
HAL_StatusTypeDef	HAL_SPI_Transmit_IT (SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size)
	Transmit an amount of data in non-blocking mode with Interrupt. More...
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. More...
HAL_StatusTypeDef	HAL_SPI_TransmitReceive_IT (SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
	Transmit and Receive an amount of data in non-blocking mode with Interrupt. More...
HAL_StatusTypeDef	HAL_SPI_Transmit_DMA (SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size)
	Transmit an amount of data in non-blocking mode with DMA. More...
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. More...
HAL_StatusTypeDef	HAL_SPI_TransmitReceive_DMA (SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
	Transmit and Receive an amount of data in non-blocking mode with DMA. More...
HAL_StatusTypeDef	HAL_SPI_DMAPause (SPI_HandleTypeDef *hspi)
	Pause the DMA Transfer. More...
HAL_StatusTypeDef	HAL_SPI_DMAResume (SPI_HandleTypeDef *hspi)
	Resume the DMA Transfer. More...
HAL_StatusTypeDef	HAL_SPI_DMAStop (SPI_HandleTypeDef *hspi)
	Stop the DMA Transfer. More...
HAL_StatusTypeDef	HAL_SPI_Abort (SPI_HandleTypeDef *hspi)
	Abort ongoing transfer (blocking mode). More...
HAL_StatusTypeDef	HAL_SPI_Abort_IT (SPI_HandleTypeDef *hspi)
	Abort ongoing transfer (Interrupt mode). More...
void	HAL_SPI_IRQHandler (SPI_HandleTypeDef *hspi)
	Handle SPI interrupt request. More...
void	HAL_SPI_TxCpltCallback (SPI_HandleTypeDef *hspi)
	Tx Transfer completed callback. More...
void	HAL_SPI_RxCpltCallback (SPI_HandleTypeDef *hspi)
	Rx Transfer completed callback. More...
void	HAL_SPI_TxRxCpltCallback (SPI_HandleTypeDef *hspi)
	Tx and Rx Transfer completed callback. More...
void	HAL_SPI_TxHalfCpltCallback (SPI_HandleTypeDef *hspi)
	Tx Half Transfer completed callback. More...
void	HAL_SPI_RxHalfCpltCallback (SPI_HandleTypeDef *hspi)
	Rx Half Transfer completed callback. More...
void	HAL_SPI_TxRxHalfCpltCallback (SPI_HandleTypeDef *hspi)
	Tx and Rx Half Transfer callback. More...
void	HAL_SPI_ErrorCallback (SPI_HandleTypeDef *hspi)
	SPI error callback. More...
void	HAL_SPI_AbortCpltCallback (SPI_HandleTypeDef *hspi)
	SPI Abort Complete callback. More...
HAL_SPI_StateTypeDef	HAL_SPI_GetState (SPI_HandleTypeDef *hspi)
	Return the SPI handle state. More...
uint32_t	HAL_SPI_GetError (SPI_HandleTypeDef *hspi)
	Return the SPI error code. More...

Detailed Description

Header file of SPI HAL module.

Author

MCD Application Team

Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_spi.h.