stm32f10x_spi.h 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491
  1. /**
  2. ******************************************************************************
  3. * @file stm32f10x_spi.h
  4. * @author MCD Application Team
  5. * @version V3.3.0
  6. * @date 04/16/2010
  7. * @brief This file contains all the functions prototypes for the SPI firmware
  8. * library.
  9. ******************************************************************************
  10. * @copy
  11. *
  12. * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
  13. * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
  14. * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
  15. * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
  16. * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
  17. * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
  18. *
  19. * <h2><center>&copy; COPYRIGHT 2010 STMicroelectronics</center></h2>
  20. */
  21. /* Define to prevent recursive inclusion -------------------------------------*/
  22. #ifndef __STM32F10x_SPI_H
  23. #define __STM32F10x_SPI_H
  24. #ifdef __cplusplus
  25. extern "C" {
  26. #endif
  27. /* Includes ------------------------------------------------------------------*/
  28. #include "stm32f10x.h"
  29. /** @addtogroup STM32F10x_StdPeriph_Driver
  30. * @{
  31. */
  32. /** @addtogroup SPI
  33. * @{
  34. */
  35. /** @defgroup SPI_Exported_Types
  36. * @{
  37. */
  38. /**
  39. * @brief SPI Init structure definition
  40. */
  41. typedef struct
  42. {
  43. uint16_t SPI_Direction; /*!< Specifies the SPI unidirectional or bidirectional data mode.
  44. This parameter can be a value of @ref SPI_data_direction */
  45. uint16_t SPI_Mode; /*!< Specifies the SPI operating mode.
  46. This parameter can be a value of @ref SPI_mode */
  47. uint16_t SPI_DataSize; /*!< Specifies the SPI data size.
  48. This parameter can be a value of @ref SPI_data_size */
  49. uint16_t SPI_CPOL; /*!< Specifies the serial clock steady state.
  50. This parameter can be a value of @ref SPI_Clock_Polarity */
  51. uint16_t SPI_CPHA; /*!< Specifies the clock active edge for the bit capture.
  52. This parameter can be a value of @ref SPI_Clock_Phase */
  53. uint16_t SPI_NSS; /*!< Specifies whether the NSS signal is managed by
  54. hardware (NSS pin) or by software using the SSI bit.
  55. This parameter can be a value of @ref SPI_Slave_Select_management */
  56. uint16_t SPI_BaudRatePrescaler; /*!< Specifies the Baud Rate prescaler value which will be
  57. used to configure the transmit and receive SCK clock.
  58. This parameter can be a value of @ref SPI_BaudRate_Prescaler.
  59. @note The communication clock is derived from the master
  60. clock. The slave clock does not need to be set. */
  61. uint16_t SPI_FirstBit; /*!< Specifies whether data transfers start from MSB or LSB bit.
  62. This parameter can be a value of @ref SPI_MSB_LSB_transmission */
  63. uint16_t SPI_CRCPolynomial; /*!< Specifies the polynomial used for the CRC calculation. */
  64. }SPI_InitTypeDef;
  65. /**
  66. * @brief I2S Init structure definition
  67. */
  68. typedef struct
  69. {
  70. uint16_t I2S_Mode; /*!< Specifies the I2S operating mode.
  71. This parameter can be a value of @ref I2S_Mode */
  72. uint16_t I2S_Standard; /*!< Specifies the standard used for the I2S communication.
  73. This parameter can be a value of @ref I2S_Standard */
  74. uint16_t I2S_DataFormat; /*!< Specifies the data format for the I2S communication.
  75. This parameter can be a value of @ref I2S_Data_Format */
  76. uint16_t I2S_MCLKOutput; /*!< Specifies whether the I2S MCLK output is enabled or not.
  77. This parameter can be a value of @ref I2S_MCLK_Output */
  78. uint32_t I2S_AudioFreq; /*!< Specifies the frequency selected for the I2S communication.
  79. This parameter can be a value of @ref I2S_Audio_Frequency */
  80. uint16_t I2S_CPOL; /*!< Specifies the idle state of the I2S clock.
  81. This parameter can be a value of @ref I2S_Clock_Polarity */
  82. }I2S_InitTypeDef;
  83. /**
  84. * @}
  85. */
  86. /** @defgroup SPI_Exported_Constants
  87. * @{
  88. */
  89. #define IS_SPI_ALL_PERIPH(PERIPH) (((PERIPH) == SPI1) || \
  90. ((PERIPH) == SPI2) || \
  91. ((PERIPH) == SPI3))
  92. #define IS_SPI_23_PERIPH(PERIPH) (((PERIPH) == SPI2) || \
  93. ((PERIPH) == SPI3))
  94. /** @defgroup SPI_data_direction
  95. * @{
  96. */
  97. #define SPI_Direction_2Lines_FullDuplex ((uint16_t)0x0000)
  98. #define SPI_Direction_2Lines_RxOnly ((uint16_t)0x0400)
  99. #define SPI_Direction_1Line_Rx ((uint16_t)0x8000)
  100. #define SPI_Direction_1Line_Tx ((uint16_t)0xC000)
  101. #define IS_SPI_DIRECTION_MODE(MODE) (((MODE) == SPI_Direction_2Lines_FullDuplex) || \
  102. ((MODE) == SPI_Direction_2Lines_RxOnly) || \
  103. ((MODE) == SPI_Direction_1Line_Rx) || \
  104. ((MODE) == SPI_Direction_1Line_Tx))
  105. /**
  106. * @}
  107. */
  108. /** @defgroup SPI_mode
  109. * @{
  110. */
  111. #define SPI_Mode_Master ((uint16_t)0x0104)
  112. #define SPI_Mode_Slave ((uint16_t)0x0000)
  113. #define IS_SPI_MODE(MODE) (((MODE) == SPI_Mode_Master) || \
  114. ((MODE) == SPI_Mode_Slave))
  115. /**
  116. * @}
  117. */
  118. /** @defgroup SPI_data_size
  119. * @{
  120. */
  121. #define SPI_DataSize_16b ((uint16_t)0x0800)
  122. #define SPI_DataSize_8b ((uint16_t)0x0000)
  123. #define IS_SPI_DATASIZE(DATASIZE) (((DATASIZE) == SPI_DataSize_16b) || \
  124. ((DATASIZE) == SPI_DataSize_8b))
  125. /**
  126. * @}
  127. */
  128. /** @defgroup SPI_Clock_Polarity
  129. * @{
  130. */
  131. #define SPI_CPOL_Low ((uint16_t)0x0000)
  132. #define SPI_CPOL_High ((uint16_t)0x0002)
  133. #define IS_SPI_CPOL(CPOL) (((CPOL) == SPI_CPOL_Low) || \
  134. ((CPOL) == SPI_CPOL_High))
  135. /**
  136. * @}
  137. */
  138. /** @defgroup SPI_Clock_Phase
  139. * @{
  140. */
  141. #define SPI_CPHA_1Edge ((uint16_t)0x0000)
  142. #define SPI_CPHA_2Edge ((uint16_t)0x0001)
  143. #define IS_SPI_CPHA(CPHA) (((CPHA) == SPI_CPHA_1Edge) || \
  144. ((CPHA) == SPI_CPHA_2Edge))
  145. /**
  146. * @}
  147. */
  148. /** @defgroup SPI_Slave_Select_management
  149. * @{
  150. */
  151. #define SPI_NSS_Soft ((uint16_t)0x0200)
  152. #define SPI_NSS_Hard ((uint16_t)0x0000)
  153. #define IS_SPI_NSS(NSS) (((NSS) == SPI_NSS_Soft) || \
  154. ((NSS) == SPI_NSS_Hard))
  155. /**
  156. * @}
  157. */
  158. /** @defgroup SPI_BaudRate_Prescaler
  159. * @{
  160. */
  161. #define SPI_BaudRatePrescaler_2 ((uint16_t)0x0000)
  162. #define SPI_BaudRatePrescaler_4 ((uint16_t)0x0008)
  163. #define SPI_BaudRatePrescaler_8 ((uint16_t)0x0010)
  164. #define SPI_BaudRatePrescaler_16 ((uint16_t)0x0018)
  165. #define SPI_BaudRatePrescaler_32 ((uint16_t)0x0020)
  166. #define SPI_BaudRatePrescaler_64 ((uint16_t)0x0028)
  167. #define SPI_BaudRatePrescaler_128 ((uint16_t)0x0030)
  168. #define SPI_BaudRatePrescaler_256 ((uint16_t)0x0038)
  169. #define IS_SPI_BAUDRATE_PRESCALER(PRESCALER) (((PRESCALER) == SPI_BaudRatePrescaler_2) || \
  170. ((PRESCALER) == SPI_BaudRatePrescaler_4) || \
  171. ((PRESCALER) == SPI_BaudRatePrescaler_8) || \
  172. ((PRESCALER) == SPI_BaudRatePrescaler_16) || \
  173. ((PRESCALER) == SPI_BaudRatePrescaler_32) || \
  174. ((PRESCALER) == SPI_BaudRatePrescaler_64) || \
  175. ((PRESCALER) == SPI_BaudRatePrescaler_128) || \
  176. ((PRESCALER) == SPI_BaudRatePrescaler_256))
  177. /**
  178. * @}
  179. */
  180. /** @defgroup SPI_MSB_LSB_transmission
  181. * @{
  182. */
  183. #define SPI_FirstBit_MSB ((uint16_t)0x0000)
  184. #define SPI_FirstBit_LSB ((uint16_t)0x0080)
  185. #define IS_SPI_FIRST_BIT(BIT) (((BIT) == SPI_FirstBit_MSB) || \
  186. ((BIT) == SPI_FirstBit_LSB))
  187. /**
  188. * @}
  189. */
  190. /** @defgroup I2S_Mode
  191. * @{
  192. */
  193. #define I2S_Mode_SlaveTx ((uint16_t)0x0000)
  194. #define I2S_Mode_SlaveRx ((uint16_t)0x0100)
  195. #define I2S_Mode_MasterTx ((uint16_t)0x0200)
  196. #define I2S_Mode_MasterRx ((uint16_t)0x0300)
  197. #define IS_I2S_MODE(MODE) (((MODE) == I2S_Mode_SlaveTx) || \
  198. ((MODE) == I2S_Mode_SlaveRx) || \
  199. ((MODE) == I2S_Mode_MasterTx) || \
  200. ((MODE) == I2S_Mode_MasterRx) )
  201. /**
  202. * @}
  203. */
  204. /** @defgroup I2S_Standard
  205. * @{
  206. */
  207. #define I2S_Standard_Phillips ((uint16_t)0x0000)
  208. #define I2S_Standard_MSB ((uint16_t)0x0010)
  209. #define I2S_Standard_LSB ((uint16_t)0x0020)
  210. #define I2S_Standard_PCMShort ((uint16_t)0x0030)
  211. #define I2S_Standard_PCMLong ((uint16_t)0x00B0)
  212. #define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_Standard_Phillips) || \
  213. ((STANDARD) == I2S_Standard_MSB) || \
  214. ((STANDARD) == I2S_Standard_LSB) || \
  215. ((STANDARD) == I2S_Standard_PCMShort) || \
  216. ((STANDARD) == I2S_Standard_PCMLong))
  217. /**
  218. * @}
  219. */
  220. /** @defgroup I2S_Data_Format
  221. * @{
  222. */
  223. #define I2S_DataFormat_16b ((uint16_t)0x0000)
  224. #define I2S_DataFormat_16bextended ((uint16_t)0x0001)
  225. #define I2S_DataFormat_24b ((uint16_t)0x0003)
  226. #define I2S_DataFormat_32b ((uint16_t)0x0005)
  227. #define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DataFormat_16b) || \
  228. ((FORMAT) == I2S_DataFormat_16bextended) || \
  229. ((FORMAT) == I2S_DataFormat_24b) || \
  230. ((FORMAT) == I2S_DataFormat_32b))
  231. /**
  232. * @}
  233. */
  234. /** @defgroup I2S_MCLK_Output
  235. * @{
  236. */
  237. #define I2S_MCLKOutput_Enable ((uint16_t)0x0200)
  238. #define I2S_MCLKOutput_Disable ((uint16_t)0x0000)
  239. #define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOutput_Enable) || \
  240. ((OUTPUT) == I2S_MCLKOutput_Disable))
  241. /**
  242. * @}
  243. */
  244. /** @defgroup I2S_Audio_Frequency
  245. * @{
  246. */
  247. #define I2S_AudioFreq_96k ((uint32_t)96000)
  248. #define I2S_AudioFreq_48k ((uint32_t)48000)
  249. #define I2S_AudioFreq_44k ((uint32_t)44100)
  250. #define I2S_AudioFreq_32k ((uint32_t)32000)
  251. #define I2S_AudioFreq_22k ((uint32_t)22050)
  252. #define I2S_AudioFreq_16k ((uint32_t)16000)
  253. #define I2S_AudioFreq_11k ((uint32_t)11025)
  254. #define I2S_AudioFreq_8k ((uint32_t)8000)
  255. #define I2S_AudioFreq_Default ((uint32_t)2)
  256. #define IS_I2S_AUDIO_FREQ(FREQ) (((FREQ) == I2S_AudioFreq_96k) || \
  257. ((FREQ) == I2S_AudioFreq_48k) || \
  258. ((FREQ) == I2S_AudioFreq_44k) || \
  259. ((FREQ) == I2S_AudioFreq_32k) || \
  260. ((FREQ) == I2S_AudioFreq_22k) || \
  261. ((FREQ) == I2S_AudioFreq_16k) || \
  262. ((FREQ) == I2S_AudioFreq_11k) || \
  263. ((FREQ) == I2S_AudioFreq_8k) || \
  264. ((FREQ) == I2S_AudioFreq_Default))
  265. /**
  266. * @}
  267. */
  268. /** @defgroup I2S_Clock_Polarity
  269. * @{
  270. */
  271. #define I2S_CPOL_Low ((uint16_t)0x0000)
  272. #define I2S_CPOL_High ((uint16_t)0x0008)
  273. #define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_Low) || \
  274. ((CPOL) == I2S_CPOL_High))
  275. /**
  276. * @}
  277. */
  278. /** @defgroup SPI_I2S_DMA_transfer_requests
  279. * @{
  280. */
  281. #define SPI_I2S_DMAReq_Tx ((uint16_t)0x0002)
  282. #define SPI_I2S_DMAReq_Rx ((uint16_t)0x0001)
  283. #define IS_SPI_I2S_DMAREQ(DMAREQ) ((((DMAREQ) & (uint16_t)0xFFFC) == 0x00) && ((DMAREQ) != 0x00))
  284. /**
  285. * @}
  286. */
  287. /** @defgroup SPI_NSS_internal_software_mangement
  288. * @{
  289. */
  290. #define SPI_NSSInternalSoft_Set ((uint16_t)0x0100)
  291. #define SPI_NSSInternalSoft_Reset ((uint16_t)0xFEFF)
  292. #define IS_SPI_NSS_INTERNAL(INTERNAL) (((INTERNAL) == SPI_NSSInternalSoft_Set) || \
  293. ((INTERNAL) == SPI_NSSInternalSoft_Reset))
  294. /**
  295. * @}
  296. */
  297. /** @defgroup SPI_CRC_Transmit_Receive
  298. * @{
  299. */
  300. #define SPI_CRC_Tx ((uint8_t)0x00)
  301. #define SPI_CRC_Rx ((uint8_t)0x01)
  302. #define IS_SPI_CRC(CRC) (((CRC) == SPI_CRC_Tx) || ((CRC) == SPI_CRC_Rx))
  303. /**
  304. * @}
  305. */
  306. /** @defgroup SPI_direction_transmit_receive
  307. * @{
  308. */
  309. #define SPI_Direction_Rx ((uint16_t)0xBFFF)
  310. #define SPI_Direction_Tx ((uint16_t)0x4000)
  311. #define IS_SPI_DIRECTION(DIRECTION) (((DIRECTION) == SPI_Direction_Rx) || \
  312. ((DIRECTION) == SPI_Direction_Tx))
  313. /**
  314. * @}
  315. */
  316. /** @defgroup SPI_I2S_interrupts_definition
  317. * @{
  318. */
  319. #define SPI_I2S_IT_TXE ((uint8_t)0x71)
  320. #define SPI_I2S_IT_RXNE ((uint8_t)0x60)
  321. #define SPI_I2S_IT_ERR ((uint8_t)0x50)
  322. #define IS_SPI_I2S_CONFIG_IT(IT) (((IT) == SPI_I2S_IT_TXE) || \
  323. ((IT) == SPI_I2S_IT_RXNE) || \
  324. ((IT) == SPI_I2S_IT_ERR))
  325. #define SPI_I2S_IT_OVR ((uint8_t)0x56)
  326. #define SPI_IT_MODF ((uint8_t)0x55)
  327. #define SPI_IT_CRCERR ((uint8_t)0x54)
  328. #define I2S_IT_UDR ((uint8_t)0x53)
  329. #define IS_SPI_I2S_CLEAR_IT(IT) (((IT) == SPI_IT_CRCERR))
  330. #define IS_SPI_I2S_GET_IT(IT) (((IT) == SPI_I2S_IT_RXNE) || ((IT) == SPI_I2S_IT_TXE) || \
  331. ((IT) == I2S_IT_UDR) || ((IT) == SPI_IT_CRCERR) || \
  332. ((IT) == SPI_IT_MODF) || ((IT) == SPI_I2S_IT_OVR))
  333. /**
  334. * @}
  335. */
  336. /** @defgroup SPI_I2S_flags_definition
  337. * @{
  338. */
  339. #define SPI_I2S_FLAG_RXNE ((uint16_t)0x0001)
  340. #define SPI_I2S_FLAG_TXE ((uint16_t)0x0002)
  341. #define I2S_FLAG_CHSIDE ((uint16_t)0x0004)
  342. #define I2S_FLAG_UDR ((uint16_t)0x0008)
  343. #define SPI_FLAG_CRCERR ((uint16_t)0x0010)
  344. #define SPI_FLAG_MODF ((uint16_t)0x0020)
  345. #define SPI_I2S_FLAG_OVR ((uint16_t)0x0040)
  346. #define SPI_I2S_FLAG_BSY ((uint16_t)0x0080)
  347. #define IS_SPI_I2S_CLEAR_FLAG(FLAG) (((FLAG) == SPI_FLAG_CRCERR))
  348. #define IS_SPI_I2S_GET_FLAG(FLAG) (((FLAG) == SPI_I2S_FLAG_BSY) || ((FLAG) == SPI_I2S_FLAG_OVR) || \
  349. ((FLAG) == SPI_FLAG_MODF) || ((FLAG) == SPI_FLAG_CRCERR) || \
  350. ((FLAG) == I2S_FLAG_UDR) || ((FLAG) == I2S_FLAG_CHSIDE) || \
  351. ((FLAG) == SPI_I2S_FLAG_TXE) || ((FLAG) == SPI_I2S_FLAG_RXNE))
  352. /**
  353. * @}
  354. */
  355. /** @defgroup SPI_CRC_polynomial
  356. * @{
  357. */
  358. #define IS_SPI_CRC_POLYNOMIAL(POLYNOMIAL) ((POLYNOMIAL) >= 0x1)
  359. /**
  360. * @}
  361. */
  362. /**
  363. * @}
  364. */
  365. /** @defgroup SPI_Exported_Macros
  366. * @{
  367. */
  368. /**
  369. * @}
  370. */
  371. /** @defgroup SPI_Exported_Functions
  372. * @{
  373. */
  374. void SPI_I2S_DeInit(SPI_TypeDef* SPIx);
  375. void SPI_Init(SPI_TypeDef* SPIx, SPI_InitTypeDef* SPI_InitStruct);
  376. void I2S_Init(SPI_TypeDef* SPIx, I2S_InitTypeDef* I2S_InitStruct);
  377. void SPI_StructInit(SPI_InitTypeDef* SPI_InitStruct);
  378. void I2S_StructInit(I2S_InitTypeDef* I2S_InitStruct);
  379. void SPI_Cmd(SPI_TypeDef* SPIx, FunctionalState NewState);
  380. void I2S_Cmd(SPI_TypeDef* SPIx, FunctionalState NewState);
  381. void SPI_I2S_ITConfig(SPI_TypeDef* SPIx, uint8_t SPI_I2S_IT, FunctionalState NewState);
  382. void SPI_I2S_DMACmd(SPI_TypeDef* SPIx, uint16_t SPI_I2S_DMAReq, FunctionalState NewState);
  383. void SPI_I2S_SendData(SPI_TypeDef* SPIx, uint16_t Data);
  384. uint16_t SPI_I2S_ReceiveData(SPI_TypeDef* SPIx);
  385. void SPI_NSSInternalSoftwareConfig(SPI_TypeDef* SPIx, uint16_t SPI_NSSInternalSoft);
  386. void SPI_SSOutputCmd(SPI_TypeDef* SPIx, FunctionalState NewState);
  387. void SPI_DataSizeConfig(SPI_TypeDef* SPIx, uint16_t SPI_DataSize);
  388. void SPI_TransmitCRC(SPI_TypeDef* SPIx);
  389. void SPI_CalculateCRC(SPI_TypeDef* SPIx, FunctionalState NewState);
  390. uint16_t SPI_GetCRC(SPI_TypeDef* SPIx, uint8_t SPI_CRC);
  391. uint16_t SPI_GetCRCPolynomial(SPI_TypeDef* SPIx);
  392. void SPI_BiDirectionalLineConfig(SPI_TypeDef* SPIx, uint16_t SPI_Direction);
  393. FlagStatus SPI_I2S_GetFlagStatus(SPI_TypeDef* SPIx, uint16_t SPI_I2S_FLAG);
  394. void SPI_I2S_ClearFlag(SPI_TypeDef* SPIx, uint16_t SPI_I2S_FLAG);
  395. ITStatus SPI_I2S_GetITStatus(SPI_TypeDef* SPIx, uint8_t SPI_I2S_IT);
  396. void SPI_I2S_ClearITPendingBit(SPI_TypeDef* SPIx, uint8_t SPI_I2S_IT);
  397. #ifdef __cplusplus
  398. }
  399. #endif
  400. #endif /*__STM32F10x_SPI_H */
  401. /**
  402. * @}
  403. */
  404. /**
  405. * @}
  406. */
  407. /**
  408. * @}
  409. */
  410. /******************* (C) COPYRIGHT 2010 STMicroelectronics *****END OF FILE****/