STM32F479xx HAL User Manual
stm32f4xx_hal_uart.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32f4xx_hal_uart.h
00004   * @author  MCD Application Team
00005   * @brief   Header file of UART HAL module.
00006   ******************************************************************************
00007   * @attention
00008   *
00009   * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
00010   * All rights reserved.</center></h2>
00011   *
00012   * This software component is licensed by ST under BSD 3-Clause license,
00013   * the "License"; You may not use this file except in compliance with the
00014   * License. You may obtain a copy of the License at:
00015   *                        opensource.org/licenses/BSD-3-Clause
00016   *
00017   ******************************************************************************
00018   */
00019 
00020 /* Define to prevent recursive inclusion -------------------------------------*/
00021 #ifndef __STM32F4xx_HAL_UART_H
00022 #define __STM32F4xx_HAL_UART_H
00023 
00024 #ifdef __cplusplus
00025 extern "C" {
00026 #endif
00027 
00028 /* Includes ------------------------------------------------------------------*/
00029 #include "stm32f4xx_hal_def.h"
00030 
00031 /** @addtogroup STM32F4xx_HAL_Driver
00032   * @{
00033   */
00034 
00035 /** @addtogroup UART
00036   * @{
00037   */
00038 
00039 /* Exported types ------------------------------------------------------------*/
00040 /** @defgroup UART_Exported_Types UART Exported Types
00041   * @{
00042   */
00043 
00044 /**
00045   * @brief UART Init Structure definition
00046   */
00047 typedef struct
00048 {
00049   uint32_t BaudRate;                  /*!< This member configures the UART communication baud rate.
00050                                            The baud rate is computed using the following formula:
00051                                            - IntegerDivider = ((PCLKx) / (8 * (OVR8+1) * (huart->Init.BaudRate)))
00052                                            - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8 * (OVR8+1)) + 0.5
00053                                            Where OVR8 is the "oversampling by 8 mode" configuration bit in the CR1 register. */
00054 
00055   uint32_t WordLength;                /*!< Specifies the number of data bits transmitted or received in a frame.
00056                                            This parameter can be a value of @ref UART_Word_Length */
00057 
00058   uint32_t StopBits;                  /*!< Specifies the number of stop bits transmitted.
00059                                            This parameter can be a value of @ref UART_Stop_Bits */
00060 
00061   uint32_t Parity;                    /*!< Specifies the parity mode.
00062                                            This parameter can be a value of @ref UART_Parity
00063                                            @note When parity is enabled, the computed parity is inserted
00064                                                  at the MSB position of the transmitted data (9th bit when
00065                                                  the word length is set to 9 data bits; 8th bit when the
00066                                                  word length is set to 8 data bits). */
00067 
00068   uint32_t Mode;                      /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
00069                                            This parameter can be a value of @ref UART_Mode */
00070 
00071   uint32_t HwFlowCtl;                 /*!< Specifies whether the hardware flow control mode is enabled or disabled.
00072                                            This parameter can be a value of @ref UART_Hardware_Flow_Control */
00073 
00074   uint32_t OverSampling;              /*!< Specifies whether the Over sampling 8 is enabled or disabled, to achieve higher speed (up to fPCLK/8).
00075                                            This parameter can be a value of @ref UART_Over_Sampling */
00076 } UART_InitTypeDef;
00077 
00078 /**
00079   * @brief HAL UART State structures definition
00080   * @note  HAL UART State value is a combination of 2 different substates: gState and RxState.
00081   *        - gState contains UART state information related to global Handle management
00082   *          and also information related to Tx operations.
00083   *          gState value coding follow below described bitmap :
00084   *          b7-b6  Error information
00085   *             00 : No Error
00086   *             01 : (Not Used)
00087   *             10 : Timeout
00088   *             11 : Error
00089   *          b5     Peripheral initialization status
00090   *             0  : Reset (Peripheral not initialized)
00091   *             1  : Init done (Peripheral initialized. HAL UART Init function already called)
00092   *          b4-b3  (not used)
00093   *             xx : Should be set to 00
00094   *          b2     Intrinsic process state
00095   *             0  : Ready
00096   *             1  : Busy (Peripheral busy with some configuration or internal operations)
00097   *          b1     (not used)
00098   *             x  : Should be set to 0
00099   *          b0     Tx state
00100   *             0  : Ready (no Tx operation ongoing)
00101   *             1  : Busy (Tx operation ongoing)
00102   *        - RxState contains information related to Rx operations.
00103   *          RxState value coding follow below described bitmap :
00104   *          b7-b6  (not used)
00105   *             xx : Should be set to 00
00106   *          b5     Peripheral initialization status
00107   *             0  : Reset (Peripheral not initialized)
00108   *             1  : Init done (Peripheral initialized)
00109   *          b4-b2  (not used)
00110   *            xxx : Should be set to 000
00111   *          b1     Rx state
00112   *             0  : Ready (no Rx operation ongoing)
00113   *             1  : Busy (Rx operation ongoing)
00114   *          b0     (not used)
00115   *             x  : Should be set to 0.
00116   */
00117 typedef enum
00118 {
00119   HAL_UART_STATE_RESET             = 0x00U,    /*!< Peripheral is not yet Initialized
00120                                                    Value is allowed for gState and RxState */
00121   HAL_UART_STATE_READY             = 0x20U,    /*!< Peripheral Initialized and ready for use
00122                                                    Value is allowed for gState and RxState */
00123   HAL_UART_STATE_BUSY              = 0x24U,    /*!< an internal process is ongoing
00124                                                    Value is allowed for gState only */
00125   HAL_UART_STATE_BUSY_TX           = 0x21U,    /*!< Data Transmission process is ongoing
00126                                                    Value is allowed for gState only */
00127   HAL_UART_STATE_BUSY_RX           = 0x22U,    /*!< Data Reception process is ongoing
00128                                                    Value is allowed for RxState only */
00129   HAL_UART_STATE_BUSY_TX_RX        = 0x23U,    /*!< Data Transmission and Reception process is ongoing
00130                                                    Not to be used for neither gState nor RxState.
00131                                                    Value is result of combination (Or) between gState and RxState values */
00132   HAL_UART_STATE_TIMEOUT           = 0xA0U,    /*!< Timeout state
00133                                                    Value is allowed for gState only */
00134   HAL_UART_STATE_ERROR             = 0xE0U     /*!< Error
00135                                                    Value is allowed for gState only */
00136 } HAL_UART_StateTypeDef;
00137 
00138 /**
00139   * @brief HAL UART Reception type definition
00140   * @note  HAL UART Reception type value aims to identify which type of Reception is ongoing.
00141   *        It is expected to admit following values :
00142   *           HAL_UART_RECEPTION_STANDARD         = 0x00U,
00143   *           HAL_UART_RECEPTION_TOIDLE           = 0x01U,
00144   */
00145 typedef uint32_t HAL_UART_RxTypeTypeDef;
00146 
00147 /**
00148   * @brief  UART handle Structure definition
00149   */
00150 typedef struct __UART_HandleTypeDef
00151 {
00152   USART_TypeDef                 *Instance;        /*!< UART registers base address        */
00153 
00154   UART_InitTypeDef              Init;             /*!< UART communication parameters      */
00155 
00156   uint8_t                       *pTxBuffPtr;      /*!< Pointer to UART Tx transfer Buffer */
00157 
00158   uint16_t                      TxXferSize;       /*!< UART Tx Transfer size              */
00159 
00160   __IO uint16_t                 TxXferCount;      /*!< UART Tx Transfer Counter           */
00161 
00162   uint8_t                       *pRxBuffPtr;      /*!< Pointer to UART Rx transfer Buffer */
00163 
00164   uint16_t                      RxXferSize;       /*!< UART Rx Transfer size              */
00165 
00166   __IO uint16_t                 RxXferCount;      /*!< UART Rx Transfer Counter           */
00167 
00168   __IO HAL_UART_RxTypeTypeDef ReceptionType;      /*!< Type of ongoing reception          */
00169 
00170   DMA_HandleTypeDef             *hdmatx;          /*!< UART Tx DMA Handle parameters      */
00171 
00172   DMA_HandleTypeDef             *hdmarx;          /*!< UART Rx DMA Handle parameters      */
00173 
00174   HAL_LockTypeDef               Lock;             /*!< Locking object                     */
00175 
00176   __IO HAL_UART_StateTypeDef    gState;           /*!< UART state information related to global Handle management
00177                                                        and also related to Tx operations.
00178                                                        This parameter can be a value of @ref HAL_UART_StateTypeDef */
00179 
00180   __IO HAL_UART_StateTypeDef    RxState;          /*!< UART state information related to Rx operations.
00181                                                        This parameter can be a value of @ref HAL_UART_StateTypeDef */
00182 
00183   __IO uint32_t                 ErrorCode;        /*!< UART Error code                    */
00184 
00185 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
00186   void (* TxHalfCpltCallback)(struct __UART_HandleTypeDef *huart);        /*!< UART Tx Half Complete Callback        */
00187   void (* TxCpltCallback)(struct __UART_HandleTypeDef *huart);            /*!< UART Tx Complete Callback             */
00188   void (* RxHalfCpltCallback)(struct __UART_HandleTypeDef *huart);        /*!< UART Rx Half Complete Callback        */
00189   void (* RxCpltCallback)(struct __UART_HandleTypeDef *huart);            /*!< UART Rx Complete Callback             */
00190   void (* ErrorCallback)(struct __UART_HandleTypeDef *huart);             /*!< UART Error Callback                   */
00191   void (* AbortCpltCallback)(struct __UART_HandleTypeDef *huart);         /*!< UART Abort Complete Callback          */
00192   void (* AbortTransmitCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Transmit Complete Callback */
00193   void (* AbortReceiveCpltCallback)(struct __UART_HandleTypeDef *huart);  /*!< UART Abort Receive Complete Callback  */
00194   void (* WakeupCallback)(struct __UART_HandleTypeDef *huart);            /*!< UART Wakeup Callback                  */
00195   void (* RxEventCallback)(struct __UART_HandleTypeDef *huart, uint16_t Pos); /*!< UART Reception Event Callback     */
00196 
00197   void (* MspInitCallback)(struct __UART_HandleTypeDef *huart);           /*!< UART Msp Init callback                */
00198   void (* MspDeInitCallback)(struct __UART_HandleTypeDef *huart);         /*!< UART Msp DeInit callback              */
00199 #endif  /* USE_HAL_UART_REGISTER_CALLBACKS */
00200 
00201 } UART_HandleTypeDef;
00202 
00203 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
00204 /**
00205   * @brief  HAL UART Callback ID enumeration definition
00206   */
00207 typedef enum
00208 {
00209   HAL_UART_TX_HALFCOMPLETE_CB_ID         = 0x00U,    /*!< UART Tx Half Complete Callback ID        */
00210   HAL_UART_TX_COMPLETE_CB_ID             = 0x01U,    /*!< UART Tx Complete Callback ID             */
00211   HAL_UART_RX_HALFCOMPLETE_CB_ID         = 0x02U,    /*!< UART Rx Half Complete Callback ID        */
00212   HAL_UART_RX_COMPLETE_CB_ID             = 0x03U,    /*!< UART Rx Complete Callback ID             */
00213   HAL_UART_ERROR_CB_ID                   = 0x04U,    /*!< UART Error Callback ID                   */
00214   HAL_UART_ABORT_COMPLETE_CB_ID          = 0x05U,    /*!< UART Abort Complete Callback ID          */
00215   HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U,    /*!< UART Abort Transmit Complete Callback ID */
00216   HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID  = 0x07U,    /*!< UART Abort Receive Complete Callback ID  */
00217   HAL_UART_WAKEUP_CB_ID                  = 0x08U,    /*!< UART Wakeup Callback ID                  */
00218 
00219   HAL_UART_MSPINIT_CB_ID                 = 0x0BU,    /*!< UART MspInit callback ID                 */
00220   HAL_UART_MSPDEINIT_CB_ID               = 0x0CU     /*!< UART MspDeInit callback ID               */
00221 
00222 } HAL_UART_CallbackIDTypeDef;
00223 
00224 /**
00225   * @brief  HAL UART Callback pointer definition
00226   */
00227 typedef  void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart);  /*!< pointer to an UART callback function */
00228 typedef  void (*pUART_RxEventCallbackTypeDef)(struct __UART_HandleTypeDef *huart, uint16_t Pos);   /*!< pointer to a UART Rx Event specific callback function */
00229 
00230 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
00231 
00232 /**
00233   * @}
00234   */
00235 
00236 /* Exported constants --------------------------------------------------------*/
00237 /** @defgroup UART_Exported_Constants UART Exported Constants
00238   * @{
00239   */
00240 
00241 /** @defgroup UART_Error_Code UART Error Code
00242   * @{
00243   */
00244 #define HAL_UART_ERROR_NONE              0x00000000U   /*!< No error            */
00245 #define HAL_UART_ERROR_PE                0x00000001U   /*!< Parity error        */
00246 #define HAL_UART_ERROR_NE                0x00000002U   /*!< Noise error         */
00247 #define HAL_UART_ERROR_FE                0x00000004U   /*!< Frame error         */
00248 #define HAL_UART_ERROR_ORE               0x00000008U   /*!< Overrun error       */
00249 #define HAL_UART_ERROR_DMA               0x00000010U   /*!< DMA transfer error  */
00250 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
00251 #define  HAL_UART_ERROR_INVALID_CALLBACK 0x00000020U   /*!< Invalid Callback error  */
00252 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
00253 /**
00254   * @}
00255   */
00256 
00257 /** @defgroup UART_Word_Length UART Word Length
00258   * @{
00259   */
00260 #define UART_WORDLENGTH_8B                  0x00000000U
00261 #define UART_WORDLENGTH_9B                  ((uint32_t)USART_CR1_M)
00262 /**
00263   * @}
00264   */
00265 
00266 /** @defgroup UART_Stop_Bits UART Number of Stop Bits
00267   * @{
00268   */
00269 #define UART_STOPBITS_1                     0x00000000U
00270 #define UART_STOPBITS_2                     ((uint32_t)USART_CR2_STOP_1)
00271 /**
00272   * @}
00273   */
00274 
00275 /** @defgroup UART_Parity UART Parity
00276   * @{
00277   */
00278 #define UART_PARITY_NONE                    0x00000000U
00279 #define UART_PARITY_EVEN                    ((uint32_t)USART_CR1_PCE)
00280 #define UART_PARITY_ODD                     ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
00281 /**
00282   * @}
00283   */
00284 
00285 /** @defgroup UART_Hardware_Flow_Control UART Hardware Flow Control
00286   * @{
00287   */
00288 #define UART_HWCONTROL_NONE                  0x00000000U
00289 #define UART_HWCONTROL_RTS                   ((uint32_t)USART_CR3_RTSE)
00290 #define UART_HWCONTROL_CTS                   ((uint32_t)USART_CR3_CTSE)
00291 #define UART_HWCONTROL_RTS_CTS               ((uint32_t)(USART_CR3_RTSE | USART_CR3_CTSE))
00292 /**
00293   * @}
00294   */
00295 
00296 /** @defgroup UART_Mode UART Transfer Mode
00297   * @{
00298   */
00299 #define UART_MODE_RX                        ((uint32_t)USART_CR1_RE)
00300 #define UART_MODE_TX                        ((uint32_t)USART_CR1_TE)
00301 #define UART_MODE_TX_RX                     ((uint32_t)(USART_CR1_TE | USART_CR1_RE))
00302 /**
00303   * @}
00304   */
00305 
00306 /** @defgroup UART_State UART State
00307   * @{
00308   */
00309 #define UART_STATE_DISABLE                  0x00000000U
00310 #define UART_STATE_ENABLE                   ((uint32_t)USART_CR1_UE)
00311 /**
00312   * @}
00313   */
00314 
00315 /** @defgroup UART_Over_Sampling UART Over Sampling
00316   * @{
00317   */
00318 #define UART_OVERSAMPLING_16                    0x00000000U
00319 #define UART_OVERSAMPLING_8                     ((uint32_t)USART_CR1_OVER8)
00320 /**
00321   * @}
00322   */
00323 
00324 /** @defgroup UART_LIN_Break_Detection_Length  UART LIN Break Detection Length
00325   * @{
00326   */
00327 #define UART_LINBREAKDETECTLENGTH_10B      0x00000000U
00328 #define UART_LINBREAKDETECTLENGTH_11B      ((uint32_t)USART_CR2_LBDL)
00329 /**
00330   * @}
00331   */
00332 
00333 /** @defgroup UART_WakeUp_functions  UART Wakeup Functions
00334   * @{
00335   */
00336 #define UART_WAKEUPMETHOD_IDLELINE                0x00000000U
00337 #define UART_WAKEUPMETHOD_ADDRESSMARK             ((uint32_t)USART_CR1_WAKE)
00338 /**
00339   * @}
00340   */
00341 
00342 /** @defgroup UART_Flags   UART FLags
00343   *        Elements values convention: 0xXXXX
00344   *           - 0xXXXX  : Flag mask in the SR register
00345   * @{
00346   */
00347 #define UART_FLAG_CTS                       ((uint32_t)USART_SR_CTS)
00348 #define UART_FLAG_LBD                       ((uint32_t)USART_SR_LBD)
00349 #define UART_FLAG_TXE                       ((uint32_t)USART_SR_TXE)
00350 #define UART_FLAG_TC                        ((uint32_t)USART_SR_TC)
00351 #define UART_FLAG_RXNE                      ((uint32_t)USART_SR_RXNE)
00352 #define UART_FLAG_IDLE                      ((uint32_t)USART_SR_IDLE)
00353 #define UART_FLAG_ORE                       ((uint32_t)USART_SR_ORE)
00354 #define UART_FLAG_NE                        ((uint32_t)USART_SR_NE)
00355 #define UART_FLAG_FE                        ((uint32_t)USART_SR_FE)
00356 #define UART_FLAG_PE                        ((uint32_t)USART_SR_PE)
00357 /**
00358   * @}
00359   */
00360 
00361 /** @defgroup UART_Interrupt_definition  UART Interrupt Definitions
00362   *        Elements values convention: 0xY000XXXX
00363   *           - XXXX  : Interrupt mask (16 bits) in the Y register
00364   *           - Y  : Interrupt source register (2bits)
00365   *                   - 0001: CR1 register
00366   *                   - 0010: CR2 register
00367   *                   - 0011: CR3 register
00368   * @{
00369   */
00370 
00371 #define UART_IT_PE                       ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_PEIE))
00372 #define UART_IT_TXE                      ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_TXEIE))
00373 #define UART_IT_TC                       ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_TCIE))
00374 #define UART_IT_RXNE                     ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_RXNEIE))
00375 #define UART_IT_IDLE                     ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_IDLEIE))
00376 
00377 #define UART_IT_LBD                      ((uint32_t)(UART_CR2_REG_INDEX << 28U | USART_CR2_LBDIE))
00378 
00379 #define UART_IT_CTS                      ((uint32_t)(UART_CR3_REG_INDEX << 28U | USART_CR3_CTSIE))
00380 #define UART_IT_ERR                      ((uint32_t)(UART_CR3_REG_INDEX << 28U | USART_CR3_EIE))
00381 /**
00382   * @}
00383   */
00384 
00385 /** @defgroup UART_RECEPTION_TYPE_Values  UART Reception type values
00386   * @{
00387   */
00388 #define HAL_UART_RECEPTION_STANDARD          (0x00000000U)             /*!< Standard reception                       */
00389 #define HAL_UART_RECEPTION_TOIDLE            (0x00000001U)             /*!< Reception till completion or IDLE event  */
00390 /**
00391   * @}
00392   */
00393 
00394 /**
00395   * @}
00396   */
00397 
00398 /* Exported macro ------------------------------------------------------------*/
00399 /** @defgroup UART_Exported_Macros UART Exported Macros
00400   * @{
00401   */
00402 
00403 /** @brief Reset UART handle gstate & RxState
00404   * @param  __HANDLE__ specifies the UART Handle.
00405   *         UART Handle selects the USARTx or UARTy peripheral
00406   *         (USART,UART availability and x,y values depending on device).
00407   * @retval None
00408   */
00409 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
00410 #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__)  do{                                                   \
00411                                                        (__HANDLE__)->gState = HAL_UART_STATE_RESET;      \
00412                                                        (__HANDLE__)->RxState = HAL_UART_STATE_RESET;     \
00413                                                        (__HANDLE__)->MspInitCallback = NULL;             \
00414                                                        (__HANDLE__)->MspDeInitCallback = NULL;           \
00415                                                      } while(0U)
00416 #else
00417 #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__)  do{                                                   \
00418                                                        (__HANDLE__)->gState = HAL_UART_STATE_RESET;      \
00419                                                        (__HANDLE__)->RxState = HAL_UART_STATE_RESET;     \
00420                                                      } while(0U)
00421 #endif /*USE_HAL_UART_REGISTER_CALLBACKS */
00422 
00423 /** @brief  Flushes the UART DR register
00424   * @param  __HANDLE__ specifies the UART Handle.
00425   *         UART Handle selects the USARTx or UARTy peripheral
00426   *         (USART,UART availability and x,y values depending on device).
00427   */
00428 #define __HAL_UART_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
00429 
00430 /** @brief  Checks whether the specified UART flag is set or not.
00431   * @param  __HANDLE__ specifies the UART Handle.
00432   *         UART Handle selects the USARTx or UARTy peripheral
00433   *         (USART,UART availability and x,y values depending on device).
00434   * @param  __FLAG__ specifies the flag to check.
00435   *        This parameter can be one of the following values:
00436   *            @arg UART_FLAG_CTS:  CTS Change flag (not available for UART4 and UART5)
00437   *            @arg UART_FLAG_LBD:  LIN Break detection flag
00438   *            @arg UART_FLAG_TXE:  Transmit data register empty flag
00439   *            @arg UART_FLAG_TC:   Transmission Complete flag
00440   *            @arg UART_FLAG_RXNE: Receive data register not empty flag
00441   *            @arg UART_FLAG_IDLE: Idle Line detection flag
00442   *            @arg UART_FLAG_ORE:  Overrun Error flag
00443   *            @arg UART_FLAG_NE:   Noise Error flag
00444   *            @arg UART_FLAG_FE:   Framing Error flag
00445   *            @arg UART_FLAG_PE:   Parity Error flag
00446   * @retval The new state of __FLAG__ (TRUE or FALSE).
00447   */
00448 #define __HAL_UART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
00449 
00450 /** @brief  Clears the specified UART pending flag.
00451   * @param  __HANDLE__ specifies the UART Handle.
00452   *         UART Handle selects the USARTx or UARTy peripheral
00453   *         (USART,UART availability and x,y values depending on device).
00454   * @param  __FLAG__ specifies the flag to check.
00455   *          This parameter can be any combination of the following values:
00456   *            @arg UART_FLAG_CTS:  CTS Change flag (not available for UART4 and UART5).
00457   *            @arg UART_FLAG_LBD:  LIN Break detection flag.
00458   *            @arg UART_FLAG_TC:   Transmission Complete flag.
00459   *            @arg UART_FLAG_RXNE: Receive data register not empty flag.
00460   *
00461   * @note   PE (Parity error), FE (Framing error), NE (Noise error), ORE (Overrun
00462   *          error) and IDLE (Idle line detected) flags are cleared by software
00463   *          sequence: a read operation to USART_SR register followed by a read
00464   *          operation to USART_DR register.
00465   * @note   RXNE flag can be also cleared by a read to the USART_DR register.
00466   * @note   TC flag can be also cleared by software sequence: a read operation to
00467   *          USART_SR register followed by a write operation to USART_DR register.
00468   * @note   TXE flag is cleared only by a write to the USART_DR register.
00469   *
00470   * @retval None
00471   */
00472 #define __HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
00473 
00474 /** @brief  Clears the UART PE pending flag.
00475   * @param  __HANDLE__ specifies the UART Handle.
00476   *         UART Handle selects the USARTx or UARTy peripheral
00477   *         (USART,UART availability and x,y values depending on device).
00478   * @retval None
00479   */
00480 #define __HAL_UART_CLEAR_PEFLAG(__HANDLE__)     \
00481   do{                                           \
00482     __IO uint32_t tmpreg = 0x00U;               \
00483     tmpreg = (__HANDLE__)->Instance->SR;        \
00484     tmpreg = (__HANDLE__)->Instance->DR;        \
00485     UNUSED(tmpreg);                             \
00486   } while(0U)
00487 
00488 /** @brief  Clears the UART FE pending flag.
00489   * @param  __HANDLE__ specifies the UART Handle.
00490   *         UART Handle selects the USARTx or UARTy peripheral
00491   *         (USART,UART availability and x,y values depending on device).
00492   * @retval None
00493   */
00494 #define __HAL_UART_CLEAR_FEFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
00495 
00496 /** @brief  Clears the UART NE pending flag.
00497   * @param  __HANDLE__ specifies the UART Handle.
00498   *         UART Handle selects the USARTx or UARTy peripheral
00499   *         (USART,UART availability and x,y values depending on device).
00500   * @retval None
00501   */
00502 #define __HAL_UART_CLEAR_NEFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
00503 
00504 /** @brief  Clears the UART ORE pending flag.
00505   * @param  __HANDLE__ specifies the UART Handle.
00506   *         UART Handle selects the USARTx or UARTy peripheral
00507   *         (USART,UART availability and x,y values depending on device).
00508   * @retval None
00509   */
00510 #define __HAL_UART_CLEAR_OREFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
00511 
00512 /** @brief  Clears the UART IDLE pending flag.
00513   * @param  __HANDLE__ specifies the UART Handle.
00514   *         UART Handle selects the USARTx or UARTy peripheral
00515   *         (USART,UART availability and x,y values depending on device).
00516   * @retval None
00517   */
00518 #define __HAL_UART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
00519 
00520 /** @brief  Enable the specified UART interrupt.
00521   * @param  __HANDLE__ specifies the UART Handle.
00522   *         UART Handle selects the USARTx or UARTy peripheral
00523   *         (USART,UART availability and x,y values depending on device).
00524   * @param  __INTERRUPT__ specifies the UART interrupt source to enable.
00525   *          This parameter can be one of the following values:
00526   *            @arg UART_IT_CTS:  CTS change interrupt
00527   *            @arg UART_IT_LBD:  LIN Break detection interrupt
00528   *            @arg UART_IT_TXE:  Transmit Data Register empty interrupt
00529   *            @arg UART_IT_TC:   Transmission complete interrupt
00530   *            @arg UART_IT_RXNE: Receive Data register not empty interrupt
00531   *            @arg UART_IT_IDLE: Idle line detection interrupt
00532   *            @arg UART_IT_PE:   Parity Error interrupt
00533   *            @arg UART_IT_ERR:  Error interrupt(Frame error, noise error, overrun error)
00534   * @retval None
00535   */
00536 #define __HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((((__INTERRUPT__) >> 28U) == UART_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & UART_IT_MASK)): \
00537                                                            (((__INTERRUPT__) >> 28U) == UART_CR2_REG_INDEX)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & UART_IT_MASK)): \
00538                                                            ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & UART_IT_MASK)))
00539 
00540 /** @brief  Disable the specified UART interrupt.
00541   * @param  __HANDLE__ specifies the UART Handle.
00542   *         UART Handle selects the USARTx or UARTy peripheral
00543   *         (USART,UART availability and x,y values depending on device).
00544   * @param  __INTERRUPT__ specifies the UART interrupt source to disable.
00545   *          This parameter can be one of the following values:
00546   *            @arg UART_IT_CTS:  CTS change interrupt
00547   *            @arg UART_IT_LBD:  LIN Break detection interrupt
00548   *            @arg UART_IT_TXE:  Transmit Data Register empty interrupt
00549   *            @arg UART_IT_TC:   Transmission complete interrupt
00550   *            @arg UART_IT_RXNE: Receive Data register not empty interrupt
00551   *            @arg UART_IT_IDLE: Idle line detection interrupt
00552   *            @arg UART_IT_PE:   Parity Error interrupt
00553   *            @arg UART_IT_ERR:  Error interrupt(Frame error, noise error, overrun error)
00554   * @retval None
00555   */
00556 #define __HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__)  ((((__INTERRUPT__) >> 28U) == UART_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & UART_IT_MASK)): \
00557                                                            (((__INTERRUPT__) >> 28U) == UART_CR2_REG_INDEX)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & UART_IT_MASK)): \
00558                                                            ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & UART_IT_MASK)))
00559 
00560 /** @brief  Checks whether the specified UART interrupt source is enabled or not.
00561   * @param  __HANDLE__ specifies the UART Handle.
00562   *         UART Handle selects the USARTx or UARTy peripheral
00563   *         (USART,UART availability and x,y values depending on device).
00564   * @param  __IT__ specifies the UART interrupt source to check.
00565   *          This parameter can be one of the following values:
00566   *            @arg UART_IT_CTS: CTS change interrupt (not available for UART4 and UART5)
00567   *            @arg UART_IT_LBD: LIN Break detection interrupt
00568   *            @arg UART_IT_TXE: Transmit Data Register empty interrupt
00569   *            @arg UART_IT_TC:  Transmission complete interrupt
00570   *            @arg UART_IT_RXNE: Receive Data register not empty interrupt
00571   *            @arg UART_IT_IDLE: Idle line detection interrupt
00572   *            @arg UART_IT_ERR: Error interrupt
00573   * @retval The new state of __IT__ (TRUE or FALSE).
00574   */
00575 #define __HAL_UART_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28U) == UART_CR1_REG_INDEX)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28U) == UART_CR2_REG_INDEX)? \
00576                                                        (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & UART_IT_MASK))
00577 
00578 /** @brief  Enable CTS flow control
00579   * @note   This macro allows to enable CTS hardware flow control for a given UART instance,
00580   *         without need to call HAL_UART_Init() function.
00581   *         As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
00582   * @note   As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
00583   *         for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
00584   *           - UART instance should have already been initialised (through call of HAL_UART_Init() )
00585   *           - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
00586   *             and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
00587   * @param  __HANDLE__ specifies the UART Handle.
00588   *         The Handle Instance can be any USARTx (supporting the HW Flow control feature).
00589   *         It is used to select the USART peripheral (USART availability and x value depending on device).
00590   * @retval None
00591   */
00592 #define __HAL_UART_HWCONTROL_CTS_ENABLE(__HANDLE__)        \
00593   do{                                                      \
00594     ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE);  \
00595     (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_CTSE;        \
00596   } while(0U)
00597 
00598 /** @brief  Disable CTS flow control
00599   * @note   This macro allows to disable CTS hardware flow control for a given UART instance,
00600   *         without need to call HAL_UART_Init() function.
00601   *         As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
00602   * @note   As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
00603   *         for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
00604   *           - UART instance should have already been initialised (through call of HAL_UART_Init() )
00605   *           - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
00606   *             and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
00607   * @param  __HANDLE__ specifies the UART Handle.
00608   *         The Handle Instance can be any USARTx (supporting the HW Flow control feature).
00609   *         It is used to select the USART peripheral (USART availability and x value depending on device).
00610   * @retval None
00611   */
00612 #define __HAL_UART_HWCONTROL_CTS_DISABLE(__HANDLE__)        \
00613   do{                                                       \
00614     ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
00615     (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_CTSE);      \
00616   } while(0U)
00617 
00618 /** @brief  Enable RTS flow control
00619   *         This macro allows to enable RTS hardware flow control for a given UART instance,
00620   *         without need to call HAL_UART_Init() function.
00621   *         As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
00622   * @note   As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
00623   *         for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
00624   *           - UART instance should have already been initialised (through call of HAL_UART_Init() )
00625   *           - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
00626   *             and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
00627   * @param  __HANDLE__ specifies the UART Handle.
00628   *         The Handle Instance can be any USARTx (supporting the HW Flow control feature).
00629   *         It is used to select the USART peripheral (USART availability and x value depending on device).
00630   * @retval None
00631   */
00632 #define __HAL_UART_HWCONTROL_RTS_ENABLE(__HANDLE__)       \
00633   do{                                                     \
00634     ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE); \
00635     (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_RTSE;       \
00636   } while(0U)
00637 
00638 /** @brief  Disable RTS flow control
00639   *         This macro allows to disable RTS hardware flow control for a given UART instance,
00640   *         without need to call HAL_UART_Init() function.
00641   *         As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
00642   * @note   As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
00643   *         for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
00644   *           - UART instance should have already been initialised (through call of HAL_UART_Init() )
00645   *           - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
00646   *             and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
00647   * @param  __HANDLE__ specifies the UART Handle.
00648   *         The Handle Instance can be any USARTx (supporting the HW Flow control feature).
00649   *         It is used to select the USART peripheral (USART availability and x value depending on device).
00650   * @retval None
00651   */
00652 #define __HAL_UART_HWCONTROL_RTS_DISABLE(__HANDLE__)       \
00653   do{                                                      \
00654     ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE);\
00655     (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_RTSE);     \
00656   } while(0U)
00657 
00658 /** @brief  Macro to enable the UART's one bit sample method
00659   * @param  __HANDLE__ specifies the UART Handle.
00660   * @retval None
00661   */
00662 #define __HAL_UART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
00663 
00664 /** @brief  Macro to disable the UART's one bit sample method
00665   * @param  __HANDLE__ specifies the UART Handle.
00666   * @retval None
00667   */
00668 #define __HAL_UART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\
00669                                                        &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
00670 
00671 /** @brief  Enable UART
00672   * @param  __HANDLE__ specifies the UART Handle.
00673   * @retval None
00674   */
00675 #define __HAL_UART_ENABLE(__HANDLE__)               ((__HANDLE__)->Instance->CR1 |=  USART_CR1_UE)
00676 
00677 /** @brief  Disable UART
00678   * @param  __HANDLE__ specifies the UART Handle.
00679   * @retval None
00680   */
00681 #define __HAL_UART_DISABLE(__HANDLE__)              ((__HANDLE__)->Instance->CR1 &=  ~USART_CR1_UE)
00682 /**
00683   * @}
00684   */
00685 
00686 /* Exported functions --------------------------------------------------------*/
00687 /** @addtogroup UART_Exported_Functions
00688   * @{
00689   */
00690 
00691 /** @addtogroup UART_Exported_Functions_Group1 Initialization and de-initialization functions
00692   * @{
00693   */
00694 
00695 /* Initialization/de-initialization functions  **********************************/
00696 HAL_StatusTypeDef HAL_UART_Init(UART_HandleTypeDef *huart);
00697 HAL_StatusTypeDef HAL_HalfDuplex_Init(UART_HandleTypeDef *huart);
00698 HAL_StatusTypeDef HAL_LIN_Init(UART_HandleTypeDef *huart, uint32_t BreakDetectLength);
00699 HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod);
00700 HAL_StatusTypeDef HAL_UART_DeInit(UART_HandleTypeDef *huart);
00701 void HAL_UART_MspInit(UART_HandleTypeDef *huart);
00702 void HAL_UART_MspDeInit(UART_HandleTypeDef *huart);
00703 
00704 /* Callbacks Register/UnRegister functions  ***********************************/
00705 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
00706 HAL_StatusTypeDef HAL_UART_RegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID,
00707                                             pUART_CallbackTypeDef pCallback);
00708 HAL_StatusTypeDef HAL_UART_UnRegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID);
00709 
00710 HAL_StatusTypeDef HAL_UART_RegisterRxEventCallback(UART_HandleTypeDef *huart, pUART_RxEventCallbackTypeDef pCallback);
00711 HAL_StatusTypeDef HAL_UART_UnRegisterRxEventCallback(UART_HandleTypeDef *huart);
00712 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
00713 
00714 /**
00715   * @}
00716   */
00717 
00718 /** @addtogroup UART_Exported_Functions_Group2 IO operation functions
00719   * @{
00720   */
00721 
00722 /* IO operation functions *******************************************************/
00723 HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
00724 HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
00725 HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
00726 HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
00727 HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
00728 HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
00729 HAL_StatusTypeDef HAL_UART_DMAPause(UART_HandleTypeDef *huart);
00730 HAL_StatusTypeDef HAL_UART_DMAResume(UART_HandleTypeDef *huart);
00731 HAL_StatusTypeDef HAL_UART_DMAStop(UART_HandleTypeDef *huart);
00732 
00733 HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint16_t *RxLen,
00734                                            uint32_t Timeout);
00735 HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
00736 HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
00737 
00738 /* Transfer Abort functions */
00739 HAL_StatusTypeDef HAL_UART_Abort(UART_HandleTypeDef *huart);
00740 HAL_StatusTypeDef HAL_UART_AbortTransmit(UART_HandleTypeDef *huart);
00741 HAL_StatusTypeDef HAL_UART_AbortReceive(UART_HandleTypeDef *huart);
00742 HAL_StatusTypeDef HAL_UART_Abort_IT(UART_HandleTypeDef *huart);
00743 HAL_StatusTypeDef HAL_UART_AbortTransmit_IT(UART_HandleTypeDef *huart);
00744 HAL_StatusTypeDef HAL_UART_AbortReceive_IT(UART_HandleTypeDef *huart);
00745 
00746 void HAL_UART_IRQHandler(UART_HandleTypeDef *huart);
00747 void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart);
00748 void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart);
00749 void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart);
00750 void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart);
00751 void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart);
00752 void HAL_UART_AbortCpltCallback(UART_HandleTypeDef *huart);
00753 void HAL_UART_AbortTransmitCpltCallback(UART_HandleTypeDef *huart);
00754 void HAL_UART_AbortReceiveCpltCallback(UART_HandleTypeDef *huart);
00755 
00756 void HAL_UARTEx_RxEventCallback(UART_HandleTypeDef *huart, uint16_t Size);
00757 
00758 /**
00759   * @}
00760   */
00761 
00762 /** @addtogroup UART_Exported_Functions_Group3
00763   * @{
00764   */
00765 /* Peripheral Control functions  ************************************************/
00766 HAL_StatusTypeDef HAL_LIN_SendBreak(UART_HandleTypeDef *huart);
00767 HAL_StatusTypeDef HAL_MultiProcessor_EnterMuteMode(UART_HandleTypeDef *huart);
00768 HAL_StatusTypeDef HAL_MultiProcessor_ExitMuteMode(UART_HandleTypeDef *huart);
00769 HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter(UART_HandleTypeDef *huart);
00770 HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver(UART_HandleTypeDef *huart);
00771 /**
00772   * @}
00773   */
00774 
00775 /** @addtogroup UART_Exported_Functions_Group4
00776   * @{
00777   */
00778 /* Peripheral State functions  **************************************************/
00779 HAL_UART_StateTypeDef HAL_UART_GetState(UART_HandleTypeDef *huart);
00780 uint32_t              HAL_UART_GetError(UART_HandleTypeDef *huart);
00781 /**
00782   * @}
00783   */
00784 
00785 /**
00786   * @}
00787   */
00788 /* Private types -------------------------------------------------------------*/
00789 /* Private variables ---------------------------------------------------------*/
00790 /* Private constants ---------------------------------------------------------*/
00791 /** @defgroup UART_Private_Constants UART Private Constants
00792   * @{
00793   */
00794 /** @brief UART interruptions flag mask
00795   *
00796   */
00797 #define UART_IT_MASK                     0x0000FFFFU
00798 
00799 #define UART_CR1_REG_INDEX               1U
00800 #define UART_CR2_REG_INDEX               2U
00801 #define UART_CR3_REG_INDEX               3U
00802 /**
00803   * @}
00804   */
00805 
00806 /* Private macros ------------------------------------------------------------*/
00807 /** @defgroup UART_Private_Macros UART Private Macros
00808   * @{
00809   */
00810 #define IS_UART_WORD_LENGTH(LENGTH) (((LENGTH) == UART_WORDLENGTH_8B) || \
00811                                      ((LENGTH) == UART_WORDLENGTH_9B))
00812 #define IS_UART_LIN_WORD_LENGTH(LENGTH) (((LENGTH) == UART_WORDLENGTH_8B))
00813 #define IS_UART_STOPBITS(STOPBITS) (((STOPBITS) == UART_STOPBITS_1) || \
00814                                     ((STOPBITS) == UART_STOPBITS_2))
00815 #define IS_UART_PARITY(PARITY) (((PARITY) == UART_PARITY_NONE) || \
00816                                 ((PARITY) == UART_PARITY_EVEN) || \
00817                                 ((PARITY) == UART_PARITY_ODD))
00818 #define IS_UART_HARDWARE_FLOW_CONTROL(CONTROL)\
00819                               (((CONTROL) == UART_HWCONTROL_NONE) || \
00820                                ((CONTROL) == UART_HWCONTROL_RTS) || \
00821                                ((CONTROL) == UART_HWCONTROL_CTS) || \
00822                                ((CONTROL) == UART_HWCONTROL_RTS_CTS))
00823 #define IS_UART_MODE(MODE) ((((MODE) & 0x0000FFF3U) == 0x00U) && ((MODE) != 0x00U))
00824 #define IS_UART_STATE(STATE) (((STATE) == UART_STATE_DISABLE) || \
00825                               ((STATE) == UART_STATE_ENABLE))
00826 #define IS_UART_OVERSAMPLING(SAMPLING) (((SAMPLING) == UART_OVERSAMPLING_16) || \
00827                                         ((SAMPLING) == UART_OVERSAMPLING_8))
00828 #define IS_UART_LIN_OVERSAMPLING(SAMPLING) (((SAMPLING) == UART_OVERSAMPLING_16))
00829 #define IS_UART_LIN_BREAK_DETECT_LENGTH(LENGTH) (((LENGTH) == UART_LINBREAKDETECTLENGTH_10B) || \
00830                                                  ((LENGTH) == UART_LINBREAKDETECTLENGTH_11B))
00831 #define IS_UART_WAKEUPMETHOD(WAKEUP) (((WAKEUP) == UART_WAKEUPMETHOD_IDLELINE) || \
00832                                       ((WAKEUP) == UART_WAKEUPMETHOD_ADDRESSMARK))
00833 #define IS_UART_BAUDRATE(BAUDRATE) ((BAUDRATE) <= 10500000U)
00834 #define IS_UART_ADDRESS(ADDRESS) ((ADDRESS) <= 0x0FU)
00835 
00836 #define UART_DIV_SAMPLING16(_PCLK_, _BAUD_)            ((uint32_t)((((uint64_t)(_PCLK_))*25U)/(4U*((uint64_t)(_BAUD_)))))
00837 #define UART_DIVMANT_SAMPLING16(_PCLK_, _BAUD_)        (UART_DIV_SAMPLING16((_PCLK_), (_BAUD_))/100U)
00838 #define UART_DIVFRAQ_SAMPLING16(_PCLK_, _BAUD_)        ((((UART_DIV_SAMPLING16((_PCLK_), (_BAUD_)) - (UART_DIVMANT_SAMPLING16((_PCLK_), (_BAUD_)) * 100U)) * 16U)\
00839                                                          + 50U) / 100U)
00840 /* UART BRR = mantissa + overflow + fraction
00841             = (UART DIVMANT << 4) + (UART DIVFRAQ & 0xF0) + (UART DIVFRAQ & 0x0FU) */
00842 #define UART_BRR_SAMPLING16(_PCLK_, _BAUD_)            ((UART_DIVMANT_SAMPLING16((_PCLK_), (_BAUD_)) << 4U) + \
00843                                                         (UART_DIVFRAQ_SAMPLING16((_PCLK_), (_BAUD_)) & 0xF0U) + \
00844                                                         (UART_DIVFRAQ_SAMPLING16((_PCLK_), (_BAUD_)) & 0x0FU))
00845 
00846 #define UART_DIV_SAMPLING8(_PCLK_, _BAUD_)             ((uint32_t)((((uint64_t)(_PCLK_))*25U)/(2U*((uint64_t)(_BAUD_)))))
00847 #define UART_DIVMANT_SAMPLING8(_PCLK_, _BAUD_)         (UART_DIV_SAMPLING8((_PCLK_), (_BAUD_))/100U)
00848 #define UART_DIVFRAQ_SAMPLING8(_PCLK_, _BAUD_)         ((((UART_DIV_SAMPLING8((_PCLK_), (_BAUD_)) - (UART_DIVMANT_SAMPLING8((_PCLK_), (_BAUD_)) * 100U)) * 8U)\
00849                                                          + 50U) / 100U)
00850 /* UART BRR = mantissa + overflow + fraction
00851             = (UART DIVMANT << 4) + ((UART DIVFRAQ & 0xF8) << 1) + (UART DIVFRAQ & 0x07U) */
00852 #define UART_BRR_SAMPLING8(_PCLK_, _BAUD_)             ((UART_DIVMANT_SAMPLING8((_PCLK_), (_BAUD_)) << 4U) + \
00853                                                         ((UART_DIVFRAQ_SAMPLING8((_PCLK_), (_BAUD_)) & 0xF8U) << 1U) + \
00854                                                         (UART_DIVFRAQ_SAMPLING8((_PCLK_), (_BAUD_)) & 0x07U))
00855 
00856 /**
00857   * @}
00858   */
00859 
00860 /* Private functions ---------------------------------------------------------*/
00861 /** @defgroup UART_Private_Functions UART Private Functions
00862   * @{
00863   */
00864 
00865 HAL_StatusTypeDef UART_Start_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
00866 HAL_StatusTypeDef UART_Start_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
00867 
00868 /**
00869   * @}
00870   */
00871 
00872 /**
00873   * @}
00874   */
00875 
00876 /**
00877   * @}
00878   */
00879 
00880 #ifdef __cplusplus
00881 }
00882 #endif
00883 
00884 #endif /* __STM32F4xx_HAL_UART_H */
00885 
00886 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/