git.rot13.org Git - DSO138/blob - Libraries/STM32F10x_StdPeriph_Driver/inc/stm32f10x_usart.h

   1 /**\r
   2   ******************************************************************************\r
   3   * @file    stm32f10x_usart.h\r
   4   * @author  MCD Application Team\r
   5   * @version V3.3.0\r
   6   * @date    04/16/2010\r
   7   * @brief   This file contains all the functions prototypes for the USART \r
   8   *          firmware 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 2010 STMicroelectronics</center></h2>\r
  20   */ \r
  21 \r
  22 /* Define to prevent recursive inclusion -------------------------------------*/\r
  23 #ifndef __STM32F10x_USART_H\r
  24 #define __STM32F10x_USART_H\r
  25 \r
  26 #ifdef __cplusplus\r
  27  extern "C" {\r
  28 #endif\r
  29 \r
  30 /* Includes ------------------------------------------------------------------*/\r
  31 #include "stm32f10x.h"\r
  32 \r
  33 /** @addtogroup STM32F10x_StdPeriph_Driver\r
  34   * @{\r
  35   */\r
  36 \r
  37 /** @addtogroup USART\r
  38   * @{\r
  39   */ \r
  40 \r
  41 /** @defgroup USART_Exported_Types\r
  42   * @{\r
  43   */ \r
  44 \r
  45 /** \r
  46   * @brief  USART Init Structure definition  \r
  47   */ \r
  48   \r
  49 typedef struct\r
  50 {\r
  51   uint32_t USART_BaudRate;            /*!< This member configures the USART communication baud rate.\r
  52                                            The baud rate is computed using the following formula:\r
  53                                             - IntegerDivider = ((PCLKx) / (16 * (USART_InitStruct->USART_BaudRate)))\r
  54                                             - FractionalDivider = ((IntegerDivider - ((u32) IntegerDivider)) * 16) + 0.5 */\r
  55 \r
  56   uint16_t USART_WordLength;          /*!< Specifies the number of data bits transmitted or received in a frame.\r
  57                                            This parameter can be a value of @ref USART_Word_Length */\r
  58 \r
  59   uint16_t USART_StopBits;            /*!< Specifies the number of stop bits transmitted.\r
  60                                            This parameter can be a value of @ref USART_Stop_Bits */\r
  61 \r
  62   uint16_t USART_Parity;              /*!< Specifies the parity mode.\r
  63                                            This parameter can be a value of @ref USART_Parity\r
  64                                            @note When parity is enabled, the computed parity is inserted\r
  65                                                  at the MSB position of the transmitted data (9th bit when\r
  66                                                  the word length is set to 9 data bits; 8th bit when the\r
  67                                                  word length is set to 8 data bits). */\r
  68  \r
  69   uint16_t USART_Mode;                /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.\r
  70                                            This parameter can be a value of @ref USART_Mode */\r
  71 \r
  72   uint16_t USART_HardwareFlowControl; /*!< Specifies wether the hardware flow control mode is enabled\r
  73                                            or disabled.\r
  74                                            This parameter can be a value of @ref USART_Hardware_Flow_Control */\r
  75 } USART_InitTypeDef;\r
  76 \r
  77 /** \r
  78   * @brief  USART Clock Init Structure definition  \r
  79   */ \r
  80   \r
  81 typedef struct\r
  82 {\r
  83 \r
  84   uint16_t USART_Clock;   /*!< Specifies whether the USART clock is enabled or disabled.\r
  85                                This parameter can be a value of @ref USART_Clock */\r
  86 \r
  87   uint16_t USART_CPOL;    /*!< Specifies the steady state value of the serial clock.\r
  88                                This parameter can be a value of @ref USART_Clock_Polarity */\r
  89 \r
  90   uint16_t USART_CPHA;    /*!< Specifies the clock transition on which the bit capture is made.\r
  91                                This parameter can be a value of @ref USART_Clock_Phase */\r
  92 \r
  93   uint16_t USART_LastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted\r
  94                                data bit (MSB) has to be output on the SCLK pin in synchronous mode.\r
  95                                This parameter can be a value of @ref USART_Last_Bit */\r
  96 } USART_ClockInitTypeDef;\r
  97 \r
  98 /**\r
  99   * @}\r
 100   */ \r
 101 \r
 102 /** @defgroup USART_Exported_Constants\r
 103   * @{\r
 104   */ \r
 105   \r
 106 #define IS_USART_ALL_PERIPH(PERIPH) (((PERIPH) == USART1) || \\r
 107                                      ((PERIPH) == USART2) || \\r
 108                                      ((PERIPH) == USART3) || \\r
 109                                      ((PERIPH) == UART4) || \\r
 110                                      ((PERIPH) == UART5))\r
 111 \r
 112 #define IS_USART_123_PERIPH(PERIPH) (((PERIPH) == USART1) || \\r
 113                                      ((PERIPH) == USART2) || \\r
 114                                      ((PERIPH) == USART3))\r
 115 \r
 116 #define IS_USART_1234_PERIPH(PERIPH) (((PERIPH) == USART1) || \\r
 117                                       ((PERIPH) == USART2) || \\r
 118                                       ((PERIPH) == USART3) || \\r
 119                                       ((PERIPH) == UART4))\r
 120 /** @defgroup USART_Word_Length \r
 121   * @{\r
 122   */ \r
 123   \r
 124 #define USART_WordLength_8b                  ((uint16_t)0x0000)\r
 125 #define USART_WordLength_9b                  ((uint16_t)0x1000)\r
 126                                     \r
 127 #define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WordLength_8b) || \\r
 128                                       ((LENGTH) == USART_WordLength_9b))\r
 129 /**\r
 130   * @}\r
 131   */ \r
 132 \r
 133 /** @defgroup USART_Stop_Bits \r
 134   * @{\r
 135   */ \r
 136   \r
 137 #define USART_StopBits_1                     ((uint16_t)0x0000)\r
 138 #define USART_StopBits_0_5                   ((uint16_t)0x1000)\r
 139 #define USART_StopBits_2                     ((uint16_t)0x2000)\r
 140 #define USART_StopBits_1_5                   ((uint16_t)0x3000)\r
 141 #define IS_USART_STOPBITS(STOPBITS) (((STOPBITS) == USART_StopBits_1) || \\r
 142                                      ((STOPBITS) == USART_StopBits_0_5) || \\r
 143                                      ((STOPBITS) == USART_StopBits_2) || \\r
 144                                      ((STOPBITS) == USART_StopBits_1_5))\r
 145 /**\r
 146   * @}\r
 147   */ \r
 148 \r
 149 /** @defgroup USART_Parity \r
 150   * @{\r
 151   */ \r
 152   \r
 153 #define USART_Parity_No                      ((uint16_t)0x0000)\r
 154 #define USART_Parity_Even                    ((uint16_t)0x0400)\r
 155 #define USART_Parity_Odd                     ((uint16_t)0x0600) \r
 156 #define IS_USART_PARITY(PARITY) (((PARITY) == USART_Parity_No) || \\r
 157                                  ((PARITY) == USART_Parity_Even) || \\r
 158                                  ((PARITY) == USART_Parity_Odd))\r
 159 /**\r
 160   * @}\r
 161   */ \r
 162 \r
 163 /** @defgroup USART_Mode \r
 164   * @{\r
 165   */ \r
 166   \r
 167 #define USART_Mode_Rx                        ((uint16_t)0x0004)\r
 168 #define USART_Mode_Tx                        ((uint16_t)0x0008)\r
 169 #define IS_USART_MODE(MODE) ((((MODE) & (uint16_t)0xFFF3) == 0x00) && ((MODE) != (uint16_t)0x00))\r
 170 /**\r
 171   * @}\r
 172   */ \r
 173 \r
 174 /** @defgroup USART_Hardware_Flow_Control \r
 175   * @{\r
 176   */ \r
 177 #define USART_HardwareFlowControl_None       ((uint16_t)0x0000)\r
 178 #define USART_HardwareFlowControl_RTS        ((uint16_t)0x0100)\r
 179 #define USART_HardwareFlowControl_CTS        ((uint16_t)0x0200)\r
 180 #define USART_HardwareFlowControl_RTS_CTS    ((uint16_t)0x0300)\r
 181 #define IS_USART_HARDWARE_FLOW_CONTROL(CONTROL)\\r
 182                               (((CONTROL) == USART_HardwareFlowControl_None) || \\r
 183                                ((CONTROL) == USART_HardwareFlowControl_RTS) || \\r
 184                                ((CONTROL) == USART_HardwareFlowControl_CTS) || \\r
 185                                ((CONTROL) == USART_HardwareFlowControl_RTS_CTS))\r
 186 /**\r
 187   * @}\r
 188   */ \r
 189 \r
 190 /** @defgroup USART_Clock \r
 191   * @{\r
 192   */ \r
 193 #define USART_Clock_Disable                  ((uint16_t)0x0000)\r
 194 #define USART_Clock_Enable                   ((uint16_t)0x0800)\r
 195 #define IS_USART_CLOCK(CLOCK) (((CLOCK) == USART_Clock_Disable) || \\r
 196                                ((CLOCK) == USART_Clock_Enable))\r
 197 /**\r
 198   * @}\r
 199   */ \r
 200 \r
 201 /** @defgroup USART_Clock_Polarity \r
 202   * @{\r
 203   */\r
 204   \r
 205 #define USART_CPOL_Low                       ((uint16_t)0x0000)\r
 206 #define USART_CPOL_High                      ((uint16_t)0x0400)\r
 207 #define IS_USART_CPOL(CPOL) (((CPOL) == USART_CPOL_Low) || ((CPOL) == USART_CPOL_High))\r
 208 \r
 209 /**\r
 210   * @}\r
 211   */ \r
 212 \r
 213 /** @defgroup USART_Clock_Phase\r
 214   * @{\r
 215   */\r
 216 \r
 217 #define USART_CPHA_1Edge                     ((uint16_t)0x0000)\r
 218 #define USART_CPHA_2Edge                     ((uint16_t)0x0200)\r
 219 #define IS_USART_CPHA(CPHA) (((CPHA) == USART_CPHA_1Edge) || ((CPHA) == USART_CPHA_2Edge))\r
 220 \r
 221 /**\r
 222   * @}\r
 223   */\r
 224 \r
 225 /** @defgroup USART_Last_Bit\r
 226   * @{\r
 227   */\r
 228 \r
 229 #define USART_LastBit_Disable                ((uint16_t)0x0000)\r
 230 #define USART_LastBit_Enable                 ((uint16_t)0x0100)\r
 231 #define IS_USART_LASTBIT(LASTBIT) (((LASTBIT) == USART_LastBit_Disable) || \\r
 232                                    ((LASTBIT) == USART_LastBit_Enable))\r
 233 /**\r
 234   * @}\r
 235   */ \r
 236 \r
 237 /** @defgroup USART_Interrupt_definition \r
 238   * @{\r
 239   */\r
 240   \r
 241 #define USART_IT_PE                          ((uint16_t)0x0028)\r
 242 #define USART_IT_TXE                         ((uint16_t)0x0727)\r
 243 #define USART_IT_TC                          ((uint16_t)0x0626)\r
 244 #define USART_IT_RXNE                        ((uint16_t)0x0525)\r
 245 #define USART_IT_IDLE                        ((uint16_t)0x0424)\r
 246 #define USART_IT_LBD                         ((uint16_t)0x0846)\r
 247 #define USART_IT_CTS                         ((uint16_t)0x096A)\r
 248 #define USART_IT_ERR                         ((uint16_t)0x0060)\r
 249 #define USART_IT_ORE                         ((uint16_t)0x0360)\r
 250 #define USART_IT_NE                          ((uint16_t)0x0260)\r
 251 #define USART_IT_FE                          ((uint16_t)0x0160)\r
 252 #define IS_USART_CONFIG_IT(IT) (((IT) == USART_IT_PE) || ((IT) == USART_IT_TXE) || \\r
 253                                ((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || \\r
 254                                ((IT) == USART_IT_IDLE) || ((IT) == USART_IT_LBD) || \\r
 255                                ((IT) == USART_IT_CTS) || ((IT) == USART_IT_ERR))\r
 256 #define IS_USART_GET_IT(IT) (((IT) == USART_IT_PE) || ((IT) == USART_IT_TXE) || \\r
 257                             ((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || \\r
 258                             ((IT) == USART_IT_IDLE) || ((IT) == USART_IT_LBD) || \\r
 259                             ((IT) == USART_IT_CTS) || ((IT) == USART_IT_ORE) || \\r
 260                             ((IT) == USART_IT_NE) || ((IT) == USART_IT_FE))\r
 261 #define IS_USART_CLEAR_IT(IT) (((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || \\r
 262                                ((IT) == USART_IT_LBD) || ((IT) == USART_IT_CTS))\r
 263 /**\r
 264   * @}\r
 265   */\r
 266 \r
 267 /** @defgroup USART_DMA_Requests \r
 268   * @{\r
 269   */\r
 270 \r
 271 #define USART_DMAReq_Tx                      ((uint16_t)0x0080)\r
 272 #define USART_DMAReq_Rx                      ((uint16_t)0x0040)\r
 273 #define IS_USART_DMAREQ(DMAREQ) ((((DMAREQ) & (uint16_t)0xFF3F) == 0x00) && ((DMAREQ) != (uint16_t)0x00))\r
 274 \r
 275 /**\r
 276   * @}\r
 277   */ \r
 278 \r
 279 /** @defgroup USART_WakeUp_methods\r
 280   * @{\r
 281   */\r
 282 \r
 283 #define USART_WakeUp_IdleLine                ((uint16_t)0x0000)\r
 284 #define USART_WakeUp_AddressMark             ((uint16_t)0x0800)\r
 285 #define IS_USART_WAKEUP(WAKEUP) (((WAKEUP) == USART_WakeUp_IdleLine) || \\r
 286                                  ((WAKEUP) == USART_WakeUp_AddressMark))\r
 287 /**\r
 288   * @}\r
 289   */\r
 290 \r
 291 /** @defgroup USART_LIN_Break_Detection_Length \r
 292   * @{\r
 293   */\r
 294   \r
 295 #define USART_LINBreakDetectLength_10b      ((uint16_t)0x0000)\r
 296 #define USART_LINBreakDetectLength_11b      ((uint16_t)0x0020)\r
 297 #define IS_USART_LIN_BREAK_DETECT_LENGTH(LENGTH) \\r
 298                                (((LENGTH) == USART_LINBreakDetectLength_10b) || \\r
 299                                 ((LENGTH) == USART_LINBreakDetectLength_11b))\r
 300 /**\r
 301   * @}\r
 302   */\r
 303 \r
 304 /** @defgroup USART_IrDA_Low_Power \r
 305   * @{\r
 306   */\r
 307 \r
 308 #define USART_IrDAMode_LowPower              ((uint16_t)0x0004)\r
 309 #define USART_IrDAMode_Normal                ((uint16_t)0x0000)\r
 310 #define IS_USART_IRDA_MODE(MODE) (((MODE) == USART_IrDAMode_LowPower) || \\r
 311                                   ((MODE) == USART_IrDAMode_Normal))\r
 312 /**\r
 313   * @}\r
 314   */ \r
 315 \r
 316 /** @defgroup USART_Flags \r
 317   * @{\r
 318   */\r
 319 \r
 320 #define USART_FLAG_CTS                       ((uint16_t)0x0200)\r
 321 #define USART_FLAG_LBD                       ((uint16_t)0x0100)\r
 322 #define USART_FLAG_TXE                       ((uint16_t)0x0080)\r
 323 #define USART_FLAG_TC                        ((uint16_t)0x0040)\r
 324 #define USART_FLAG_RXNE                      ((uint16_t)0x0020)\r
 325 #define USART_FLAG_IDLE                      ((uint16_t)0x0010)\r
 326 #define USART_FLAG_ORE                       ((uint16_t)0x0008)\r
 327 #define USART_FLAG_NE                        ((uint16_t)0x0004)\r
 328 #define USART_FLAG_FE                        ((uint16_t)0x0002)\r
 329 #define USART_FLAG_PE                        ((uint16_t)0x0001)\r
 330 #define IS_USART_FLAG(FLAG) (((FLAG) == USART_FLAG_PE) || ((FLAG) == USART_FLAG_TXE) || \\r
 331                              ((FLAG) == USART_FLAG_TC) || ((FLAG) == USART_FLAG_RXNE) || \\r
 332                              ((FLAG) == USART_FLAG_IDLE) || ((FLAG) == USART_FLAG_LBD) || \\r
 333                              ((FLAG) == USART_FLAG_CTS) || ((FLAG) == USART_FLAG_ORE) || \\r
 334                              ((FLAG) == USART_FLAG_NE) || ((FLAG) == USART_FLAG_FE))\r
 335                               \r
 336 #define IS_USART_CLEAR_FLAG(FLAG) ((((FLAG) & (uint16_t)0xFC9F) == 0x00) && ((FLAG) != (uint16_t)0x00))\r
 337 #define IS_USART_PERIPH_FLAG(PERIPH, USART_FLAG) ((((*(uint32_t*)&(PERIPH)) != UART4_BASE) &&\\r
 338                                                   ((*(uint32_t*)&(PERIPH)) != UART5_BASE)) \\r
 339                                                   || ((USART_FLAG) != USART_FLAG_CTS)) \r
 340 #define IS_USART_BAUDRATE(BAUDRATE) (((BAUDRATE) > 0) && ((BAUDRATE) < 0x0044AA21))\r
 341 #define IS_USART_ADDRESS(ADDRESS) ((ADDRESS) <= 0xF)\r
 342 #define IS_USART_DATA(DATA) ((DATA) <= 0x1FF)\r
 343 \r
 344 /**\r
 345   * @}\r
 346   */ \r
 347 \r
 348 /**\r
 349   * @}\r
 350   */ \r
 351 \r
 352 /** @defgroup USART_Exported_Macros\r
 353   * @{\r
 354   */ \r
 355 \r
 356 /**\r
 357   * @}\r
 358   */ \r
 359 \r
 360 /** @defgroup USART_Exported_Functions\r
 361   * @{\r
 362   */\r
 363 \r
 364 void USART_DeInit(USART_TypeDef* USARTx);\r
 365 void USART_Init(USART_TypeDef* USARTx, USART_InitTypeDef* USART_InitStruct);\r
 366 void USART_StructInit(USART_InitTypeDef* USART_InitStruct);\r
 367 void USART_ClockInit(USART_TypeDef* USARTx, USART_ClockInitTypeDef* USART_ClockInitStruct);\r
 368 void USART_ClockStructInit(USART_ClockInitTypeDef* USART_ClockInitStruct);\r
 369 void USART_Cmd(USART_TypeDef* USARTx, FunctionalState NewState);\r
 370 void USART_ITConfig(USART_TypeDef* USARTx, uint16_t USART_IT, FunctionalState NewState);\r
 371 void USART_DMACmd(USART_TypeDef* USARTx, uint16_t USART_DMAReq, FunctionalState NewState);\r
 372 void USART_SetAddress(USART_TypeDef* USARTx, uint8_t USART_Address);\r
 373 void USART_WakeUpConfig(USART_TypeDef* USARTx, uint16_t USART_WakeUp);\r
 374 void USART_ReceiverWakeUpCmd(USART_TypeDef* USARTx, FunctionalState NewState);\r
 375 void USART_LINBreakDetectLengthConfig(USART_TypeDef* USARTx, uint16_t USART_LINBreakDetectLength);\r
 376 void USART_LINCmd(USART_TypeDef* USARTx, FunctionalState NewState);\r
 377 void USART_SendData(USART_TypeDef* USARTx, uint16_t Data);\r
 378 uint16_t USART_ReceiveData(USART_TypeDef* USARTx);\r
 379 void USART_SendBreak(USART_TypeDef* USARTx);\r
 380 void USART_SetGuardTime(USART_TypeDef* USARTx, uint8_t USART_GuardTime);\r
 381 void USART_SetPrescaler(USART_TypeDef* USARTx, uint8_t USART_Prescaler);\r
 382 void USART_SmartCardCmd(USART_TypeDef* USARTx, FunctionalState NewState);\r
 383 void USART_SmartCardNACKCmd(USART_TypeDef* USARTx, FunctionalState NewState);\r
 384 void USART_HalfDuplexCmd(USART_TypeDef* USARTx, FunctionalState NewState);\r
 385 void USART_OverSampling8Cmd(USART_TypeDef* USARTx, FunctionalState NewState);\r
 386 void USART_OneBitMethodCmd(USART_TypeDef* USARTx, FunctionalState NewState);\r
 387 void USART_IrDAConfig(USART_TypeDef* USARTx, uint16_t USART_IrDAMode);\r
 388 void USART_IrDACmd(USART_TypeDef* USARTx, FunctionalState NewState);\r
 389 FlagStatus USART_GetFlagStatus(USART_TypeDef* USARTx, uint16_t USART_FLAG);\r
 390 void USART_ClearFlag(USART_TypeDef* USARTx, uint16_t USART_FLAG);\r
 391 ITStatus USART_GetITStatus(USART_TypeDef* USARTx, uint16_t USART_IT);\r
 392 void USART_ClearITPendingBit(USART_TypeDef* USARTx, uint16_t USART_IT);\r
 393 \r
 394 #ifdef __cplusplus\r
 395 }\r
 396 #endif\r
 397 \r
 398 #endif /* __STM32F10x_USART_H */\r
 399 /**\r
 400   * @}\r
 401   */ \r
 402 \r
 403 /**\r
 404   * @}\r
 405   */ \r
 406 \r
 407 /**\r
 408   * @}\r
 409   */ \r
 410 \r
 411 /******************* (C) COPYRIGHT 2010 STMicroelectronics *****END OF FILE****/\r