lib/main/STM32F4/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_usart.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f4xx_hal_usart.h
   4   * @author  MCD Application Team
   5   * @version V1.7.1
   6   * @date    14-April-2017
   7   * @brief   Header file of USART HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F4xx_HAL_USART_H
  40 #define __STM32F4xx_HAL_USART_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f4xx_hal_def.h"
  48
  49 /** @addtogroup STM32F4xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup USART
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /** @defgroup USART_Exported_Types USART Exported Types
  59   * @{
  60   */
  61
  62 /**
  63   * @brief USART Init Structure definition
  64   */
  65 typedef struct
  66 {
  67   uint32_t BaudRate;                  /*!< This member configures the Usart communication baud rate.
  68                                            The baud rate is computed using the following formula:
  69                                            - IntegerDivider = ((PCLKx) / (8 * (husart->Init.BaudRate)))
  70                                            - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8) + 0.5 */
  71
  72   uint32_t WordLength;                /*!< Specifies the number of data bits transmitted or received in a frame.
  73                                            This parameter can be a value of @ref USART_Word_Length */
  74
  75   uint32_t StopBits;                  /*!< Specifies the number of stop bits transmitted.
  76                                            This parameter can be a value of @ref USART_Stop_Bits */
  77
  78   uint32_t Parity;                   /*!< Specifies the parity mode.
  79                                            This parameter can be a value of @ref USART_Parity
  80                                            @note When parity is enabled, the computed parity is inserted
  81                                                  at the MSB position of the transmitted data (9th bit when
  82                                                  the word length is set to 9 data bits; 8th bit when the
  83                                                  word length is set to 8 data bits). */
  84
  85   uint32_t Mode;                      /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
  86                                            This parameter can be a value of @ref USART_Mode */
  87
  88   uint32_t CLKPolarity;               /*!< Specifies the steady state of the serial clock.
  89                                            This parameter can be a value of @ref USART_Clock_Polarity */
  90
  91   uint32_t CLKPhase;                  /*!< Specifies the clock transition on which the bit capture is made.
  92                                            This parameter can be a value of @ref USART_Clock_Phase */
  93
  94   uint32_t CLKLastBit;                /*!< Specifies whether the clock pulse corresponding to the last transmitted
  95                                            data bit (MSB) has to be output on the SCLK pin in synchronous mode.
  96                                            This parameter can be a value of @ref USART_Last_Bit */
  97 }USART_InitTypeDef;
  98
  99 /**
 100   * @brief HAL State structures definition
 101   */
 102 typedef enum
 103 {
 104   HAL_USART_STATE_RESET             = 0x00U,    /*!< Peripheral is not yet Initialized   */
 105   HAL_USART_STATE_READY             = 0x01U,    /*!< Peripheral Initialized and ready for use */
 106   HAL_USART_STATE_BUSY              = 0x02U,    /*!< an internal process is ongoing */
 107   HAL_USART_STATE_BUSY_TX           = 0x12U,    /*!< Data Transmission process is ongoing */
 108   HAL_USART_STATE_BUSY_RX           = 0x22U,    /*!< Data Reception process is ongoing */
 109   HAL_USART_STATE_BUSY_TX_RX        = 0x32U,    /*!< Data Transmission Reception process is ongoing */
 110   HAL_USART_STATE_TIMEOUT           = 0x03U,    /*!< Timeout state */
 111   HAL_USART_STATE_ERROR             = 0x04U     /*!< Error */
 112 }HAL_USART_StateTypeDef;
 113
 114 /**
 115   * @brief  USART handle Structure definition
 116   */
 117 typedef struct
 118 {
 119   USART_TypeDef                 *Instance;        /* USART registers base address        */
 120
 121   USART_InitTypeDef             Init;             /* Usart communication parameters      */
 122
 123   uint8_t                       *pTxBuffPtr;      /* Pointer to Usart Tx transfer Buffer */
 124
 125   uint16_t                      TxXferSize;       /* Usart Tx Transfer size              */
 126
 127   __IO uint16_t                 TxXferCount;      /* Usart Tx Transfer Counter           */
 128
 129   uint8_t                       *pRxBuffPtr;      /* Pointer to Usart Rx transfer Buffer */
 130
 131   uint16_t                      RxXferSize;       /* Usart Rx Transfer size              */
 132
 133   __IO uint16_t                 RxXferCount;      /* Usart Rx Transfer Counter           */
 134
 135   DMA_HandleTypeDef             *hdmatx;          /* Usart Tx DMA Handle parameters      */
 136
 137   DMA_HandleTypeDef             *hdmarx;          /* Usart Rx DMA Handle parameters      */
 138
 139   HAL_LockTypeDef                Lock;            /* Locking object                      */
 140
 141   __IO HAL_USART_StateTypeDef    State;           /* Usart communication state           */
 142
 143   __IO uint32_t                  ErrorCode;       /* USART Error code                    */
 144
 145 }USART_HandleTypeDef;
 146 /**
 147   * @}
 148   */
 149
 150 /* Exported constants --------------------------------------------------------*/
 151 /** @defgroup USART_Exported_Constants USART Exported Constants
 152   * @{
 153   */
 154
 155 /** @defgroup USART_Error_Code USART Error Code
 156   * @brief    USART Error Code
 157   * @{
 158   */
 159 #define HAL_USART_ERROR_NONE         0x00000000U   /*!< No error            */
 160 #define HAL_USART_ERROR_PE           0x00000001U   /*!< Parity error        */
 161 #define HAL_USART_ERROR_NE           0x00000002U   /*!< Noise error         */
 162 #define HAL_USART_ERROR_FE           0x00000004U   /*!< Frame error         */
 163 #define HAL_USART_ERROR_ORE          0x00000008U   /*!< Overrun error       */
 164 #define HAL_USART_ERROR_DMA          0x00000010U   /*!< DMA transfer error  */
 165 /**
 166   * @}
 167   */
 168
 169 /** @defgroup USART_Word_Length USART Word Length
 170   * @{
 171   */
 172 #define USART_WORDLENGTH_8B                  0x00000000U
 173 #define USART_WORDLENGTH_9B                  ((uint32_t)USART_CR1_M)
 174 /**
 175   * @}
 176   */
 177
 178 /** @defgroup USART_Stop_Bits USART Number of Stop Bits
 179   * @{
 180   */
 181 #define USART_STOPBITS_1                     0x00000000U
 182 #define USART_STOPBITS_0_5                   ((uint32_t)USART_CR2_STOP_0)
 183 #define USART_STOPBITS_2                     ((uint32_t)USART_CR2_STOP_1)
 184 #define USART_STOPBITS_1_5                   ((uint32_t)(USART_CR2_STOP_0 | USART_CR2_STOP_1))
 185 /**
 186   * @}
 187   */
 188
 189 /** @defgroup USART_Parity USART Parity
 190   * @{
 191   */
 192 #define USART_PARITY_NONE                    0x00000000U
 193 #define USART_PARITY_EVEN                    ((uint32_t)USART_CR1_PCE)
 194 #define USART_PARITY_ODD                     ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
 195 /**
 196   * @}
 197   */
 198
 199 /** @defgroup USART_Mode USART Mode
 200   * @{
 201   */
 202 #define USART_MODE_RX                        ((uint32_t)USART_CR1_RE)
 203 #define USART_MODE_TX                        ((uint32_t)USART_CR1_TE)
 204 #define USART_MODE_TX_RX                     ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
 205 /**
 206   * @}
 207   */
 208
 209 /** @defgroup USART_Clock USART Clock
 210   * @{
 211   */
 212 #define USART_CLOCK_DISABLE                 0x00000000U
 213 #define USART_CLOCK_ENABLE                  ((uint32_t)USART_CR2_CLKEN)
 214 /**
 215   * @}
 216   */
 217
 218 /** @defgroup USART_Clock_Polarity USART Clock Polarity
 219   * @{
 220   */
 221 #define USART_POLARITY_LOW                   0x00000000U
 222 #define USART_POLARITY_HIGH                  ((uint32_t)USART_CR2_CPOL)
 223 /**
 224   * @}
 225   */
 226
 227 /** @defgroup USART_Clock_Phase  USART Clock Phase
 228   * @{
 229   */
 230 #define USART_PHASE_1EDGE                    0x00000000U
 231 #define USART_PHASE_2EDGE                    ((uint32_t)USART_CR2_CPHA)
 232 /**
 233   * @}
 234   */
 235
 236 /** @defgroup USART_Last_Bit  USART Last Bit
 237   * @{
 238   */
 239 #define USART_LASTBIT_DISABLE                0x00000000U
 240 #define USART_LASTBIT_ENABLE                 ((uint32_t)USART_CR2_LBCL)
 241 /**
 242   * @}
 243   */
 244
 245 /** @defgroup USART_NACK_State USART NACK State
 246   * @{
 247   */
 248 #define USART_NACK_ENABLE           ((uint32_t)USART_CR3_NACK)
 249 #define USART_NACK_DISABLE          0x00000000U
 250 /**
 251   * @}
 252   */
 253
 254 /** @defgroup USART_Flags USART Flags
 255   *        Elements values convention: 0xXXXX
 256   *           - 0xXXXX  : Flag mask in the SR register
 257   * @{
 258   */
 259 #define USART_FLAG_TXE                       0x00000080U
 260 #define USART_FLAG_TC                        0x00000040U
 261 #define USART_FLAG_RXNE                      0x00000020U
 262 #define USART_FLAG_IDLE                      0x00000010U
 263 #define USART_FLAG_ORE                       0x00000008U
 264 #define USART_FLAG_NE                        0x00000004U
 265 #define USART_FLAG_FE                        0x00000002U
 266 #define USART_FLAG_PE                        0x00000001U
 267 /**
 268   * @}
 269   */
 270
 271 /** @defgroup USART_Interrupt_definition USART Interrupts Definition
 272   *        Elements values convention: 0xY000XXXX
 273   *           - XXXX  : Interrupt mask in the XX register
 274   *           - Y  : Interrupt source register (2bits)
 275   *                 - 01: CR1 register
 276   *                 - 10: CR2 register
 277   *                 - 11: CR3 register
 278   *
 279   * @{
 280   */
 281 #define USART_IT_PE                     ((uint32_t)(USART_CR1_REG_INDEX << 28U | USART_CR1_PEIE))
 282 #define USART_IT_TXE                    ((uint32_t)(USART_CR1_REG_INDEX << 28U | USART_CR1_TXEIE))
 283 #define USART_IT_TC                     ((uint32_t)(USART_CR1_REG_INDEX << 28U | USART_CR1_TCIE))
 284 #define USART_IT_RXNE                   ((uint32_t)(USART_CR1_REG_INDEX << 28U | USART_CR1_RXNEIE))
 285 #define USART_IT_IDLE                   ((uint32_t)(USART_CR1_REG_INDEX << 28U | USART_CR1_IDLEIE))
 286
 287 #define USART_IT_LBD                    ((uint32_t)(USART_CR2_REG_INDEX << 28U | USART_CR2_LBDIE))
 288
 289 #define USART_IT_CTS                    ((uint32_t)(USART_CR3_REG_INDEX << 28U | USART_CR3_CTSIE))
 290 #define USART_IT_ERR                    ((uint32_t)(USART_CR3_REG_INDEX << 28U | USART_CR3_EIE))
 291 /**
 292   * @}
 293   */
 294
 295 /**
 296   * @}
 297   */
 298
 299 /* Exported macro ------------------------------------------------------------*/
 300 /** @defgroup USART_Exported_Macros USART Exported Macros
 301   * @{
 302   */
 303
 304 /** @brief Reset USART handle state
 305   * @param  __HANDLE__: specifies the USART Handle.
 306   *         This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
 307   * @retval None
 308   */
 309 #define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_USART_STATE_RESET)
 310
 311 /** @brief  Checks whether the specified Smartcard flag is set or not.
 312   * @param  __HANDLE__: specifies the USART Handle.
 313   *         This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
 314   * @param  __FLAG__: specifies the flag to check.
 315   *        This parameter can be one of the following values:
 316   *            @arg USART_FLAG_TXE:  Transmit data register empty flag
 317   *            @arg USART_FLAG_TC:   Transmission Complete flag
 318   *            @arg USART_FLAG_RXNE: Receive data register not empty flag
 319   *            @arg USART_FLAG_IDLE: Idle Line detection flag
 320   *            @arg USART_FLAG_ORE:  Overrun Error flag
 321   *            @arg USART_FLAG_NE:   Noise Error flag
 322   *            @arg USART_FLAG_FE:   Framing Error flag
 323   *            @arg USART_FLAG_PE:   Parity Error flag
 324   * @retval The new state of __FLAG__ (TRUE or FALSE).
 325   */
 326 #define __HAL_USART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
 327
 328 /** @brief  Clears the specified Smartcard pending flags.
 329   * @param  __HANDLE__: specifies the USART Handle.
 330   *         This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
 331   * @param  __FLAG__: specifies the flag to check.
 332   *          This parameter can be any combination of the following values:
 333   *            @arg USART_FLAG_TC:   Transmission Complete flag.
 334   *            @arg USART_FLAG_RXNE: Receive data register not empty flag.
 335   *
 336   * @note   PE (Parity error), FE (Framing error), NE (Noise error), ORE (Overrun
 337   *          error) and IDLE (Idle line detected) flags are cleared by software
 338   *          sequence: a read operation to USART_SR register followed by a read
 339   *          operation to USART_DR register.
 340   * @note   RXNE flag can be also cleared by a read to the USART_DR register.
 341   * @note   TC flag can be also cleared by software sequence: a read operation to
 342   *          USART_SR register followed by a write operation to USART_DR register.
 343   * @note   TXE flag is cleared only by a write to the USART_DR register.
 344   *
 345   * @retval None
 346   */
 347 #define __HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
 348
 349 /** @brief  Clear the USART PE pending flag.
 350   * @param  __HANDLE__: specifies the USART Handle.
 351   *         This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
 352   * @retval None
 353   */
 354 #define __HAL_USART_CLEAR_PEFLAG(__HANDLE__)    \
 355   do{                                           \
 356     __IO uint32_t tmpreg = 0x00U;                \
 357     tmpreg = (__HANDLE__)->Instance->SR;        \
 358     tmpreg = (__HANDLE__)->Instance->DR;        \
 359     UNUSED(tmpreg);                             \
 360   } while(0U)
 361
 362 /** @brief  Clear the USART FE pending flag.
 363   * @param  __HANDLE__: specifies the USART Handle.
 364   *         This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
 365   * @retval None
 366   */
 367 #define __HAL_USART_CLEAR_FEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 368
 369 /** @brief  Clear the USART NE pending flag.
 370   * @param  __HANDLE__: specifies the USART Handle.
 371   *         This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
 372   * @retval None
 373   */
 374 #define __HAL_USART_CLEAR_NEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 375
 376 /** @brief  Clear the UART ORE pending flag.
 377   * @param  __HANDLE__: specifies the USART Handle.
 378   *         This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
 379   * @retval None
 380   */
 381 #define __HAL_USART_CLEAR_OREFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 382
 383 /** @brief  Clear the USART IDLE pending flag.
 384   * @param  __HANDLE__: specifies the USART Handle.
 385   *         This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
 386   * @retval None
 387   */
 388 #define __HAL_USART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 389
 390 /** @brief  Enables or disables the specified USART interrupts.
 391   * @param  __HANDLE__: specifies the USART Handle.
 392   *         This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
 393   * @param  __INTERRUPT__: specifies the USART interrupt source to check.
 394   *          This parameter can be one of the following values:
 395   *            @arg USART_IT_TXE:  Transmit Data Register empty interrupt
 396   *            @arg USART_IT_TC:   Transmission complete interrupt
 397   *            @arg USART_IT_RXNE: Receive Data register not empty interrupt
 398   *            @arg USART_IT_IDLE: Idle line detection interrupt
 399   *            @arg USART_IT_PE:   Parity Error interrupt
 400   *            @arg USART_IT_ERR:  Error interrupt(Frame error, noise error, overrun error)
 401   *          This parameter can be: ENABLE or DISABLE.
 402   * @retval None
 403   */
 404 #define __HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((((__INTERRUPT__) >> 28U) == 1U)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & USART_IT_MASK)): \
 405                                                             (((__INTERRUPT__) >> 28U) == 2U)? ((__HANDLE__)->Instance->CR2 |=  ((__INTERRUPT__) & USART_IT_MASK)): \
 406                                                              ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & USART_IT_MASK)))
 407 #define __HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__)  ((((__INTERRUPT__) >> 28U) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
 408                                                             (((__INTERRUPT__) >> 28U) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
 409                                                              ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & USART_IT_MASK)))
 410
 411 /** @brief  Checks whether the specified USART interrupt has occurred or not.
 412   * @param  __HANDLE__: specifies the USART Handle.
 413   *         This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
 414   * @param  __IT__: specifies the USART interrupt source to check.
 415   *          This parameter can be one of the following values:
 416   *            @arg USART_IT_TXE: Transmit Data Register empty interrupt
 417   *            @arg USART_IT_TC:  Transmission complete interrupt
 418   *            @arg USART_IT_RXNE: Receive Data register not empty interrupt
 419   *            @arg USART_IT_IDLE: Idle line detection interrupt
 420   *            @arg USART_IT_ERR: Error interrupt
 421   *            @arg USART_IT_PE: Parity Error interrupt
 422   * @retval The new state of __IT__ (TRUE or FALSE).
 423   */
 424 #define __HAL_USART_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28U) == 1U)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28U) == 2U)? \
 425                                                       (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & USART_IT_MASK))
 426
 427 /** @brief  Macro to enable the USART's one bit sample method
 428   * @param  __HANDLE__: specifies the USART Handle.
 429   * @retval None
 430   */
 431 #define __HAL_USART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
 432
 433 /** @brief  Macro to disable the USART's one bit sample method
 434   * @param  __HANDLE__: specifies the USART Handle.
 435   * @retval None
 436   */
 437 #define __HAL_USART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
 438
 439 /** @brief  Enable USART
 440   * @param  __HANDLE__: specifies the USART Handle.
 441   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 442   * @retval None
 443   */
 444 #define __HAL_USART_ENABLE(__HANDLE__)               ( (__HANDLE__)->Instance->CR1 |=  USART_CR1_UE)
 445
 446 /** @brief  Disable USART
 447   * @param  __HANDLE__: specifies the USART Handle.
 448   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 449   * @retval None
 450   */
 451 #define __HAL_USART_DISABLE(__HANDLE__)              ( (__HANDLE__)->Instance->CR1 &=  ~USART_CR1_UE)
 452
 453 /**
 454   * @}
 455   */
 456 /* Exported functions --------------------------------------------------------*/
 457 /** @addtogroup USART_Exported_Functions
 458   * @{
 459   */
 460
 461 /** @addtogroup USART_Exported_Functions_Group1
 462   * @{
 463   */
 464 /* Initialization/de-initialization functions  **********************************/
 465 HAL_StatusTypeDef HAL_USART_Init(USART_HandleTypeDef *husart);
 466 HAL_StatusTypeDef HAL_USART_DeInit(USART_HandleTypeDef *husart);
 467 void HAL_USART_MspInit(USART_HandleTypeDef *husart);
 468 void HAL_USART_MspDeInit(USART_HandleTypeDef *husart);
 469 /**
 470   * @}
 471   */
 472
 473 /** @addtogroup USART_Exported_Functions_Group2
 474   * @{
 475   */
 476 /* IO operation functions *******************************************************/
 477 HAL_StatusTypeDef HAL_USART_Transmit(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size, uint32_t Timeout);
 478 HAL_StatusTypeDef HAL_USART_Receive(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
 479 HAL_StatusTypeDef HAL_USART_TransmitReceive(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
 480 HAL_StatusTypeDef HAL_USART_Transmit_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
 481 HAL_StatusTypeDef HAL_USART_Receive_IT(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
 482 HAL_StatusTypeDef HAL_USART_TransmitReceive_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData,  uint16_t Size);
 483 HAL_StatusTypeDef HAL_USART_Transmit_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
 484 HAL_StatusTypeDef HAL_USART_Receive_DMA(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
 485 HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
 486 HAL_StatusTypeDef HAL_USART_DMAPause(USART_HandleTypeDef *husart);
 487 HAL_StatusTypeDef HAL_USART_DMAResume(USART_HandleTypeDef *husart);
 488 HAL_StatusTypeDef HAL_USART_DMAStop(USART_HandleTypeDef *husart);
 489 /* Transfer Abort functions */
 490 HAL_StatusTypeDef HAL_USART_Abort(USART_HandleTypeDef *husart);
 491 HAL_StatusTypeDef HAL_USART_Abort_IT(USART_HandleTypeDef *husart);
 492
 493 void HAL_USART_IRQHandler(USART_HandleTypeDef *husart);
 494 void HAL_USART_TxCpltCallback(USART_HandleTypeDef *husart);
 495 void HAL_USART_TxHalfCpltCallback(USART_HandleTypeDef *husart);
 496 void HAL_USART_RxCpltCallback(USART_HandleTypeDef *husart);
 497 void HAL_USART_RxHalfCpltCallback(USART_HandleTypeDef *husart);
 498 void HAL_USART_TxRxCpltCallback(USART_HandleTypeDef *husart);
 499 void HAL_USART_ErrorCallback(USART_HandleTypeDef *husart);
 500 void HAL_USART_AbortCpltCallback (USART_HandleTypeDef *husart);
 501 /**
 502   * @}
 503   */
 504
 505 /** @addtogroup USART_Exported_Functions_Group3
 506   * @{
 507   */
 508 /* Peripheral State functions  ************************************************/
 509 HAL_USART_StateTypeDef HAL_USART_GetState(USART_HandleTypeDef *husart);
 510 uint32_t               HAL_USART_GetError(USART_HandleTypeDef *husart);
 511 /**
 512   * @}
 513   */
 514
 515 /**
 516   * @}
 517   */
 518 /* Private types -------------------------------------------------------------*/
 519 /* Private variables ---------------------------------------------------------*/
 520 /* Private constants ---------------------------------------------------------*/
 521 /** @defgroup USART_Private_Constants USART Private Constants
 522   * @{
 523   */
 524 /** @brief USART interruptions flag mask
 525   *
 526   */
 527 #define USART_IT_MASK  ((uint32_t) USART_CR1_PEIE | USART_CR1_TXEIE | USART_CR1_TCIE | USART_CR1_RXNEIE | \
 528                                    USART_CR1_IDLEIE | USART_CR2_LBDIE | USART_CR3_CTSIE | USART_CR3_EIE )
 529
 530 #define USART_CR1_REG_INDEX             1U
 531 #define USART_CR2_REG_INDEX             2U
 532 #define USART_CR3_REG_INDEX             3U
 533 /**
 534   * @}
 535   */
 536
 537 /* Private macros ------------------------------------------------------------*/
 538 /** @defgroup USART_Private_Macros USART Private Macros
 539   * @{
 540   */
 541 #define IS_USART_NACK_STATE(NACK) (((NACK) == USART_NACK_ENABLE) || \
 542                                    ((NACK) == USART_NACK_DISABLE))
 543 #define IS_USART_LASTBIT(LASTBIT) (((LASTBIT) == USART_LASTBIT_DISABLE) || \
 544                                        ((LASTBIT) == USART_LASTBIT_ENABLE))
 545 #define IS_USART_PHASE(CPHA) (((CPHA) == USART_PHASE_1EDGE) || ((CPHA) == USART_PHASE_2EDGE))
 546 #define IS_USART_POLARITY(CPOL) (((CPOL) == USART_POLARITY_LOW) || ((CPOL) == USART_POLARITY_HIGH))
 547 #define IS_USART_CLOCK(CLOCK) (((CLOCK) == USART_CLOCK_DISABLE) || \
 548                                ((CLOCK) == USART_CLOCK_ENABLE))
 549 #define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WORDLENGTH_8B) || \
 550                                           ((LENGTH) == USART_WORDLENGTH_9B))
 551 #define IS_USART_STOPBITS(STOPBITS) (((STOPBITS) == USART_STOPBITS_1) || \
 552                                          ((STOPBITS) == USART_STOPBITS_0_5) || \
 553                                          ((STOPBITS) == USART_STOPBITS_1_5) || \
 554                                          ((STOPBITS) == USART_STOPBITS_2))
 555 #define IS_USART_PARITY(PARITY) (((PARITY) == USART_PARITY_NONE) || \
 556                                      ((PARITY) == USART_PARITY_EVEN) || \
 557                                      ((PARITY) == USART_PARITY_ODD))
 558 #define IS_USART_MODE(MODE) ((((MODE) & 0xFFF3U) == 0x00U) && ((MODE) != 0x00U))
 559 #define IS_USART_BAUDRATE(BAUDRATE) ((BAUDRATE) < 10500001U)
 560
 561 #define USART_DIV(_PCLK_, _BAUD_)                  (((_PCLK_)*25U)/(2U*(_BAUD_)))
 562 #define USART_DIVMANT(_PCLK_, _BAUD_)              (USART_DIV((_PCLK_), (_BAUD_))/100U)
 563 #define USART_DIVFRAQ(_PCLK_, _BAUD_)              (((USART_DIV((_PCLK_), (_BAUD_)) - (USART_DIVMANT((_PCLK_), (_BAUD_)) * 100U)) * 16U + 50U) / 100U)
 564 #define USART_BRR(_PCLK_, _BAUD_)                  ((USART_DIVMANT((_PCLK_), (_BAUD_)) << 4U)|(USART_DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0FU))
 565 /**
 566   * @}
 567   */
 568
 569 /* Private functions ---------------------------------------------------------*/
 570 /** @defgroup USART_Private_Functions USART Private Functions
 571   * @{
 572   */
 573
 574 /**
 575   * @}
 576   */
 577
 578 /**
 579   * @}
 580   */
 581
 582 /**
 583   * @}
 584   */
 585
 586 #ifdef __cplusplus
 587 }
 588 #endif
 589
 590 #endif /* __STM32F4xx_HAL_USART_H */
 591
 592 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/