mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_STM/TARGET_STM32L0/device/stm32l0xx_hal_usart.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
186:707f6e361f3e 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /**
<> 144:ef7eb2e8f9f7 2 ******************************************************************************
<> 144:ef7eb2e8f9f7 3 * @file stm32l0xx_hal_usart.h
<> 144:ef7eb2e8f9f7 4 * @author MCD Application Team
<> 144:ef7eb2e8f9f7 5 * @brief Header file of USART HAL module.
<> 144:ef7eb2e8f9f7 6 ******************************************************************************
<> 144:ef7eb2e8f9f7 7 * @attention
<> 144:ef7eb2e8f9f7 8 *
<> 144:ef7eb2e8f9f7 9 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
<> 144:ef7eb2e8f9f7 10 *
<> 144:ef7eb2e8f9f7 11 * Redistribution and use in source and binary forms, with or without modification,
<> 144:ef7eb2e8f9f7 12 * are permitted provided that the following conditions are met:
<> 144:ef7eb2e8f9f7 13 * 1. Redistributions of source code must retain the above copyright notice,
<> 144:ef7eb2e8f9f7 14 * this list of conditions and the following disclaimer.
<> 144:ef7eb2e8f9f7 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
<> 144:ef7eb2e8f9f7 16 * this list of conditions and the following disclaimer in the documentation
<> 144:ef7eb2e8f9f7 17 * and/or other materials provided with the distribution.
<> 144:ef7eb2e8f9f7 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
<> 144:ef7eb2e8f9f7 19 * may be used to endorse or promote products derived from this software
<> 144:ef7eb2e8f9f7 20 * without specific prior written permission.
<> 144:ef7eb2e8f9f7 21 *
<> 144:ef7eb2e8f9f7 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
<> 144:ef7eb2e8f9f7 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
<> 144:ef7eb2e8f9f7 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
<> 144:ef7eb2e8f9f7 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
<> 144:ef7eb2e8f9f7 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
<> 144:ef7eb2e8f9f7 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
<> 144:ef7eb2e8f9f7 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
<> 144:ef7eb2e8f9f7 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
<> 144:ef7eb2e8f9f7 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
<> 144:ef7eb2e8f9f7 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<> 144:ef7eb2e8f9f7 32 *
<> 144:ef7eb2e8f9f7 33 ******************************************************************************
Anna Bridge 186:707f6e361f3e 34 */
<> 144:ef7eb2e8f9f7 35
<> 144:ef7eb2e8f9f7 36 /* Define to prevent recursive inclusion -------------------------------------*/
<> 144:ef7eb2e8f9f7 37 #ifndef __STM32L0xx_HAL_USART_H
<> 144:ef7eb2e8f9f7 38 #define __STM32L0xx_HAL_USART_H
<> 144:ef7eb2e8f9f7 39
<> 144:ef7eb2e8f9f7 40 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 41 extern "C" {
<> 144:ef7eb2e8f9f7 42 #endif
<> 144:ef7eb2e8f9f7 43
<> 144:ef7eb2e8f9f7 44 /* Includes ------------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 45 #include "stm32l0xx_hal_def.h"
<> 144:ef7eb2e8f9f7 46
<> 144:ef7eb2e8f9f7 47 /** @addtogroup STM32L0xx_HAL_Driver
<> 144:ef7eb2e8f9f7 48 * @{
<> 144:ef7eb2e8f9f7 49 */
<> 144:ef7eb2e8f9f7 50
Anna Bridge 186:707f6e361f3e 51 /** @addtogroup USART
<> 144:ef7eb2e8f9f7 52 * @{
<> 144:ef7eb2e8f9f7 53 */
<> 144:ef7eb2e8f9f7 54
Anna Bridge 186:707f6e361f3e 55 /* Exported types ------------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 56 /** @defgroup USART_Exported_Types USART Exported Types
<> 144:ef7eb2e8f9f7 57 * @{
<> 144:ef7eb2e8f9f7 58 */
Anna Bridge 186:707f6e361f3e 59
Anna Bridge 186:707f6e361f3e 60 /**
Anna Bridge 186:707f6e361f3e 61 * @brief USART Init Structure definition
Anna Bridge 186:707f6e361f3e 62 */
<> 144:ef7eb2e8f9f7 63 typedef struct
<> 144:ef7eb2e8f9f7 64 {
<> 144:ef7eb2e8f9f7 65 uint32_t BaudRate; /*!< This member configures the Usart communication baud rate.
<> 144:ef7eb2e8f9f7 66 The baud rate is computed using the following formula:
Anna Bridge 186:707f6e361f3e 67 Baud Rate Register = ((PCLKx) / ((huart->Init.BaudRate))). */
<> 144:ef7eb2e8f9f7 68
<> 144:ef7eb2e8f9f7 69 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
Anna Bridge 186:707f6e361f3e 70 This parameter can be a value of @ref USARTEx_Word_Length. */
<> 144:ef7eb2e8f9f7 71
<> 144:ef7eb2e8f9f7 72 uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
Anna Bridge 186:707f6e361f3e 73 This parameter can be a value of @ref USART_Stop_Bits. */
<> 144:ef7eb2e8f9f7 74
<> 144:ef7eb2e8f9f7 75 uint32_t Parity; /*!< Specifies the parity mode.
<> 144:ef7eb2e8f9f7 76 This parameter can be a value of @ref USART_Parity
<> 144:ef7eb2e8f9f7 77 @note When parity is enabled, the computed parity is inserted
<> 144:ef7eb2e8f9f7 78 at the MSB position of the transmitted data (9th bit when
<> 144:ef7eb2e8f9f7 79 the word length is set to 9 data bits; 8th bit when the
<> 144:ef7eb2e8f9f7 80 word length is set to 8 data bits). */
Anna Bridge 186:707f6e361f3e 81
Anna Bridge 186:707f6e361f3e 82 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
Anna Bridge 186:707f6e361f3e 83 This parameter can be a value of @ref USART_Mode. */
<> 144:ef7eb2e8f9f7 84
<> 144:ef7eb2e8f9f7 85 uint32_t CLKPolarity; /*!< Specifies the steady state of the serial clock.
Anna Bridge 186:707f6e361f3e 86 This parameter can be a value of @ref USART_Clock_Polarity. */
<> 144:ef7eb2e8f9f7 87
<> 144:ef7eb2e8f9f7 88 uint32_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made.
Anna Bridge 186:707f6e361f3e 89 This parameter can be a value of @ref USART_Clock_Phase. */
<> 144:ef7eb2e8f9f7 90
<> 144:ef7eb2e8f9f7 91 uint32_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted
<> 144:ef7eb2e8f9f7 92 data bit (MSB) has to be output on the SCLK pin in synchronous mode.
Anna Bridge 186:707f6e361f3e 93 This parameter can be a value of @ref USART_Last_Bit. */
<> 144:ef7eb2e8f9f7 94 }USART_InitTypeDef;
<> 144:ef7eb2e8f9f7 95
<> 144:ef7eb2e8f9f7 96 /**
Anna Bridge 186:707f6e361f3e 97 * @brief HAL USART State structures definition
<> 144:ef7eb2e8f9f7 98 */
<> 144:ef7eb2e8f9f7 99 typedef enum
<> 144:ef7eb2e8f9f7 100 {
Anna Bridge 186:707f6e361f3e 101 HAL_USART_STATE_RESET = 0x00U, /*!< Peripheral is not initialized */
Anna Bridge 186:707f6e361f3e 102 HAL_USART_STATE_READY = 0x01U, /*!< Peripheral Initialized and ready for use */
Anna Bridge 186:707f6e361f3e 103 HAL_USART_STATE_BUSY = 0x02U, /*!< an internal process is ongoing */
Anna Bridge 186:707f6e361f3e 104 HAL_USART_STATE_BUSY_TX = 0x12U, /*!< Data Transmission process is ongoing */
Anna Bridge 186:707f6e361f3e 105 HAL_USART_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing */
<> 151:5eaa88a5bcc7 106 HAL_USART_STATE_BUSY_TX_RX = 0x32U, /*!< Data Transmission Reception process is ongoing */
Anna Bridge 186:707f6e361f3e 107 HAL_USART_STATE_TIMEOUT = 0x03U, /*!< Timeout state */
Anna Bridge 186:707f6e361f3e 108 HAL_USART_STATE_ERROR = 0x04U /*!< Error */
<> 144:ef7eb2e8f9f7 109 }HAL_USART_StateTypeDef;
Anna Bridge 186:707f6e361f3e 110
<> 144:ef7eb2e8f9f7 111 /**
Anna Bridge 186:707f6e361f3e 112 * @brief HAL USART Error Code structure definition
<> 144:ef7eb2e8f9f7 113 */
<> 151:5eaa88a5bcc7 114 #define HAL_USART_ERROR_NONE ((uint32_t)0x00U) /*!< No error */
<> 151:5eaa88a5bcc7 115 #define HAL_USART_ERROR_PE ((uint32_t)0x01U) /*!< Parity error */
<> 151:5eaa88a5bcc7 116 #define HAL_USART_ERROR_NE ((uint32_t)0x02U) /*!< Noise error */
<> 151:5eaa88a5bcc7 117 #define HAL_USART_ERROR_FE ((uint32_t)0x04U) /*!< frame error */
<> 151:5eaa88a5bcc7 118 #define HAL_USART_ERROR_ORE ((uint32_t)0x08U) /*!< Overrun error */
<> 151:5eaa88a5bcc7 119 #define HAL_USART_ERROR_DMA ((uint32_t)0x10U) /*!< DMA transfer error */
<> 144:ef7eb2e8f9f7 120
<> 144:ef7eb2e8f9f7 121 /**
<> 144:ef7eb2e8f9f7 122 * @brief USART clock sources definitions
<> 144:ef7eb2e8f9f7 123 */
<> 144:ef7eb2e8f9f7 124 typedef enum
<> 144:ef7eb2e8f9f7 125 {
Anna Bridge 186:707f6e361f3e 126 USART_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */
Anna Bridge 186:707f6e361f3e 127 USART_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */
Anna Bridge 186:707f6e361f3e 128 USART_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */
Anna Bridge 186:707f6e361f3e 129 USART_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */
Anna Bridge 186:707f6e361f3e 130 USART_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */
<> 151:5eaa88a5bcc7 131 USART_CLOCKSOURCE_UNDEFINED = 0x10U /*!< Undefined clock source */
<> 144:ef7eb2e8f9f7 132 }USART_ClockSourceTypeDef;
Anna Bridge 186:707f6e361f3e 133
Anna Bridge 186:707f6e361f3e 134
<> 144:ef7eb2e8f9f7 135 /**
Anna Bridge 186:707f6e361f3e 136 * @brief USART handle Structure definition
<> 144:ef7eb2e8f9f7 137 */
<> 144:ef7eb2e8f9f7 138 typedef struct
<> 144:ef7eb2e8f9f7 139 {
Anna Bridge 186:707f6e361f3e 140 USART_TypeDef *Instance; /*!< USART registers base address */
Anna Bridge 186:707f6e361f3e 141
Anna Bridge 186:707f6e361f3e 142 USART_InitTypeDef Init; /*!< USART communication parameters */
Anna Bridge 186:707f6e361f3e 143
Anna Bridge 186:707f6e361f3e 144 uint8_t *pTxBuffPtr; /*!< Pointer to USART Tx transfer Buffer */
<> 144:ef7eb2e8f9f7 145
Anna Bridge 186:707f6e361f3e 146 uint16_t TxXferSize; /*!< USART Tx Transfer size */
Anna Bridge 186:707f6e361f3e 147
Anna Bridge 186:707f6e361f3e 148 __IO uint16_t TxXferCount; /*!< USART Tx Transfer Counter */
Anna Bridge 186:707f6e361f3e 149
Anna Bridge 186:707f6e361f3e 150 uint8_t *pRxBuffPtr; /*!< Pointer to USART Rx transfer Buffer */
Anna Bridge 186:707f6e361f3e 151
Anna Bridge 186:707f6e361f3e 152 uint16_t RxXferSize; /*!< USART Rx Transfer size */
<> 144:ef7eb2e8f9f7 153
Anna Bridge 186:707f6e361f3e 154 __IO uint16_t RxXferCount; /*!< USART Rx Transfer Counter */
Anna Bridge 186:707f6e361f3e 155
Anna Bridge 186:707f6e361f3e 156 uint16_t Mask; /*!< USART Rx RDR register mask */
Anna Bridge 186:707f6e361f3e 157
Anna Bridge 186:707f6e361f3e 158 DMA_HandleTypeDef *hdmatx; /*!< USART Tx DMA Handle parameters */
Anna Bridge 186:707f6e361f3e 159
Anna Bridge 186:707f6e361f3e 160 DMA_HandleTypeDef *hdmarx; /*!< USART Rx DMA Handle parameters */
Anna Bridge 186:707f6e361f3e 161
Anna Bridge 186:707f6e361f3e 162 HAL_LockTypeDef Lock; /*!< Locking object */
Anna Bridge 186:707f6e361f3e 163
Anna Bridge 186:707f6e361f3e 164 __IO HAL_USART_StateTypeDef State; /*!< USART communication state */
Anna Bridge 186:707f6e361f3e 165
Anna Bridge 186:707f6e361f3e 166 __IO uint32_t ErrorCode; /*!< USART Error code */
Anna Bridge 186:707f6e361f3e 167
<> 144:ef7eb2e8f9f7 168 }USART_HandleTypeDef;
Anna Bridge 186:707f6e361f3e 169
<> 144:ef7eb2e8f9f7 170 /**
<> 144:ef7eb2e8f9f7 171 * @}
<> 144:ef7eb2e8f9f7 172 */
<> 144:ef7eb2e8f9f7 173
<> 144:ef7eb2e8f9f7 174 /* Exported constants --------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 175 /** @defgroup USART_Exported_Constants USART Exported Constants
<> 144:ef7eb2e8f9f7 176 * @{
<> 144:ef7eb2e8f9f7 177 */
<> 144:ef7eb2e8f9f7 178
Anna Bridge 186:707f6e361f3e 179 /** @defgroup USART_Stop_Bits USART Number of Stop Bits
<> 144:ef7eb2e8f9f7 180 * @{
<> 144:ef7eb2e8f9f7 181 */
Anna Bridge 186:707f6e361f3e 182 #define USART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< USART frame with 0.5 stop bit */
Anna Bridge 186:707f6e361f3e 183 #define USART_STOPBITS_1 ((uint32_t)0x00000000) /*!< USART frame with 1 stop bit */
Anna Bridge 186:707f6e361f3e 184 #define USART_STOPBITS_1_5 (USART_CR2_STOP_0 | USART_CR2_STOP_1) /*!< USART frame with 1.5 stop bits */
Anna Bridge 186:707f6e361f3e 185 #define USART_STOPBITS_2 USART_CR2_STOP_1 /*!< USART frame with 2 stop bits */
<> 144:ef7eb2e8f9f7 186 /**
<> 144:ef7eb2e8f9f7 187 * @}
Anna Bridge 186:707f6e361f3e 188 */
<> 144:ef7eb2e8f9f7 189
Anna Bridge 186:707f6e361f3e 190 /** @defgroup USART_Parity USART Parity
<> 144:ef7eb2e8f9f7 191 * @{
Anna Bridge 186:707f6e361f3e 192 */
Anna Bridge 186:707f6e361f3e 193 #define USART_PARITY_NONE ((uint32_t)0x00000000U) /*!< No parity */
Anna Bridge 186:707f6e361f3e 194 #define USART_PARITY_EVEN ((uint32_t)USART_CR1_PCE) /*!< Even parity */
Anna Bridge 186:707f6e361f3e 195 #define USART_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS)) /*!< Odd parity */
<> 144:ef7eb2e8f9f7 196 /**
<> 144:ef7eb2e8f9f7 197 * @}
<> 144:ef7eb2e8f9f7 198 */
Anna Bridge 186:707f6e361f3e 199
Anna Bridge 186:707f6e361f3e 200 /** @defgroup USART_Mode USART Mode
<> 144:ef7eb2e8f9f7 201 * @{
Anna Bridge 186:707f6e361f3e 202 */
Anna Bridge 186:707f6e361f3e 203 #define USART_MODE_RX ((uint32_t)USART_CR1_RE) /*!< RX mode */
Anna Bridge 186:707f6e361f3e 204 #define USART_MODE_TX ((uint32_t)USART_CR1_TE) /*!< TX mode */
Anna Bridge 186:707f6e361f3e 205 #define USART_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE)) /*!< RX and TX mode */
<> 144:ef7eb2e8f9f7 206 /**
<> 144:ef7eb2e8f9f7 207 * @}
Anna Bridge 186:707f6e361f3e 208 */
<> 144:ef7eb2e8f9f7 209
Anna Bridge 186:707f6e361f3e 210 /** @defgroup USART_Clock USART Clock
<> 144:ef7eb2e8f9f7 211 * @{
<> 144:ef7eb2e8f9f7 212 */
Anna Bridge 186:707f6e361f3e 213 #define USART_CLOCK_DISABLE ((uint32_t)0x00000000U) /*!< USART clock disable */
Anna Bridge 186:707f6e361f3e 214 #define USART_CLOCK_ENABLE ((uint32_t)USART_CR2_CLKEN) /*!< USART clock enable */
<> 144:ef7eb2e8f9f7 215 /**
<> 144:ef7eb2e8f9f7 216 * @}
Anna Bridge 186:707f6e361f3e 217 */
<> 144:ef7eb2e8f9f7 218
Anna Bridge 186:707f6e361f3e 219 /** @defgroup USART_Clock_Polarity USART Clock Polarity
<> 144:ef7eb2e8f9f7 220 * @{
<> 144:ef7eb2e8f9f7 221 */
Anna Bridge 186:707f6e361f3e 222 #define USART_POLARITY_LOW ((uint32_t)0x00000000U) /*!< USART Clock signal is steady Low */
Anna Bridge 186:707f6e361f3e 223 #define USART_POLARITY_HIGH ((uint32_t)USART_CR2_CPOL) /*!< USART Clock signal is steady High */
<> 144:ef7eb2e8f9f7 224 /**
<> 144:ef7eb2e8f9f7 225 * @}
<> 144:ef7eb2e8f9f7 226 */
<> 144:ef7eb2e8f9f7 227
Anna Bridge 186:707f6e361f3e 228 /** @defgroup USART_Clock_Phase USART Clock Phase
<> 144:ef7eb2e8f9f7 229 * @{
<> 144:ef7eb2e8f9f7 230 */
Anna Bridge 186:707f6e361f3e 231 #define USART_PHASE_1EDGE ((uint32_t)0x00000000U) /*!< USART frame phase on first clock transition */
Anna Bridge 186:707f6e361f3e 232 #define USART_PHASE_2EDGE ((uint32_t)USART_CR2_CPHA) /*!< USART frame phase on second clock transition */
<> 144:ef7eb2e8f9f7 233 /**
<> 144:ef7eb2e8f9f7 234 * @}
<> 144:ef7eb2e8f9f7 235 */
<> 144:ef7eb2e8f9f7 236
Anna Bridge 186:707f6e361f3e 237 /** @defgroup USART_Last_Bit USART Last Bit
Anna Bridge 186:707f6e361f3e 238 * @{
Anna Bridge 186:707f6e361f3e 239 */
Anna Bridge 186:707f6e361f3e 240 #define USART_LASTBIT_DISABLE ((uint32_t)0x00000000U) /*!< USART frame last data bit clock pulse not output to SCLK pin */
Anna Bridge 186:707f6e361f3e 241 #define USART_LASTBIT_ENABLE ((uint32_t)USART_CR2_LBCL) /*!< USART frame last data bit clock pulse output to SCLK pin */
Anna Bridge 186:707f6e361f3e 242 /**
Anna Bridge 186:707f6e361f3e 243 * @}
Anna Bridge 186:707f6e361f3e 244 */
<> 144:ef7eb2e8f9f7 245
Anna Bridge 186:707f6e361f3e 246 /** @defgroup USART_Request_Parameters USART Request Parameters
Anna Bridge 186:707f6e361f3e 247 * @{
Anna Bridge 186:707f6e361f3e 248 */
Anna Bridge 186:707f6e361f3e 249 #define USART_RXDATA_FLUSH_REQUEST ((uint32_t)USART_RQR_RXFRQ) /*!< Receive Data flush Request */
Anna Bridge 186:707f6e361f3e 250 #define USART_TXDATA_FLUSH_REQUEST ((uint32_t)USART_RQR_TXFRQ) /*!< Transmit data flush Request */
Anna Bridge 186:707f6e361f3e 251 /**
Anna Bridge 186:707f6e361f3e 252 * @}
Anna Bridge 186:707f6e361f3e 253 */
Anna Bridge 186:707f6e361f3e 254
Anna Bridge 186:707f6e361f3e 255 /** @defgroup USART_Flags USART Flags
<> 144:ef7eb2e8f9f7 256 * Elements values convention: 0xXXXX
<> 144:ef7eb2e8f9f7 257 * - 0xXXXX : Flag mask in the ISR register
<> 144:ef7eb2e8f9f7 258 * @{
<> 144:ef7eb2e8f9f7 259 */
Anna Bridge 186:707f6e361f3e 260 #define USART_FLAG_REACK USART_ISR_REACK /*!< USART receive enable acknowledge flag */
Anna Bridge 186:707f6e361f3e 261 #define USART_FLAG_TEACK USART_ISR_TEACK /*!< USART transmit enable acknowledge flag */
Anna Bridge 186:707f6e361f3e 262 #define USART_FLAG_BUSY USART_ISR_BUSY /*!< USART busy flag */
Anna Bridge 186:707f6e361f3e 263 #define USART_FLAG_CTS USART_ISR_CTS /*!< USART clear to send flag */
Anna Bridge 186:707f6e361f3e 264 #define USART_FLAG_CTSIF USART_ISR_CTSIF /*!< USART clear to send interrupt flag */
Anna Bridge 186:707f6e361f3e 265 #define USART_FLAG_LBDF USART_ISR_LBDF /*!< USART LIN break detection flag */
Anna Bridge 186:707f6e361f3e 266 #define USART_FLAG_TXE USART_ISR_TXE /*!< USART transmit data register empty */
Anna Bridge 186:707f6e361f3e 267 #define USART_FLAG_TC USART_ISR_TC /*!< USART transmission complete */
Anna Bridge 186:707f6e361f3e 268 #define USART_FLAG_RXNE USART_ISR_RXNE /*!< USART read data register not empty */
Anna Bridge 186:707f6e361f3e 269 #define USART_FLAG_IDLE USART_ISR_IDLE /*!< USART idle flag */
Anna Bridge 186:707f6e361f3e 270 #define USART_FLAG_ORE USART_ISR_ORE /*!< USART overrun error */
Anna Bridge 186:707f6e361f3e 271 #define USART_FLAG_NE USART_ISR_NE /*!< USART noise error */
Anna Bridge 186:707f6e361f3e 272 #define USART_FLAG_FE USART_ISR_FE /*!< USART frame error */
Anna Bridge 186:707f6e361f3e 273 #define USART_FLAG_PE USART_ISR_PE /*!< USART parity error */
<> 144:ef7eb2e8f9f7 274 /**
<> 144:ef7eb2e8f9f7 275 * @}
<> 144:ef7eb2e8f9f7 276 */
<> 144:ef7eb2e8f9f7 277
Anna Bridge 186:707f6e361f3e 278 /** @defgroup USART_Interrupt_definition USART Interrupts Definition
<> 144:ef7eb2e8f9f7 279 * Elements values convention: 0000ZZZZ0XXYYYYYb
<> 144:ef7eb2e8f9f7 280 * - YYYYY : Interrupt source position in the XX register (5bits)
<> 144:ef7eb2e8f9f7 281 * - XX : Interrupt source register (2bits)
<> 144:ef7eb2e8f9f7 282 * - 01: CR1 register
<> 144:ef7eb2e8f9f7 283 * - 10: CR2 register
<> 144:ef7eb2e8f9f7 284 * - 11: CR3 register
<> 144:ef7eb2e8f9f7 285 * - ZZZZ : Flag position in the ISR register(4bits)
<> 144:ef7eb2e8f9f7 286 * @{
<> 144:ef7eb2e8f9f7 287 */
<> 144:ef7eb2e8f9f7 288
Anna Bridge 186:707f6e361f3e 289 #define USART_IT_PE ((uint16_t)0x0028U) /*!< USART parity error interruption */
Anna Bridge 186:707f6e361f3e 290 #define USART_IT_TXE ((uint16_t)0x0727U) /*!< USART transmit data register empty interruption */
Anna Bridge 186:707f6e361f3e 291 #define USART_IT_TC ((uint16_t)0x0626U) /*!< USART transmission complete interruption */
Anna Bridge 186:707f6e361f3e 292 #define USART_IT_RXNE ((uint16_t)0x0525U) /*!< USART read data register not empty interruption */
Anna Bridge 186:707f6e361f3e 293 #define USART_IT_IDLE ((uint16_t)0x0424U) /*!< USART idle interruption */
Anna Bridge 186:707f6e361f3e 294 #define USART_IT_ERR ((uint16_t)0x0060U) /*!< USART error interruption */
Anna Bridge 186:707f6e361f3e 295 #define USART_IT_ORE ((uint16_t)0x0300U) /*!< USART overrun error interruption */
Anna Bridge 186:707f6e361f3e 296 #define USART_IT_NE ((uint16_t)0x0200U) /*!< USART noise error interruption */
Anna Bridge 186:707f6e361f3e 297 #define USART_IT_FE ((uint16_t)0x0100U) /*!< USART frame error interruption */
<> 144:ef7eb2e8f9f7 298 /**
<> 144:ef7eb2e8f9f7 299 * @}
<> 144:ef7eb2e8f9f7 300 */
<> 144:ef7eb2e8f9f7 301
Anna Bridge 186:707f6e361f3e 302 /** @defgroup USART_IT_CLEAR_Flags USART Interruption Clear Flags
<> 144:ef7eb2e8f9f7 303 * @{
<> 144:ef7eb2e8f9f7 304 */
Anna Bridge 186:707f6e361f3e 305 #define USART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
Anna Bridge 186:707f6e361f3e 306 #define USART_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
Anna Bridge 186:707f6e361f3e 307 #define USART_CLEAR_NEF USART_ICR_NCF /*!< Noise detected Clear Flag */
Anna Bridge 186:707f6e361f3e 308 #define USART_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */
Anna Bridge 186:707f6e361f3e 309 #define USART_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */
Anna Bridge 186:707f6e361f3e 310 #define USART_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
Anna Bridge 186:707f6e361f3e 311 #define USART_CLEAR_CTSF USART_ICR_CTSCF /*!< CTS Interrupt Clear Flag */
<> 144:ef7eb2e8f9f7 312 /**
<> 144:ef7eb2e8f9f7 313 * @}
<> 144:ef7eb2e8f9f7 314 */
<> 144:ef7eb2e8f9f7 315
Anna Bridge 186:707f6e361f3e 316 /** @defgroup USART_Interruption_Mask USART Interruption Flags Mask
<> 144:ef7eb2e8f9f7 317 * @{
Anna Bridge 186:707f6e361f3e 318 */
Anna Bridge 186:707f6e361f3e 319 #define USART_IT_MASK ((uint16_t)0x001FU) /*!< USART interruptions flags mask */
<> 144:ef7eb2e8f9f7 320 /**
<> 144:ef7eb2e8f9f7 321 * @}
<> 144:ef7eb2e8f9f7 322 */
<> 144:ef7eb2e8f9f7 323
<> 144:ef7eb2e8f9f7 324 /**
<> 144:ef7eb2e8f9f7 325 * @}
<> 144:ef7eb2e8f9f7 326 */
<> 144:ef7eb2e8f9f7 327
Anna Bridge 186:707f6e361f3e 328 /* Exported macros -----------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 329 /** @defgroup USART_Exported_Macros USART Exported Macros
<> 144:ef7eb2e8f9f7 330 * @{
<> 144:ef7eb2e8f9f7 331 */
Anna Bridge 186:707f6e361f3e 332
Anna Bridge 186:707f6e361f3e 333 /** @brief Reset USART handle state.
Anna Bridge 186:707f6e361f3e 334 * @param __HANDLE__: USART handle.
<> 144:ef7eb2e8f9f7 335 * @retval None
<> 144:ef7eb2e8f9f7 336 */
<> 144:ef7eb2e8f9f7 337 #define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_USART_STATE_RESET)
<> 144:ef7eb2e8f9f7 338
<> 144:ef7eb2e8f9f7 339 /** @brief Flush the USART Data registers
<> 144:ef7eb2e8f9f7 340 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 341 */
<> 144:ef7eb2e8f9f7 342 #define __HAL_USART_FLUSH_DRREGISTER(__HANDLE__) \
<> 144:ef7eb2e8f9f7 343 do{ \
<> 144:ef7eb2e8f9f7 344 SET_BIT((__HANDLE__)->Instance->RQR, USART_RXDATA_FLUSH_REQUEST); \
<> 144:ef7eb2e8f9f7 345 SET_BIT((__HANDLE__)->Instance->RQR, USART_TXDATA_FLUSH_REQUEST); \
<> 144:ef7eb2e8f9f7 346 } while(0)
<> 144:ef7eb2e8f9f7 347
<> 144:ef7eb2e8f9f7 348
Anna Bridge 186:707f6e361f3e 349 /** @brief Check whether the specified USART flag is set or not.
Anna Bridge 186:707f6e361f3e 350 * @param __HANDLE__: specifies the USART Handle
<> 144:ef7eb2e8f9f7 351 * @param __FLAG__: specifies the flag to check.
<> 144:ef7eb2e8f9f7 352 * This parameter can be one of the following values:
Anna Bridge 186:707f6e361f3e 353 * @arg @ref USART_FLAG_REACK Receive enable acknowledge flag
Anna Bridge 186:707f6e361f3e 354 * @arg @ref USART_FLAG_TEACK Transmit enable acknowledge flag
Anna Bridge 186:707f6e361f3e 355 * @arg @ref USART_FLAG_BUSY Busy flag
Anna Bridge 186:707f6e361f3e 356 * @arg @ref USART_FLAG_CTS CTS Change flag
Anna Bridge 186:707f6e361f3e 357 * @arg @ref USART_FLAG_TXE Transmit data register empty flag
Anna Bridge 186:707f6e361f3e 358 * @arg @ref USART_FLAG_TC Transmission Complete flag
Anna Bridge 186:707f6e361f3e 359 * @arg @ref USART_FLAG_RXNE Receive data register not empty flag
Anna Bridge 186:707f6e361f3e 360 * @arg @ref USART_FLAG_IDLE Idle Line detection flag
Anna Bridge 186:707f6e361f3e 361 * @arg @ref USART_FLAG_ORE OverRun Error flag
Anna Bridge 186:707f6e361f3e 362 * @arg @ref USART_FLAG_NE Noise Error flag
Anna Bridge 186:707f6e361f3e 363 * @arg @ref USART_FLAG_FE Framing Error flag
Anna Bridge 186:707f6e361f3e 364 * @arg @ref USART_FLAG_PE Parity Error flag
<> 144:ef7eb2e8f9f7 365 * @retval The new state of __FLAG__ (TRUE or FALSE).
<> 144:ef7eb2e8f9f7 366 */
<> 144:ef7eb2e8f9f7 367 #define __HAL_USART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
<> 144:ef7eb2e8f9f7 368
Anna Bridge 186:707f6e361f3e 369 /** @brief Clear the specified USART pending flag.
<> 144:ef7eb2e8f9f7 370 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 371 * @param __FLAG__: specifies the flag to check.
<> 144:ef7eb2e8f9f7 372 * This parameter can be any combination of the following values:
Anna Bridge 186:707f6e361f3e 373 * @arg @ref USART_CLEAR_PEF
Anna Bridge 186:707f6e361f3e 374 * @arg @ref USART_CLEAR_FEF
Anna Bridge 186:707f6e361f3e 375 * @arg @ref USART_CLEAR_NEF
Anna Bridge 186:707f6e361f3e 376 * @arg @ref USART_CLEAR_OREF
Anna Bridge 186:707f6e361f3e 377 * @arg @ref USART_CLEAR_IDLEF
Anna Bridge 186:707f6e361f3e 378 * @arg @ref USART_CLEAR_TCF
Anna Bridge 186:707f6e361f3e 379 * @arg @ref USART_CLEAR_CTSF
<> 144:ef7eb2e8f9f7 380 * @retval None
<> 144:ef7eb2e8f9f7 381 */
<> 144:ef7eb2e8f9f7 382 #define __HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
<> 144:ef7eb2e8f9f7 383
<> 144:ef7eb2e8f9f7 384 /** @brief Clear the USART PE pending flag.
Anna Bridge 186:707f6e361f3e 385 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 386 * @retval None
<> 144:ef7eb2e8f9f7 387 */
Anna Bridge 186:707f6e361f3e 388 #define __HAL_USART_CLEAR_PEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_PEF)
<> 144:ef7eb2e8f9f7 389
<> 144:ef7eb2e8f9f7 390 /** @brief Clear the USART FE pending flag.
Anna Bridge 186:707f6e361f3e 391 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 392 * @retval None
<> 144:ef7eb2e8f9f7 393 */
Anna Bridge 186:707f6e361f3e 394 #define __HAL_USART_CLEAR_FEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_FEF)
<> 144:ef7eb2e8f9f7 395
Anna Bridge 186:707f6e361f3e 396 /** @brief Clear the USART NE pending flag.
Anna Bridge 186:707f6e361f3e 397 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 398 * @retval None
<> 144:ef7eb2e8f9f7 399 */
Anna Bridge 186:707f6e361f3e 400 #define __HAL_USART_CLEAR_NEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_NEF)
<> 144:ef7eb2e8f9f7 401
Anna Bridge 186:707f6e361f3e 402 /** @brief Clear the USART ORE pending flag.
Anna Bridge 186:707f6e361f3e 403 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 404 * @retval None
<> 144:ef7eb2e8f9f7 405 */
Anna Bridge 186:707f6e361f3e 406 #define __HAL_USART_CLEAR_OREFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_OREF)
<> 144:ef7eb2e8f9f7 407
Anna Bridge 186:707f6e361f3e 408 /** @brief Clear the USART IDLE pending flag.
Anna Bridge 186:707f6e361f3e 409 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 410 * @retval None
<> 144:ef7eb2e8f9f7 411 */
Anna Bridge 186:707f6e361f3e 412 #define __HAL_USART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_IDLEF)
<> 144:ef7eb2e8f9f7 413
Anna Bridge 186:707f6e361f3e 414 /** @brief Enable the specified USART interrupt.
Anna Bridge 186:707f6e361f3e 415 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 416 * @param __INTERRUPT__: specifies the USART interrupt source to enable.
<> 144:ef7eb2e8f9f7 417 * This parameter can be one of the following values:
Anna Bridge 186:707f6e361f3e 418 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
Anna Bridge 186:707f6e361f3e 419 * @arg @ref USART_IT_TC Transmission complete interrupt
Anna Bridge 186:707f6e361f3e 420 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
Anna Bridge 186:707f6e361f3e 421 * @arg @ref USART_IT_IDLE Idle line detection interrupt
Anna Bridge 186:707f6e361f3e 422 * @arg @ref USART_IT_PE Parity Error interrupt
Anna Bridge 186:707f6e361f3e 423 * @arg @ref USART_IT_ERR Error interrupt(Frame error, noise error, overrun error)
<> 144:ef7eb2e8f9f7 424 * @retval None
<> 144:ef7eb2e8f9f7 425 */
Anna Bridge 186:707f6e361f3e 426 #define __HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
Anna Bridge 186:707f6e361f3e 427 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
Anna Bridge 186:707f6e361f3e 428 ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))))
<> 144:ef7eb2e8f9f7 429
Anna Bridge 186:707f6e361f3e 430 /** @brief Disable the specified USART interrupt.
Anna Bridge 186:707f6e361f3e 431 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 432 * @param __INTERRUPT__: specifies the USART interrupt source to disable.
<> 144:ef7eb2e8f9f7 433 * This parameter can be one of the following values:
Anna Bridge 186:707f6e361f3e 434 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
Anna Bridge 186:707f6e361f3e 435 * @arg @ref USART_IT_TC Transmission complete interrupt
Anna Bridge 186:707f6e361f3e 436 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
Anna Bridge 186:707f6e361f3e 437 * @arg @ref USART_IT_IDLE Idle line detection interrupt
Anna Bridge 186:707f6e361f3e 438 * @arg @ref USART_IT_PE Parity Error interrupt
Anna Bridge 186:707f6e361f3e 439 * @arg @ref USART_IT_ERR Error interrupt(Frame error, noise error, overrun error)
<> 144:ef7eb2e8f9f7 440 * @retval None
<> 144:ef7eb2e8f9f7 441 */
Anna Bridge 186:707f6e361f3e 442 #define __HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
Anna Bridge 186:707f6e361f3e 443 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
Anna Bridge 186:707f6e361f3e 444 ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))))
<> 144:ef7eb2e8f9f7 445
Anna Bridge 186:707f6e361f3e 446
Anna Bridge 186:707f6e361f3e 447 /** @brief Check whether the specified USART interrupt has occurred or not.
Anna Bridge 186:707f6e361f3e 448 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 449 * @param __IT__: specifies the USART interrupt source to check.
<> 144:ef7eb2e8f9f7 450 * This parameter can be one of the following values:
Anna Bridge 186:707f6e361f3e 451 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
Anna Bridge 186:707f6e361f3e 452 * @arg @ref USART_IT_TC Transmission complete interrupt
Anna Bridge 186:707f6e361f3e 453 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
Anna Bridge 186:707f6e361f3e 454 * @arg @ref USART_IT_IDLE Idle line detection interrupt
Anna Bridge 186:707f6e361f3e 455 * @arg @ref USART_IT_ORE OverRun Error interrupt
Anna Bridge 186:707f6e361f3e 456 * @arg @ref USART_IT_NE Noise Error interrupt
Anna Bridge 186:707f6e361f3e 457 * @arg @ref USART_IT_FE Framing Error interrupt
Anna Bridge 186:707f6e361f3e 458 * @arg @ref USART_IT_PE Parity Error interrupt
<> 144:ef7eb2e8f9f7 459 * @retval The new state of __IT__ (TRUE or FALSE).
<> 144:ef7eb2e8f9f7 460 */
Anna Bridge 186:707f6e361f3e 461 #define __HAL_USART_GET_IT(__HANDLE__, __IT__) ((__HANDLE__)->Instance->ISR & ((uint32_t)1U << ((__IT__)>> 0x08U)))
<> 144:ef7eb2e8f9f7 462
Anna Bridge 186:707f6e361f3e 463 /** @brief Check whether the specified USART interrupt source is enabled or not.
Anna Bridge 186:707f6e361f3e 464 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 465 * @param __IT__: specifies the USART interrupt source to check.
<> 144:ef7eb2e8f9f7 466 * This parameter can be one of the following values:
Anna Bridge 186:707f6e361f3e 467 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
Anna Bridge 186:707f6e361f3e 468 * @arg @ref USART_IT_TC Transmission complete interrupt
Anna Bridge 186:707f6e361f3e 469 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
Anna Bridge 186:707f6e361f3e 470 * @arg @ref USART_IT_IDLE Idle line detection interrupt
Anna Bridge 186:707f6e361f3e 471 * @arg @ref USART_IT_ORE OverRun Error interrupt
Anna Bridge 186:707f6e361f3e 472 * @arg @ref USART_IT_NE Noise Error interrupt
Anna Bridge 186:707f6e361f3e 473 * @arg @ref USART_IT_FE Framing Error interrupt
Anna Bridge 186:707f6e361f3e 474 * @arg @ref USART_IT_PE Parity Error interrupt
<> 144:ef7eb2e8f9f7 475 * @retval The new state of __IT__ (TRUE or FALSE).
<> 144:ef7eb2e8f9f7 476 */
<> 151:5eaa88a5bcc7 477 #define __HAL_USART_GET_IT_SOURCE(__HANDLE__, __IT__) ((((((uint8_t)(__IT__)) >> 5U) == 1U)? (__HANDLE__)->Instance->CR1:(((((uint8_t)(__IT__)) >> 5U) == 2U)? \
<> 151:5eaa88a5bcc7 478 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & ((uint32_t)1U << \
<> 144:ef7eb2e8f9f7 479 (((uint16_t)(__IT__)) & USART_IT_MASK)))
<> 144:ef7eb2e8f9f7 480
<> 144:ef7eb2e8f9f7 481
Anna Bridge 186:707f6e361f3e 482 /** @brief Clear the specified USART ISR flag, in setting the proper ICR register flag.
Anna Bridge 186:707f6e361f3e 483 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 484 * @param __IT_CLEAR__: specifies the interrupt clear register flag that needs to be set
Anna Bridge 186:707f6e361f3e 485 * to clear the corresponding interrupt.
<> 144:ef7eb2e8f9f7 486 * This parameter can be one of the following values:
Anna Bridge 186:707f6e361f3e 487 * @arg @ref USART_CLEAR_PEF Parity Error Clear Flag
Anna Bridge 186:707f6e361f3e 488 * @arg @ref USART_CLEAR_FEF Framing Error Clear Flag
Anna Bridge 186:707f6e361f3e 489 * @arg @ref USART_CLEAR_NEF Noise detected Clear Flag
Anna Bridge 186:707f6e361f3e 490 * @arg @ref USART_CLEAR_OREF OverRun Error Clear Flag
Anna Bridge 186:707f6e361f3e 491 * @arg @ref USART_CLEAR_IDLEF IDLE line detected Clear Flag
Anna Bridge 186:707f6e361f3e 492 * @arg @ref USART_CLEAR_TCF Transmission Complete Clear Flag
Anna Bridge 186:707f6e361f3e 493 * @arg @ref USART_CLEAR_CTSF CTS Interrupt Clear Flag
<> 144:ef7eb2e8f9f7 494 * @retval None
<> 144:ef7eb2e8f9f7 495 */
Anna Bridge 186:707f6e361f3e 496 #define __HAL_USART_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
<> 144:ef7eb2e8f9f7 497
<> 144:ef7eb2e8f9f7 498 /** @brief Set a specific USART request flag.
Anna Bridge 186:707f6e361f3e 499 * @param __HANDLE__: specifies the USART Handle.
Anna Bridge 186:707f6e361f3e 500 * @param __REQ__: specifies the request flag to set.
<> 144:ef7eb2e8f9f7 501 * This parameter can be one of the following values:
Anna Bridge 186:707f6e361f3e 502 * @arg @ref USART_RXDATA_FLUSH_REQUEST Receive Data flush Request
Anna Bridge 186:707f6e361f3e 503 * @arg @ref USART_TXDATA_FLUSH_REQUEST Transmit data flush Request
<> 144:ef7eb2e8f9f7 504 *
<> 144:ef7eb2e8f9f7 505 * @retval None
Anna Bridge 186:707f6e361f3e 506 */
Anna Bridge 186:707f6e361f3e 507 #define __HAL_USART_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint32_t)(__REQ__))
<> 144:ef7eb2e8f9f7 508
Anna Bridge 186:707f6e361f3e 509 /** @brief Enable the USART one bit sample method.
Anna Bridge 186:707f6e361f3e 510 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 511 * @retval None
<> 144:ef7eb2e8f9f7 512 */
<> 144:ef7eb2e8f9f7 513 #define __HAL_USART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
<> 144:ef7eb2e8f9f7 514
Anna Bridge 186:707f6e361f3e 515 /** @brief Disable the USART one bit sample method.
Anna Bridge 186:707f6e361f3e 516 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 517 * @retval None
<> 144:ef7eb2e8f9f7 518 */
<> 144:ef7eb2e8f9f7 519 #define __HAL_USART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
<> 144:ef7eb2e8f9f7 520
Anna Bridge 186:707f6e361f3e 521 /** @brief Enable USART.
<> 144:ef7eb2e8f9f7 522 * @param __HANDLE__: specifies the USART Handle.
<> 144:ef7eb2e8f9f7 523 * @retval None
Anna Bridge 186:707f6e361f3e 524 */
Anna Bridge 186:707f6e361f3e 525 #define __HAL_USART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
<> 144:ef7eb2e8f9f7 526
Anna Bridge 186:707f6e361f3e 527 /** @brief Disable USART.
Anna Bridge 186:707f6e361f3e 528 * @param __HANDLE__: specifies the USART Handle.
Anna Bridge 186:707f6e361f3e 529 * @retval None
<> 144:ef7eb2e8f9f7 530 */
Anna Bridge 186:707f6e361f3e 531 #define __HAL_USART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
<> 144:ef7eb2e8f9f7 532
<> 144:ef7eb2e8f9f7 533 /**
<> 144:ef7eb2e8f9f7 534 * @}
<> 144:ef7eb2e8f9f7 535 */
Anna Bridge 186:707f6e361f3e 536
Anna Bridge 186:707f6e361f3e 537 /* Private macros --------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 538 /** @defgroup USART_Private_Macros USART Private Macros
<> 144:ef7eb2e8f9f7 539 * @{
<> 144:ef7eb2e8f9f7 540 */
Anna Bridge 186:707f6e361f3e 541
Anna Bridge 186:707f6e361f3e 542 /** @brief Check USART Baud rate.
Anna Bridge 186:707f6e361f3e 543 * @param __BAUDRATE__: Baudrate specified by the user.
Anna Bridge 186:707f6e361f3e 544 * The maximum Baud Rate is derived from the maximum clock on L0 (i.e. 32 MHz)
Anna Bridge 186:707f6e361f3e 545 * divided by the smallest oversampling used on the USART (i.e. 8).
Anna Bridge 186:707f6e361f3e 546 * @retval Test result (TRUE or FALSE).
Anna Bridge 186:707f6e361f3e 547 */
Anna Bridge 186:707f6e361f3e 548 #define IS_USART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 4000001U)
Anna Bridge 186:707f6e361f3e 549
Anna Bridge 186:707f6e361f3e 550
Anna Bridge 186:707f6e361f3e 551 /**
Anna Bridge 186:707f6e361f3e 552 * @brief Ensure that USART frame number of stop bits is valid.
Anna Bridge 186:707f6e361f3e 553 * @param __STOPBITS__: USART frame number of stop bits.
Anna Bridge 186:707f6e361f3e 554 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
Anna Bridge 186:707f6e361f3e 555 */
Anna Bridge 186:707f6e361f3e 556 #define IS_USART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == USART_STOPBITS_0_5) || \
Anna Bridge 186:707f6e361f3e 557 ((__STOPBITS__) == USART_STOPBITS_1) || \
Anna Bridge 186:707f6e361f3e 558 ((__STOPBITS__) == USART_STOPBITS_1_5) || \
Anna Bridge 186:707f6e361f3e 559 ((__STOPBITS__) == USART_STOPBITS_2))
Anna Bridge 186:707f6e361f3e 560
Anna Bridge 186:707f6e361f3e 561 /**
Anna Bridge 186:707f6e361f3e 562 * @brief Ensure that USART frame parity is valid.
Anna Bridge 186:707f6e361f3e 563 * @param __PARITY__: USART frame parity.
Anna Bridge 186:707f6e361f3e 564 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
Anna Bridge 186:707f6e361f3e 565 */
Anna Bridge 186:707f6e361f3e 566 #define IS_USART_PARITY(__PARITY__) (((__PARITY__) == USART_PARITY_NONE) || \
Anna Bridge 186:707f6e361f3e 567 ((__PARITY__) == USART_PARITY_EVEN) || \
Anna Bridge 186:707f6e361f3e 568 ((__PARITY__) == USART_PARITY_ODD))
Anna Bridge 186:707f6e361f3e 569
Anna Bridge 186:707f6e361f3e 570 /**
Anna Bridge 186:707f6e361f3e 571 * @brief Ensure that USART communication mode is valid.
Anna Bridge 186:707f6e361f3e 572 * @param __MODE__: USART communication mode.
Anna Bridge 186:707f6e361f3e 573 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
Anna Bridge 186:707f6e361f3e 574 */
Anna Bridge 186:707f6e361f3e 575 #define IS_USART_MODE(MODE) (((MODE) == USART_MODE_RX) || \
Anna Bridge 186:707f6e361f3e 576 ((MODE) == USART_MODE_TX) || \
Anna Bridge 186:707f6e361f3e 577 ((MODE) == USART_MODE_TX_RX))
Anna Bridge 186:707f6e361f3e 578
Anna Bridge 186:707f6e361f3e 579 /**
Anna Bridge 186:707f6e361f3e 580 * @brief Ensure that USART clock state is valid.
Anna Bridge 186:707f6e361f3e 581 * @param __CLOCK__: USART clock state.
Anna Bridge 186:707f6e361f3e 582 * @retval SET (__CLOCK__ is valid) or RESET (__CLOCK__ is invalid)
Anna Bridge 186:707f6e361f3e 583 */
Anna Bridge 186:707f6e361f3e 584 #define IS_USART_CLOCK(__CLOCK__) (((__CLOCK__) == USART_CLOCK_DISABLE) || \
Anna Bridge 186:707f6e361f3e 585 ((__CLOCK__) == USART_CLOCK_ENABLE))
Anna Bridge 186:707f6e361f3e 586
Anna Bridge 186:707f6e361f3e 587 /**
Anna Bridge 186:707f6e361f3e 588 * @brief Ensure that USART frame polarity is valid.
Anna Bridge 186:707f6e361f3e 589 * @param __CPOL__: USART frame polarity.
Anna Bridge 186:707f6e361f3e 590 * @retval SET (__CPOL__ is valid) or RESET (__CPOL__ is invalid)
Anna Bridge 186:707f6e361f3e 591 */
Anna Bridge 186:707f6e361f3e 592 #define IS_USART_POLARITY(__CPOL__) (((__CPOL__) == USART_POLARITY_LOW) || ((__CPOL__) == USART_POLARITY_HIGH))
Anna Bridge 186:707f6e361f3e 593
Anna Bridge 186:707f6e361f3e 594 /**
Anna Bridge 186:707f6e361f3e 595 * @brief Ensure that USART frame phase is valid.
Anna Bridge 186:707f6e361f3e 596 * @param __CPHA__: USART frame phase.
Anna Bridge 186:707f6e361f3e 597 * @retval SET (__CPHA__ is valid) or RESET (__CPHA__ is invalid)
Anna Bridge 186:707f6e361f3e 598 */
Anna Bridge 186:707f6e361f3e 599 #define IS_USART_PHASE(__CPHA__) (((__CPHA__) == USART_PHASE_1EDGE) || ((__CPHA__) == USART_PHASE_2EDGE))
Anna Bridge 186:707f6e361f3e 600
Anna Bridge 186:707f6e361f3e 601 /**
Anna Bridge 186:707f6e361f3e 602 * @brief Ensure that USART frame last bit clock pulse setting is valid.
Anna Bridge 186:707f6e361f3e 603 * @param __LASTBIT__: USART frame last bit clock pulse setting.
Anna Bridge 186:707f6e361f3e 604 * @retval SET (__LASTBIT__ is valid) or RESET (__LASTBIT__ is invalid)
Anna Bridge 186:707f6e361f3e 605 */
Anna Bridge 186:707f6e361f3e 606 #define IS_USART_LASTBIT(__LASTBIT__) (((__LASTBIT__) == USART_LASTBIT_DISABLE) || \
Anna Bridge 186:707f6e361f3e 607 ((__LASTBIT__) == USART_LASTBIT_ENABLE))
Anna Bridge 186:707f6e361f3e 608
Anna Bridge 186:707f6e361f3e 609 /**
Anna Bridge 186:707f6e361f3e 610 * @brief Ensure that USART request parameter is valid.
Anna Bridge 186:707f6e361f3e 611 * @param __PARAM__: USART request parameter.
Anna Bridge 186:707f6e361f3e 612 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
Anna Bridge 186:707f6e361f3e 613 */
Anna Bridge 186:707f6e361f3e 614 #define IS_USART_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == USART_RXDATA_FLUSH_REQUEST) || \
Anna Bridge 186:707f6e361f3e 615 ((__PARAM__) == USART_TXDATA_FLUSH_REQUEST))
Anna Bridge 186:707f6e361f3e 616
Anna Bridge 186:707f6e361f3e 617 /**
Anna Bridge 186:707f6e361f3e 618 * @}
Anna Bridge 186:707f6e361f3e 619 */
Anna Bridge 186:707f6e361f3e 620
Anna Bridge 186:707f6e361f3e 621 /* Include USART HAL Extended module */
Anna Bridge 186:707f6e361f3e 622 #include "stm32l0xx_hal_usart_ex.h"
Anna Bridge 186:707f6e361f3e 623
Anna Bridge 186:707f6e361f3e 624 /* Exported functions --------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 625 /** @addtogroup USART_Exported_Functions USART Exported Functions
Anna Bridge 186:707f6e361f3e 626 * @{
Anna Bridge 186:707f6e361f3e 627 */
Anna Bridge 186:707f6e361f3e 628
Anna Bridge 186:707f6e361f3e 629 /** @addtogroup USART_Exported_Functions_Group1 Initialization and de-initialization functions
Anna Bridge 186:707f6e361f3e 630 * @{
Anna Bridge 186:707f6e361f3e 631 */
Anna Bridge 186:707f6e361f3e 632
Anna Bridge 186:707f6e361f3e 633 /* Initialization and de-initialization functions ****************************/
<> 144:ef7eb2e8f9f7 634 HAL_StatusTypeDef HAL_USART_Init(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 635 HAL_StatusTypeDef HAL_USART_DeInit(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 636 void HAL_USART_MspInit(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 637 void HAL_USART_MspDeInit(USART_HandleTypeDef *husart);
Anna Bridge 186:707f6e361f3e 638
<> 144:ef7eb2e8f9f7 639 /**
<> 144:ef7eb2e8f9f7 640 * @}
<> 144:ef7eb2e8f9f7 641 */
Anna Bridge 186:707f6e361f3e 642
Anna Bridge 186:707f6e361f3e 643 /** @addtogroup USART_Exported_Functions_Group2 IO operation functions
Anna Bridge 186:707f6e361f3e 644 * @{
Anna Bridge 186:707f6e361f3e 645 */
Anna Bridge 186:707f6e361f3e 646
<> 144:ef7eb2e8f9f7 647 /* IO operation functions *****************************************************/
<> 144:ef7eb2e8f9f7 648 HAL_StatusTypeDef HAL_USART_Transmit(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size, uint32_t Timeout);
<> 144:ef7eb2e8f9f7 649 HAL_StatusTypeDef HAL_USART_Receive(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
<> 144:ef7eb2e8f9f7 650 HAL_StatusTypeDef HAL_USART_TransmitReceive(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
<> 144:ef7eb2e8f9f7 651 HAL_StatusTypeDef HAL_USART_Transmit_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
<> 144:ef7eb2e8f9f7 652 HAL_StatusTypeDef HAL_USART_Receive_IT(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
<> 144:ef7eb2e8f9f7 653 HAL_StatusTypeDef HAL_USART_TransmitReceive_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
<> 144:ef7eb2e8f9f7 654 HAL_StatusTypeDef HAL_USART_Transmit_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
<> 144:ef7eb2e8f9f7 655 HAL_StatusTypeDef HAL_USART_Receive_DMA(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
<> 144:ef7eb2e8f9f7 656 HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
<> 144:ef7eb2e8f9f7 657 HAL_StatusTypeDef HAL_USART_DMAPause(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 658 HAL_StatusTypeDef HAL_USART_DMAResume(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 659 HAL_StatusTypeDef HAL_USART_DMAStop(USART_HandleTypeDef *husart);
Anna Bridge 186:707f6e361f3e 660 /* Transfer Abort functions */
Anna Bridge 186:707f6e361f3e 661 HAL_StatusTypeDef HAL_USART_Abort(USART_HandleTypeDef *husart);
Anna Bridge 186:707f6e361f3e 662 HAL_StatusTypeDef HAL_USART_Abort_IT(USART_HandleTypeDef *husart);
Anna Bridge 186:707f6e361f3e 663
<> 144:ef7eb2e8f9f7 664 void HAL_USART_IRQHandler(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 665 void HAL_USART_TxCpltCallback(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 666 void HAL_USART_TxHalfCpltCallback(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 667 void HAL_USART_RxCpltCallback(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 668 void HAL_USART_RxHalfCpltCallback(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 669 void HAL_USART_TxRxCpltCallback(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 670 void HAL_USART_ErrorCallback(USART_HandleTypeDef *husart);
Anna Bridge 186:707f6e361f3e 671 void HAL_USART_AbortCpltCallback (USART_HandleTypeDef *husart);
Anna Bridge 186:707f6e361f3e 672
<> 144:ef7eb2e8f9f7 673 /**
<> 144:ef7eb2e8f9f7 674 * @}
<> 144:ef7eb2e8f9f7 675 */
Anna Bridge 186:707f6e361f3e 676
Anna Bridge 186:707f6e361f3e 677 /* Peripheral Control functions ***********************************************/
Anna Bridge 186:707f6e361f3e 678
Anna Bridge 186:707f6e361f3e 679 /** @addtogroup USART_Exported_Functions_Group4 Peripheral State and Error functions
Anna Bridge 186:707f6e361f3e 680 * @{
Anna Bridge 186:707f6e361f3e 681 */
Anna Bridge 186:707f6e361f3e 682
Anna Bridge 186:707f6e361f3e 683 /* Peripheral State and Error functions ***************************************/
<> 144:ef7eb2e8f9f7 684 HAL_USART_StateTypeDef HAL_USART_GetState(USART_HandleTypeDef *husart);
<> 144:ef7eb2e8f9f7 685 uint32_t HAL_USART_GetError(USART_HandleTypeDef *husart);
Anna Bridge 186:707f6e361f3e 686
<> 144:ef7eb2e8f9f7 687 /**
<> 144:ef7eb2e8f9f7 688 * @}
<> 144:ef7eb2e8f9f7 689 */
<> 144:ef7eb2e8f9f7 690
<> 144:ef7eb2e8f9f7 691 /**
<> 144:ef7eb2e8f9f7 692 * @}
<> 144:ef7eb2e8f9f7 693 */
<> 144:ef7eb2e8f9f7 694
<> 144:ef7eb2e8f9f7 695 /**
<> 144:ef7eb2e8f9f7 696 * @}
<> 144:ef7eb2e8f9f7 697 */
<> 144:ef7eb2e8f9f7 698
<> 144:ef7eb2e8f9f7 699 /**
<> 144:ef7eb2e8f9f7 700 * @}
<> 144:ef7eb2e8f9f7 701 */
Anna Bridge 186:707f6e361f3e 702
<> 144:ef7eb2e8f9f7 703 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 704 }
<> 144:ef7eb2e8f9f7 705 #endif
<> 144:ef7eb2e8f9f7 706
<> 144:ef7eb2e8f9f7 707 #endif /* __STM32L0xx_HAL_USART_H */
<> 144:ef7eb2e8f9f7 708
<> 144:ef7eb2e8f9f7 709 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
<> 144:ef7eb2e8f9f7 710