mbed official / mbed

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

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_L011K4/TOOLCHAIN_ARM_MICRO/stm32l0xx_hal_usart.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_DISCO_L072CZ_LRWAN1/TARGET_STM/TARGET_STM32L0/device/stm32l0xx_hal_usart.h@167:84c0a372a020 
mbed library. Release version 164

Who changed what in which revision?

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