stm32f4xx_hal_spi.h 22 KB

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