Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_ARCH_MAX/stm32f4xx_hal_usart.h@89:552587b429a1, 2014-09-12 (annotated)

Committer:
bogdanm
Date:
Fri Sep 12 16:41:52 2014 +0100
Revision:
89:552587b429a1
Child:
92:4fc01daae5a5
Release 89 of the mbed library



Main changes:



- low power optimizations for Nordic targets

- code structure changes for Freescale K64F targets

- bug fixes in various backends

Who changed what in which revision?

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