stm32f0xx_hal_spi.h 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851
  1. /**
  2. ******************************************************************************
  3. * @file stm32f0xx_hal_spi.h
  4. * @author MCD Application Team
  5. * @brief Header file of SPI HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * Copyright (c) 2016 STMicroelectronics.
  10. * All rights reserved.
  11. *
  12. * This software is licensed under terms that can be found in the LICENSE file
  13. * in the root directory of this software component.
  14. * If no LICENSE file comes with this software, it is provided AS-IS.
  15. *
  16. ******************************************************************************
  17. */
  18. /* Define to prevent recursive inclusion -------------------------------------*/
  19. #ifndef STM32F0xx_HAL_SPI_H
  20. #define STM32F0xx_HAL_SPI_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32f0xx_hal_def.h"
  26. /** @addtogroup STM32F0xx_HAL_Driver
  27. * @{
  28. */
  29. /** @addtogroup SPI
  30. * @{
  31. */
  32. /* Exported types ------------------------------------------------------------*/
  33. /** @defgroup SPI_Exported_Types SPI Exported Types
  34. * @{
  35. */
  36. /**
  37. * @brief SPI Configuration Structure definition
  38. */
  39. typedef struct
  40. {
  41. uint32_t Mode; /*!< Specifies the SPI operating mode.
  42. This parameter can be a value of @ref SPI_Mode */
  43. uint32_t Direction; /*!< Specifies the SPI bidirectional mode state.
  44. This parameter can be a value of @ref SPI_Direction */
  45. uint32_t DataSize; /*!< Specifies the SPI data size.
  46. This parameter can be a value of @ref SPI_Data_Size */
  47. uint32_t CLKPolarity; /*!< Specifies the serial clock steady state.
  48. This parameter can be a value of @ref SPI_Clock_Polarity */
  49. uint32_t CLKPhase; /*!< Specifies the clock active edge for the bit capture.
  50. This parameter can be a value of @ref SPI_Clock_Phase */
  51. uint32_t NSS; /*!< Specifies whether the NSS signal is managed by
  52. hardware (NSS pin) or by software using the SSI bit.
  53. This parameter can be a value of @ref SPI_Slave_Select_management */
  54. uint32_t BaudRatePrescaler; /*!< Specifies the Baud Rate prescaler value which will be
  55. used to configure the transmit and receive SCK clock.
  56. This parameter can be a value of @ref SPI_BaudRate_Prescaler
  57. @note The communication clock is derived from the master
  58. clock. The slave clock does not need to be set. */
  59. uint32_t FirstBit; /*!< Specifies whether data transfers start from MSB or LSB bit.
  60. This parameter can be a value of @ref SPI_MSB_LSB_transmission */
  61. uint32_t TIMode; /*!< Specifies if the TI mode is enabled or not.
  62. This parameter can be a value of @ref SPI_TI_mode */
  63. uint32_t CRCCalculation; /*!< Specifies if the CRC calculation is enabled or not.
  64. This parameter can be a value of @ref SPI_CRC_Calculation */
  65. uint32_t CRCPolynomial; /*!< Specifies the polynomial used for the CRC calculation.
  66. This parameter must be an odd number between Min_Data = 1 and Max_Data = 65535 */
  67. uint32_t CRCLength; /*!< Specifies the CRC Length used for the CRC calculation.
  68. CRC Length is only used with Data8 and Data16, not other data size
  69. This parameter can be a value of @ref SPI_CRC_length */
  70. uint32_t NSSPMode; /*!< Specifies whether the NSSP signal is enabled or not .
  71. This parameter can be a value of @ref SPI_NSSP_Mode
  72. This mode is activated by the NSSP bit in the SPIx_CR2 register and
  73. it takes effect only if the SPI interface is configured as Motorola SPI
  74. master (FRF=0) with capture on the first edge (SPIx_CR1 CPHA = 0,
  75. CPOL setting is ignored).. */
  76. } SPI_InitTypeDef;
  77. /**
  78. * @brief HAL SPI State structure definition
  79. */
  80. typedef enum
  81. {
  82. HAL_SPI_STATE_RESET = 0x00U, /*!< Peripheral not Initialized */
  83. HAL_SPI_STATE_READY = 0x01U, /*!< Peripheral Initialized and ready for use */
  84. HAL_SPI_STATE_BUSY = 0x02U, /*!< an internal process is ongoing */
  85. HAL_SPI_STATE_BUSY_TX = 0x03U, /*!< Data Transmission process is ongoing */
  86. HAL_SPI_STATE_BUSY_RX = 0x04U, /*!< Data Reception process is ongoing */
  87. HAL_SPI_STATE_BUSY_TX_RX = 0x05U, /*!< Data Transmission and Reception process is ongoing */
  88. HAL_SPI_STATE_ERROR = 0x06U, /*!< SPI error state */
  89. HAL_SPI_STATE_ABORT = 0x07U /*!< SPI abort is ongoing */
  90. } HAL_SPI_StateTypeDef;
  91. /**
  92. * @brief SPI handle Structure definition
  93. */
  94. typedef struct __SPI_HandleTypeDef
  95. {
  96. SPI_TypeDef *Instance; /*!< SPI registers base address */
  97. SPI_InitTypeDef Init; /*!< SPI communication parameters */
  98. uint8_t *pTxBuffPtr; /*!< Pointer to SPI Tx transfer Buffer */
  99. uint16_t TxXferSize; /*!< SPI Tx Transfer size */
  100. __IO uint16_t TxXferCount; /*!< SPI Tx Transfer Counter */
  101. uint8_t *pRxBuffPtr; /*!< Pointer to SPI Rx transfer Buffer */
  102. uint16_t RxXferSize; /*!< SPI Rx Transfer size */
  103. __IO uint16_t RxXferCount; /*!< SPI Rx Transfer Counter */
  104. uint32_t CRCSize; /*!< SPI CRC size used for the transfer */
  105. void (*RxISR)(struct __SPI_HandleTypeDef *hspi); /*!< function pointer on Rx ISR */
  106. void (*TxISR)(struct __SPI_HandleTypeDef *hspi); /*!< function pointer on Tx ISR */
  107. DMA_HandleTypeDef *hdmatx; /*!< SPI Tx DMA Handle parameters */
  108. DMA_HandleTypeDef *hdmarx; /*!< SPI Rx DMA Handle parameters */
  109. HAL_LockTypeDef Lock; /*!< Locking object */
  110. __IO HAL_SPI_StateTypeDef State; /*!< SPI communication state */
  111. __IO uint32_t ErrorCode; /*!< SPI Error code */
  112. #if (USE_HAL_SPI_REGISTER_CALLBACKS == 1U)
  113. void (* TxCpltCallback)(struct __SPI_HandleTypeDef *hspi); /*!< SPI Tx Completed callback */
  114. void (* RxCpltCallback)(struct __SPI_HandleTypeDef *hspi); /*!< SPI Rx Completed callback */
  115. void (* TxRxCpltCallback)(struct __SPI_HandleTypeDef *hspi); /*!< SPI TxRx Completed callback */
  116. void (* TxHalfCpltCallback)(struct __SPI_HandleTypeDef *hspi); /*!< SPI Tx Half Completed callback */
  117. void (* RxHalfCpltCallback)(struct __SPI_HandleTypeDef *hspi); /*!< SPI Rx Half Completed callback */
  118. void (* TxRxHalfCpltCallback)(struct __SPI_HandleTypeDef *hspi); /*!< SPI TxRx Half Completed callback */
  119. void (* ErrorCallback)(struct __SPI_HandleTypeDef *hspi); /*!< SPI Error callback */
  120. void (* AbortCpltCallback)(struct __SPI_HandleTypeDef *hspi); /*!< SPI Abort callback */
  121. void (* MspInitCallback)(struct __SPI_HandleTypeDef *hspi); /*!< SPI Msp Init callback */
  122. void (* MspDeInitCallback)(struct __SPI_HandleTypeDef *hspi); /*!< SPI Msp DeInit callback */
  123. #endif /* USE_HAL_SPI_REGISTER_CALLBACKS */
  124. } SPI_HandleTypeDef;
  125. #if (USE_HAL_SPI_REGISTER_CALLBACKS == 1U)
  126. /**
  127. * @brief HAL SPI Callback ID enumeration definition
  128. */
  129. typedef enum
  130. {
  131. HAL_SPI_TX_COMPLETE_CB_ID = 0x00U, /*!< SPI Tx Completed callback ID */
  132. HAL_SPI_RX_COMPLETE_CB_ID = 0x01U, /*!< SPI Rx Completed callback ID */
  133. HAL_SPI_TX_RX_COMPLETE_CB_ID = 0x02U, /*!< SPI TxRx Completed callback ID */
  134. HAL_SPI_TX_HALF_COMPLETE_CB_ID = 0x03U, /*!< SPI Tx Half Completed callback ID */
  135. HAL_SPI_RX_HALF_COMPLETE_CB_ID = 0x04U, /*!< SPI Rx Half Completed callback ID */
  136. HAL_SPI_TX_RX_HALF_COMPLETE_CB_ID = 0x05U, /*!< SPI TxRx Half Completed callback ID */
  137. HAL_SPI_ERROR_CB_ID = 0x06U, /*!< SPI Error callback ID */
  138. HAL_SPI_ABORT_CB_ID = 0x07U, /*!< SPI Abort callback ID */
  139. HAL_SPI_MSPINIT_CB_ID = 0x08U, /*!< SPI Msp Init callback ID */
  140. HAL_SPI_MSPDEINIT_CB_ID = 0x09U /*!< SPI Msp DeInit callback ID */
  141. } HAL_SPI_CallbackIDTypeDef;
  142. /**
  143. * @brief HAL SPI Callback pointer definition
  144. */
  145. typedef void (*pSPI_CallbackTypeDef)(SPI_HandleTypeDef *hspi); /*!< pointer to an SPI callback function */
  146. #endif /* USE_HAL_SPI_REGISTER_CALLBACKS */
  147. /**
  148. * @}
  149. */
  150. /* Exported constants --------------------------------------------------------*/
  151. /** @defgroup SPI_Exported_Constants SPI Exported Constants
  152. * @{
  153. */
  154. /** @defgroup SPI_Error_Code SPI Error Code
  155. * @{
  156. */
  157. #define HAL_SPI_ERROR_NONE (0x00000000U) /*!< No error */
  158. #define HAL_SPI_ERROR_MODF (0x00000001U) /*!< MODF error */
  159. #define HAL_SPI_ERROR_CRC (0x00000002U) /*!< CRC error */
  160. #define HAL_SPI_ERROR_OVR (0x00000004U) /*!< OVR error */
  161. #define HAL_SPI_ERROR_FRE (0x00000008U) /*!< FRE error */
  162. #define HAL_SPI_ERROR_DMA (0x00000010U) /*!< DMA transfer error */
  163. #define HAL_SPI_ERROR_FLAG (0x00000020U) /*!< Error on RXNE/TXE/BSY/FTLVL/FRLVL Flag */
  164. #define HAL_SPI_ERROR_ABORT (0x00000040U) /*!< Error during SPI Abort procedure */
  165. #if (USE_HAL_SPI_REGISTER_CALLBACKS == 1U)
  166. #define HAL_SPI_ERROR_INVALID_CALLBACK (0x00000080U) /*!< Invalid Callback error */
  167. #endif /* USE_HAL_SPI_REGISTER_CALLBACKS */
  168. /**
  169. * @}
  170. */
  171. /** @defgroup SPI_Mode SPI Mode
  172. * @{
  173. */
  174. #define SPI_MODE_SLAVE (0x00000000U)
  175. #define SPI_MODE_MASTER (SPI_CR1_MSTR | SPI_CR1_SSI)
  176. /**
  177. * @}
  178. */
  179. /** @defgroup SPI_Direction SPI Direction Mode
  180. * @{
  181. */
  182. #define SPI_DIRECTION_2LINES (0x00000000U)
  183. #define SPI_DIRECTION_2LINES_RXONLY SPI_CR1_RXONLY
  184. #define SPI_DIRECTION_1LINE SPI_CR1_BIDIMODE
  185. /**
  186. * @}
  187. */
  188. /** @defgroup SPI_Data_Size SPI Data Size
  189. * @{
  190. */
  191. #define SPI_DATASIZE_4BIT (0x00000300U)
  192. #define SPI_DATASIZE_5BIT (0x00000400U)
  193. #define SPI_DATASIZE_6BIT (0x00000500U)
  194. #define SPI_DATASIZE_7BIT (0x00000600U)
  195. #define SPI_DATASIZE_8BIT (0x00000700U)
  196. #define SPI_DATASIZE_9BIT (0x00000800U)
  197. #define SPI_DATASIZE_10BIT (0x00000900U)
  198. #define SPI_DATASIZE_11BIT (0x00000A00U)
  199. #define SPI_DATASIZE_12BIT (0x00000B00U)
  200. #define SPI_DATASIZE_13BIT (0x00000C00U)
  201. #define SPI_DATASIZE_14BIT (0x00000D00U)
  202. #define SPI_DATASIZE_15BIT (0x00000E00U)
  203. #define SPI_DATASIZE_16BIT (0x00000F00U)
  204. /**
  205. * @}
  206. */
  207. /** @defgroup SPI_Clock_Polarity SPI Clock Polarity
  208. * @{
  209. */
  210. #define SPI_POLARITY_LOW (0x00000000U)
  211. #define SPI_POLARITY_HIGH SPI_CR1_CPOL
  212. /**
  213. * @}
  214. */
  215. /** @defgroup SPI_Clock_Phase SPI Clock Phase
  216. * @{
  217. */
  218. #define SPI_PHASE_1EDGE (0x00000000U)
  219. #define SPI_PHASE_2EDGE SPI_CR1_CPHA
  220. /**
  221. * @}
  222. */
  223. /** @defgroup SPI_Slave_Select_management SPI Slave Select Management
  224. * @{
  225. */
  226. #define SPI_NSS_SOFT SPI_CR1_SSM
  227. #define SPI_NSS_HARD_INPUT (0x00000000U)
  228. #define SPI_NSS_HARD_OUTPUT (SPI_CR2_SSOE << 16U)
  229. /**
  230. * @}
  231. */
  232. /** @defgroup SPI_NSSP_Mode SPI NSS Pulse Mode
  233. * @{
  234. */
  235. #define SPI_NSS_PULSE_ENABLE SPI_CR2_NSSP
  236. #define SPI_NSS_PULSE_DISABLE (0x00000000U)
  237. /**
  238. * @}
  239. */
  240. /** @defgroup SPI_BaudRate_Prescaler SPI BaudRate Prescaler
  241. * @{
  242. */
  243. #define SPI_BAUDRATEPRESCALER_2 (0x00000000U)
  244. #define SPI_BAUDRATEPRESCALER_4 (SPI_CR1_BR_0)
  245. #define SPI_BAUDRATEPRESCALER_8 (SPI_CR1_BR_1)
  246. #define SPI_BAUDRATEPRESCALER_16 (SPI_CR1_BR_1 | SPI_CR1_BR_0)
  247. #define SPI_BAUDRATEPRESCALER_32 (SPI_CR1_BR_2)
  248. #define SPI_BAUDRATEPRESCALER_64 (SPI_CR1_BR_2 | SPI_CR1_BR_0)
  249. #define SPI_BAUDRATEPRESCALER_128 (SPI_CR1_BR_2 | SPI_CR1_BR_1)
  250. #define SPI_BAUDRATEPRESCALER_256 (SPI_CR1_BR_2 | SPI_CR1_BR_1 | SPI_CR1_BR_0)
  251. /**
  252. * @}
  253. */
  254. /** @defgroup SPI_MSB_LSB_transmission SPI MSB LSB Transmission
  255. * @{
  256. */
  257. #define SPI_FIRSTBIT_MSB (0x00000000U)
  258. #define SPI_FIRSTBIT_LSB SPI_CR1_LSBFIRST
  259. /**
  260. * @}
  261. */
  262. /** @defgroup SPI_TI_mode SPI TI Mode
  263. * @{
  264. */
  265. #define SPI_TIMODE_DISABLE (0x00000000U)
  266. #define SPI_TIMODE_ENABLE SPI_CR2_FRF
  267. /**
  268. * @}
  269. */
  270. /** @defgroup SPI_CRC_Calculation SPI CRC Calculation
  271. * @{
  272. */
  273. #define SPI_CRCCALCULATION_DISABLE (0x00000000U)
  274. #define SPI_CRCCALCULATION_ENABLE SPI_CR1_CRCEN
  275. /**
  276. * @}
  277. */
  278. /** @defgroup SPI_CRC_length SPI CRC Length
  279. * @{
  280. * This parameter can be one of the following values:
  281. * SPI_CRC_LENGTH_DATASIZE: aligned with the data size
  282. * SPI_CRC_LENGTH_8BIT : CRC 8bit
  283. * SPI_CRC_LENGTH_16BIT : CRC 16bit
  284. */
  285. #define SPI_CRC_LENGTH_DATASIZE (0x00000000U)
  286. #define SPI_CRC_LENGTH_8BIT (0x00000001U)
  287. #define SPI_CRC_LENGTH_16BIT (0x00000002U)
  288. /**
  289. * @}
  290. */
  291. /** @defgroup SPI_FIFO_reception_threshold SPI FIFO Reception Threshold
  292. * @{
  293. * This parameter can be one of the following values:
  294. * SPI_RXFIFO_THRESHOLD or SPI_RXFIFO_THRESHOLD_QF :
  295. * RXNE event is generated if the FIFO
  296. * level is greater or equal to 1/4(8-bits).
  297. * SPI_RXFIFO_THRESHOLD_HF: RXNE event is generated if the FIFO
  298. * level is greater or equal to 1/2(16 bits). */
  299. #define SPI_RXFIFO_THRESHOLD SPI_CR2_FRXTH
  300. #define SPI_RXFIFO_THRESHOLD_QF SPI_CR2_FRXTH
  301. #define SPI_RXFIFO_THRESHOLD_HF (0x00000000U)
  302. /**
  303. * @}
  304. */
  305. /** @defgroup SPI_Interrupt_definition SPI Interrupt Definition
  306. * @{
  307. */
  308. #define SPI_IT_TXE SPI_CR2_TXEIE
  309. #define SPI_IT_RXNE SPI_CR2_RXNEIE
  310. #define SPI_IT_ERR SPI_CR2_ERRIE
  311. /**
  312. * @}
  313. */
  314. /** @defgroup SPI_Flags_definition SPI Flags Definition
  315. * @{
  316. */
  317. #define SPI_FLAG_RXNE SPI_SR_RXNE /* SPI status flag: Rx buffer not empty flag */
  318. #define SPI_FLAG_TXE SPI_SR_TXE /* SPI status flag: Tx buffer empty flag */
  319. #define SPI_FLAG_BSY SPI_SR_BSY /* SPI status flag: Busy flag */
  320. #define SPI_FLAG_CRCERR SPI_SR_CRCERR /* SPI Error flag: CRC error flag */
  321. #define SPI_FLAG_MODF SPI_SR_MODF /* SPI Error flag: Mode fault flag */
  322. #define SPI_FLAG_OVR SPI_SR_OVR /* SPI Error flag: Overrun flag */
  323. #define SPI_FLAG_FRE SPI_SR_FRE /* SPI Error flag: TI mode frame format error flag */
  324. #define SPI_FLAG_FTLVL SPI_SR_FTLVL /* SPI fifo transmission level */
  325. #define SPI_FLAG_FRLVL SPI_SR_FRLVL /* SPI fifo reception level */
  326. #define SPI_FLAG_MASK (SPI_SR_RXNE | SPI_SR_TXE | SPI_SR_BSY | SPI_SR_CRCERR\
  327. | SPI_SR_MODF | SPI_SR_OVR | SPI_SR_FRE | SPI_SR_FTLVL | SPI_SR_FRLVL)
  328. /**
  329. * @}
  330. */
  331. /** @defgroup SPI_transmission_fifo_status_level SPI Transmission FIFO Status Level
  332. * @{
  333. */
  334. #define SPI_FTLVL_EMPTY (0x00000000U)
  335. #define SPI_FTLVL_QUARTER_FULL (0x00000800U)
  336. #define SPI_FTLVL_HALF_FULL (0x00001000U)
  337. #define SPI_FTLVL_FULL (0x00001800U)
  338. /**
  339. * @}
  340. */
  341. /** @defgroup SPI_reception_fifo_status_level SPI Reception FIFO Status Level
  342. * @{
  343. */
  344. #define SPI_FRLVL_EMPTY (0x00000000U)
  345. #define SPI_FRLVL_QUARTER_FULL (0x00000200U)
  346. #define SPI_FRLVL_HALF_FULL (0x00000400U)
  347. #define SPI_FRLVL_FULL (0x00000600U)
  348. /**
  349. * @}
  350. */
  351. /**
  352. * @}
  353. */
  354. /* Exported macros -----------------------------------------------------------*/
  355. /** @defgroup SPI_Exported_Macros SPI Exported Macros
  356. * @{
  357. */
  358. /** @brief Reset SPI handle state.
  359. * @param __HANDLE__ specifies the SPI Handle.
  360. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  361. * @retval None
  362. */
  363. #if (USE_HAL_SPI_REGISTER_CALLBACKS == 1U)
  364. #define __HAL_SPI_RESET_HANDLE_STATE(__HANDLE__) do{ \
  365. (__HANDLE__)->State = HAL_SPI_STATE_RESET; \
  366. (__HANDLE__)->MspInitCallback = NULL; \
  367. (__HANDLE__)->MspDeInitCallback = NULL; \
  368. } while(0)
  369. #else
  370. #define __HAL_SPI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SPI_STATE_RESET)
  371. #endif /* USE_HAL_SPI_REGISTER_CALLBACKS */
  372. /** @brief Enable the specified SPI interrupts.
  373. * @param __HANDLE__ specifies the SPI Handle.
  374. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  375. * @param __INTERRUPT__ specifies the interrupt source to enable.
  376. * This parameter can be one of the following values:
  377. * @arg SPI_IT_TXE: Tx buffer empty interrupt enable
  378. * @arg SPI_IT_RXNE: RX buffer not empty interrupt enable
  379. * @arg SPI_IT_ERR: Error interrupt enable
  380. * @retval None
  381. */
  382. #define __HAL_SPI_ENABLE_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CR2, (__INTERRUPT__))
  383. /** @brief Disable the specified SPI interrupts.
  384. * @param __HANDLE__ specifies the SPI handle.
  385. * This parameter can be SPIx where x: 1, 2, or 3 to select the SPI peripheral.
  386. * @param __INTERRUPT__ specifies the interrupt source to disable.
  387. * This parameter can be one of the following values:
  388. * @arg SPI_IT_TXE: Tx buffer empty interrupt enable
  389. * @arg SPI_IT_RXNE: RX buffer not empty interrupt enable
  390. * @arg SPI_IT_ERR: Error interrupt enable
  391. * @retval None
  392. */
  393. #define __HAL_SPI_DISABLE_IT(__HANDLE__, __INTERRUPT__) CLEAR_BIT((__HANDLE__)->Instance->CR2, (__INTERRUPT__))
  394. /** @brief Check whether the specified SPI interrupt source is enabled or not.
  395. * @param __HANDLE__ specifies the SPI Handle.
  396. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  397. * @param __INTERRUPT__ specifies the SPI interrupt source to check.
  398. * This parameter can be one of the following values:
  399. * @arg SPI_IT_TXE: Tx buffer empty interrupt enable
  400. * @arg SPI_IT_RXNE: RX buffer not empty interrupt enable
  401. * @arg SPI_IT_ERR: Error interrupt enable
  402. * @retval The new state of __IT__ (TRUE or FALSE).
  403. */
  404. #define __HAL_SPI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2\
  405. & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  406. /** @brief Check whether the specified SPI flag is set or not.
  407. * @param __HANDLE__ specifies the SPI Handle.
  408. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  409. * @param __FLAG__ specifies the flag to check.
  410. * This parameter can be one of the following values:
  411. * @arg SPI_FLAG_RXNE: Receive buffer not empty flag
  412. * @arg SPI_FLAG_TXE: Transmit buffer empty flag
  413. * @arg SPI_FLAG_CRCERR: CRC error flag
  414. * @arg SPI_FLAG_MODF: Mode fault flag
  415. * @arg SPI_FLAG_OVR: Overrun flag
  416. * @arg SPI_FLAG_BSY: Busy flag
  417. * @arg SPI_FLAG_FRE: Frame format error flag
  418. * @arg SPI_FLAG_FTLVL: SPI fifo transmission level
  419. * @arg SPI_FLAG_FRLVL: SPI fifo reception level
  420. * @retval The new state of __FLAG__ (TRUE or FALSE).
  421. */
  422. #define __HAL_SPI_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
  423. /** @brief Clear the SPI CRCERR pending flag.
  424. * @param __HANDLE__ specifies the SPI Handle.
  425. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  426. * @retval None
  427. */
  428. #define __HAL_SPI_CLEAR_CRCERRFLAG(__HANDLE__) ((__HANDLE__)->Instance->SR = (uint16_t)(~SPI_FLAG_CRCERR))
  429. /** @brief Clear the SPI MODF pending flag.
  430. * @param __HANDLE__ specifies the SPI Handle.
  431. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  432. * @retval None
  433. */
  434. #define __HAL_SPI_CLEAR_MODFFLAG(__HANDLE__) \
  435. do{ \
  436. __IO uint32_t tmpreg_modf = 0x00U; \
  437. tmpreg_modf = (__HANDLE__)->Instance->SR; \
  438. CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE); \
  439. UNUSED(tmpreg_modf); \
  440. } while(0U)
  441. /** @brief Clear the SPI OVR pending flag.
  442. * @param __HANDLE__ specifies the SPI Handle.
  443. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  444. * @retval None
  445. */
  446. #define __HAL_SPI_CLEAR_OVRFLAG(__HANDLE__) \
  447. do{ \
  448. __IO uint32_t tmpreg_ovr = 0x00U; \
  449. tmpreg_ovr = (__HANDLE__)->Instance->DR; \
  450. tmpreg_ovr = (__HANDLE__)->Instance->SR; \
  451. UNUSED(tmpreg_ovr); \
  452. } while(0U)
  453. /** @brief Clear the SPI FRE pending flag.
  454. * @param __HANDLE__ specifies the SPI Handle.
  455. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  456. * @retval None
  457. */
  458. #define __HAL_SPI_CLEAR_FREFLAG(__HANDLE__) \
  459. do{ \
  460. __IO uint32_t tmpreg_fre = 0x00U; \
  461. tmpreg_fre = (__HANDLE__)->Instance->SR; \
  462. UNUSED(tmpreg_fre); \
  463. }while(0U)
  464. /** @brief Enable the SPI peripheral.
  465. * @param __HANDLE__ specifies the SPI Handle.
  466. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  467. * @retval None
  468. */
  469. #define __HAL_SPI_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE)
  470. /** @brief Disable the SPI peripheral.
  471. * @param __HANDLE__ specifies the SPI Handle.
  472. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  473. * @retval None
  474. */
  475. #define __HAL_SPI_DISABLE(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE)
  476. /**
  477. * @}
  478. */
  479. /* Private macros ------------------------------------------------------------*/
  480. /** @defgroup SPI_Private_Macros SPI Private Macros
  481. * @{
  482. */
  483. /** @brief Set the SPI transmit-only mode.
  484. * @param __HANDLE__ specifies the SPI Handle.
  485. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  486. * @retval None
  487. */
  488. #define SPI_1LINE_TX(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_BIDIOE)
  489. /** @brief Set the SPI receive-only mode.
  490. * @param __HANDLE__ specifies the SPI Handle.
  491. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  492. * @retval None
  493. */
  494. #define SPI_1LINE_RX(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_BIDIOE)
  495. /** @brief Reset the CRC calculation of the SPI.
  496. * @param __HANDLE__ specifies the SPI Handle.
  497. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  498. * @retval None
  499. */
  500. #define SPI_RESET_CRC(__HANDLE__) do{CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_CRCEN);\
  501. SET_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_CRCEN);}while(0U)
  502. /** @brief Check whether the specified SPI flag is set or not.
  503. * @param __SR__ copy of SPI SR register.
  504. * @param __FLAG__ specifies the flag to check.
  505. * This parameter can be one of the following values:
  506. * @arg SPI_FLAG_RXNE: Receive buffer not empty flag
  507. * @arg SPI_FLAG_TXE: Transmit buffer empty flag
  508. * @arg SPI_FLAG_CRCERR: CRC error flag
  509. * @arg SPI_FLAG_MODF: Mode fault flag
  510. * @arg SPI_FLAG_OVR: Overrun flag
  511. * @arg SPI_FLAG_BSY: Busy flag
  512. * @arg SPI_FLAG_FRE: Frame format error flag
  513. * @arg SPI_FLAG_FTLVL: SPI fifo transmission level
  514. * @arg SPI_FLAG_FRLVL: SPI fifo reception level
  515. * @retval SET or RESET.
  516. */
  517. #define SPI_CHECK_FLAG(__SR__, __FLAG__) ((((__SR__) & ((__FLAG__) & SPI_FLAG_MASK)) == \
  518. ((__FLAG__) & SPI_FLAG_MASK)) ? SET : RESET)
  519. /** @brief Check whether the specified SPI Interrupt is set or not.
  520. * @param __CR2__ copy of SPI CR2 register.
  521. * @param __INTERRUPT__ specifies the SPI interrupt source to check.
  522. * This parameter can be one of the following values:
  523. * @arg SPI_IT_TXE: Tx buffer empty interrupt enable
  524. * @arg SPI_IT_RXNE: RX buffer not empty interrupt enable
  525. * @arg SPI_IT_ERR: Error interrupt enable
  526. * @retval SET or RESET.
  527. */
  528. #define SPI_CHECK_IT_SOURCE(__CR2__, __INTERRUPT__) ((((__CR2__) & (__INTERRUPT__)) == \
  529. (__INTERRUPT__)) ? SET : RESET)
  530. /** @brief Checks if SPI Mode parameter is in allowed range.
  531. * @param __MODE__ specifies the SPI Mode.
  532. * This parameter can be a value of @ref SPI_Mode
  533. * @retval None
  534. */
  535. #define IS_SPI_MODE(__MODE__) (((__MODE__) == SPI_MODE_SLAVE) || \
  536. ((__MODE__) == SPI_MODE_MASTER))
  537. /** @brief Checks if SPI Direction Mode parameter is in allowed range.
  538. * @param __MODE__ specifies the SPI Direction Mode.
  539. * This parameter can be a value of @ref SPI_Direction
  540. * @retval None
  541. */
  542. #define IS_SPI_DIRECTION(__MODE__) (((__MODE__) == SPI_DIRECTION_2LINES) || \
  543. ((__MODE__) == SPI_DIRECTION_2LINES_RXONLY) || \
  544. ((__MODE__) == SPI_DIRECTION_1LINE))
  545. /** @brief Checks if SPI Direction Mode parameter is 2 lines.
  546. * @param __MODE__ specifies the SPI Direction Mode.
  547. * @retval None
  548. */
  549. #define IS_SPI_DIRECTION_2LINES(__MODE__) ((__MODE__) == SPI_DIRECTION_2LINES)
  550. /** @brief Checks if SPI Direction Mode parameter is 1 or 2 lines.
  551. * @param __MODE__ specifies the SPI Direction Mode.
  552. * @retval None
  553. */
  554. #define IS_SPI_DIRECTION_2LINES_OR_1LINE(__MODE__) (((__MODE__) == SPI_DIRECTION_2LINES) || \
  555. ((__MODE__) == SPI_DIRECTION_1LINE))
  556. /** @brief Checks if SPI Data Size parameter is in allowed range.
  557. * @param __DATASIZE__ specifies the SPI Data Size.
  558. * This parameter can be a value of @ref SPI_Data_Size
  559. * @retval None
  560. */
  561. #define IS_SPI_DATASIZE(__DATASIZE__) (((__DATASIZE__) == SPI_DATASIZE_16BIT) || \
  562. ((__DATASIZE__) == SPI_DATASIZE_15BIT) || \
  563. ((__DATASIZE__) == SPI_DATASIZE_14BIT) || \
  564. ((__DATASIZE__) == SPI_DATASIZE_13BIT) || \
  565. ((__DATASIZE__) == SPI_DATASIZE_12BIT) || \
  566. ((__DATASIZE__) == SPI_DATASIZE_11BIT) || \
  567. ((__DATASIZE__) == SPI_DATASIZE_10BIT) || \
  568. ((__DATASIZE__) == SPI_DATASIZE_9BIT) || \
  569. ((__DATASIZE__) == SPI_DATASIZE_8BIT) || \
  570. ((__DATASIZE__) == SPI_DATASIZE_7BIT) || \
  571. ((__DATASIZE__) == SPI_DATASIZE_6BIT) || \
  572. ((__DATASIZE__) == SPI_DATASIZE_5BIT) || \
  573. ((__DATASIZE__) == SPI_DATASIZE_4BIT))
  574. /** @brief Checks if SPI Serial clock steady state parameter is in allowed range.
  575. * @param __CPOL__ specifies the SPI serial clock steady state.
  576. * This parameter can be a value of @ref SPI_Clock_Polarity
  577. * @retval None
  578. */
  579. #define IS_SPI_CPOL(__CPOL__) (((__CPOL__) == SPI_POLARITY_LOW) || \
  580. ((__CPOL__) == SPI_POLARITY_HIGH))
  581. /** @brief Checks if SPI Clock Phase parameter is in allowed range.
  582. * @param __CPHA__ specifies the SPI Clock Phase.
  583. * This parameter can be a value of @ref SPI_Clock_Phase
  584. * @retval None
  585. */
  586. #define IS_SPI_CPHA(__CPHA__) (((__CPHA__) == SPI_PHASE_1EDGE) || \
  587. ((__CPHA__) == SPI_PHASE_2EDGE))
  588. /** @brief Checks if SPI Slave Select parameter is in allowed range.
  589. * @param __NSS__ specifies the SPI Slave Select management parameter.
  590. * This parameter can be a value of @ref SPI_Slave_Select_management
  591. * @retval None
  592. */
  593. #define IS_SPI_NSS(__NSS__) (((__NSS__) == SPI_NSS_SOFT) || \
  594. ((__NSS__) == SPI_NSS_HARD_INPUT) || \
  595. ((__NSS__) == SPI_NSS_HARD_OUTPUT))
  596. /** @brief Checks if SPI NSS Pulse parameter is in allowed range.
  597. * @param __NSSP__ specifies the SPI NSS Pulse Mode parameter.
  598. * This parameter can be a value of @ref SPI_NSSP_Mode
  599. * @retval None
  600. */
  601. #define IS_SPI_NSSP(__NSSP__) (((__NSSP__) == SPI_NSS_PULSE_ENABLE) || \
  602. ((__NSSP__) == SPI_NSS_PULSE_DISABLE))
  603. /** @brief Checks if SPI Baudrate prescaler parameter is in allowed range.
  604. * @param __PRESCALER__ specifies the SPI Baudrate prescaler.
  605. * This parameter can be a value of @ref SPI_BaudRate_Prescaler
  606. * @retval None
  607. */
  608. #define IS_SPI_BAUDRATE_PRESCALER(__PRESCALER__) (((__PRESCALER__) == SPI_BAUDRATEPRESCALER_2) || \
  609. ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_4) || \
  610. ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_8) || \
  611. ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_16) || \
  612. ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_32) || \
  613. ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_64) || \
  614. ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_128) || \
  615. ((__PRESCALER__) == SPI_BAUDRATEPRESCALER_256))
  616. /** @brief Checks if SPI MSB LSB transmission parameter is in allowed range.
  617. * @param __BIT__ specifies the SPI MSB LSB transmission (whether data transfer starts from MSB or LSB bit).
  618. * This parameter can be a value of @ref SPI_MSB_LSB_transmission
  619. * @retval None
  620. */
  621. #define IS_SPI_FIRST_BIT(__BIT__) (((__BIT__) == SPI_FIRSTBIT_MSB) || \
  622. ((__BIT__) == SPI_FIRSTBIT_LSB))
  623. /** @brief Checks if SPI TI mode parameter is in allowed range.
  624. * @param __MODE__ specifies the SPI TI mode.
  625. * This parameter can be a value of @ref SPI_TI_mode
  626. * @retval None
  627. */
  628. #define IS_SPI_TIMODE(__MODE__) (((__MODE__) == SPI_TIMODE_DISABLE) || \
  629. ((__MODE__) == SPI_TIMODE_ENABLE))
  630. /** @brief Checks if SPI CRC calculation enabled state is in allowed range.
  631. * @param __CALCULATION__ specifies the SPI CRC calculation enable state.
  632. * This parameter can be a value of @ref SPI_CRC_Calculation
  633. * @retval None
  634. */
  635. #define IS_SPI_CRC_CALCULATION(__CALCULATION__) (((__CALCULATION__) == SPI_CRCCALCULATION_DISABLE) || \
  636. ((__CALCULATION__) == SPI_CRCCALCULATION_ENABLE))
  637. /** @brief Checks if SPI CRC length is in allowed range.
  638. * @param __LENGTH__ specifies the SPI CRC length.
  639. * This parameter can be a value of @ref SPI_CRC_length
  640. * @retval None
  641. */
  642. #define IS_SPI_CRC_LENGTH(__LENGTH__) (((__LENGTH__) == SPI_CRC_LENGTH_DATASIZE) || \
  643. ((__LENGTH__) == SPI_CRC_LENGTH_8BIT) || \
  644. ((__LENGTH__) == SPI_CRC_LENGTH_16BIT))
  645. /** @brief Checks if SPI polynomial value to be used for the CRC calculation, is in allowed range.
  646. * @param __POLYNOMIAL__ specifies the SPI polynomial value to be used for the CRC calculation.
  647. * This parameter must be a number between Min_Data = 0 and Max_Data = 65535
  648. * @retval None
  649. */
  650. #define IS_SPI_CRC_POLYNOMIAL(__POLYNOMIAL__) (((__POLYNOMIAL__) >= 0x1U) && \
  651. ((__POLYNOMIAL__) <= 0xFFFFU) && \
  652. (((__POLYNOMIAL__)&0x1U) != 0U))
  653. /** @brief Checks if DMA handle is valid.
  654. * @param __HANDLE__ specifies a DMA Handle.
  655. * @retval None
  656. */
  657. #define IS_SPI_DMA_HANDLE(__HANDLE__) ((__HANDLE__) != NULL)
  658. /**
  659. * @}
  660. */
  661. /* Include SPI HAL Extended module */
  662. #include "stm32f0xx_hal_spi_ex.h"
  663. /* Exported functions --------------------------------------------------------*/
  664. /** @addtogroup SPI_Exported_Functions
  665. * @{
  666. */
  667. /** @addtogroup SPI_Exported_Functions_Group1
  668. * @{
  669. */
  670. /* Initialization/de-initialization functions ********************************/
  671. HAL_StatusTypeDef HAL_SPI_Init(SPI_HandleTypeDef *hspi);
  672. HAL_StatusTypeDef HAL_SPI_DeInit(SPI_HandleTypeDef *hspi);
  673. void HAL_SPI_MspInit(SPI_HandleTypeDef *hspi);
  674. void HAL_SPI_MspDeInit(SPI_HandleTypeDef *hspi);
  675. /* Callbacks Register/UnRegister functions ***********************************/
  676. #if (USE_HAL_SPI_REGISTER_CALLBACKS == 1U)
  677. HAL_StatusTypeDef HAL_SPI_RegisterCallback(SPI_HandleTypeDef *hspi, HAL_SPI_CallbackIDTypeDef CallbackID,
  678. pSPI_CallbackTypeDef pCallback);
  679. HAL_StatusTypeDef HAL_SPI_UnRegisterCallback(SPI_HandleTypeDef *hspi, HAL_SPI_CallbackIDTypeDef CallbackID);
  680. #endif /* USE_HAL_SPI_REGISTER_CALLBACKS */
  681. /**
  682. * @}
  683. */
  684. /** @addtogroup SPI_Exported_Functions_Group2
  685. * @{
  686. */
  687. /* I/O operation functions ***************************************************/
  688. HAL_StatusTypeDef HAL_SPI_Transmit(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  689. HAL_StatusTypeDef HAL_SPI_Receive(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  690. HAL_StatusTypeDef HAL_SPI_TransmitReceive(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size,
  691. uint32_t Timeout);
  692. HAL_StatusTypeDef HAL_SPI_Transmit_IT(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  693. HAL_StatusTypeDef HAL_SPI_Receive_IT(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  694. HAL_StatusTypeDef HAL_SPI_TransmitReceive_IT(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData,
  695. uint16_t Size);
  696. HAL_StatusTypeDef HAL_SPI_Transmit_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  697. HAL_StatusTypeDef HAL_SPI_Receive_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  698. HAL_StatusTypeDef HAL_SPI_TransmitReceive_DMA(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData,
  699. uint16_t Size);
  700. HAL_StatusTypeDef HAL_SPI_DMAPause(SPI_HandleTypeDef *hspi);
  701. HAL_StatusTypeDef HAL_SPI_DMAResume(SPI_HandleTypeDef *hspi);
  702. HAL_StatusTypeDef HAL_SPI_DMAStop(SPI_HandleTypeDef *hspi);
  703. /* Transfer Abort functions */
  704. HAL_StatusTypeDef HAL_SPI_Abort(SPI_HandleTypeDef *hspi);
  705. HAL_StatusTypeDef HAL_SPI_Abort_IT(SPI_HandleTypeDef *hspi);
  706. void HAL_SPI_IRQHandler(SPI_HandleTypeDef *hspi);
  707. void HAL_SPI_TxCpltCallback(SPI_HandleTypeDef *hspi);
  708. void HAL_SPI_RxCpltCallback(SPI_HandleTypeDef *hspi);
  709. void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi);
  710. void HAL_SPI_TxHalfCpltCallback(SPI_HandleTypeDef *hspi);
  711. void HAL_SPI_RxHalfCpltCallback(SPI_HandleTypeDef *hspi);
  712. void HAL_SPI_TxRxHalfCpltCallback(SPI_HandleTypeDef *hspi);
  713. void HAL_SPI_ErrorCallback(SPI_HandleTypeDef *hspi);
  714. void HAL_SPI_AbortCpltCallback(SPI_HandleTypeDef *hspi);
  715. /**
  716. * @}
  717. */
  718. /** @addtogroup SPI_Exported_Functions_Group3
  719. * @{
  720. */
  721. /* Peripheral State and Error functions ***************************************/
  722. HAL_SPI_StateTypeDef HAL_SPI_GetState(SPI_HandleTypeDef *hspi);
  723. uint32_t HAL_SPI_GetError(SPI_HandleTypeDef *hspi);
  724. /**
  725. * @}
  726. */
  727. /**
  728. * @}
  729. */
  730. /**
  731. * @}
  732. */
  733. /**
  734. * @}
  735. */
  736. #ifdef __cplusplus
  737. }
  738. #endif
  739. #endif /* STM32F0xx_HAL_SPI_H */