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