VSF Documented
Data Structures | Macros | Typedefs | Enumerations | Functions
sthal_spi.h File Reference
#include "sthal_def.h"

Go to the source code of this file.

Data Structures

struct  SPI_InitTypeDef
 
struct  __SPI_HandleTypeDef
 

Macros

#define HAL_SPI_ERROR_NONE   (0x00000000U)
 
#define HAL_SPI_ERROR_MODF   (0x00000001U)
 
#define HAL_SPI_ERROR_CRC   (0x00000002U)
 
#define HAL_SPI_ERROR_OVR   (0x00000004U)
 
#define HAL_SPI_ERROR_FRE   (0x00000008U)
 
#define HAL_SPI_ERROR_DMA   (0x00000010U)
 
#define HAL_SPI_ERROR_FLAG   (0x00000020U)
 
#define HAL_SPI_ERROR_ABORT   (0x00000040U)
 
#define SPI_MODE_SLAVE   VSF_SPI_SLAVE
 
#define SPI_MODE_MASTER   VSF_SPI_MASTER
 
#define SPI_DATASIZE_8BIT   VSF_SPI_DATASIZE_8
 
#define SPI_DATASIZE_16BIT   VSF_SPI_DATASIZE_16
 
#define SPI_POLARITY_LOW   VSF_SPI_CPOL_LOW
 
#define SPI_POLARITY_HIGH   VSF_SPI_CPOL_HIGH
 
#define SPI_PHASE_1EDGE   VSF_SPI_CPHA_LOW
 
#define SPI_PHASE_2EDGE   VSF_SPI_CPHA_HIGH
 
#define SPI_FIRSTBIT_MSB   VSF_SPI_MSB_FIRST
 
#define SPI_FIRSTBIT_LSB   VSF_SPI_LSB_FIRST
 
#define SPI_NSS_SOFT   VSF_SPI_CS_SOFTWARE_MODE
 
#define SPI_NSS_HARD_OUTPUT   VSF_SPI_CS_HARDWARE_MODE
 
#define SPI_NSS_HARD_INPUT   0
 
#define SPI_DIRECTION_2LINES   0
 
#define SPI_DIRECTION_2LINES_RXONLY   0
 
#define SPI_DIRECTION_1LINE   0
 
#define SPI_BAUDRATEPRESCALER_2   2
 
#define SPI_BAUDRATEPRESCALER_4   4
 
#define SPI_BAUDRATEPRESCALER_8   8
 
#define SPI_BAUDRATEPRESCALER_16   16
 
#define SPI_BAUDRATEPRESCALER_32   32
 
#define SPI_BAUDRATEPRESCALER_64   64
 
#define SPI_BAUDRATEPRESCALER_128   128
 
#define SPI_BAUDRATEPRESCALER_256   256
 
#define SPI_TIMODE_DISABLE   (0x00000000U)
 
#define SPI_TIMODE_ENABLE   (0x00000000U)
 
#define SPI_CRCCALCULATION_DISABLE   (0x00000000U)
 
#define IS_SPI_ALL_INSTANCE(INSTANCE)   1
 
#define IS_SPI_MODE(__MODE__)    (((__MODE__) == SPI_MODE_SLAVE) || ((__MODE__) == SPI_MODE_MASTER))
 
#define IS_SPI_DIRECTION(__MODE__)
 
#define IS_SPI_DIRECTION_2LINES(__MODE__)   ((__MODE__) == SPI_DIRECTION_2LINES)
 
#define IS_SPI_DIRECTION_2LINES_OR_1LINE(__MODE__)
 
#define IS_SPI_DATASIZE(__DATASIZE__)
 
#define IS_SPI_CPOL(__CPOL__)    (((__CPOL__) == SPI_POLARITY_LOW) || ((__CPOL__) == SPI_POLARITY_HIGH))
 
#define IS_SPI_CPHA(__CPHA__)    (((__CPHA__) == SPI_PHASE_1EDGE) || ((__CPHA__) == SPI_PHASE_2EDGE))
 
#define IS_SPI_NSS(__NSS__)
 
#define IS_SPI_BAUDRATE_PRESCALER(__PRESCALER__)
 
#define IS_SPI_FIRST_BIT(__BIT__)    (((__BIT__) == SPI_FIRSTBIT_MSB) || ((__BIT__) == SPI_FIRSTBIT_LSB))
 
#define IS_SPI_TIMODE(__MODE__)    (((__MODE__) == SPI_TIMODE_DISABLE) || ((__MODE__) == SPI_TIMODE_ENABLE))
 
#define IS_SPI_CRC_CALCULATION(__CALCULATION__)
 
#define IS_SPI_CRC_POLYNOMIAL(__POLYNOMIAL__)
 

Typedefs

typedef vsf_spi_t SPI_TypeDef
 
typedef struct __SPI_HandleTypeDef SPI_HandleTypeDef
 

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
}
 

Functions

HAL_StatusTypeDef HAL_SPI_Init (SPI_HandleTypeDef *hspi)
 
HAL_StatusTypeDef HAL_SPI_DeInit (SPI_HandleTypeDef *hspi)
 
void HAL_SPI_MspInit (SPI_HandleTypeDef *hspi)
 
void HAL_SPI_MspDeInit (SPI_HandleTypeDef *hspi)
 
HAL_StatusTypeDef HAL_SPI_Transmit (SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout)
 
HAL_StatusTypeDef HAL_SPI_Receive (SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout)
 
HAL_StatusTypeDef HAL_SPI_TransmitReceive (SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout)
 
HAL_StatusTypeDef HAL_SPI_Transmit_IT (SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size)
 
HAL_StatusTypeDef HAL_SPI_Receive_IT (SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size)
 
HAL_StatusTypeDef HAL_SPI_TransmitReceive_IT (SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
 
HAL_StatusTypeDef HAL_SPI_Transmit_DMA (SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size)
 
HAL_StatusTypeDef HAL_SPI_Receive_DMA (SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size)
 
HAL_StatusTypeDef HAL_SPI_TransmitReceive_DMA (SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
 
HAL_StatusTypeDef HAL_SPI_DMAPause (SPI_HandleTypeDef *hspi)
 
HAL_StatusTypeDef HAL_SPI_DMAResume (SPI_HandleTypeDef *hspi)
 
HAL_StatusTypeDef HAL_SPI_DMAStop (SPI_HandleTypeDef *hspi)
 
HAL_StatusTypeDef HAL_SPI_Abort (SPI_HandleTypeDef *hspi)
 
HAL_StatusTypeDef HAL_SPI_Abort_IT (SPI_HandleTypeDef *hspi)
 
void HAL_SPI_IRQHandler (SPI_HandleTypeDef *hspi)
 
void HAL_SPI_TxCpltCallback (SPI_HandleTypeDef *hspi)
 
void HAL_SPI_RxCpltCallback (SPI_HandleTypeDef *hspi)
 
void HAL_SPI_TxRxCpltCallback (SPI_HandleTypeDef *hspi)
 
void HAL_SPI_TxHalfCpltCallback (SPI_HandleTypeDef *hspi)
 
void HAL_SPI_RxHalfCpltCallback (SPI_HandleTypeDef *hspi)
 
void HAL_SPI_TxRxHalfCpltCallback (SPI_HandleTypeDef *hspi)
 
void HAL_SPI_ErrorCallback (SPI_HandleTypeDef *hspi)
 
void HAL_SPI_AbortCpltCallback (SPI_HandleTypeDef *hspi)
 
HAL_SPI_StateTypeDef HAL_SPI_GetState (SPI_HandleTypeDef *hspi)
 
uint32_t HAL_SPI_GetError (SPI_HandleTypeDef *hspi)
 

Macro Definition Documentation

◆ HAL_SPI_ERROR_NONE

#define HAL_SPI_ERROR_NONE   (0x00000000U)

◆ HAL_SPI_ERROR_MODF

#define HAL_SPI_ERROR_MODF   (0x00000001U)

◆ HAL_SPI_ERROR_CRC

#define HAL_SPI_ERROR_CRC   (0x00000002U)

◆ HAL_SPI_ERROR_OVR

#define HAL_SPI_ERROR_OVR   (0x00000004U)

◆ HAL_SPI_ERROR_FRE

#define HAL_SPI_ERROR_FRE   (0x00000008U)

◆ HAL_SPI_ERROR_DMA

#define HAL_SPI_ERROR_DMA   (0x00000010U)

◆ HAL_SPI_ERROR_FLAG

#define HAL_SPI_ERROR_FLAG   (0x00000020U)

◆ HAL_SPI_ERROR_ABORT

#define HAL_SPI_ERROR_ABORT   (0x00000040U)

◆ SPI_MODE_SLAVE

#define SPI_MODE_SLAVE   VSF_SPI_SLAVE

◆ SPI_MODE_MASTER

#define SPI_MODE_MASTER   VSF_SPI_MASTER

◆ SPI_DATASIZE_8BIT

#define SPI_DATASIZE_8BIT   VSF_SPI_DATASIZE_8

◆ SPI_DATASIZE_16BIT

#define SPI_DATASIZE_16BIT   VSF_SPI_DATASIZE_16

◆ SPI_POLARITY_LOW

#define SPI_POLARITY_LOW   VSF_SPI_CPOL_LOW

◆ SPI_POLARITY_HIGH

#define SPI_POLARITY_HIGH   VSF_SPI_CPOL_HIGH

◆ SPI_PHASE_1EDGE

#define SPI_PHASE_1EDGE   VSF_SPI_CPHA_LOW

◆ SPI_PHASE_2EDGE

#define SPI_PHASE_2EDGE   VSF_SPI_CPHA_HIGH

◆ SPI_FIRSTBIT_MSB

#define SPI_FIRSTBIT_MSB   VSF_SPI_MSB_FIRST

◆ SPI_FIRSTBIT_LSB

#define SPI_FIRSTBIT_LSB   VSF_SPI_LSB_FIRST

◆ SPI_NSS_SOFT

#define SPI_NSS_SOFT   VSF_SPI_CS_SOFTWARE_MODE

◆ SPI_NSS_HARD_OUTPUT

#define SPI_NSS_HARD_OUTPUT   VSF_SPI_CS_HARDWARE_MODE

◆ SPI_NSS_HARD_INPUT

#define SPI_NSS_HARD_INPUT   0

◆ SPI_DIRECTION_2LINES

#define SPI_DIRECTION_2LINES   0

◆ SPI_DIRECTION_2LINES_RXONLY

#define SPI_DIRECTION_2LINES_RXONLY   0

◆ SPI_DIRECTION_1LINE

#define SPI_DIRECTION_1LINE   0

◆ SPI_BAUDRATEPRESCALER_2

#define SPI_BAUDRATEPRESCALER_2   2

◆ SPI_BAUDRATEPRESCALER_4

#define SPI_BAUDRATEPRESCALER_4   4

◆ SPI_BAUDRATEPRESCALER_8

#define SPI_BAUDRATEPRESCALER_8   8

◆ SPI_BAUDRATEPRESCALER_16

#define SPI_BAUDRATEPRESCALER_16   16

◆ SPI_BAUDRATEPRESCALER_32

#define SPI_BAUDRATEPRESCALER_32   32

◆ SPI_BAUDRATEPRESCALER_64

#define SPI_BAUDRATEPRESCALER_64   64

◆ SPI_BAUDRATEPRESCALER_128

#define SPI_BAUDRATEPRESCALER_128   128

◆ SPI_BAUDRATEPRESCALER_256

#define SPI_BAUDRATEPRESCALER_256   256

◆ SPI_TIMODE_DISABLE

#define SPI_TIMODE_DISABLE   (0x00000000U)

◆ SPI_TIMODE_ENABLE

#define SPI_TIMODE_ENABLE   (0x00000000U)

◆ SPI_CRCCALCULATION_DISABLE

#define SPI_CRCCALCULATION_DISABLE   (0x00000000U)

◆ IS_SPI_ALL_INSTANCE

#define IS_SPI_ALL_INSTANCE (   INSTANCE)    1

◆ IS_SPI_MODE

#define IS_SPI_MODE (   __MODE__)     (((__MODE__) == SPI_MODE_SLAVE) || ((__MODE__) == SPI_MODE_MASTER))

◆ IS_SPI_DIRECTION

#define IS_SPI_DIRECTION (   __MODE__)
Value:
(((__MODE__) == SPI_DIRECTION_2LINES) || \
((__MODE__) == SPI_DIRECTION_2LINES_RXONLY) || \
((__MODE__) == SPI_DIRECTION_1LINE))
#define SPI_DIRECTION_2LINES_RXONLY
Definition sthal_spi.h:69
#define SPI_DIRECTION_2LINES
Definition sthal_spi.h:63
#define SPI_DIRECTION_1LINE
Definition sthal_spi.h:75

◆ IS_SPI_DIRECTION_2LINES

#define IS_SPI_DIRECTION_2LINES (   __MODE__)    ((__MODE__) == SPI_DIRECTION_2LINES)

◆ IS_SPI_DIRECTION_2LINES_OR_1LINE

#define IS_SPI_DIRECTION_2LINES_OR_1LINE (   __MODE__)
Value:
(((__MODE__) == SPI_DIRECTION_2LINES) || \
((__MODE__) == SPI_DIRECTION_1LINE))

◆ IS_SPI_DATASIZE

#define IS_SPI_DATASIZE (   __DATASIZE__)
Value:
(((__DATASIZE__) == SPI_DATASIZE_16BIT) || \
((__DATASIZE__) == SPI_DATASIZE_8BIT))
#define SPI_DATASIZE_8BIT
Definition sthal_spi.h:45
#define SPI_DATASIZE_16BIT
Definition sthal_spi.h:46

◆ IS_SPI_CPOL

#define IS_SPI_CPOL (   __CPOL__)     (((__CPOL__) == SPI_POLARITY_LOW) || ((__CPOL__) == SPI_POLARITY_HIGH))

◆ IS_SPI_CPHA

#define IS_SPI_CPHA (   __CPHA__)     (((__CPHA__) == SPI_PHASE_1EDGE) || ((__CPHA__) == SPI_PHASE_2EDGE))

◆ IS_SPI_NSS

#define IS_SPI_NSS (   __NSS__)
Value:
(((__NSS__) == SPI_NSS_SOFT) || ((__NSS__) == SPI_NSS_HARD_INPUT) || \
((__NSS__) == SPI_NSS_HARD_OUTPUT))
#define SPI_NSS_SOFT
Definition sthal_spi.h:53
#define SPI_NSS_HARD_INPUT
Definition sthal_spi.h:58
#define SPI_NSS_HARD_OUTPUT
Definition sthal_spi.h:54

◆ IS_SPI_BAUDRATE_PRESCALER

#define IS_SPI_BAUDRATE_PRESCALER (   __PRESCALER__)
Value:
(((__PRESCALER__) == SPI_BAUDRATEPRESCALER_2) || \
((__PRESCALER__) == SPI_BAUDRATEPRESCALER_4) || \
((__PRESCALER__) == SPI_BAUDRATEPRESCALER_8) || \
((__PRESCALER__) == SPI_BAUDRATEPRESCALER_16) || \
((__PRESCALER__) == SPI_BAUDRATEPRESCALER_32) || \
((__PRESCALER__) == SPI_BAUDRATEPRESCALER_64) || \
((__PRESCALER__) == SPI_BAUDRATEPRESCALER_128) || \
((__PRESCALER__) == SPI_BAUDRATEPRESCALER_256))
#define SPI_BAUDRATEPRESCALER_8
Definition sthal_spi.h:79
#define SPI_BAUDRATEPRESCALER_2
Definition sthal_spi.h:77
#define SPI_BAUDRATEPRESCALER_256
Definition sthal_spi.h:84
#define SPI_BAUDRATEPRESCALER_32
Definition sthal_spi.h:81
#define SPI_BAUDRATEPRESCALER_64
Definition sthal_spi.h:82
#define SPI_BAUDRATEPRESCALER_4
Definition sthal_spi.h:78
#define SPI_BAUDRATEPRESCALER_128
Definition sthal_spi.h:83
#define SPI_BAUDRATEPRESCALER_16
Definition sthal_spi.h:80

◆ IS_SPI_FIRST_BIT

#define IS_SPI_FIRST_BIT (   __BIT__)     (((__BIT__) == SPI_FIRSTBIT_MSB) || ((__BIT__) == SPI_FIRSTBIT_LSB))

◆ IS_SPI_TIMODE

#define IS_SPI_TIMODE (   __MODE__)     (((__MODE__) == SPI_TIMODE_DISABLE) || ((__MODE__) == SPI_TIMODE_ENABLE))

◆ IS_SPI_CRC_CALCULATION

#define IS_SPI_CRC_CALCULATION (   __CALCULATION__)
Value:
(((__CALCULATION__) == SPI_CRCCALCULATION_DISABLE) || \
((__CALCULATION__) == SPI_CRCCALCULATION_ENABLE))
#define SPI_CRCCALCULATION_DISABLE
Definition sthal_spi.h:98
@ SPI_CRCCALCULATION_ENABLE
Definition vsf_spi.h:33

◆ IS_SPI_CRC_POLYNOMIAL

#define IS_SPI_CRC_POLYNOMIAL (   __POLYNOMIAL__)
Value:
(((__POLYNOMIAL__) >= 0x1U) && ((__POLYNOMIAL__) <= 0xFFFFU) && \
(((__POLYNOMIAL__) & 0x1U) != 0U))

Typedef Documentation

◆ SPI_TypeDef

◆ SPI_HandleTypeDef

Enumeration Type Documentation

◆ HAL_SPI_StateTypeDef

Enumerator
HAL_SPI_STATE_RESET 
HAL_SPI_STATE_READY 
HAL_SPI_STATE_BUSY 
HAL_SPI_STATE_BUSY_TX 
HAL_SPI_STATE_BUSY_RX 
HAL_SPI_STATE_BUSY_TX_RX 
HAL_SPI_STATE_ERROR 
HAL_SPI_STATE_ABORT 

Function Documentation

◆ HAL_SPI_Init()

HAL_StatusTypeDef HAL_SPI_Init ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_DeInit()

HAL_StatusTypeDef HAL_SPI_DeInit ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_MspInit()

void HAL_SPI_MspInit ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_MspDeInit()

void HAL_SPI_MspDeInit ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_Transmit()

HAL_StatusTypeDef HAL_SPI_Transmit ( SPI_HandleTypeDef hspi,
uint8_t pData,
uint16_t  Size,
uint32_t  Timeout 
)

◆ HAL_SPI_Receive()

HAL_StatusTypeDef HAL_SPI_Receive ( SPI_HandleTypeDef hspi,
uint8_t pData,
uint16_t  Size,
uint32_t  Timeout 
)

◆ HAL_SPI_TransmitReceive()

HAL_StatusTypeDef HAL_SPI_TransmitReceive ( SPI_HandleTypeDef hspi,
uint8_t pTxData,
uint8_t pRxData,
uint16_t  Size,
uint32_t  Timeout 
)

◆ HAL_SPI_Transmit_IT()

HAL_StatusTypeDef HAL_SPI_Transmit_IT ( SPI_HandleTypeDef hspi,
uint8_t pData,
uint16_t  Size 
)

◆ HAL_SPI_Receive_IT()

HAL_StatusTypeDef HAL_SPI_Receive_IT ( SPI_HandleTypeDef hspi,
uint8_t pData,
uint16_t  Size 
)

◆ HAL_SPI_TransmitReceive_IT()

HAL_StatusTypeDef HAL_SPI_TransmitReceive_IT ( SPI_HandleTypeDef hspi,
uint8_t pTxData,
uint8_t pRxData,
uint16_t  Size 
)

◆ HAL_SPI_Transmit_DMA()

HAL_StatusTypeDef HAL_SPI_Transmit_DMA ( SPI_HandleTypeDef hspi,
uint8_t pData,
uint16_t  Size 
)

◆ HAL_SPI_Receive_DMA()

HAL_StatusTypeDef HAL_SPI_Receive_DMA ( SPI_HandleTypeDef hspi,
uint8_t pData,
uint16_t  Size 
)

◆ HAL_SPI_TransmitReceive_DMA()

HAL_StatusTypeDef HAL_SPI_TransmitReceive_DMA ( SPI_HandleTypeDef hspi,
uint8_t pTxData,
uint8_t pRxData,
uint16_t  Size 
)

◆ HAL_SPI_DMAPause()

HAL_StatusTypeDef HAL_SPI_DMAPause ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_DMAResume()

HAL_StatusTypeDef HAL_SPI_DMAResume ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_DMAStop()

HAL_StatusTypeDef HAL_SPI_DMAStop ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_Abort()

HAL_StatusTypeDef HAL_SPI_Abort ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_Abort_IT()

HAL_StatusTypeDef HAL_SPI_Abort_IT ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_IRQHandler()

void HAL_SPI_IRQHandler ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_TxCpltCallback()

void HAL_SPI_TxCpltCallback ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_RxCpltCallback()

void HAL_SPI_RxCpltCallback ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_TxRxCpltCallback()

void HAL_SPI_TxRxCpltCallback ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_TxHalfCpltCallback()

void HAL_SPI_TxHalfCpltCallback ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_RxHalfCpltCallback()

void HAL_SPI_RxHalfCpltCallback ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_TxRxHalfCpltCallback()

void HAL_SPI_TxRxHalfCpltCallback ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_ErrorCallback()

void HAL_SPI_ErrorCallback ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_AbortCpltCallback()

void HAL_SPI_AbortCpltCallback ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_GetState()

HAL_SPI_StateTypeDef HAL_SPI_GetState ( SPI_HandleTypeDef hspi)

◆ HAL_SPI_GetError()

uint32_t HAL_SPI_GetError ( SPI_HandleTypeDef hspi)
Generated from commit: vsfteam/vsf@2b286be