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.
 
 
 

705 lines
29 KiB

  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. * <h2><center>&copy; COPYRIGHT(c) 2016 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 __STM32F0xx_HAL_SPI_H
  37. #define __STM32F0xx_HAL_SPI_H
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. /* Includes ------------------------------------------------------------------*/
  42. #include "stm32f0xx_hal_def.h"
  43. /** @addtogroup STM32F0xx_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 an odd number between Min_Data = 1 and Max_Data = 65535 */
  84. uint32_t CRCLength; /*!< Specifies the CRC Length used for the CRC calculation.
  85. CRC Length is only used with Data8 and Data16, not other data size
  86. This parameter can be a value of @ref SPI_CRC_length */
  87. uint32_t NSSPMode; /*!< Specifies whether the NSSP signal is enabled or not .
  88. This parameter can be a value of @ref SPI_NSSP_Mode
  89. This mode is activated by the NSSP bit in the SPIx_CR2 register and
  90. it takes effect only if the SPI interface is configured as Motorola SPI
  91. master (FRF=0) with capture on the first edge (SPIx_CR1 CPHA = 0,
  92. CPOL setting is ignored).. */
  93. } SPI_InitTypeDef;
  94. /**
  95. * @brief HAL SPI State structure definition
  96. */
  97. typedef enum
  98. {
  99. HAL_SPI_STATE_RESET = 0x00U, /*!< Peripheral not Initialized */
  100. HAL_SPI_STATE_READY = 0x01U, /*!< Peripheral Initialized and ready for use */
  101. HAL_SPI_STATE_BUSY = 0x02U, /*!< an internal process is ongoing */
  102. HAL_SPI_STATE_BUSY_TX = 0x03U, /*!< Data Transmission process is ongoing */
  103. HAL_SPI_STATE_BUSY_RX = 0x04U, /*!< Data Reception process is ongoing */
  104. HAL_SPI_STATE_BUSY_TX_RX = 0x05U, /*!< Data Transmission and Reception process is ongoing */
  105. HAL_SPI_STATE_ERROR = 0x06U, /*!< SPI error state */
  106. HAL_SPI_STATE_ABORT = 0x07U /*!< SPI abort is ongoing */
  107. } HAL_SPI_StateTypeDef;
  108. /**
  109. * @brief SPI handle Structure definition
  110. */
  111. typedef struct __SPI_HandleTypeDef
  112. {
  113. SPI_TypeDef *Instance; /*!< SPI registers base address */
  114. SPI_InitTypeDef Init; /*!< SPI communication parameters */
  115. uint8_t *pTxBuffPtr; /*!< Pointer to SPI Tx transfer Buffer */
  116. uint16_t TxXferSize; /*!< SPI Tx Transfer size */
  117. __IO uint16_t TxXferCount; /*!< SPI Tx Transfer Counter */
  118. uint8_t *pRxBuffPtr; /*!< Pointer to SPI Rx transfer Buffer */
  119. uint16_t RxXferSize; /*!< SPI Rx Transfer size */
  120. __IO uint16_t RxXferCount; /*!< SPI Rx Transfer Counter */
  121. uint32_t CRCSize; /*!< SPI CRC size used for the transfer */
  122. void (*RxISR)(struct __SPI_HandleTypeDef *hspi); /*!< function pointer on Rx ISR */
  123. void (*TxISR)(struct __SPI_HandleTypeDef *hspi); /*!< function pointer on Tx ISR */
  124. DMA_HandleTypeDef *hdmatx; /*!< SPI Tx DMA Handle parameters */
  125. DMA_HandleTypeDef *hdmarx; /*!< SPI Rx DMA Handle parameters */
  126. HAL_LockTypeDef Lock; /*!< Locking object */
  127. __IO HAL_SPI_StateTypeDef State; /*!< SPI communication state */
  128. __IO uint32_t ErrorCode; /*!< SPI Error code */
  129. } SPI_HandleTypeDef;
  130. /**
  131. * @}
  132. */
  133. /* Exported constants --------------------------------------------------------*/
  134. /** @defgroup SPI_Exported_Constants SPI Exported Constants
  135. * @{
  136. */
  137. /** @defgroup SPI_Error_Code SPI Error Code
  138. * @{
  139. */
  140. #define HAL_SPI_ERROR_NONE (0x00000000U) /*!< No error */
  141. #define HAL_SPI_ERROR_MODF (0x00000001U) /*!< MODF error */
  142. #define HAL_SPI_ERROR_CRC (0x00000002U) /*!< CRC error */
  143. #define HAL_SPI_ERROR_OVR (0x00000004U) /*!< OVR error */
  144. #define HAL_SPI_ERROR_FRE (0x00000008U) /*!< FRE error */
  145. #define HAL_SPI_ERROR_DMA (0x00000010U) /*!< DMA transfer error */
  146. #define HAL_SPI_ERROR_FLAG (0x00000020U) /*!< Error on RXNE/TXE/BSY/FTLVL/FRLVL Flag */
  147. #define HAL_SPI_ERROR_ABORT (0x00000040U) /*!< Error during SPI Abort procedure */
  148. /**
  149. * @}
  150. */
  151. /** @defgroup SPI_Mode SPI Mode
  152. * @{
  153. */
  154. #define SPI_MODE_SLAVE (0x00000000U)
  155. #define SPI_MODE_MASTER (SPI_CR1_MSTR | SPI_CR1_SSI)
  156. /**
  157. * @}
  158. */
  159. /** @defgroup SPI_Direction SPI Direction Mode
  160. * @{
  161. */
  162. #define SPI_DIRECTION_2LINES (0x00000000U)
  163. #define SPI_DIRECTION_2LINES_RXONLY SPI_CR1_RXONLY
  164. #define SPI_DIRECTION_1LINE SPI_CR1_BIDIMODE
  165. /**
  166. * @}
  167. */
  168. /** @defgroup SPI_Data_Size SPI Data Size
  169. * @{
  170. */
  171. #define SPI_DATASIZE_4BIT (0x00000300U)
  172. #define SPI_DATASIZE_5BIT (0x00000400U)
  173. #define SPI_DATASIZE_6BIT (0x00000500U)
  174. #define SPI_DATASIZE_7BIT (0x00000600U)
  175. #define SPI_DATASIZE_8BIT (0x00000700U)
  176. #define SPI_DATASIZE_9BIT (0x00000800U)
  177. #define SPI_DATASIZE_10BIT (0x00000900U)
  178. #define SPI_DATASIZE_11BIT (0x00000A00U)
  179. #define SPI_DATASIZE_12BIT (0x00000B00U)
  180. #define SPI_DATASIZE_13BIT (0x00000C00U)
  181. #define SPI_DATASIZE_14BIT (0x00000D00U)
  182. #define SPI_DATASIZE_15BIT (0x00000E00U)
  183. #define SPI_DATASIZE_16BIT (0x00000F00U)
  184. /**
  185. * @}
  186. */
  187. /** @defgroup SPI_Clock_Polarity SPI Clock Polarity
  188. * @{
  189. */
  190. #define SPI_POLARITY_LOW (0x00000000U)
  191. #define SPI_POLARITY_HIGH SPI_CR1_CPOL
  192. /**
  193. * @}
  194. */
  195. /** @defgroup SPI_Clock_Phase SPI Clock Phase
  196. * @{
  197. */
  198. #define SPI_PHASE_1EDGE (0x00000000U)
  199. #define SPI_PHASE_2EDGE SPI_CR1_CPHA
  200. /**
  201. * @}
  202. */
  203. /** @defgroup SPI_Slave_Select_management SPI Slave Select Management
  204. * @{
  205. */
  206. #define SPI_NSS_SOFT SPI_CR1_SSM
  207. #define SPI_NSS_HARD_INPUT (0x00000000U)
  208. #define SPI_NSS_HARD_OUTPUT (SPI_CR2_SSOE << 16U)
  209. /**
  210. * @}
  211. */
  212. /** @defgroup SPI_NSSP_Mode SPI NSS Pulse Mode
  213. * @{
  214. */
  215. #define SPI_NSS_PULSE_ENABLE SPI_CR2_NSSP
  216. #define SPI_NSS_PULSE_DISABLE (0x00000000U)
  217. /**
  218. * @}
  219. */
  220. /** @defgroup SPI_BaudRate_Prescaler SPI BaudRate Prescaler
  221. * @{
  222. */
  223. #define SPI_BAUDRATEPRESCALER_2 (0x00000000U)
  224. #define SPI_BAUDRATEPRESCALER_4 (SPI_CR1_BR_0)
  225. #define SPI_BAUDRATEPRESCALER_8 (SPI_CR1_BR_1)
  226. #define SPI_BAUDRATEPRESCALER_16 (SPI_CR1_BR_1 | SPI_CR1_BR_0)
  227. #define SPI_BAUDRATEPRESCALER_32 (SPI_CR1_BR_2)
  228. #define SPI_BAUDRATEPRESCALER_64 (SPI_CR1_BR_2 | SPI_CR1_BR_0)
  229. #define SPI_BAUDRATEPRESCALER_128 (SPI_CR1_BR_2 | SPI_CR1_BR_1)
  230. #define SPI_BAUDRATEPRESCALER_256 (SPI_CR1_BR_2 | SPI_CR1_BR_1 | SPI_CR1_BR_0)
  231. /**
  232. * @}
  233. */
  234. /** @defgroup SPI_MSB_LSB_transmission SPI MSB LSB Transmission
  235. * @{
  236. */
  237. #define SPI_FIRSTBIT_MSB (0x00000000U)
  238. #define SPI_FIRSTBIT_LSB SPI_CR1_LSBFIRST
  239. /**
  240. * @}
  241. */
  242. /** @defgroup SPI_TI_mode SPI TI Mode
  243. * @{
  244. */
  245. #define SPI_TIMODE_DISABLE (0x00000000U)
  246. #define SPI_TIMODE_ENABLE SPI_CR2_FRF
  247. /**
  248. * @}
  249. */
  250. /** @defgroup SPI_CRC_Calculation SPI CRC Calculation
  251. * @{
  252. */
  253. #define SPI_CRCCALCULATION_DISABLE (0x00000000U)
  254. #define SPI_CRCCALCULATION_ENABLE SPI_CR1_CRCEN
  255. /**
  256. * @}
  257. */
  258. /** @defgroup SPI_CRC_length SPI CRC Length
  259. * @{
  260. * This parameter can be one of the following values:
  261. * SPI_CRC_LENGTH_DATASIZE: aligned with the data size
  262. * SPI_CRC_LENGTH_8BIT : CRC 8bit
  263. * SPI_CRC_LENGTH_16BIT : CRC 16bit
  264. */
  265. #define SPI_CRC_LENGTH_DATASIZE (0x00000000U)
  266. #define SPI_CRC_LENGTH_8BIT (0x00000001U)
  267. #define SPI_CRC_LENGTH_16BIT (0x00000002U)
  268. /**
  269. * @}
  270. */
  271. /** @defgroup SPI_FIFO_reception_threshold SPI FIFO Reception Threshold
  272. * @{
  273. * This parameter can be one of the following values:
  274. * SPI_RXFIFO_THRESHOLD or SPI_RXFIFO_THRESHOLD_QF :
  275. * RXNE event is generated if the FIFO
  276. * level is greater or equal to 1/2(16-bits).
  277. * SPI_RXFIFO_THRESHOLD_HF: RXNE event is generated if the FIFO
  278. * level is greater or equal to 1/4(8 bits). */
  279. #define SPI_RXFIFO_THRESHOLD SPI_CR2_FRXTH
  280. #define SPI_RXFIFO_THRESHOLD_QF SPI_CR2_FRXTH
  281. #define SPI_RXFIFO_THRESHOLD_HF (0x00000000U)
  282. /**
  283. * @}
  284. */
  285. /** @defgroup SPI_Interrupt_definition SPI Interrupt Definition
  286. * @{
  287. */
  288. #define SPI_IT_TXE SPI_CR2_TXEIE
  289. #define SPI_IT_RXNE SPI_CR2_RXNEIE
  290. #define SPI_IT_ERR SPI_CR2_ERRIE
  291. /**
  292. * @}
  293. */
  294. /** @defgroup SPI_Flags_definition SPI Flags Definition
  295. * @{
  296. */
  297. #define SPI_FLAG_RXNE SPI_SR_RXNE /* SPI status flag: Rx buffer not empty flag */
  298. #define SPI_FLAG_TXE SPI_SR_TXE /* SPI status flag: Tx buffer empty flag */
  299. #define SPI_FLAG_BSY SPI_SR_BSY /* SPI status flag: Busy flag */
  300. #define SPI_FLAG_CRCERR SPI_SR_CRCERR /* SPI Error flag: CRC error flag */
  301. #define SPI_FLAG_MODF SPI_SR_MODF /* SPI Error flag: Mode fault flag */
  302. #define SPI_FLAG_OVR SPI_SR_OVR /* SPI Error flag: Overrun flag */
  303. #define SPI_FLAG_FRE SPI_SR_FRE /* SPI Error flag: TI mode frame format error flag */
  304. #define SPI_FLAG_FTLVL SPI_SR_FTLVL /* SPI fifo transmission level */
  305. #define SPI_FLAG_FRLVL SPI_SR_FRLVL /* SPI fifo reception level */
  306. /**
  307. * @}
  308. */
  309. /** @defgroup SPI_transmission_fifo_status_level SPI Transmission FIFO Status Level
  310. * @{
  311. */
  312. #define SPI_FTLVL_EMPTY (0x00000000U)
  313. #define SPI_FTLVL_QUARTER_FULL (0x00000800U)
  314. #define SPI_FTLVL_HALF_FULL (0x00001000U)
  315. #define SPI_FTLVL_FULL (0x00001800U)
  316. /**
  317. * @}
  318. */
  319. /** @defgroup SPI_reception_fifo_status_level SPI Reception FIFO Status Level
  320. * @{
  321. */
  322. #define SPI_FRLVL_EMPTY (0x00000000U)
  323. #define SPI_FRLVL_QUARTER_FULL (0x00000200U)
  324. #define SPI_FRLVL_HALF_FULL (0x00000400U)
  325. #define SPI_FRLVL_FULL (0x00000600U)
  326. /**
  327. * @}
  328. */
  329. /**
  330. * @}
  331. */
  332. /* Exported macros -----------------------------------------------------------*/
  333. /** @defgroup SPI_Exported_Macros SPI Exported Macros
  334. * @{
  335. */
  336. /** @brief Reset SPI handle state.
  337. * @param __HANDLE__ specifies the SPI Handle.
  338. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  339. * @retval None
  340. */
  341. #define __HAL_SPI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SPI_STATE_RESET)
  342. /** @brief Enable the specified SPI interrupts.
  343. * @param __HANDLE__ specifies the SPI Handle.
  344. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  345. * @param __INTERRUPT__ specifies the interrupt source to enable.
  346. * This parameter can be one of the following values:
  347. * @arg SPI_IT_TXE: Tx buffer empty interrupt enable
  348. * @arg SPI_IT_RXNE: RX buffer not empty interrupt enable
  349. * @arg SPI_IT_ERR: Error interrupt enable
  350. * @retval None
  351. */
  352. #define __HAL_SPI_ENABLE_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CR2, (__INTERRUPT__))
  353. /** @brief Disable the specified SPI interrupts.
  354. * @param __HANDLE__ specifies the SPI handle.
  355. * This parameter can be SPIx where x: 1, 2, or 3 to select the SPI peripheral.
  356. * @param __INTERRUPT__ specifies the interrupt source to disable.
  357. * This parameter can be one of the following values:
  358. * @arg SPI_IT_TXE: Tx buffer empty interrupt enable
  359. * @arg SPI_IT_RXNE: RX buffer not empty interrupt enable
  360. * @arg SPI_IT_ERR: Error interrupt enable
  361. * @retval None
  362. */
  363. #define __HAL_SPI_DISABLE_IT(__HANDLE__, __INTERRUPT__) CLEAR_BIT((__HANDLE__)->Instance->CR2, (__INTERRUPT__))
  364. /** @brief Check whether the specified SPI interrupt source is enabled or not.
  365. * @param __HANDLE__ specifies the SPI Handle.
  366. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  367. * @param __INTERRUPT__ specifies the SPI interrupt source to check.
  368. * This parameter can be one of the following values:
  369. * @arg SPI_IT_TXE: Tx buffer empty interrupt enable
  370. * @arg SPI_IT_RXNE: RX buffer not empty interrupt enable
  371. * @arg SPI_IT_ERR: Error interrupt enable
  372. * @retval The new state of __IT__ (TRUE or FALSE).
  373. */
  374. #define __HAL_SPI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  375. /** @brief Check whether the specified SPI flag is set or not.
  376. * @param __HANDLE__ specifies the SPI Handle.
  377. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  378. * @param __FLAG__ specifies the flag to check.
  379. * This parameter can be one of the following values:
  380. * @arg SPI_FLAG_RXNE: Receive buffer not empty flag
  381. * @arg SPI_FLAG_TXE: Transmit buffer empty flag
  382. * @arg SPI_FLAG_CRCERR: CRC error flag
  383. * @arg SPI_FLAG_MODF: Mode fault flag
  384. * @arg SPI_FLAG_OVR: Overrun flag
  385. * @arg SPI_FLAG_BSY: Busy flag
  386. * @arg SPI_FLAG_FRE: Frame format error flag
  387. * @arg SPI_FLAG_FTLVL: SPI fifo transmission level
  388. * @arg SPI_FLAG_FRLVL: SPI fifo reception level
  389. * @retval The new state of __FLAG__ (TRUE or FALSE).
  390. */
  391. #define __HAL_SPI_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
  392. /** @brief Clear the SPI CRCERR pending flag.
  393. * @param __HANDLE__ specifies the SPI Handle.
  394. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  395. * @retval None
  396. */
  397. #define __HAL_SPI_CLEAR_CRCERRFLAG(__HANDLE__) ((__HANDLE__)->Instance->SR = (uint16_t)(~SPI_FLAG_CRCERR))
  398. /** @brief Clear the SPI MODF pending flag.
  399. * @param __HANDLE__ specifies the SPI Handle.
  400. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  401. * @retval None
  402. */
  403. #define __HAL_SPI_CLEAR_MODFFLAG(__HANDLE__) \
  404. do{ \
  405. __IO uint32_t tmpreg_modf = 0x00U; \
  406. tmpreg_modf = (__HANDLE__)->Instance->SR; \
  407. CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE); \
  408. UNUSED(tmpreg_modf); \
  409. } while(0U)
  410. /** @brief Clear the SPI OVR pending flag.
  411. * @param __HANDLE__ specifies the SPI Handle.
  412. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  413. * @retval None
  414. */
  415. #define __HAL_SPI_CLEAR_OVRFLAG(__HANDLE__) \
  416. do{ \
  417. __IO uint32_t tmpreg_ovr = 0x00U; \
  418. tmpreg_ovr = (__HANDLE__)->Instance->DR; \
  419. tmpreg_ovr = (__HANDLE__)->Instance->SR; \
  420. UNUSED(tmpreg_ovr); \
  421. } while(0U)
  422. /** @brief Clear the SPI FRE pending flag.
  423. * @param __HANDLE__ specifies the SPI Handle.
  424. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  425. * @retval None
  426. */
  427. #define __HAL_SPI_CLEAR_FREFLAG(__HANDLE__) \
  428. do{ \
  429. __IO uint32_t tmpreg_fre = 0x00U; \
  430. tmpreg_fre = (__HANDLE__)->Instance->SR; \
  431. UNUSED(tmpreg_fre); \
  432. }while(0U)
  433. /** @brief Enable the SPI peripheral.
  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 __HAL_SPI_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE)
  439. /** @brief Disable the SPI peripheral.
  440. * @param __HANDLE__ specifies the SPI Handle.
  441. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  442. * @retval None
  443. */
  444. #define __HAL_SPI_DISABLE(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_SPE)
  445. /**
  446. * @}
  447. */
  448. /* Private macros ------------------------------------------------------------*/
  449. /** @defgroup SPI_Private_Macros SPI Private Macros
  450. * @{
  451. */
  452. /** @brief Set the SPI transmit-only mode.
  453. * @param __HANDLE__ specifies the SPI Handle.
  454. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  455. * @retval None
  456. */
  457. #define SPI_1LINE_TX(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_BIDIOE)
  458. /** @brief Set the SPI receive-only mode.
  459. * @param __HANDLE__ specifies the SPI Handle.
  460. * This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.
  461. * @retval None
  462. */
  463. #define SPI_1LINE_RX(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_BIDIOE)
  464. /** @brief Reset the CRC calculation of the SPI.
  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 SPI_RESET_CRC(__HANDLE__) do{CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_CRCEN);\
  470. SET_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_CRCEN);}while(0U)
  471. #define IS_SPI_MODE(MODE) (((MODE) == SPI_MODE_SLAVE) || \
  472. ((MODE) == SPI_MODE_MASTER))
  473. #define IS_SPI_DIRECTION(MODE) (((MODE) == SPI_DIRECTION_2LINES) || \
  474. ((MODE) == SPI_DIRECTION_2LINES_RXONLY) || \
  475. ((MODE) == SPI_DIRECTION_1LINE))
  476. #define IS_SPI_DIRECTION_2LINES(MODE) ((MODE) == SPI_DIRECTION_2LINES)
  477. #define IS_SPI_DIRECTION_2LINES_OR_1LINE(MODE) (((MODE) == SPI_DIRECTION_2LINES) || \
  478. ((MODE) == SPI_DIRECTION_1LINE))
  479. #define IS_SPI_DATASIZE(DATASIZE) (((DATASIZE) == SPI_DATASIZE_16BIT) || \
  480. ((DATASIZE) == SPI_DATASIZE_15BIT) || \
  481. ((DATASIZE) == SPI_DATASIZE_14BIT) || \
  482. ((DATASIZE) == SPI_DATASIZE_13BIT) || \
  483. ((DATASIZE) == SPI_DATASIZE_12BIT) || \
  484. ((DATASIZE) == SPI_DATASIZE_11BIT) || \
  485. ((DATASIZE) == SPI_DATASIZE_10BIT) || \
  486. ((DATASIZE) == SPI_DATASIZE_9BIT) || \
  487. ((DATASIZE) == SPI_DATASIZE_8BIT) || \
  488. ((DATASIZE) == SPI_DATASIZE_7BIT) || \
  489. ((DATASIZE) == SPI_DATASIZE_6BIT) || \
  490. ((DATASIZE) == SPI_DATASIZE_5BIT) || \
  491. ((DATASIZE) == SPI_DATASIZE_4BIT))
  492. #define IS_SPI_CPOL(CPOL) (((CPOL) == SPI_POLARITY_LOW) || \
  493. ((CPOL) == SPI_POLARITY_HIGH))
  494. #define IS_SPI_CPHA(CPHA) (((CPHA) == SPI_PHASE_1EDGE) || \
  495. ((CPHA) == SPI_PHASE_2EDGE))
  496. #define IS_SPI_NSS(NSS) (((NSS) == SPI_NSS_SOFT) || \
  497. ((NSS) == SPI_NSS_HARD_INPUT) || \
  498. ((NSS) == SPI_NSS_HARD_OUTPUT))
  499. #define IS_SPI_NSSP(NSSP) (((NSSP) == SPI_NSS_PULSE_ENABLE) || \
  500. ((NSSP) == SPI_NSS_PULSE_DISABLE))
  501. #define IS_SPI_BAUDRATE_PRESCALER(PRESCALER) (((PRESCALER) == SPI_BAUDRATEPRESCALER_2) || \
  502. ((PRESCALER) == SPI_BAUDRATEPRESCALER_4) || \
  503. ((PRESCALER) == SPI_BAUDRATEPRESCALER_8) || \
  504. ((PRESCALER) == SPI_BAUDRATEPRESCALER_16) || \
  505. ((PRESCALER) == SPI_BAUDRATEPRESCALER_32) || \
  506. ((PRESCALER) == SPI_BAUDRATEPRESCALER_64) || \
  507. ((PRESCALER) == SPI_BAUDRATEPRESCALER_128) || \
  508. ((PRESCALER) == SPI_BAUDRATEPRESCALER_256))
  509. #define IS_SPI_FIRST_BIT(BIT) (((BIT) == SPI_FIRSTBIT_MSB) || \
  510. ((BIT) == SPI_FIRSTBIT_LSB))
  511. #define IS_SPI_TIMODE(MODE) (((MODE) == SPI_TIMODE_DISABLE) || \
  512. ((MODE) == SPI_TIMODE_ENABLE))
  513. #define IS_SPI_CRC_CALCULATION(CALCULATION) (((CALCULATION) == SPI_CRCCALCULATION_DISABLE) || \
  514. ((CALCULATION) == SPI_CRCCALCULATION_ENABLE))
  515. #define IS_SPI_CRC_LENGTH(LENGTH) (((LENGTH) == SPI_CRC_LENGTH_DATASIZE) ||\
  516. ((LENGTH) == SPI_CRC_LENGTH_8BIT) || \
  517. ((LENGTH) == SPI_CRC_LENGTH_16BIT))
  518. #define IS_SPI_CRC_POLYNOMIAL(POLYNOMIAL) (((POLYNOMIAL) >= 0x1U) && ((POLYNOMIAL) <= 0xFFFFU) && (((POLYNOMIAL)&0x1U) != 0U))
  519. #define IS_SPI_DMA_HANDLE(HANDLE) ((HANDLE) != NULL)
  520. #define IS_SPI_16BIT_ALIGNED_ADDRESS(DATA) (((uint32_t)(DATA) % 2U) == 0U)
  521. /**
  522. * @}
  523. */
  524. /* Include SPI HAL Extended module */
  525. #include "stm32f0xx_hal_spi_ex.h"
  526. /* Exported functions --------------------------------------------------------*/
  527. /** @addtogroup SPI_Exported_Functions
  528. * @{
  529. */
  530. /** @addtogroup SPI_Exported_Functions_Group1
  531. * @{
  532. */
  533. /* Initialization/de-initialization functions ********************************/
  534. HAL_StatusTypeDef HAL_SPI_Init(SPI_HandleTypeDef *hspi);
  535. HAL_StatusTypeDef HAL_SPI_DeInit(SPI_HandleTypeDef *hspi);
  536. void HAL_SPI_MspInit(SPI_HandleTypeDef *hspi);
  537. void HAL_SPI_MspDeInit(SPI_HandleTypeDef *hspi);
  538. /**
  539. * @}
  540. */
  541. /** @addtogroup SPI_Exported_Functions_Group2
  542. * @{
  543. */
  544. /* I/O operation functions ***************************************************/
  545. HAL_StatusTypeDef HAL_SPI_Transmit(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  546. HAL_StatusTypeDef HAL_SPI_Receive(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  547. HAL_StatusTypeDef HAL_SPI_TransmitReceive(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size,
  548. uint32_t Timeout);
  549. HAL_StatusTypeDef HAL_SPI_Transmit_IT(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  550. HAL_StatusTypeDef HAL_SPI_Receive_IT(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  551. HAL_StatusTypeDef HAL_SPI_TransmitReceive_IT(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData,
  552. uint16_t Size);
  553. HAL_StatusTypeDef HAL_SPI_Transmit_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  554. HAL_StatusTypeDef HAL_SPI_Receive_DMA(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
  555. HAL_StatusTypeDef HAL_SPI_TransmitReceive_DMA(SPI_HandleTypeDef *hspi, uint8_t *pTxData, uint8_t *pRxData,
  556. uint16_t Size);
  557. HAL_StatusTypeDef HAL_SPI_DMAPause(SPI_HandleTypeDef *hspi);
  558. HAL_StatusTypeDef HAL_SPI_DMAResume(SPI_HandleTypeDef *hspi);
  559. HAL_StatusTypeDef HAL_SPI_DMAStop(SPI_HandleTypeDef *hspi);
  560. /* Transfer Abort functions */
  561. HAL_StatusTypeDef HAL_SPI_Abort(SPI_HandleTypeDef *hspi);
  562. HAL_StatusTypeDef HAL_SPI_Abort_IT(SPI_HandleTypeDef *hspi);
  563. void HAL_SPI_IRQHandler(SPI_HandleTypeDef *hspi);
  564. void HAL_SPI_TxCpltCallback(SPI_HandleTypeDef *hspi);
  565. void HAL_SPI_RxCpltCallback(SPI_HandleTypeDef *hspi);
  566. void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi);
  567. void HAL_SPI_TxHalfCpltCallback(SPI_HandleTypeDef *hspi);
  568. void HAL_SPI_RxHalfCpltCallback(SPI_HandleTypeDef *hspi);
  569. void HAL_SPI_TxRxHalfCpltCallback(SPI_HandleTypeDef *hspi);
  570. void HAL_SPI_ErrorCallback(SPI_HandleTypeDef *hspi);
  571. void HAL_SPI_AbortCpltCallback(SPI_HandleTypeDef *hspi);
  572. /**
  573. * @}
  574. */
  575. /** @addtogroup SPI_Exported_Functions_Group3
  576. * @{
  577. */
  578. /* Peripheral State and Error functions ***************************************/
  579. HAL_SPI_StateTypeDef HAL_SPI_GetState(SPI_HandleTypeDef *hspi);
  580. uint32_t HAL_SPI_GetError(SPI_HandleTypeDef *hspi);
  581. /**
  582. * @}
  583. */
  584. /**
  585. * @}
  586. */
  587. /**
  588. * @}
  589. */
  590. /**
  591. * @}
  592. */
  593. #ifdef __cplusplus
  594. }
  595. #endif
  596. #endif /* __STM32F0xx_HAL_SPI_H */
  597. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/