git.gag.com Git - fw/stlink/blob - example/libs_stm/inc/stm32l1xx/stm32l1xx_spi.h

   1 /**\r
   2   ******************************************************************************\r
   3   * @file    stm32l1xx_spi.h\r
   4   * @author  MCD Application Team\r
   5   * @version V1.0.0\r
   6   * @date    31-December-2010\r
   7   * @brief   This file contains all the functions prototypes for the SPI \r
   8   *          firmware library.\r
   9   ******************************************************************************\r
  10   * @attention\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 2010 STMicroelectronics</center></h2>\r
  20   ******************************************************************************  \r
  21   */ \r
  22 \r
  23 /* Define to prevent recursive inclusion -------------------------------------*/\r
  24 #ifndef __STM32L1xx_SPI_H\r
  25 #define __STM32L1xx_SPI_H\r
  26 \r
  27 #ifdef __cplusplus\r
  28  extern "C" {\r
  29 #endif\r
  30 \r
  31 /* Includes ------------------------------------------------------------------*/\r
  32 #include "stm32l1xx.h"\r
  33 \r
  34 /** @addtogroup STM32L1xx_StdPeriph_Driver\r
  35   * @{\r
  36   */\r
  37 \r
  38 /** @addtogroup SPI\r
  39   * @{\r
  40   */ \r
  41 \r
  42 /* Exported types ------------------------------------------------------------*/\r
  43 \r
  44 /** \r
  45   * @brief  SPI Init structure definition  \r
  46   */\r
  47 \r
  48 typedef struct\r
  49 {\r
  50   uint16_t SPI_Direction;           /*!< Specifies the SPI unidirectional or bidirectional data mode.\r
  51                                          This parameter can be any combination of @ref SPI_data_direction */\r
  52 \r
  53   uint16_t SPI_Mode;                /*!< Specifies the SPI operating mode.\r
  54                                          This parameter can be any combination of @ref SPI_mode */\r
  55 \r
  56   uint16_t SPI_DataSize;            /*!< Specifies the SPI data size.\r
  57                                          This parameter can be any combination of @ref SPI_data_size */\r
  58 \r
  59   uint16_t SPI_CPOL;                /*!< Specifies the serial clock steady state.\r
  60                                          This parameter can be any combination of @ref SPI_Clock_Polarity */\r
  61 \r
  62   uint16_t SPI_CPHA;                /*!< Specifies the clock active edge for the bit capture.\r
  63                                          This parameter can be any combination of @ref SPI_Clock_Phase */\r
  64 \r
  65   uint16_t SPI_NSS;                 /*!< Specifies whether the NSS signal is managed by\r
  66                                          hardware (NSS pin) or by software using the SSI bit.\r
  67                                          This parameter can be any combination of @ref SPI_Slave_Select_management */\r
  68  \r
  69   uint16_t SPI_BaudRatePrescaler;   /*!< Specifies the Baud Rate prescaler value which will be\r
  70                                          used to configure the transmit and receive SCK clock.\r
  71                                          This parameter can be any combination of @ref SPI_BaudRate_Prescaler.\r
  72                                          @note The communication clock is derived from the master\r
  73                                                clock. The slave clock does not need to be set. */\r
  74 \r
  75   uint16_t SPI_FirstBit;            /*!< Specifies whether data transfers start from MSB or LSB bit.\r
  76                                          This parameter can be any combination of @ref SPI_MSB_LSB_transmission */\r
  77 \r
  78   uint16_t SPI_CRCPolynomial;       /*!< Specifies the polynomial used for the CRC calculation. */\r
  79 }SPI_InitTypeDef;\r
  80 \r
  81 /* Exported constants --------------------------------------------------------*/\r
  82 \r
  83 /** @defgroup SPI_Exported_Constants\r
  84   * @{\r
  85   */\r
  86 \r
  87 #define IS_SPI_ALL_PERIPH(PERIPH) (((PERIPH) == SPI1) || \\r
  88                                    ((PERIPH) == SPI2))\r
  89 \r
  90 /** @defgroup SPI_data_direction \r
  91   * @{\r
  92   */\r
  93   \r
  94 #define SPI_Direction_2Lines_FullDuplex ((uint16_t)0x0000)\r
  95 #define SPI_Direction_2Lines_RxOnly     ((uint16_t)0x0400)\r
  96 #define SPI_Direction_1Line_Rx          ((uint16_t)0x8000)\r
  97 #define SPI_Direction_1Line_Tx          ((uint16_t)0xC000)\r
  98 #define IS_SPI_DIRECTION_MODE(MODE) (((MODE) == SPI_Direction_2Lines_FullDuplex) || \\r
  99                                      ((MODE) == SPI_Direction_2Lines_RxOnly) || \\r
 100                                      ((MODE) == SPI_Direction_1Line_Rx) || \\r
 101                                      ((MODE) == SPI_Direction_1Line_Tx))\r
 102 /**\r
 103   * @}\r
 104   */\r
 105 \r
 106 /** @defgroup SPI_mode \r
 107   * @{\r
 108   */\r
 109 \r
 110 #define SPI_Mode_Master                 ((uint16_t)0x0104)\r
 111 #define SPI_Mode_Slave                  ((uint16_t)0x0000)\r
 112 #define IS_SPI_MODE(MODE) (((MODE) == SPI_Mode_Master) || \\r
 113                            ((MODE) == SPI_Mode_Slave))\r
 114 /**\r
 115   * @}\r
 116   */\r
 117 \r
 118 /** @defgroup SPI_data_size \r
 119   * @{\r
 120   */\r
 121 \r
 122 #define SPI_DataSize_16b                ((uint16_t)0x0800)\r
 123 #define SPI_DataSize_8b                 ((uint16_t)0x0000)\r
 124 #define IS_SPI_DATASIZE(DATASIZE) (((DATASIZE) == SPI_DataSize_16b) || \\r
 125                                    ((DATASIZE) == SPI_DataSize_8b))\r
 126 /**\r
 127   * @}\r
 128   */ \r
 129 \r
 130 /** @defgroup SPI_Clock_Polarity \r
 131   * @{\r
 132   */\r
 133 \r
 134 #define SPI_CPOL_Low                    ((uint16_t)0x0000)\r
 135 #define SPI_CPOL_High                   ((uint16_t)0x0002)\r
 136 #define IS_SPI_CPOL(CPOL) (((CPOL) == SPI_CPOL_Low) || \\r
 137                            ((CPOL) == SPI_CPOL_High))\r
 138 /**\r
 139   * @}\r
 140   */\r
 141 \r
 142 /** @defgroup SPI_Clock_Phase \r
 143   * @{\r
 144   */\r
 145 \r
 146 #define SPI_CPHA_1Edge                  ((uint16_t)0x0000)\r
 147 #define SPI_CPHA_2Edge                  ((uint16_t)0x0001)\r
 148 #define IS_SPI_CPHA(CPHA) (((CPHA) == SPI_CPHA_1Edge) || \\r
 149                            ((CPHA) == SPI_CPHA_2Edge))\r
 150 /**\r
 151   * @}\r
 152   */\r
 153 \r
 154 /** @defgroup SPI_Slave_Select_management \r
 155   * @{\r
 156   */\r
 157 \r
 158 #define SPI_NSS_Soft                    ((uint16_t)0x0200)\r
 159 #define SPI_NSS_Hard                    ((uint16_t)0x0000)\r
 160 #define IS_SPI_NSS(NSS) (((NSS) == SPI_NSS_Soft) || \\r
 161                          ((NSS) == SPI_NSS_Hard))\r
 162 /**\r
 163   * @}\r
 164   */ \r
 165 \r
 166 /** @defgroup SPI_BaudRate_Prescaler \r
 167   * @{\r
 168   */\r
 169 \r
 170 #define SPI_BaudRatePrescaler_2         ((uint16_t)0x0000)\r
 171 #define SPI_BaudRatePrescaler_4         ((uint16_t)0x0008)\r
 172 #define SPI_BaudRatePrescaler_8         ((uint16_t)0x0010)\r
 173 #define SPI_BaudRatePrescaler_16        ((uint16_t)0x0018)\r
 174 #define SPI_BaudRatePrescaler_32        ((uint16_t)0x0020)\r
 175 #define SPI_BaudRatePrescaler_64        ((uint16_t)0x0028)\r
 176 #define SPI_BaudRatePrescaler_128       ((uint16_t)0x0030)\r
 177 #define SPI_BaudRatePrescaler_256       ((uint16_t)0x0038)\r
 178 #define IS_SPI_BAUDRATE_PRESCALER(PRESCALER) (((PRESCALER) == SPI_BaudRatePrescaler_2) || \\r
 179                                               ((PRESCALER) == SPI_BaudRatePrescaler_4) || \\r
 180                                               ((PRESCALER) == SPI_BaudRatePrescaler_8) || \\r
 181                                               ((PRESCALER) == SPI_BaudRatePrescaler_16) || \\r
 182                                               ((PRESCALER) == SPI_BaudRatePrescaler_32) || \\r
 183                                               ((PRESCALER) == SPI_BaudRatePrescaler_64) || \\r
 184                                               ((PRESCALER) == SPI_BaudRatePrescaler_128) || \\r
 185                                               ((PRESCALER) == SPI_BaudRatePrescaler_256))\r
 186 /**\r
 187   * @}\r
 188   */ \r
 189 \r
 190 /** @defgroup SPI_MSB_LSB_transmission \r
 191   * @{\r
 192   */\r
 193 \r
 194 #define SPI_FirstBit_MSB                ((uint16_t)0x0000)\r
 195 #define SPI_FirstBit_LSB                ((uint16_t)0x0080)\r
 196 #define IS_SPI_FIRST_BIT(BIT) (((BIT) == SPI_FirstBit_MSB) || \\r
 197                                ((BIT) == SPI_FirstBit_LSB))\r
 198 /**\r
 199   * @}\r
 200   */\r
 201 \r
 202 /** @defgroup SPI_I2S_DMA_transfer_requests \r
 203   * @{\r
 204   */\r
 205 \r
 206 #define SPI_I2S_DMAReq_Tx               ((uint16_t)0x0002)\r
 207 #define SPI_I2S_DMAReq_Rx               ((uint16_t)0x0001)\r
 208 #define IS_SPI_I2S_DMAREQ(DMAREQ) ((((DMAREQ) & (uint16_t)0xFFFC) == 0x00) && ((DMAREQ) != 0x00))\r
 209 /**\r
 210   * @}\r
 211   */\r
 212 \r
 213 /** @defgroup SPI_NSS_internal_software_management \r
 214   * @{\r
 215   */\r
 216 \r
 217 #define SPI_NSSInternalSoft_Set         ((uint16_t)0x0100)\r
 218 #define SPI_NSSInternalSoft_Reset       ((uint16_t)0xFEFF)\r
 219 #define IS_SPI_NSS_INTERNAL(INTERNAL) (((INTERNAL) == SPI_NSSInternalSoft_Set) || \\r
 220                                        ((INTERNAL) == SPI_NSSInternalSoft_Reset))\r
 221 /**\r
 222   * @}\r
 223   */\r
 224 \r
 225 /** @defgroup SPI_CRC_Transmit_Receive \r
 226   * @{\r
 227   */\r
 228 \r
 229 #define SPI_CRC_Tx                      ((uint8_t)0x00)\r
 230 #define SPI_CRC_Rx                      ((uint8_t)0x01)\r
 231 #define IS_SPI_CRC(CRC) (((CRC) == SPI_CRC_Tx) || ((CRC) == SPI_CRC_Rx))\r
 232 /**\r
 233   * @}\r
 234   */\r
 235 \r
 236 /** @defgroup SPI_direction_transmit_receive \r
 237   * @{\r
 238   */\r
 239 \r
 240 #define SPI_Direction_Rx                ((uint16_t)0xBFFF)\r
 241 #define SPI_Direction_Tx                ((uint16_t)0x4000)\r
 242 #define IS_SPI_DIRECTION(DIRECTION) (((DIRECTION) == SPI_Direction_Rx) || \\r
 243                                      ((DIRECTION) == SPI_Direction_Tx))\r
 244 /**\r
 245   * @}\r
 246   */\r
 247 \r
 248 /** @defgroup SPI_I2S_interrupts_definition \r
 249   * @{\r
 250   */\r
 251 \r
 252 #define SPI_I2S_IT_TXE                  ((uint8_t)0x71)\r
 253 #define SPI_I2S_IT_RXNE                 ((uint8_t)0x60)\r
 254 #define SPI_I2S_IT_ERR                  ((uint8_t)0x50)\r
 255 #define IS_SPI_I2S_CONFIG_IT(IT) (((IT) == SPI_I2S_IT_TXE) || \\r
 256                                   ((IT) == SPI_I2S_IT_RXNE) || \\r
 257                                   ((IT) == SPI_I2S_IT_ERR))\r
 258 \r
 259 #define SPI_I2S_IT_OVR                  ((uint8_t)0x56)\r
 260 #define SPI_IT_MODF                     ((uint8_t)0x55)\r
 261 #define SPI_IT_CRCERR                   ((uint8_t)0x54)\r
 262 \r
 263 #define IS_SPI_I2S_CLEAR_IT(IT) (((IT) == SPI_IT_CRCERR))\r
 264 \r
 265 #define IS_SPI_I2S_GET_IT(IT) (((IT) == SPI_I2S_IT_RXNE) || ((IT) == SPI_I2S_IT_TXE) || \\r
 266                                ((IT) == SPI_IT_CRCERR) || ((IT) == SPI_IT_MODF) || \\r
 267                                ((IT) == SPI_I2S_IT_OVR))\r
 268 /**\r
 269   * @}\r
 270   */\r
 271 \r
 272 /** @defgroup SPI_I2S_flags_definition \r
 273   * @{\r
 274   */\r
 275 \r
 276 #define SPI_I2S_FLAG_RXNE               ((uint16_t)0x0001)\r
 277 #define SPI_I2S_FLAG_TXE                ((uint16_t)0x0002)\r
 278 #define SPI_FLAG_CRCERR                 ((uint16_t)0x0010)\r
 279 #define SPI_FLAG_MODF                   ((uint16_t)0x0020)\r
 280 #define SPI_I2S_FLAG_OVR                ((uint16_t)0x0040)\r
 281 #define SPI_I2S_FLAG_BSY                ((uint16_t)0x0080)\r
 282 #define IS_SPI_I2S_CLEAR_FLAG(FLAG) (((FLAG) == SPI_FLAG_CRCERR))\r
 283 #define IS_SPI_I2S_GET_FLAG(FLAG) (((FLAG) == SPI_I2S_FLAG_BSY) || ((FLAG) == SPI_I2S_FLAG_OVR) || \\r
 284                                    ((FLAG) == SPI_FLAG_MODF) || ((FLAG) == SPI_FLAG_CRCERR) || \\r
 285                                    ((FLAG) == SPI_I2S_FLAG_TXE) || ((FLAG) == SPI_I2S_FLAG_RXNE))\r
 286 /**\r
 287   * @}\r
 288   */\r
 289 \r
 290 /** @defgroup SPI_CRC_polynomial \r
 291   * @{\r
 292   */\r
 293 \r
 294 #define IS_SPI_CRC_POLYNOMIAL(POLYNOMIAL) ((POLYNOMIAL) >= 0x1)\r
 295 /**\r
 296   * @}\r
 297   */\r
 298 \r
 299 /** @defgroup SPI_I2S_Legacy \r
 300   * @{\r
 301   */\r
 302 \r
 303 #define SPI_DMAReq_Tx                SPI_I2S_DMAReq_Tx\r
 304 #define SPI_DMAReq_Rx                SPI_I2S_DMAReq_Rx\r
 305 #define SPI_IT_TXE                   SPI_I2S_IT_TXE\r
 306 #define SPI_IT_RXNE                  SPI_I2S_IT_RXNE\r
 307 #define SPI_IT_ERR                   SPI_I2S_IT_ERR\r
 308 #define SPI_IT_OVR                   SPI_I2S_IT_OVR\r
 309 #define SPI_FLAG_RXNE                SPI_I2S_FLAG_RXNE\r
 310 #define SPI_FLAG_TXE                 SPI_I2S_FLAG_TXE\r
 311 #define SPI_FLAG_OVR                 SPI_I2S_FLAG_OVR\r
 312 #define SPI_FLAG_BSY                 SPI_I2S_FLAG_BSY\r
 313 #define SPI_DeInit                   SPI_I2S_DeInit\r
 314 #define SPI_ITConfig                 SPI_I2S_ITConfig\r
 315 #define SPI_DMACmd                   SPI_I2S_DMACmd\r
 316 #define SPI_SendData                 SPI_I2S_SendData\r
 317 #define SPI_ReceiveData              SPI_I2S_ReceiveData\r
 318 #define SPI_GetFlagStatus            SPI_I2S_GetFlagStatus\r
 319 #define SPI_ClearFlag                SPI_I2S_ClearFlag\r
 320 #define SPI_GetITStatus              SPI_I2S_GetITStatus\r
 321 #define SPI_ClearITPendingBit        SPI_I2S_ClearITPendingBit\r
 322 /**\r
 323   * @}\r
 324   */\r
 325   \r
 326 /**\r
 327   * @}\r
 328   */\r
 329 \r
 330 /* Exported macro ------------------------------------------------------------*/\r
 331 /* Exported functions ------------------------------------------------------- */\r
 332 \r
 333 /*  Function used to set the SPI configuration to the default reset state *****/ \r
 334 void SPI_I2S_DeInit(SPI_TypeDef* SPIx);\r
 335 \r
 336 /* Initialization and Configuration functions *********************************/\r
 337 void SPI_Init(SPI_TypeDef* SPIx, SPI_InitTypeDef* SPI_InitStruct);\r
 338 void SPI_StructInit(SPI_InitTypeDef* SPI_InitStruct);\r
 339 void SPI_Cmd(SPI_TypeDef* SPIx, FunctionalState NewState);\r
 340 void SPI_DataSizeConfig(SPI_TypeDef* SPIx, uint16_t SPI_DataSize);\r
 341 void SPI_BiDirectionalLineConfig(SPI_TypeDef* SPIx, uint16_t SPI_Direction);\r
 342 void SPI_NSSInternalSoftwareConfig(SPI_TypeDef* SPIx, uint16_t SPI_NSSInternalSoft);\r
 343 void SPI_SSOutputCmd(SPI_TypeDef* SPIx, FunctionalState NewState);\r
 344 \r
 345 /* Data transfers functions ***************************************************/ \r
 346 void SPI_I2S_SendData(SPI_TypeDef* SPIx, uint16_t Data);\r
 347 uint16_t SPI_I2S_ReceiveData(SPI_TypeDef* SPIx);\r
 348 \r
 349 /* Hardware CRC Calculation functions *****************************************/\r
 350 void SPI_CalculateCRC(SPI_TypeDef* SPIx, FunctionalState NewState);\r
 351 void SPI_TransmitCRC(SPI_TypeDef* SPIx);\r
 352 uint16_t SPI_GetCRC(SPI_TypeDef* SPIx, uint8_t SPI_CRC);\r
 353 uint16_t SPI_GetCRCPolynomial(SPI_TypeDef* SPIx);\r
 354 \r
 355 /* DMA transfers management functions *****************************************/\r
 356 void SPI_I2S_DMACmd(SPI_TypeDef* SPIx, uint16_t SPI_I2S_DMAReq, FunctionalState NewState);\r
 357 \r
 358 /* Interrupts and flags management functions **********************************/\r
 359 void SPI_I2S_ITConfig(SPI_TypeDef* SPIx, uint8_t SPI_I2S_IT, FunctionalState NewState);\r
 360 FlagStatus SPI_I2S_GetFlagStatus(SPI_TypeDef* SPIx, uint16_t SPI_I2S_FLAG);\r
 361 void SPI_I2S_ClearFlag(SPI_TypeDef* SPIx, uint16_t SPI_I2S_FLAG);\r
 362 ITStatus SPI_I2S_GetITStatus(SPI_TypeDef* SPIx, uint8_t SPI_I2S_IT);\r
 363 void SPI_I2S_ClearITPendingBit(SPI_TypeDef* SPIx, uint8_t SPI_I2S_IT);\r
 364 \r
 365 #ifdef __cplusplus\r
 366 }\r
 367 #endif\r
 368 \r
 369 #endif /*__STM32L1xx_SPI_H */\r
 370 \r
 371 /**\r
 372   * @}\r
 373   */\r
 374 \r
 375 /**\r
 376   * @}\r
 377   */\r
 378 \r
 379 /******************* (C) COPYRIGHT 2010 STMicroelectronics *****END OF FILE****/\r