Nut/OS  5.0.5
API Reference
stm32f10x_spi.h
Go to the documentation of this file.
00001 
00022 /* Define to prevent recursive inclusion -------------------------------------*/
00023 #ifndef __STM32F10x_SPI_H
00024 #define __STM32F10x_SPI_H
00025 
00026 /* Includes ------------------------------------------------------------------*/
00027 #include "stm32f10x.h"
00028 #include <dev/spibus.h>
00029 
00030 #define SPI1_BASE            (STM32_APB2PERIPH_BASE + 0x3000)
00031 #define SPI2_BASE            (STM32_APB1PERIPH_BASE + 0x3800)
00032 #define SPI3_BASE            (STM32_APB1PERIPH_BASE + 0x3C00)
00033 
00034 #define SPI1                ((SPI_TypeDef *) SPI1_BASE)
00035 #define SPI2                ((SPI_TypeDef *) SPI2_BASE)
00036 #define SPI3                ((SPI_TypeDef *) SPI3_BASE)
00037 
00038 typedef struct
00039 {
00040   __IO uint16_t CR1;
00041   uint16_t  RESERVED0;
00042   __IO uint16_t CR2;
00043   uint16_t  RESERVED1;
00044   __IO uint16_t SR;
00045   uint16_t  RESERVED2;
00046   __IO uint16_t DR;
00047   uint16_t  RESERVED3;
00048   __IO uint16_t CRCPR;
00049   uint16_t  RESERVED4;
00050   __IO uint16_t RXCRCR;
00051   uint16_t  RESERVED5;
00052   __IO uint16_t TXCRCR;
00053   uint16_t  RESERVED6;
00054   __IO uint16_t I2SCFGR;
00055   uint16_t  RESERVED7;
00056   __IO uint16_t I2SPR;
00057   uint16_t  RESERVED8;
00058 } SPI_TypeDef;
00059 
00060 
00065 #define SPI_Direction_2Lines_FullDuplex ((uint16_t)0x0000)
00066 #define SPI_Direction_2Lines_RxOnly     ((uint16_t)0x0400)
00067 #define SPI_Direction_1Line_Rx          ((uint16_t)0x8000)
00068 #define SPI_Direction_1Line_Tx          ((uint16_t)0xC000)
00069 #define IS_SPI_DIRECTION_MODE(MODE) (((MODE) == SPI_Direction_2Lines_FullDuplex) || \
00070                                      ((MODE) == SPI_Direction_2Lines_RxOnly) || \
00071                                      ((MODE) == SPI_Direction_1Line_Rx) || \
00072                                      ((MODE) == SPI_Direction_1Line_Tx))
00073 
00081 #define SPI_Enable          ((uint16_t)0x0040)
00082 
00083 #define SPI_Mode_Master                 ((uint16_t)0x0104)
00084 #define SPI_Mode_Slave                  ((uint16_t)0x0000)
00085 #define IS_SPI_MODE(MODE) (((MODE) == SPI_Mode_Master) || \
00086                            ((MODE) == SPI_Mode_Slave))
00087 
00088 #define SPI_DataSize_16b                ((uint16_t)0x0800)
00089 #define SPI_DataSize_8b                 ((uint16_t)0x0000)
00090 #define IS_SPI_DATASIZE(DATASIZE) (((DATASIZE) == SPI_DataSize_16b) || \
00091                                    ((DATASIZE) == SPI_DataSize_8b))
00092 
00093 #define SPI_CPOL_Low                    ((uint16_t)0x0000)
00094 #define SPI_CPOL_High                   ((uint16_t)0x0002)
00095 #define IS_SPI_CPOL(CPOL) (((CPOL) == SPI_CPOL_Low) || \
00096                            ((CPOL) == SPI_CPOL_High))
00097 
00098 #define SPI_CPHA_1Edge                  ((uint16_t)0x0000)
00099 #define SPI_CPHA_2Edge                  ((uint16_t)0x0001)
00100 #define IS_SPI_CPHA(CPHA) (((CPHA) == SPI_CPHA_1Edge) || \
00101                            ((CPHA) == SPI_CPHA_2Edge))
00102 
00103 #define SPI_NSS_Soft                    ((uint16_t)0x0200)
00104 #define SPI_NSS_Hard                    ((uint16_t)0x0000)
00105 #define IS_SPI_NSS(NSS) (((NSS) == SPI_NSS_Soft) || \
00106                          ((NSS) == SPI_NSS_Hard))
00107 
00108 #define SPI_BaudRatePrescaler_2         ((uint16_t)0x0000)
00109 #define SPI_BaudRatePrescaler_4         ((uint16_t)0x0008)
00110 #define SPI_BaudRatePrescaler_8         ((uint16_t)0x0010)
00111 #define SPI_BaudRatePrescaler_16        ((uint16_t)0x0018)
00112 #define SPI_BaudRatePrescaler_32        ((uint16_t)0x0020)
00113 #define SPI_BaudRatePrescaler_64        ((uint16_t)0x0028)
00114 #define SPI_BaudRatePrescaler_128       ((uint16_t)0x0030)
00115 #define SPI_BaudRatePrescaler_256       ((uint16_t)0x0038)
00116 #define IS_SPI_BAUDRATE_PRESCALER(PRESCALER) (((PRESCALER) == SPI_BaudRatePrescaler_2) || \
00117                                               ((PRESCALER) == SPI_BaudRatePrescaler_4) || \
00118                                               ((PRESCALER) == SPI_BaudRatePrescaler_8) || \
00119                                               ((PRESCALER) == SPI_BaudRatePrescaler_16) || \
00120                                               ((PRESCALER) == SPI_BaudRatePrescaler_32) || \
00121                                               ((PRESCALER) == SPI_BaudRatePrescaler_64) || \
00122                                               ((PRESCALER) == SPI_BaudRatePrescaler_128) || \
00123                                               ((PRESCALER) == SPI_BaudRatePrescaler_256))
00124 
00125 #define SPI_FirstBit_MSB                ((uint16_t)0x0000)
00126 #define SPI_FirstBit_LSB                ((uint16_t)0x0080)
00127 #define IS_SPI_FIRST_BIT(BIT) (((BIT) == SPI_FirstBit_MSB) || \
00128                                ((BIT) == SPI_FirstBit_LSB))
00129 
00130 #define I2S_Mode_SlaveTx                ((uint16_t)0x0000)
00131 #define I2S_Mode_SlaveRx                ((uint16_t)0x0100)
00132 #define I2S_Mode_MasterTx               ((uint16_t)0x0200)
00133 #define I2S_Mode_MasterRx               ((uint16_t)0x0300)
00134 #define IS_I2S_MODE(MODE) (((MODE) == I2S_Mode_SlaveTx) || \
00135                            ((MODE) == I2S_Mode_SlaveRx) || \
00136                            ((MODE) == I2S_Mode_MasterTx) || \
00137                            ((MODE) == I2S_Mode_MasterRx) )
00138 
00146 #define I2S_Standard_Phillips           ((uint16_t)0x0000)
00147 #define I2S_Standard_MSB                ((uint16_t)0x0010)
00148 #define I2S_Standard_LSB                ((uint16_t)0x0020)
00149 #define I2S_Standard_PCMShort           ((uint16_t)0x0030)
00150 #define I2S_Standard_PCMLong            ((uint16_t)0x00B0)
00151 #define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_Standard_Phillips) || \
00152                                    ((STANDARD) == I2S_Standard_MSB) || \
00153                                    ((STANDARD) == I2S_Standard_LSB) || \
00154                                    ((STANDARD) == I2S_Standard_PCMShort) || \
00155                                    ((STANDARD) == I2S_Standard_PCMLong))
00156 
00164 #define I2S_DataFormat_16b              ((uint16_t)0x0000)
00165 #define I2S_DataFormat_16bextended      ((uint16_t)0x0001)
00166 #define I2S_DataFormat_24b              ((uint16_t)0x0003)
00167 #define I2S_DataFormat_32b              ((uint16_t)0x0005)
00168 #define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DataFormat_16b) || \
00169                                     ((FORMAT) == I2S_DataFormat_16bextended) || \
00170                                     ((FORMAT) == I2S_DataFormat_24b) || \
00171                                     ((FORMAT) == I2S_DataFormat_32b))
00172 
00180 #define I2S_MCLKOutput_Enable           ((uint16_t)0x0200)
00181 #define I2S_MCLKOutput_Disable          ((uint16_t)0x0000)
00182 #define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOutput_Enable) || \
00183                                     ((OUTPUT) == I2S_MCLKOutput_Disable))
00184 
00192 #define I2S_AudioFreq_96k                ((uint32_t)96000)
00193 #define I2S_AudioFreq_48k                ((uint32_t)48000)
00194 #define I2S_AudioFreq_44k                ((uint32_t)44100)
00195 #define I2S_AudioFreq_32k                ((uint32_t)32000)
00196 #define I2S_AudioFreq_22k                ((uint32_t)22050)
00197 #define I2S_AudioFreq_16k                ((uint32_t)16000)
00198 #define I2S_AudioFreq_11k                ((uint32_t)11025)
00199 #define I2S_AudioFreq_8k                 ((uint32_t)8000)
00200 #define I2S_AudioFreq_Default            ((uint32_t)2)
00201 #define IS_I2S_AUDIO_FREQ(FREQ) (((FREQ) == I2S_AudioFreq_96k) || \
00202                                  ((FREQ) == I2S_AudioFreq_48k) || \
00203                                  ((FREQ) == I2S_AudioFreq_44k) || \
00204                                  ((FREQ) == I2S_AudioFreq_32k) || \
00205                                  ((FREQ) == I2S_AudioFreq_22k) || \
00206                                  ((FREQ) == I2S_AudioFreq_16k) || \
00207                                  ((FREQ) == I2S_AudioFreq_11k) || \
00208                                  ((FREQ) == I2S_AudioFreq_8k)  || \
00209                                  ((FREQ) == I2S_AudioFreq_Default))
00210 
00218 #define I2S_CPOL_Low                    ((uint16_t)0x0000)
00219 #define I2S_CPOL_High                   ((uint16_t)0x0008)
00220 #define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_Low) || \
00221                            ((CPOL) == I2S_CPOL_High))
00222 
00230 #define SPI_I2S_DMAReq_Tx               ((uint16_t)0x0002)
00231 #define SPI_I2S_DMAReq_Rx               ((uint16_t)0x0001)
00232 #define IS_SPI_I2S_DMAREQ(DMAREQ) ((((DMAREQ) & (uint16_t)0xFFFC) == 0x00) && ((DMAREQ) != 0x00))
00233 
00241 #define SPI_NSSInternalSoft_Set         ((uint16_t)0x0100)
00242 #define SPI_NSSInternalSoft_Reset       ((uint16_t)0xFEFF)
00243 #define IS_SPI_NSS_INTERNAL(INTERNAL) (((INTERNAL) == SPI_NSSInternalSoft_Set) || \
00244                                        ((INTERNAL) == SPI_NSSInternalSoft_Reset))
00245 
00253 #define SPI_CRC_Tx                      ((uint8_t)0x00)
00254 #define SPI_CRC_Rx                      ((uint8_t)0x01)
00255 #define IS_SPI_CRC(CRC) (((CRC) == SPI_CRC_Tx) || ((CRC) == SPI_CRC_Rx))
00256 
00264 #define SPI_Direction_Rx                ((uint16_t)0xBFFF)
00265 #define SPI_Direction_Tx                ((uint16_t)0x4000)
00266 #define IS_SPI_DIRECTION(DIRECTION) (((DIRECTION) == SPI_Direction_Rx) || \
00267                                      ((DIRECTION) == SPI_Direction_Tx))
00268 
00276 #define SPI_I2S_IT_TXE                  ((uint8_t)0x71)
00277 #define SPI_I2S_IT_RXNE                 ((uint8_t)0x60)
00278 #define SPI_I2S_IT_ERR                  ((uint8_t)0x50)
00279 #define IS_SPI_I2S_CONFIG_IT(IT) (((IT) == SPI_I2S_IT_TXE) || \
00280                                  ((IT) == SPI_I2S_IT_RXNE) || \
00281                                  ((IT) == SPI_I2S_IT_ERR))
00282 #define SPI_I2S_IT_OVR                  ((uint8_t)0x56)
00283 #define SPI_IT_MODF                     ((uint8_t)0x55)
00284 #define SPI_IT_CRCERR                   ((uint8_t)0x54)
00285 #define I2S_IT_UDR                      ((uint8_t)0x53)
00286 #define IS_SPI_I2S_CLEAR_IT(IT) (((IT) == SPI_IT_CRCERR))
00287 #define IS_SPI_I2S_GET_IT(IT) (((IT) == SPI_I2S_IT_RXNE) || ((IT) == SPI_I2S_IT_TXE) || \
00288                                ((IT) == I2S_IT_UDR) || ((IT) == SPI_IT_CRCERR) || \
00289                                ((IT) == SPI_IT_MODF) || ((IT) == SPI_I2S_IT_OVR))
00290 
00298 #define SPI_I2S_FLAG_RXNE               ((uint16_t)0x0001)
00299 #define SPI_I2S_FLAG_TXE                ((uint16_t)0x0002)
00300 #define I2S_FLAG_CHSIDE                 ((uint16_t)0x0004)
00301 #define I2S_FLAG_UDR                    ((uint16_t)0x0008)
00302 #define SPI_FLAG_CRCERR                 ((uint16_t)0x0010)
00303 #define SPI_FLAG_MODF                   ((uint16_t)0x0020)
00304 #define SPI_I2S_FLAG_OVR                ((uint16_t)0x0040)
00305 #define SPI_I2S_FLAG_BSY                ((uint16_t)0x0080)
00306 #define IS_SPI_I2S_CLEAR_FLAG(FLAG) (((FLAG) == SPI_FLAG_CRCERR))
00307 #define IS_SPI_I2S_GET_FLAG(FLAG) (((FLAG) == SPI_I2S_FLAG_BSY) || ((FLAG) == SPI_I2S_FLAG_OVR) || \
00308                                    ((FLAG) == SPI_FLAG_MODF) || ((FLAG) == SPI_FLAG_CRCERR) || \
00309                                    ((FLAG) == I2S_FLAG_UDR) || ((FLAG) == I2S_FLAG_CHSIDE) || \
00310                                    ((FLAG) == SPI_I2S_FLAG_TXE) || ((FLAG) == SPI_I2S_FLAG_RXNE))
00311 
00319 #define IS_SPI_CRC_POLYNOMIAL(POLYNOMIAL) ((POLYNOMIAL) >= 0x1)
00320 
00336 extern NUTSPIBUS spiBus2Stm32;
00337 
00338 #endif /*__STM32F10x_SPI_H */
00339 
00340 /******************* (C) COPYRIGHT 2009 STMicroelectronics *****END OF FILE****/