Egor Rumjantsev / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

TARGET_NUCLEO_F411RE/stm32f4xx_hal_usart.h@99:7f6c6de930c0, 2015-05-03 (annotated)

Committer:
Mikchel
Date:
Sun May 03 16:04:42 2015 +0000
Revision:
99:7f6c6de930c0
Parent:
86:04dd9b1680ae 
12

Who changed what in which revision?

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