mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

cmsis/BUILD/mbed/TARGET_DISCO_L072CZ_LRWAN1/TOOLCHAIN_IAR/stm32l0xx_hal_usart.h@189:f392fc9709a3, 2019-02-20 (annotated)

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

Who changed what in which revision?

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