VSF Documented
sthal_spi.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2024 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __ST_HAL_SPI_H__
19#define __ST_HAL_SPI_H__
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25#if defined(HAL_SPI_MODULE_ENABLED) && VSF_HAL_USE_SPI == ENABLED
26
27/*============================ INCLUDES ======================================*/
28
29#include "sthal_def.h"
30
31/*============================ MACROS ========================================*/
32
33#define HAL_SPI_ERROR_NONE (0x00000000U)
34#define HAL_SPI_ERROR_MODF (0x00000001U)
35#define HAL_SPI_ERROR_CRC (0x00000002U)
36#define HAL_SPI_ERROR_OVR (0x00000004U)
37#define HAL_SPI_ERROR_FRE (0x00000008U)
38#define HAL_SPI_ERROR_DMA (0x00000010U)
39#define HAL_SPI_ERROR_FLAG (0x00000020U)
40#define HAL_SPI_ERROR_ABORT (0x00000040U)
41#if (USE_HAL_SPI_REGISTER_CALLBACKS == 1U)
42# define HAL_SPI_ERROR_INVALID_CALLBACK (0x00000080U)
43#endif
44
45#define SPI_MODE_SLAVE VSF_SPI_SLAVE
46#define SPI_MODE_MASTER VSF_SPI_MASTER
47#define SPI_DATASIZE_8BIT VSF_SPI_DATASIZE_8
48#define SPI_DATASIZE_16BIT VSF_SPI_DATASIZE_16
49#define SPI_POLARITY_LOW VSF_SPI_CPOL_LOW
50#define SPI_POLARITY_HIGH VSF_SPI_CPOL_HIGH
51#define SPI_PHASE_1EDGE VSF_SPI_CPHA_LOW
52#define SPI_PHASE_2EDGE VSF_SPI_CPHA_HIGH
53#define SPI_FIRSTBIT_MSB VSF_SPI_MSB_FIRST
54#define SPI_FIRSTBIT_LSB VSF_SPI_LSB_FIRST
55#define SPI_NSS_SOFT VSF_SPI_CS_SOFTWARE_MODE
56#define SPI_NSS_HARD_OUTPUT VSF_SPI_CS_HARDWARE_MODE
57#ifdef VSF_SPI_CS_HARDWARE_INPUT_MODE
58# define SPI_NSS_HARD_INPUT VSF_SPI_CS_HARDWARE_INPUT_MODE
59#else
60# define SPI_NSS_HARD_INPUT 0
61#endif
62#ifdef VSF_SPI_DATALINE_2_LINE_FULL_DUPLEX
63# define SPI_DIRECTION_2LINES VSF_SPI_DATALINE_2_LINE_FULL_DUPLEX
64#else
65# define SPI_DIRECTION_2LINES 0
66#endif
67
68#ifdef VSF_SPI_DATALINE_2_LINE_RX_ONLY
69# define SPI_DIRECTION_2LINES_RXONLY VSF_SPI_DATALINE_2_LINE_RX_ONLY
70#else
71# define SPI_DIRECTION_2LINES_RXONLY 0
72#endif
73
74#ifdef VSF_SPI_DATALINE_1_LINE_HALF_DUPLEX
75# define SPI_DIRECTION_1LINE VSF_SPI_DATALINE_1_LINE_HALF_DUPLEX
76#else
77# define SPI_DIRECTION_1LINE 0
78#endif
79# define SPI_BAUDRATEPRESCALER_2 2
80# define SPI_BAUDRATEPRESCALER_4 4
81# define SPI_BAUDRATEPRESCALER_8 8
82# define SPI_BAUDRATEPRESCALER_16 16
83# define SPI_BAUDRATEPRESCALER_32 32
84# define SPI_BAUDRATEPRESCALER_64 64
85# define SPI_BAUDRATEPRESCALER_128 128
86# define SPI_BAUDRATEPRESCALER_256 256
87#ifdef VSF_SPI_TI_MODE_DISABLE
88# define SPI_TIMODE_DISABLE VSF_SPI_TI_MODE_DISABLE
89#else
90# define SPI_TIMODE_DISABLE (0x00000000U)
91#endif
92#ifdef VSF_SPI_TI_MMOE_ENABLE
93# define SPI_TIMODE_ENABLE VSF_SPI_TI_MMOE_ENABLE
94#else
95# define SPI_TIMODE_ENABLE (0x00000000U)
96#endif
97#ifdef VSF_SPI_CRCCALCULATION_DISABLE
98# define SPI_CRCCALCULATION_DISABLE VSF_SPI_CRCCALCULATION_DISABLE
99#else
100# define SPI_CRCCALCULATION_DISABLE (0x00000000U)
101#endif
102
103// TODO: need vsf-hal support
104#define IS_SPI_ALL_INSTANCE(INSTANCE) 1
105#define IS_SPI_MODE(__MODE__) \
106 (((__MODE__) == SPI_MODE_SLAVE) || ((__MODE__) == SPI_MODE_MASTER))
107
108#define IS_SPI_DIRECTION(__MODE__) \
109 (((__MODE__) == SPI_DIRECTION_2LINES) || \
110 ((__MODE__) == SPI_DIRECTION_2LINES_RXONLY) || \
111 ((__MODE__) == SPI_DIRECTION_1LINE))
112#define IS_SPI_DIRECTION_2LINES(__MODE__) ((__MODE__) == SPI_DIRECTION_2LINES)
113#define IS_SPI_DIRECTION_2LINES_OR_1LINE(__MODE__) \
114 (((__MODE__) == SPI_DIRECTION_2LINES) || \
115 ((__MODE__) == SPI_DIRECTION_1LINE))
116#define IS_SPI_DATASIZE(__DATASIZE__) \
117 (((__DATASIZE__) == SPI_DATASIZE_16BIT) || \
118 ((__DATASIZE__) == SPI_DATASIZE_8BIT))
119#define IS_SPI_CPOL(__CPOL__) \
120 (((__CPOL__) == SPI_POLARITY_LOW) || ((__CPOL__) == SPI_POLARITY_HIGH))
121#define IS_SPI_CPHA(__CPHA__) \
122 (((__CPHA__) == SPI_PHASE_1EDGE) || ((__CPHA__) == SPI_PHASE_2EDGE))
123#define IS_SPI_NSS(__NSS__) \
124 (((__NSS__) == SPI_NSS_SOFT) || ((__NSS__) == SPI_NSS_HARD_INPUT) || \
125 ((__NSS__) == SPI_NSS_HARD_OUTPUT))
126#define IS_SPI_BAUDRATE_PRESCALER(__PRESCALER__) \
127 (((__PRESCALER__) == SPI_BAUDRATEPRESCALER_2) || \
128 ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_4) || \
129 ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_8) || \
130 ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_16) || \
131 ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_32) || \
132 ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_64) || \
133 ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_128) || \
134 ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_256))
135#define IS_SPI_FIRST_BIT(__BIT__) \
136 (((__BIT__) == SPI_FIRSTBIT_MSB) || ((__BIT__) == SPI_FIRSTBIT_LSB))
137#define IS_SPI_TIMODE(__MODE__) \
138 (((__MODE__) == SPI_TIMODE_DISABLE) || ((__MODE__) == SPI_TIMODE_ENABLE))
139#define IS_SPI_CRC_CALCULATION(__CALCULATION__) \
140 (((__CALCULATION__) == SPI_CRCCALCULATION_DISABLE) || \
141 ((__CALCULATION__) == SPI_CRCCALCULATION_ENABLE))
142#define IS_SPI_CRC_POLYNOMIAL(__POLYNOMIAL__) \
143 (((__POLYNOMIAL__) >= 0x1U) && ((__POLYNOMIAL__) <= 0xFFFFU) && \
144 (((__POLYNOMIAL__) & 0x1U) != 0U))
145
146/*============================ MACROFIED FUNCTIONS ===========================*/
147/*============================ TYPES =========================================*/
148
149typedef vsf_spi_t SPI_TypeDef;
150
151typedef struct {
152 uint32_t Mode;
153 uint32_t Direction;
154 uint32_t DataSize;
155 uint32_t CLKPolarity;
156 uint32_t CLKPhase;
157 uint32_t NSS;
158 uint32_t BaudRatePrescaler;
159 uint32_t FirstBit;
160 uint32_t TIMode;
161 uint32_t CRCCalculation;
162 uint32_t CRCPolynomial;
163} SPI_InitTypeDef;
164
165typedef enum {
166 HAL_SPI_STATE_RESET = 0x00U,
167 HAL_SPI_STATE_READY = 0x01U,
168 HAL_SPI_STATE_BUSY = 0x02U,
169 HAL_SPI_STATE_BUSY_TX = 0x03U,
170 HAL_SPI_STATE_BUSY_RX = 0x04U,
171 HAL_SPI_STATE_BUSY_TX_RX = 0x05U,
172 HAL_SPI_STATE_ERROR = 0x06U,
173 HAL_SPI_STATE_ABORT = 0x07U,
174} HAL_SPI_StateTypeDef;
175
176typedef struct __SPI_HandleTypeDef {
177 SPI_TypeDef *Instance;
178 SPI_InitTypeDef Init;
179 uint8_t *pTxBuffPtr;
180 uint16_t TxXferSize;
181 volatile uint16_t TxXferCount;
182 uint8_t *pRxBuffPtr;
183 uint16_t RxXferSize;
184 volatile uint16_t RxXferCount;
185 void (*RxISR)(struct __SPI_HandleTypeDef *hspi);
186 void (*TxISR)(struct __SPI_HandleTypeDef *hspi);
187 DMA_HandleTypeDef *hdmatx;
188 DMA_HandleTypeDef *hdmarx;
189 HAL_LockTypeDef Lock;
190 volatile HAL_SPI_StateTypeDef State;
191 volatile uint32_t ErrorCode;
192#if (USE_HAL_SPI_REGISTER_CALLBACKS == 1U)
193 void (*TxCpltCallback)(struct __SPI_HandleTypeDef *hspi);
194 void (*RxCpltCallback)(struct __SPI_HandleTypeDef *hspi);
195 void (*TxRxCpltCallback)(struct __SPI_HandleTypeDef *hspi);
196 void (*TxHalfCpltCallback)(struct __SPI_HandleTypeDef *hspi);
197 void (*RxHalfCpltCallback)(struct __SPI_HandleTypeDef *hspi);
198 void (*TxRxHalfCpltCallback)(struct __SPI_HandleTypeDef *hspi);
199 void (*ErrorCallback)(struct __SPI_HandleTypeDef *hspi);
200 void (*AbortCpltCallback)(struct __SPI_HandleTypeDef *hspi);
201 void (*MspInitCallback)(struct __SPI_HandleTypeDef *hspi);
202 void (*MspDeInitCallback)(struct __SPI_HandleTypeDef *hspi);
203
204#endif
205} SPI_HandleTypeDef;
206
207#if (USE_HAL_SPI_REGISTER_CALLBACKS == 1U)
208typedef enum {
209 HAL_SPI_TX_COMPLETE_CB_ID = 0x00U,
210 HAL_SPI_RX_COMPLETE_CB_ID = 0x01U,
211 HAL_SPI_TX_RX_COMPLETE_CB_ID = 0x02U,
212 HAL_SPI_TX_HALF_COMPLETE_CB_ID = 0x03U,
213 HAL_SPI_RX_HALF_COMPLETE_CB_ID = 0x04U,
214 HAL_SPI_TX_RX_HALF_COMPLETE_CB_ID = 0x05U,
215 HAL_SPI_ERROR_CB_ID = 0x06U,
216 HAL_SPI_ABORT_CB_ID = 0x07U,
217 HAL_SPI_MSPINIT_CB_ID = 0x08U,
218 HAL_SPI_MSPDEINIT_CB_ID = 0x09U
219
220} HAL_SPI_CallbackIDTypeDef;
221typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi);
222#endif
223
224/*============================ GLOBAL VARIABLES ==============================*/
225/*============================ PROTOTYPES ====================================*/
226
227HAL_StatusTypeDef HAL_SPI_Init(SPI_HandleTypeDef *hspi);
228HAL_StatusTypeDef HAL_SPI_DeInit(SPI_HandleTypeDef *hspi);
229void HAL_SPI_MspInit(SPI_HandleTypeDef *hspi);
230void HAL_SPI_MspDeInit(SPI_HandleTypeDef *hspi);
231
232#if (USE_HAL_SPI_REGISTER_CALLBACKS == 1U)
233HAL_StatusTypeDef HAL_SPI_RegisterCallback(SPI_HandleTypeDef *hspi,
234 HAL_SPI_CallbackIDTypeDef CallbackID,
235 pSPI_CallbackTypeDef pCallback);
236HAL_StatusTypeDef HAL_SPI_UnRegisterCallback(
237 SPI_HandleTypeDef *hspi, HAL_SPI_CallbackIDTypeDef CallbackID);
238#endif
239
240HAL_StatusTypeDef HAL_SPI_Transmit(SPI_HandleTypeDef *hspi, uint8_t *pData,
241 uint16_t Size, uint32_t Timeout);
242HAL_StatusTypeDef HAL_SPI_Receive(SPI_HandleTypeDef *hspi, uint8_t *pData,
243 uint16_t Size, uint32_t Timeout);
244HAL_StatusTypeDef HAL_SPI_TransmitReceive(SPI_HandleTypeDef *hspi,
245 uint8_t *pTxData, uint8_t *pRxData,
246 uint16_t Size, uint32_t Timeout);
247HAL_StatusTypeDef HAL_SPI_Transmit_IT(SPI_HandleTypeDef *hspi, uint8_t *pData,
248 uint16_t Size);
249HAL_StatusTypeDef HAL_SPI_Receive_IT(SPI_HandleTypeDef *hspi, uint8_t *pData,
250 uint16_t Size);
251HAL_StatusTypeDef HAL_SPI_TransmitReceive_IT(SPI_HandleTypeDef *hspi,
252 uint8_t *pTxData, uint8_t *pRxData,
253 uint16_t Size);
254HAL_StatusTypeDef HAL_SPI_Transmit_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData,
255 uint16_t Size);
256HAL_StatusTypeDef HAL_SPI_Receive_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData,
257 uint16_t Size);
258HAL_StatusTypeDef HAL_SPI_TransmitReceive_DMA(SPI_HandleTypeDef *hspi,
259 uint8_t *pTxData,
260 uint8_t *pRxData, uint16_t Size);
261HAL_StatusTypeDef HAL_SPI_DMAPause(SPI_HandleTypeDef *hspi);
262HAL_StatusTypeDef HAL_SPI_DMAResume(SPI_HandleTypeDef *hspi);
263HAL_StatusTypeDef HAL_SPI_DMAStop(SPI_HandleTypeDef *hspi);
264HAL_StatusTypeDef HAL_SPI_Abort(SPI_HandleTypeDef *hspi);
265HAL_StatusTypeDef HAL_SPI_Abort_IT(SPI_HandleTypeDef *hspi);
266void HAL_SPI_IRQHandler(SPI_HandleTypeDef *hspi);
267void HAL_SPI_TxCpltCallback(SPI_HandleTypeDef *hspi);
268void HAL_SPI_RxCpltCallback(SPI_HandleTypeDef *hspi);
269void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi);
270void HAL_SPI_TxHalfCpltCallback(SPI_HandleTypeDef *hspi);
271void HAL_SPI_RxHalfCpltCallback(SPI_HandleTypeDef *hspi);
272void HAL_SPI_TxRxHalfCpltCallback(SPI_HandleTypeDef *hspi);
273void HAL_SPI_ErrorCallback(SPI_HandleTypeDef *hspi);
274void HAL_SPI_AbortCpltCallback(SPI_HandleTypeDef *hspi);
275HAL_SPI_StateTypeDef HAL_SPI_GetState(SPI_HandleTypeDef *hspi);
276uint32_t HAL_SPI_GetError(SPI_HandleTypeDef *hspi);
277
278#endif /* defined(HAL_SPI_MODULE_ENABLED) && VSF_HAL_USE_SPI == ENABLED */
279
280#ifdef __cplusplus
281}
282#endif
283
284#endif
Init
vsf_err_t(* Init)(vsf_adc_cfg_t *pCfg)
Definition adc_interface.h:38
uint16_t
unsigned short uint16_t
Definition stdint.h:7
uint32_t
unsigned uint32_t
Definition stdint.h:9
uint8_t
unsigned char uint8_t
Definition stdint.h:5
sthal_def.h
HAL_StatusTypeDef
HAL_StatusTypeDef
Definition sthal_def.h:61
HAL_LockTypeDef
HAL_LockTypeDef
Definition sthal_def.h:68
HAL_SPI_Transmit
HAL_StatusTypeDef HAL_SPI_Transmit(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout)
Definition sthal_spi.c:533
HAL_SPI_TxRxCpltCallback
void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:76
HAL_SPI_TxCpltCallback
void HAL_SPI_TxCpltCallback(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:64
HAL_SPI_Abort
HAL_StatusTypeDef HAL_SPI_Abort(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:865
HAL_SPI_MspInit
void HAL_SPI_MspInit(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:52
HAL_SPI_TransmitReceive_DMA
HAL_StatusTypeDef HAL_SPI_TransmitReceive_DMA(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
Definition sthal_spi.c:814
HAL_SPI_ErrorCallback
void HAL_SPI_ErrorCallback(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:100
HAL_SPI_RxCpltCallback
void HAL_SPI_RxCpltCallback(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:70
HAL_SPI_AbortCpltCallback
void HAL_SPI_AbortCpltCallback(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:106
HAL_SPI_GetState
HAL_SPI_StateTypeDef HAL_SPI_GetState(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:977
HAL_SPI_TransmitReceive_IT
HAL_StatusTypeDef HAL_SPI_TransmitReceive_IT(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
Definition sthal_spi.c:690
HAL_SPI_DMAPause
HAL_StatusTypeDef HAL_SPI_DMAPause(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:927
HAL_SPI_Receive_DMA
HAL_StatusTypeDef HAL_SPI_Receive_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size)
Definition sthal_spi.c:777
HAL_SPI_Transmit_DMA
HAL_StatusTypeDef HAL_SPI_Transmit_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size)
Definition sthal_spi.c:737
HAL_SPI_Abort_IT
HAL_StatusTypeDef HAL_SPI_Abort_IT(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:893
HAL_SPI_TransmitReceive
HAL_StatusTypeDef HAL_SPI_TransmitReceive(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout)
Definition sthal_spi.c:577
HAL_SPI_DMAStop
HAL_StatusTypeDef HAL_SPI_DMAStop(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:956
HAL_SPI_GetError
uint32_t HAL_SPI_GetError(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:993
HAL_SPI_DMAResume
HAL_StatusTypeDef HAL_SPI_DMAResume(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:942
HAL_SPI_TxHalfCpltCallback
void HAL_SPI_TxHalfCpltCallback(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:82
HAL_SPI_Receive_IT
HAL_StatusTypeDef HAL_SPI_Receive_IT(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size)
Definition sthal_spi.c:656
HAL_SPI_Init
HAL_StatusTypeDef HAL_SPI_Init(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:337
HAL_SPI_TxRxHalfCpltCallback
void HAL_SPI_TxRxHalfCpltCallback(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:94
HAL_SPI_MspDeInit
void HAL_SPI_MspDeInit(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:58
HAL_SPI_DeInit
HAL_StatusTypeDef HAL_SPI_DeInit(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:414
HAL_SPI_RxHalfCpltCallback
void HAL_SPI_RxHalfCpltCallback(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:88
HAL_SPI_IRQHandler
void HAL_SPI_IRQHandler(SPI_HandleTypeDef *hspi)
Definition sthal_spi.c:971
HAL_SPI_Transmit_IT
HAL_StatusTypeDef HAL_SPI_Transmit_IT(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size)
Definition sthal_spi.c:622
HAL_SPI_Receive
HAL_StatusTypeDef HAL_SPI_Receive(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout)
Definition sthal_spi.c:555
vsf_spi_t
SPI instance structure, used for SPI Multi Class support, not needed in non Multi Class mode.
Definition vsf_template_spi.h:990
Size
struct @852 Size
Generated from commit: vsfteam/vsf@0c4049f