You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

stm32f4xx_hal_spi.h 23KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585
  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_spi.h
  4. * @author MCD Application Team
  5. * @brief Header file of SPI HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  10. *
  11. * Redistribution and use in source and binary forms, with or without modification,
  12. * are permitted provided that the following conditions are met:
  13. * 1. Redistributions of source code must retain the above copyright notice,
  14. * this list of conditions and the following disclaimer.
  15. * 2. Redistributions in binary form must reproduce the above copyright notice,
  16. * this list of conditions and the following disclaimer in the documentation
  17. * and/or other materials provided with the distribution.
  18. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  19. * may be used to endorse or promote products derived from this software
  20. * without specific prior written permission.
  21. *
  22. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  26. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32. *
  33. ******************************************************************************
  34. */
  35. /* Define to prevent recursive inclusion -------------------------------------*/
  36. #ifndef __STM32F4xx_HAL_SPI_H
  37. #define __STM32F4xx_HAL_SPI_H
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. /* Includes ------------------------------------------------------------------*/
  42. #include "stm32f4xx_hal_def.h"
  43. /** @addtogroup STM32F4xx_HAL_Driver
  44. * @{
  45. */
  46. /** @addtogroup SPI
  47. * @{
  48. */
  49. /* Exported types ------------------------------------------------------------*/
  50. /** @defgroup SPI_Exported_Types SPI Exported Types
  51. * @{
  52. */
  53. /**
  54. * @brief SPI Configuration Structure definition
  55. */
  56. typedef struct
  57. {
  58. uint32_t Mode; /*!< Specifies the SPI operating mode.
  59. This parameter can be a value of @ref SPI_Mode */
  60. uint32_t Direction; /*!< Specifies the SPI bidirectional mode state.
  61. This parameter can be a value of @ref SPI_Direction */
  62. uint32_t DataSize; /*!< Specifies the SPI data size.
  63. This parameter can be a value of @ref SPI_Data_Size */
  64. uint32_t CLKPolarity; /*!< Specifies the serial clock steady state.
  65. This parameter can be a value of @ref SPI_Clock_Polarity */
  66. uint32_t CLKPhase; /*!< Specifies the clock active edge for the bit capture.
  67. This parameter can be a value of @ref SPI_Clock_Phase */
  68. uint32_t NSS; /*!< Specifies whether the NSS signal is managed by
  69. hardware (NSS pin) or by software using the SSI bit.
  70. This parameter can be a value of @ref SPI_Slave_Select_management */
  71. uint32_t BaudRatePrescaler; /*!< Specifies the Baud Rate prescaler value which will be
  72. used to configure the transmit and receive SCK clock.
  73. This parameter can be a value of @ref SPI_BaudRate_Prescaler
  74. @note The communication clock is derived from the master
  75. clock. The slave clock does not need to be set. */
  76. uint32_t FirstBit; /*!< Specifies whether data transfers start from MSB or LSB bit.
  77. This parameter can be a value of @ref SPI_MSB_LSB_transmission */
  78. uint32_t TIMode; /*!< Specifies if the TI mode is enabled or not.
  79. This parameter can be a value of @ref SPI_TI_mode */
  80. uint32_t CRCCalculation; /*!< Specifies if the CRC calculation is enabled or not.
  81. This parameter can be a value of @ref SPI_CRC_Calculation */
  82. uint32_t CRCPolynomial; /*!< Specifies the polynomial used for the CRC calculation.
  83. This parameter must be a number between Min_Data = 0 and Max_Data = 65535 */
  84. }SPI_InitTypeDef;
  85. /**
  86. * @brief HAL SPI State structure definition
  87. */
  88. typedef enum
  89. {
  90. HAL_SPI_STATE_RESET = 0x00U, /*!< Peripheral not Initialized */
  91. HAL_SPI_STATE_READY = 0x01U, /*!< Peripheral Initialized and ready for use */
  92. HAL_SPI_STATE_BUSY = 0x02U, /*!< an internal process is ongoing */
  93. HAL_SPI_STATE_BUSY_TX = 0x03U, /*!< Data Transmission process is ongoing */
  94. HAL_SPI_STATE_BUSY_RX = 0x04U, /*!< Data Reception process is ongoing */
  95. HAL_SPI_STATE_BUSY_TX_RX = 0x05U, /*!< Data Transmission and Reception process is ongoing */
  96. HAL_SPI_STATE_ERROR = 0x06U /*!< SPI error state */
  97. }HAL_SPI_StateTypeDef;
  98. /**
  99. * @brief SPI handle Structure definition
  100. */
  101. typedef struct __SPI_HandleTypeDef
  102. {
  103. SPI_TypeDef *Instance; /* SPI registers base address */
  104. SPI_InitTypeDef Init; /* SPI communication parameters */
  105. uint8_t *pTxBuffPtr; /* Pointer to SPI Tx transfer Buffer */
  106. uint16_t TxXferSize; /* SPI Tx Transfer size */
  107. __IO uint16_t TxXferCount; /* SPI Tx Transfer Counter */
  108. uint8_t *pRxBuffPtr; /* Pointer to SPI Rx transfer Buffer */
  109. uint16_t RxXferSize; /* SPI Rx Transfer size */
  110. __IO uint16_t RxXferCount; /* SPI Rx Transfer Counter */
  111. void (*RxISR)(struct __SPI_HandleTypeDef * hspi); /* function pointer on Rx ISR */
  112. void (*TxISR)(struct __SPI_HandleTypeDef * hspi); /* function pointer on Tx ISR */
  113. DMA_HandleTypeDef *hdmatx; /* SPI Tx DMA Handle parameters */
  114. DMA_HandleTypeDef *hdmarx; /* SPI Rx DMA Handle parameters */
  115. HAL_LockTypeDef Lock; /* Locking object */
  116. __IO HAL_SPI_StateTypeDef State; /* SPI communication state */
  117. __IO uint32_t ErrorCode; /* SPI Error code */
  118. }SPI_HandleTypeDef;
  119. /**
  120. * @}
  121. */
  122. /* Exported constants --------------------------------------------------------*/
  123. /** @defgroup SPI_Exported_Constants SPI Exported Constants
  124. * @{
  125. */
  126. /** @defgroup SPI_Error_Code SPI Error Code
  127. * @{
  128. */
  129. #define HAL_SPI_ERROR_NONE 0x00000000U /*!< No error */
  130. #define HAL_SPI_ERROR_MODF 0x00000001U /*!< MODF error */
  131. #define HAL_SPI_ERROR_CRC 0x00000002U /*!< CRC error */
  132. #define HAL_SPI_ERROR_OVR 0x00000004U /*!< OVR error */
  133. #define HAL_SPI_ERROR_FRE 0x00000008U /*!< FRE error */
  134. #define HAL_SPI_ERROR_DMA 0x00000010U /*!< DMA transfer error */
  135. #define HAL_SPI_ERROR_FLAG 0x00000020U /*!< Flag: RXNE,TXE, BSY */
  136. /**
  137. * @}
  138. */
  139. /** @defgroup SPI_Mode SPI Mode
  140. * @{
  141. */
  142. #define SPI_MODE_SLAVE 0x00000000U
  143. #define SPI_MODE_MASTER (SPI_CR1_MSTR | SPI_CR1_SSI)
  144. /**
  145. * @}
  146. */
  147. /** @defgroup SPI_Direction SPI Direction Mode
  148. * @{
  149. */
  150. #define SPI_DIRECTION_2LINES 0x00000000U
  151. #define SPI_DIRECTION_2LINES_RXONLY SPI_CR1_RXONLY
  152. #define SPI_DIRECTION_1LINE SPI_CR1_BIDIMODE
  153. /**
  154. * @}
  155. */
  156. /** @defgroup SPI_Data_Size SPI Data Size
  157. * @{
  158. */
  159. #define SPI_DATASIZE_8BIT 0x00000000U
  160. #define SPI_DATASIZE_16BIT SPI_CR1_DFF
  161. /**
  162. * @}
  163. */
  164. /** @defgroup SPI_Clock_Polarity SPI Clock Polarity
  165. * @{
  166. */
  167. #define SPI_POLARITY_LOW 0x00000000U
  168. #define SPI_POLARITY_HIGH SPI_CR1_CPOL
  169. /**
  170. * @}
  171. */
  172. /** @defgroup SPI_Clock_Phase SPI Clock Phase
  173. * @{
  174. */
  175. #define SPI_PHASE_1EDGE 0x00000000U
  176. #define SPI_PHASE_2EDGE SPI_CR1_CPHA
  177. /**
  178. * @}
  179. */
  180. /** @defgroup SPI_Slave_Select_management SPI Slave Select Management
  181. * @{
  182. */
  183. #define SPI_NSS_SOFT SPI_CR1_SSM
  184. #define SPI_NSS_HARD_INPUT 0x00000000U
  185. #define SPI_NSS_HARD_OUTPUT 0x00040000U
  186. /**
  187. * @}
  188. */
  189. /** @defgroup SPI_BaudRate_Prescaler SPI BaudRate Prescaler
  190. * @{
  191. */
  192. #define SPI_BAUDRATEPRESCALER_2 0x00000000U
  193. #define SPI_BAUDRATEPRESCALER_4 0x00000008U
  194. #define SPI_BAUDRATEPRESCALER_8 0x00000010U
  195. #define SPI_BAUDRATEPRESCALER_16 0x00000018U
  196. #define SPI_BAUDRATEPRESCALER_32 0x00000020U
  197. #define SPI_BAUDRATEPRESCALER_64 0x00000028U
  198. #define SPI_BAUDRATEPRESCALER_128 0x00000030U
  199. #define SPI_BAUDRATEPRESCALER_256 0x00000038U
  200. /**
  201. * @}
  202. */
  203. /** @defgroup SPI_MSB_LSB_transmission SPI MSB LSB Transmission
  204. * @{
  205. */
  206. #define SPI_FIRSTBIT_MSB 0x00000000U
  207. #define SPI_FIRSTBIT_LSB SPI_CR1_LSBFIRST
  208. /**
  209. * @}
  210. */
  211. /** @defgroup SPI_TI_mode SPI TI Mode
  212. * @{
  213. */
  214. #define SPI_TIMODE_DISABLE 0x00000000U
  215. #define SPI_TIMODE_ENABLE SPI_CR2_FRF
  216. /**
  217. * @}
  218. */
  219. /** @defgroup SPI_CRC_Calculation SPI CRC Calculation
  220. * @{
  221. */
  222. #define SPI_CRCCALCULATION_DISABLE 0x00000000U
  223. #define SPI_CRCCALCULATION_ENABLE SPI_CR1_CRCEN
  224. /**
  225. * @}
  226. */
  227. /** @defgroup SPI_Interrupt_definition SPI Interrupt Definition
  228. * @{
  229. */
  230. #define SPI_IT_TXE SPI_CR2_TXEIE
  231. #define SPI_IT_RXNE SPI_CR2_RXNEIE
  232. #define SPI_IT_ERR SPI_CR2_ERRIE
  233. /**
  234. * @}
  235. */
  236. /** @defgroup SPI_Flags_definition SPI Flags Definition
  237. * @{
  238. */
  239. #define SPI_FLAG_RXNE SPI_SR_RXNE /* SPI status flag: Rx buffer not empty flag */
  240. #define SPI_FLAG_TXE SPI_SR_TXE /* SPI status flag: Tx buffer empty flag */
  241. #define SPI_FLAG_BSY SPI_SR_BSY /* SPI status flag: Busy flag */
  242. #define SPI_FLAG_CRCERR SPI_SR_CRCERR /* SPI Error flag: CRC error flag */
  243. #define SPI_FLAG_MODF SPI_SR_MODF /* SPI Error flag: Mode fault flag */
  244. #define SPI_FLAG_OVR SPI_SR_OVR /* SPI Error flag: Overrun flag */
  245. #define SPI_FLAG_FRE SPI_SR_FRE /* SPI Error flag: TI mode frame format error flag */
  246. /**
  247. * @}
  248. */
  249. /**
  250. * @}
  251. */
  252. /* Exported macro ------------------------------------------------------------*/
  253. /** @defgroup SPI_Exported_Macros SPI Exported Macros
  254. * @{
  255. */
  256. /** @brief Reset SPI handle state.
  257. * @param __HANDLE__ specifies the SPI Handle.
  258. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  259. * @retval None
  260. */
  261. #define __HAL_SPI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SPI_STATE_RESET)
  262. /** @brief Enable or disable the specified SPI interrupts.
  263. * @param __HANDLE__ specifies the SPI Handle.
  264. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  265. * @param __INTERRUPT__ specifies the interrupt source to enable or disable.
  266. * This parameter can be one of the following values:
  267. * @arg SPI_IT_TXE: Tx buffer empty interrupt enable
  268. * @arg SPI_IT_RXNE: RX buffer not empty interrupt enable
  269. * @arg SPI_IT_ERR: Error interrupt enable
  270. * @retval None
  271. */
  272. #define __HAL_SPI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
  273. #define __HAL_SPI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= (~(__INTERRUPT__)))
  274. /** @brief Check whether the specified SPI interrupt source is enabled or not.
  275. * @param __HANDLE__ specifies the SPI Handle.
  276. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  277. * @param __INTERRUPT__ specifies the SPI interrupt source to check.
  278. * This parameter can be one of the following values:
  279. * @arg SPI_IT_TXE: Tx buffer empty interrupt enable
  280. * @arg SPI_IT_RXNE: RX buffer not empty interrupt enable
  281. * @arg SPI_IT_ERR: Error interrupt enable
  282. * @retval The new state of __IT__ (TRUE or FALSE).
  283. */
  284. #define __HAL_SPI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  285. /** @brief Check whether the specified SPI flag is set or not.
  286. * @param __HANDLE__ specifies the SPI Handle.
  287. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  288. * @param __FLAG__ specifies the flag to check.
  289. * This parameter can be one of the following values:
  290. * @arg SPI_FLAG_RXNE: Receive buffer not empty flag
  291. * @arg SPI_FLAG_TXE: Transmit buffer empty flag
  292. * @arg SPI_FLAG_CRCERR: CRC error flag
  293. * @arg SPI_FLAG_MODF: Mode fault flag
  294. * @arg SPI_FLAG_OVR: Overrun flag
  295. * @arg SPI_FLAG_BSY: Busy flag
  296. * @arg SPI_FLAG_FRE: Frame format error flag
  297. * @retval The new state of __FLAG__ (TRUE or FALSE).
  298. */
  299. #define __HAL_SPI_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
  300. /** @brief Clear the SPI CRCERR pending flag.
  301. * @param __HANDLE__ specifies the SPI Handle.
  302. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  303. * @retval None
  304. */
  305. #define __HAL_SPI_CLEAR_CRCERRFLAG(__HANDLE__) ((__HANDLE__)->Instance->SR = (uint16_t)(~SPI_FLAG_CRCERR))
  306. /** @brief Clear the SPI MODF pending flag.
  307. * @param __HANDLE__ specifies the SPI Handle.
  308. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  309. * @retval None
  310. */
  311. #define __HAL_SPI_CLEAR_MODFFLAG(__HANDLE__) \
  312. do{ \
  313. __IO uint32_t tmpreg_modf = 0x00U; \
  314. tmpreg_modf = (__HANDLE__)->Instance->SR; \
  315. (__HANDLE__)->Instance->CR1 &= (~SPI_CR1_SPE); \
  316. UNUSED(tmpreg_modf); \
  317. } while(0U)
  318. /** @brief Clear the SPI OVR pending flag.
  319. * @param __HANDLE__ specifies the SPI Handle.
  320. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  321. * @retval None
  322. */
  323. #define __HAL_SPI_CLEAR_OVRFLAG(__HANDLE__) \
  324. do{ \
  325. __IO uint32_t tmpreg_ovr = 0x00U; \
  326. tmpreg_ovr = (__HANDLE__)->Instance->DR; \
  327. tmpreg_ovr = (__HANDLE__)->Instance->SR; \
  328. UNUSED(tmpreg_ovr); \
  329. } while(0U)
  330. /** @brief Clear the SPI FRE pending flag.
  331. * @param __HANDLE__ specifies the SPI Handle.
  332. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  333. * @retval None
  334. */
  335. #define __HAL_SPI_CLEAR_FREFLAG(__HANDLE__) \
  336. do{ \
  337. __IO uint32_t tmpreg_fre = 0x00U; \
  338. tmpreg_fre = (__HANDLE__)->Instance->SR; \
  339. UNUSED(tmpreg_fre); \
  340. }while(0U)
  341. /** @brief Enable the SPI peripheral.
  342. * @param __HANDLE__ specifies the SPI Handle.
  343. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  344. * @retval None
  345. */
  346. #define __HAL_SPI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= SPI_CR1_SPE)
  347. /** @brief Disable the SPI peripheral.
  348. * @param __HANDLE__ specifies the SPI Handle.
  349. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  350. * @retval None
  351. */
  352. #define __HAL_SPI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= (~SPI_CR1_SPE))
  353. /**
  354. * @}
  355. */
  356. /* Exported functions --------------------------------------------------------*/
  357. /** @addtogroup SPI_Exported_Functions
  358. * @{
  359. */
  360. /** @addtogroup SPI_Exported_Functions_Group1
  361. * @{
  362. */
  363. /* Initialization/de-initialization functions **********************************/
  364. HAL_StatusTypeDef HAL_SPI_Init(SPI_HandleTypeDef *hspi);
  365. HAL_StatusTypeDef HAL_SPI_DeInit (SPI_HandleTypeDef *hspi);
  366. void HAL_SPI_MspInit(SPI_HandleTypeDef *hspi);
  367. void HAL_SPI_MspDeInit(SPI_HandleTypeDef *hspi);
  368. /**
  369. * @}
  370. */
  371. /** @addtogroup SPI_Exported_Functions_Group2
  372. * @{
  373. */
  374. /* I/O operation functions *****************************************************/
  375. HAL_StatusTypeDef HAL_SPI_Transmit(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  376. HAL_StatusTypeDef HAL_SPI_Receive(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  377. HAL_StatusTypeDef HAL_SPI_TransmitReceive(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
  378. HAL_StatusTypeDef HAL_SPI_Transmit_IT(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  379. HAL_StatusTypeDef HAL_SPI_Receive_IT(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  380. HAL_StatusTypeDef HAL_SPI_TransmitReceive_IT(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
  381. HAL_StatusTypeDef HAL_SPI_Transmit_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  382. HAL_StatusTypeDef HAL_SPI_Receive_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  383. HAL_StatusTypeDef HAL_SPI_TransmitReceive_DMA(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
  384. HAL_StatusTypeDef HAL_SPI_DMAPause(SPI_HandleTypeDef *hspi);
  385. HAL_StatusTypeDef HAL_SPI_DMAResume(SPI_HandleTypeDef *hspi);
  386. HAL_StatusTypeDef HAL_SPI_DMAStop(SPI_HandleTypeDef *hspi);
  387. /* Transfer Abort functions */
  388. HAL_StatusTypeDef HAL_SPI_Abort(SPI_HandleTypeDef *hspi);
  389. HAL_StatusTypeDef HAL_SPI_Abort_IT(SPI_HandleTypeDef *hspi);
  390. void HAL_SPI_IRQHandler(SPI_HandleTypeDef *hspi);
  391. void HAL_SPI_TxCpltCallback(SPI_HandleTypeDef *hspi);
  392. void HAL_SPI_RxCpltCallback(SPI_HandleTypeDef *hspi);
  393. void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi);
  394. void HAL_SPI_TxHalfCpltCallback(SPI_HandleTypeDef *hspi);
  395. void HAL_SPI_RxHalfCpltCallback(SPI_HandleTypeDef *hspi);
  396. void HAL_SPI_TxRxHalfCpltCallback(SPI_HandleTypeDef *hspi);
  397. void HAL_SPI_ErrorCallback(SPI_HandleTypeDef *hspi);
  398. void HAL_SPI_AbortCpltCallback(SPI_HandleTypeDef *hspi);
  399. /**
  400. * @}
  401. */
  402. /** @addtogroup SPI_Exported_Functions_Group3
  403. * @{
  404. */
  405. /* Peripheral State and Error functions ***************************************/
  406. HAL_SPI_StateTypeDef HAL_SPI_GetState(SPI_HandleTypeDef *hspi);
  407. uint32_t HAL_SPI_GetError(SPI_HandleTypeDef *hspi);
  408. /**
  409. * @}
  410. */
  411. /**
  412. * @}
  413. */
  414. /* Private types -------------------------------------------------------------*/
  415. /* Private variables ---------------------------------------------------------*/
  416. /* Private constants ---------------------------------------------------------*/
  417. /* Private macros ------------------------------------------------------------*/
  418. /** @defgroup SPI_Private_Macros SPI Private Macros
  419. * @{
  420. */
  421. /** @brief Set the SPI transmit-only mode.
  422. * @param __HANDLE__ specifies the SPI Handle.
  423. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  424. * @retval None
  425. */
  426. #define SPI_1LINE_TX(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= SPI_CR1_BIDIOE)
  427. /** @brief Set the SPI receive-only mode.
  428. * @param __HANDLE__ specifies the SPI Handle.
  429. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  430. * @retval None
  431. */
  432. #define SPI_1LINE_RX(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= (~SPI_CR1_BIDIOE))
  433. /** @brief Reset the CRC calculation of the SPI.
  434. * @param __HANDLE__ specifies the SPI Handle.
  435. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  436. * @retval None
  437. */
  438. #define SPI_RESET_CRC(__HANDLE__) do{(__HANDLE__)->Instance->CR1 &= (uint16_t)(~SPI_CR1_CRCEN);\
  439. (__HANDLE__)->Instance->CR1 |= SPI_CR1_CRCEN;}while(0U)
  440. #define IS_SPI_MODE(MODE) (((MODE) == SPI_MODE_SLAVE) || \
  441. ((MODE) == SPI_MODE_MASTER))
  442. #define IS_SPI_DIRECTION(MODE) (((MODE) == SPI_DIRECTION_2LINES) || \
  443. ((MODE) == SPI_DIRECTION_2LINES_RXONLY) || \
  444. ((MODE) == SPI_DIRECTION_1LINE))
  445. #define IS_SPI_DIRECTION_2LINES(MODE) ((MODE) == SPI_DIRECTION_2LINES)
  446. #define IS_SPI_DIRECTION_2LINES_OR_1LINE(MODE) (((MODE) == SPI_DIRECTION_2LINES) || \
  447. ((MODE) == SPI_DIRECTION_1LINE))
  448. #define IS_SPI_DATASIZE(DATASIZE) (((DATASIZE) == SPI_DATASIZE_16BIT) || \
  449. ((DATASIZE) == SPI_DATASIZE_8BIT))
  450. #define IS_SPI_CPOL(CPOL) (((CPOL) == SPI_POLARITY_LOW) || \
  451. ((CPOL) == SPI_POLARITY_HIGH))
  452. #define IS_SPI_CPHA(CPHA) (((CPHA) == SPI_PHASE_1EDGE) || \
  453. ((CPHA) == SPI_PHASE_2EDGE))
  454. #define IS_SPI_NSS(NSS) (((NSS) == SPI_NSS_SOFT) || \
  455. ((NSS) == SPI_NSS_HARD_INPUT) || \
  456. ((NSS) == SPI_NSS_HARD_OUTPUT))
  457. #define IS_SPI_BAUDRATE_PRESCALER(PRESCALER) (((PRESCALER) == SPI_BAUDRATEPRESCALER_2) || \
  458. ((PRESCALER) == SPI_BAUDRATEPRESCALER_4) || \
  459. ((PRESCALER) == SPI_BAUDRATEPRESCALER_8) || \
  460. ((PRESCALER) == SPI_BAUDRATEPRESCALER_16) || \
  461. ((PRESCALER) == SPI_BAUDRATEPRESCALER_32) || \
  462. ((PRESCALER) == SPI_BAUDRATEPRESCALER_64) || \
  463. ((PRESCALER) == SPI_BAUDRATEPRESCALER_128) || \
  464. ((PRESCALER) == SPI_BAUDRATEPRESCALER_256))
  465. #define IS_SPI_FIRST_BIT(BIT) (((BIT) == SPI_FIRSTBIT_MSB) || \
  466. ((BIT) == SPI_FIRSTBIT_LSB))
  467. #define IS_SPI_TIMODE(MODE) (((MODE) == SPI_TIMODE_DISABLE) || \
  468. ((MODE) == SPI_TIMODE_ENABLE))
  469. #define IS_SPI_CRC_CALCULATION(CALCULATION) (((CALCULATION) == SPI_CRCCALCULATION_DISABLE) || \
  470. ((CALCULATION) == SPI_CRCCALCULATION_ENABLE))
  471. #define IS_SPI_CRC_POLYNOMIAL(POLYNOMIAL) (((POLYNOMIAL) >= 0x01U) && ((POLYNOMIAL) <= 0xFFFFU))
  472. /**
  473. * @}
  474. */
  475. /* Private functions ---------------------------------------------------------*/
  476. /** @defgroup SPI_Private_Functions SPI Private Functions
  477. * @{
  478. */
  479. /**
  480. * @}
  481. */
  482. /**
  483. * @}
  484. */
  485. /**
  486. * @}
  487. */
  488. #ifdef __cplusplus
  489. }
  490. #endif
  491. #endif /* __STM32F4xx_HAL_SPI_H */
  492. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/