mbed library sources

Dependents:   frdm_kl05z_gpio_test

Fork of mbed-src by mbed official

Committer:
shaoziyang
Date:
Sat Sep 13 14:25:46 2014 +0000
Revision:
323:9e901b0a5aa1
Parent:
235:685d5f11838f
test with CLOCK_SETUP = 0

Who changed what in which revision?

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