mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

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

Last commit 20 Feb 2019 by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_usart.h@369:2e96f1b71984, 2014-10-27 (annotated)

Committer:
mbed_official
Date:
Mon Oct 27 09:45:07 2014 +0000
Revision:
369:2e96f1b71984
Parent:
226:b062af740e40 
Synchronized with git revision 2d1f64de28cfb25c0e602532e3ce5ad1d9accbed



Full URL: https://github.com/mbedmicro/mbed/commit/2d1f64de28cfb25c0e602532e3ce5ad1d9accbed/



CMSIS: NUCLEO_F401RE - Update STM32Cube driver

Who changed what in which revision?

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