lib/main/STM32F1/Drivers/STM32F1xx_HAL_Driver/Inc/stm32f1xx_hal_usart.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f1xx_hal_usart.h
   4   * @author  MCD Application Team
   5   * @version V1.1.1
   6   * @date    12-May-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 __STM32F1xx_HAL_USART_H
  40 #define __STM32F1xx_HAL_USART_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f1xx_hal_def.h"
  48
  49 /** @addtogroup STM32F1xx_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) / (16 * (husart->Init.BaudRate)))
  70                                            - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 16) + 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 }USART_HandleTypeDef;
 145 /**
 146   * @}
 147   */
 148
 149 /* Exported constants --------------------------------------------------------*/
 150 /** @defgroup USART_Exported_Constants USART Exported Constants
 151   * @{
 152   */
 153
 154 /** @defgroup USART_Error_Code USART Error Code
 155   * @brief    USART Error Code
 156   * @{
 157   */
 158 #define HAL_USART_ERROR_NONE         0x00000000U   /*!< No error            */
 159 #define HAL_USART_ERROR_PE           0x00000001U   /*!< Parity error        */
 160 #define HAL_USART_ERROR_NE           0x00000002U   /*!< Noise error         */
 161 #define HAL_USART_ERROR_FE           0x00000004U   /*!< Frame error         */
 162 #define HAL_USART_ERROR_ORE          0x00000008U   /*!< Overrun error       */
 163 #define HAL_USART_ERROR_DMA          0x00000010U   /*!< DMA transfer error  */
 164 /**
 165   * @}
 166   */
 167
 168 /** @defgroup USART_Word_Length USART Word Length
 169   * @{
 170   */
 171 #define USART_WORDLENGTH_8B                  0x00000000U
 172 #define USART_WORDLENGTH_9B                  ((uint32_t)USART_CR1_M)
 173 /**
 174   * @}
 175   */
 176
 177 /** @defgroup USART_Stop_Bits USART Number of Stop Bits
 178   * @{
 179   */
 180 #define USART_STOPBITS_1                     0x00000000U
 181 #define USART_STOPBITS_0_5                   ((uint32_t)USART_CR2_STOP_0)
 182 #define USART_STOPBITS_2                     ((uint32_t)USART_CR2_STOP_1)
 183 #define USART_STOPBITS_1_5                   ((uint32_t)(USART_CR2_STOP_0 | USART_CR2_STOP_1))
 184 /**
 185   * @}
 186   */
 187
 188 /** @defgroup USART_Parity USART Parity
 189   * @{
 190   */
 191 #define USART_PARITY_NONE                    0x00000000U
 192 #define USART_PARITY_EVEN                    ((uint32_t)USART_CR1_PCE)
 193 #define USART_PARITY_ODD                     ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
 194 /**
 195   * @}
 196   */
 197
 198 /** @defgroup USART_Mode USART Mode
 199   * @{
 200   */
 201 #define USART_MODE_RX                        ((uint32_t)USART_CR1_RE)
 202 #define USART_MODE_TX                        ((uint32_t)USART_CR1_TE)
 203 #define USART_MODE_TX_RX                     ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
 204 /**
 205   * @}
 206   */
 207
 208 /** @defgroup USART_Clock USART Clock
 209   * @{
 210   */
 211 #define USART_CLOCK_DISABLE                 0x00000000U
 212 #define USART_CLOCK_ENABLE                  ((uint32_t)USART_CR2_CLKEN)
 213 /**
 214   * @}
 215   */
 216
 217 /** @defgroup USART_Clock_Polarity USART Clock Polarity
 218   * @{
 219   */
 220 #define USART_POLARITY_LOW                   0x00000000U
 221 #define USART_POLARITY_HIGH                  ((uint32_t)USART_CR2_CPOL)
 222 /**
 223   * @}
 224   */
 225
 226 /** @defgroup USART_Clock_Phase USART Clock Phase
 227   * @{
 228   */
 229 #define USART_PHASE_1EDGE                    0x00000000U
 230 #define USART_PHASE_2EDGE                    ((uint32_t)USART_CR2_CPHA)
 231 /**
 232   * @}
 233   */
 234
 235 /** @defgroup USART_Last_Bit USART Last Bit
 236   * @{
 237   */
 238 #define USART_LASTBIT_DISABLE                0x00000000U
 239 #define USART_LASTBIT_ENABLE                 ((uint32_t)USART_CR2_LBCL)
 240 /**
 241   * @}
 242   */
 243
 244 /** @defgroup USART_NACK_State USART NACK State
 245   * @{
 246   */
 247 #define USART_NACK_ENABLE           ((uint32_t)USART_CR3_NACK)
 248 #define USART_NACK_DISABLE          0x00000000U
 249 /**
 250   * @}
 251   */
 252
 253 /** @defgroup USART_Flags USART Flags
 254   *        Elements values convention: 0xXXXX
 255   *           - 0xXXXX  : Flag mask in the SR register
 256   * @{
 257   */
 258 #define USART_FLAG_TXE                  ((uint32_t)USART_SR_TXE)
 259 #define USART_FLAG_TC                   ((uint32_t)USART_SR_TC)
 260 #define USART_FLAG_RXNE                 ((uint32_t)USART_SR_RXNE)
 261 #define USART_FLAG_IDLE                 ((uint32_t)USART_SR_IDLE)
 262 #define USART_FLAG_ORE                  ((uint32_t)USART_SR_ORE)
 263 #define USART_FLAG_NE                   ((uint32_t)USART_SR_NE)
 264 #define USART_FLAG_FE                   ((uint32_t)USART_SR_FE)
 265 #define USART_FLAG_PE                   ((uint32_t)USART_SR_PE)
 266 /**
 267   * @}
 268   */
 269
 270 /** @defgroup USART_Interrupt_definition USART Interrupts Definition
 271   *        Elements values convention: 0xY000XXXX
 272   *           - XXXX  : Interrupt mask in the XX register
 273   *           - Y  : Interrupt source register (2bits)
 274   *                 - 01: CR1 register
 275   *                 - 10: CR2 register
 276   *                 - 11: CR3 register
 277   *
 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   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 307   */
 308 #define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_USART_STATE_RESET)
 309
 310 /** @brief  Checks whether the specified USART flag is set or not.
 311   * @param  __HANDLE__: specifies the USART Handle.
 312   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 313   * @param  __FLAG__: specifies the flag to check.
 314   *        This parameter can be one of the following values:
 315   *            @arg USART_FLAG_TXE:  Transmit data register empty flag
 316   *            @arg USART_FLAG_TC:   Transmission Complete flag
 317   *            @arg USART_FLAG_RXNE: Receive data register not empty flag
 318   *            @arg USART_FLAG_IDLE: Idle Line detection flag
 319   *            @arg USART_FLAG_ORE:  OverRun Error flag
 320   *            @arg USART_FLAG_NE:   Noise Error flag
 321   *            @arg USART_FLAG_FE:   Framing Error flag
 322   *            @arg USART_FLAG_PE:   Parity Error flag
 323   * @retval The new state of __FLAG__ (TRUE or FALSE).
 324   */
 325 #define __HAL_USART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
 326
 327 /** @brief  Clears the specified USART pending flags.
 328   * @param  __HANDLE__: specifies the USART Handle.
 329   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 330   * @param  __FLAG__: specifies the flag to check.
 331   *          This parameter can be any combination of the following values:
 332   *            @arg USART_FLAG_TC:   Transmission Complete flag.
 333   *            @arg USART_FLAG_RXNE: Receive data register not empty flag.
 334   *
 335   * @note   PE (Parity error), FE (Framing error), NE (Noise error), ORE (OverRun
 336   *          error) and IDLE (Idle line detected) flags are cleared by software
 337   *          sequence: a read operation to USART_SR register followed by a read
 338   *          operation to USART_DR register.
 339   * @note   RXNE flag can be also cleared by a read to the USART_DR register.
 340   * @note   TC flag can be also cleared by software sequence: a read operation to
 341   *          USART_SR register followed by a write operation to USART_DR register
 342   * @note   TXE flag is cleared only by a write to the USART_DR register
 343   *
 344   */
 345 #define __HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
 346
 347 /** @brief  Clear the USART PE pending flag.
 348   * @param  __HANDLE__: specifies the USART Handle.
 349   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 350   */
 351 #define __HAL_USART_CLEAR_PEFLAG(__HANDLE__)    \
 352   do{                                           \
 353     __IO uint32_t tmpreg = 0x00U;               \
 354     tmpreg = (__HANDLE__)->Instance->SR;        \
 355     tmpreg = (__HANDLE__)->Instance->DR;        \
 356     UNUSED(tmpreg);                             \
 357   } while(0U)
 358
 359 /** @brief  Clear the USART FE pending flag.
 360   * @param  __HANDLE__: specifies the USART Handle.
 361   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 362   */
 363 #define __HAL_USART_CLEAR_FEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 364
 365 /** @brief  Clear the USART NE pending flag.
 366   * @param  __HANDLE__: specifies the USART Handle.
 367   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 368   */
 369 #define __HAL_USART_CLEAR_NEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 370
 371 /** @brief  Clear the USART ORE pending flag.
 372   * @param  __HANDLE__: specifies the USART Handle.
 373   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 374
 375   */
 376 #define __HAL_USART_CLEAR_OREFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 377
 378 /** @brief  Clear the USART IDLE pending flag.
 379   * @param  __HANDLE__: specifies the USART Handle.
 380   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 381   */
 382 #define __HAL_USART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
 383
 384 /** @brief  Enable the specified USART interrupts.
 385   * @param  __HANDLE__: specifies the USART Handle.
 386   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 387   * @param  __INTERRUPT__: specifies the USART interrupt source to enable.
 388   *          This parameter can be one of the following values:
 389   *            @arg USART_IT_TXE:  Transmit Data Register empty interrupt
 390   *            @arg USART_IT_TC:   Transmission complete interrupt
 391   *            @arg USART_IT_RXNE: Receive Data register not empty interrupt
 392   *            @arg USART_IT_IDLE: Idle line detection interrupt
 393   *            @arg USART_IT_PE:   Parity Error interrupt
 394   *            @arg USART_IT_ERR:  Error interrupt(Frame error, noise error, overrun error)
 395   *          This parameter can be: ENABLE or DISABLE.
 396   */
 397 #define __HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((((__INTERRUPT__) >> 28U) == USART_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & USART_IT_MASK)): \
 398                                                             (((__INTERRUPT__) >> 28U) == USART_CR2_REG_INDEX)? ((__HANDLE__)->Instance->CR2 |=  ((__INTERRUPT__) & USART_IT_MASK)): \
 399                                                             ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & USART_IT_MASK)))
 400
 401 /** @brief  Disable the specified USART interrupts.
 402   * @param  __HANDLE__: specifies the USART Handle.
 403   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 404   * @param  __INTERRUPT__: specifies the USART interrupt source to disable.
 405   *          This parameter can be one of the following values:
 406   *            @arg USART_IT_TXE:  Transmit Data Register empty interrupt
 407   *            @arg USART_IT_TC:   Transmission complete interrupt
 408   *            @arg USART_IT_RXNE: Receive Data register not empty interrupt
 409   *            @arg USART_IT_IDLE: Idle line detection interrupt
 410   *            @arg USART_IT_PE:   Parity Error interrupt
 411   *            @arg USART_IT_ERR:  Error interrupt(Frame error, noise error, overrun error)
 412   *          This parameter can be: ENABLE or DISABLE.
 413   */
 414 #define __HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__)  ((((__INTERRUPT__) >> 28U) == USART_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
 415                                                             (((__INTERRUPT__) >> 28U) == USART_CR2_REG_INDEX)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
 416                                                              ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & USART_IT_MASK)))
 417
 418 /** @brief  Checks whether the specified USART interrupt has occurred or not.
 419   * @param  __HANDLE__: specifies the USART Handle.
 420   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 421   * @param  __IT__: specifies the USART interrupt source to check.
 422   *          This parameter can be one of the following values:
 423   *            @arg USART_IT_TXE: Transmit Data Register empty interrupt
 424   *            @arg USART_IT_TC:  Transmission complete interrupt
 425   *            @arg USART_IT_RXNE: Receive Data register not empty interrupt
 426   *            @arg USART_IT_IDLE: Idle line detection interrupt
 427   *            @arg USART_IT_ERR: Error interrupt
 428   *            @arg USART_IT_PE: Parity Error interrupt
 429   * @retval The new state of __IT__ (TRUE or FALSE).
 430   */
 431 #define __HAL_USART_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28U) == USART_CR1_REG_INDEX)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28U) == USART_CR2_REG_INDEX)? \
 432                                                       (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & USART_IT_MASK))
 433
 434 /** @brief  Enable USART
 435   * @param  __HANDLE__: specifies the USART Handle.
 436   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 437   */
 438 #define __HAL_USART_ENABLE(__HANDLE__)               SET_BIT((__HANDLE__)->Instance->CR1,(USART_CR1_UE))
 439
 440 /** @brief  Disable USART
 441   * @param  __HANDLE__: specifies the USART Handle.
 442   *         USART Handle selects the USARTx peripheral (USART availability and x value depending on device).
 443   */
 444 #define __HAL_USART_DISABLE(__HANDLE__)              CLEAR_BIT((__HANDLE__)->Instance->CR1,(USART_CR1_UE))
 445 /**
 446   * @}
 447   */
 448 /* Exported functions --------------------------------------------------------*/
 449 /** @addtogroup USART_Exported_Functions
 450   * @{
 451   */
 452
 453 /** @addtogroup USART_Exported_Functions_Group1
 454   * @{
 455   */
 456 /* Initialization/de-initialization functions  **********************************/
 457 HAL_StatusTypeDef HAL_USART_Init(USART_HandleTypeDef *husart);
 458 HAL_StatusTypeDef HAL_USART_DeInit(USART_HandleTypeDef *husart);
 459 void HAL_USART_MspInit(USART_HandleTypeDef *husart);
 460 void HAL_USART_MspDeInit(USART_HandleTypeDef *husart);
 461 /**
 462   * @}
 463   */
 464
 465 /** @addtogroup USART_Exported_Functions_Group2
 466   * @{
 467   */
 468 /* IO operation functions *******************************************************/
 469 HAL_StatusTypeDef HAL_USART_Transmit(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size, uint32_t Timeout);
 470 HAL_StatusTypeDef HAL_USART_Receive(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
 471 HAL_StatusTypeDef HAL_USART_TransmitReceive(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
 472 HAL_StatusTypeDef HAL_USART_Transmit_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
 473 HAL_StatusTypeDef HAL_USART_Receive_IT(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
 474 HAL_StatusTypeDef HAL_USART_TransmitReceive_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData,  uint16_t Size);
 475 HAL_StatusTypeDef HAL_USART_Transmit_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
 476 HAL_StatusTypeDef HAL_USART_Receive_DMA(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
 477 HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
 478 HAL_StatusTypeDef HAL_USART_DMAPause(USART_HandleTypeDef *husart);
 479 HAL_StatusTypeDef HAL_USART_DMAResume(USART_HandleTypeDef *husart);
 480 HAL_StatusTypeDef HAL_USART_DMAStop(USART_HandleTypeDef *husart);
 481 /* Transfer Abort functions */
 482 HAL_StatusTypeDef HAL_USART_Abort(USART_HandleTypeDef *husart);
 483 HAL_StatusTypeDef HAL_USART_Abort_IT(USART_HandleTypeDef *husart);
 484
 485 void HAL_USART_IRQHandler(USART_HandleTypeDef *husart);
 486 void HAL_USART_TxCpltCallback(USART_HandleTypeDef *husart);
 487 void HAL_USART_TxHalfCpltCallback(USART_HandleTypeDef *husart);
 488 void HAL_USART_RxCpltCallback(USART_HandleTypeDef *husart);
 489 void HAL_USART_RxHalfCpltCallback(USART_HandleTypeDef *husart);
 490 void HAL_USART_TxRxCpltCallback(USART_HandleTypeDef *husart);
 491 void HAL_USART_ErrorCallback(USART_HandleTypeDef *husart);
 492 void HAL_USART_AbortCpltCallback (USART_HandleTypeDef *husart);
 493 /**
 494   * @}
 495   */
 496
 497 /** @addtogroup USART_Exported_Functions_Group3
 498   * @{
 499   */
 500 /* Peripheral State functions  ************************************************/
 501 HAL_USART_StateTypeDef HAL_USART_GetState(USART_HandleTypeDef *husart);
 502 uint32_t               HAL_USART_GetError(USART_HandleTypeDef *husart);
 503 /**
 504   * @}
 505   */
 506
 507 /**
 508   * @}
 509   */
 510 /* Private types -------------------------------------------------------------*/
 511 /* Private variables ---------------------------------------------------------*/
 512 /* Private constants ---------------------------------------------------------*/
 513 /** @defgroup USART_Private_Constants USART Private Constants
 514   * @{
 515   */
 516 /** @brief USART interruptions flag mask
 517   *
 518   */
 519 #define USART_IT_MASK                   0x0000FFFFU
 520
 521 #define USART_CR1_REG_INDEX             1U
 522 #define USART_CR2_REG_INDEX             2U
 523 #define USART_CR3_REG_INDEX             3U
 524 /**
 525   * @}
 526   */
 527
 528 /* Private macros ------------------------------------------------------------*/
 529 /** @defgroup USART_Private_Macros USART Private Macros
 530   * @{
 531   */
 532 #define IS_USART_NACK_STATE(NACK) (((NACK) == USART_NACK_ENABLE) || \
 533                                    ((NACK) == USART_NACK_DISABLE))
 534
 535 #define IS_USART_LASTBIT(LASTBIT) (((LASTBIT) == USART_LASTBIT_DISABLE) || \
 536                                    ((LASTBIT) == USART_LASTBIT_ENABLE))
 537
 538 #define IS_USART_PHASE(CPHA) (((CPHA) == USART_PHASE_1EDGE) || ((CPHA) == USART_PHASE_2EDGE))
 539
 540 #define IS_USART_POLARITY(CPOL) (((CPOL) == USART_POLARITY_LOW) || ((CPOL) == USART_POLARITY_HIGH))
 541
 542 #define IS_USART_CLOCK(CLOCK) (((CLOCK) == USART_CLOCK_DISABLE) || \
 543                                ((CLOCK) == USART_CLOCK_ENABLE))
 544
 545 #define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WORDLENGTH_8B) || \
 546                                       ((LENGTH) == USART_WORDLENGTH_9B))
 547
 548 #define IS_USART_STOPBITS(STOPBITS) (((STOPBITS) == USART_STOPBITS_1)   || \
 549                                      ((STOPBITS) == USART_STOPBITS_0_5) || \
 550                                      ((STOPBITS) == USART_STOPBITS_1_5) || \
 551                                      ((STOPBITS) == USART_STOPBITS_2))
 552
 553 #define IS_USART_PARITY(PARITY) (((PARITY) == USART_PARITY_NONE) || \
 554                                  ((PARITY) == USART_PARITY_EVEN) || \
 555                                  ((PARITY) == USART_PARITY_ODD))
 556
 557 #define IS_USART_MODE(MODE) ((((MODE) & 0xFFF3U) == 0x00U) && ((MODE) != 0x00U))
 558
 559 #define IS_USART_BAUDRATE(BAUDRATE) ((BAUDRATE) < 4500001U)
 560
 561 #define USART_DIV(_PCLK_, _BAUD_) (((_PCLK_)*25U)/(2U*(_BAUD_)))
 562
 563 #define USART_DIVMANT(_PCLK_, _BAUD_) (USART_DIV((_PCLK_), (_BAUD_))/100U)
 564
 565 #define USART_DIVFRAQ(_PCLK_, _BAUD_) (((USART_DIV((_PCLK_), (_BAUD_)) - (USART_DIVMANT((_PCLK_), (_BAUD_)) * 100U)) * 16U + 50U) / 100U)
 566
 567 #define USART_BRR(_PCLK_, _BAUD_) ((USART_DIVMANT((_PCLK_), (_BAUD_)) << 4U)|(USART_DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0FU))
 568 /**
 569   * @}
 570   */
 571
 572 /* Private functions ---------------------------------------------------------*/
 573 /** @defgroup USART_Private_Functions USART Private Functions
 574   * @{
 575   */
 576
 577 /**
 578   * @}
 579   */
 580
 581 /**
 582   * @}
 583   */
 584
 585 /**
 586   * @}
 587   */
 588
 589 #ifdef __cplusplus
 590 }
 591 #endif
 592
 593 #endif /* __STM32F1xx_HAL_USART_H */
 594
 595 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/