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_L496ZG_P/TOOLCHAIN_IAR/stm32l4xx_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_L475VG_IOT01A/TARGET_STM/TARGET_STM32L4/device/stm32l4xx_hal_usart.h@161:aa5281ff4a02 
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 145:64910690c574 1 /**
AnnaBridge 145:64910690c574 2 ******************************************************************************
AnnaBridge 145:64910690c574 3 * @file stm32l4xx_hal_usart.h
AnnaBridge 145:64910690c574 4 * @author MCD Application Team
AnnaBridge 145:64910690c574 5 * @brief Header file of USART HAL module.
AnnaBridge 145:64910690c574 6 ******************************************************************************
AnnaBridge 145:64910690c574 7 * @attention
AnnaBridge 145:64910690c574 8 *
AnnaBridge 145:64910690c574 9 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
AnnaBridge 145:64910690c574 10 *
AnnaBridge 145:64910690c574 11 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 145:64910690c574 12 * are permitted provided that the following conditions are met:
AnnaBridge 145:64910690c574 13 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 145:64910690c574 14 * this list of conditions and the following disclaimer.
AnnaBridge 145:64910690c574 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 145:64910690c574 16 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 145:64910690c574 17 * and/or other materials provided with the distribution.
AnnaBridge 145:64910690c574 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 145:64910690c574 19 * may be used to endorse or promote products derived from this software
AnnaBridge 145:64910690c574 20 * without specific prior written permission.
AnnaBridge 145:64910690c574 21 *
AnnaBridge 145:64910690c574 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 145:64910690c574 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 145:64910690c574 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 145:64910690c574 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 145:64910690c574 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 145:64910690c574 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 145:64910690c574 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 145:64910690c574 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 145:64910690c574 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 145:64910690c574 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 145:64910690c574 32 *
AnnaBridge 145:64910690c574 33 ******************************************************************************
AnnaBridge 145:64910690c574 34 */
AnnaBridge 145:64910690c574 35
AnnaBridge 145:64910690c574 36 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 145:64910690c574 37 #ifndef __STM32L4xx_HAL_USART_H
AnnaBridge 145:64910690c574 38 #define __STM32L4xx_HAL_USART_H
AnnaBridge 145:64910690c574 39
AnnaBridge 145:64910690c574 40 #ifdef __cplusplus
AnnaBridge 145:64910690c574 41 extern "C" {
AnnaBridge 145:64910690c574 42 #endif
AnnaBridge 145:64910690c574 43
AnnaBridge 145:64910690c574 44 /* Includes ------------------------------------------------------------------*/
AnnaBridge 145:64910690c574 45 #include "stm32l4xx_hal_def.h"
AnnaBridge 145:64910690c574 46
AnnaBridge 145:64910690c574 47 /** @addtogroup STM32L4xx_HAL_Driver
AnnaBridge 145:64910690c574 48 * @{
AnnaBridge 145:64910690c574 49 */
AnnaBridge 145:64910690c574 50
AnnaBridge 145:64910690c574 51 /** @addtogroup USART
AnnaBridge 145:64910690c574 52 * @{
AnnaBridge 145:64910690c574 53 */
AnnaBridge 145:64910690c574 54
AnnaBridge 145:64910690c574 55 /* Exported types ------------------------------------------------------------*/
AnnaBridge 145:64910690c574 56 /** @defgroup USART_Exported_Types USART Exported Types
AnnaBridge 145:64910690c574 57 * @{
AnnaBridge 145:64910690c574 58 */
AnnaBridge 145:64910690c574 59
AnnaBridge 145:64910690c574 60 /**
AnnaBridge 145:64910690c574 61 * @brief USART Init Structure definition
AnnaBridge 145:64910690c574 62 */
AnnaBridge 145:64910690c574 63 typedef struct
AnnaBridge 145:64910690c574 64 {
AnnaBridge 145:64910690c574 65 uint32_t BaudRate; /*!< This member configures the Usart communication baud rate.
AnnaBridge 145:64910690c574 66 The baud rate is computed using the following formula:
AnnaBridge 161:aa5281ff4a02 67 Baud Rate Register[15:4] = ((2 * fclk_pres) / ((huart->Init.BaudRate)))[15:4]
AnnaBridge 161:aa5281ff4a02 68 Baud Rate Register[3] = 0
AnnaBridge 161:aa5281ff4a02 69 Baud Rate Register[2:0] = (((2 * fclk_pres) / ((huart->Init.BaudRate)))[3:0]) >> 1
AnnaBridge 161:aa5281ff4a02 70 where fclk_pres is the USART input clock frequency (fclk) divided by a prescaler.
AnnaBridge 161:aa5281ff4a02 71 @note Oversampling by 8 is systematically applied to achieve high baud rates. */
AnnaBridge 145:64910690c574 72
AnnaBridge 145:64910690c574 73 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
AnnaBridge 145:64910690c574 74 This parameter can be a value of @ref USARTEx_Word_Length. */
AnnaBridge 145:64910690c574 75
AnnaBridge 145:64910690c574 76 uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
AnnaBridge 145:64910690c574 77 This parameter can be a value of @ref USART_Stop_Bits. */
AnnaBridge 145:64910690c574 78
AnnaBridge 145:64910690c574 79 uint32_t Parity; /*!< Specifies the parity mode.
AnnaBridge 145:64910690c574 80 This parameter can be a value of @ref USART_Parity
AnnaBridge 145:64910690c574 81 @note When parity is enabled, the computed parity is inserted
AnnaBridge 145:64910690c574 82 at the MSB position of the transmitted data (9th bit when
AnnaBridge 145:64910690c574 83 the word length is set to 9 data bits; 8th bit when the
AnnaBridge 145:64910690c574 84 word length is set to 8 data bits). */
AnnaBridge 145:64910690c574 85
AnnaBridge 145:64910690c574 86 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
AnnaBridge 145:64910690c574 87 This parameter can be a value of @ref USART_Mode. */
AnnaBridge 145:64910690c574 88
AnnaBridge 145:64910690c574 89 uint32_t CLKPolarity; /*!< Specifies the steady state of the serial clock.
AnnaBridge 145:64910690c574 90 This parameter can be a value of @ref USART_Clock_Polarity. */
AnnaBridge 145:64910690c574 91
AnnaBridge 145:64910690c574 92 uint32_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made.
AnnaBridge 145:64910690c574 93 This parameter can be a value of @ref USART_Clock_Phase. */
AnnaBridge 145:64910690c574 94
AnnaBridge 145:64910690c574 95 uint32_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted
AnnaBridge 145:64910690c574 96 data bit (MSB) has to be output on the SCLK pin in synchronous mode.
AnnaBridge 145:64910690c574 97 This parameter can be a value of @ref USART_Last_Bit. */
AnnaBridge 161:aa5281ff4a02 98
AnnaBridge 161:aa5281ff4a02 99 #if defined(USART_PRESC_PRESCALER)
AnnaBridge 161:aa5281ff4a02 100 uint32_t ClockPrescaler; /*!< Specifies the prescaler value used to divide the USART clock source.
AnnaBridge 161:aa5281ff4a02 101 This parameter can be a value of @ref USART_ClockPrescaler. */
AnnaBridge 161:aa5281ff4a02 102 #endif
AnnaBridge 161:aa5281ff4a02 103
AnnaBridge 145:64910690c574 104 }USART_InitTypeDef;
AnnaBridge 145:64910690c574 105
AnnaBridge 145:64910690c574 106 /**
AnnaBridge 145:64910690c574 107 * @brief HAL USART State structures definition
AnnaBridge 145:64910690c574 108 */
AnnaBridge 145:64910690c574 109 typedef enum
AnnaBridge 145:64910690c574 110 {
AnnaBridge 161:aa5281ff4a02 111 HAL_USART_STATE_RESET = 0x00U, /*!< Peripheral is not initialized */
AnnaBridge 161:aa5281ff4a02 112 HAL_USART_STATE_READY = 0x01U, /*!< Peripheral Initialized and ready for use */
AnnaBridge 161:aa5281ff4a02 113 HAL_USART_STATE_BUSY = 0x02U, /*!< an internal process is ongoing */
AnnaBridge 161:aa5281ff4a02 114 HAL_USART_STATE_BUSY_TX = 0x12U, /*!< Data Transmission process is ongoing */
AnnaBridge 161:aa5281ff4a02 115 HAL_USART_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing */
AnnaBridge 161:aa5281ff4a02 116 HAL_USART_STATE_BUSY_TX_RX = 0x32U, /*!< Data Transmission Reception process is ongoing */
AnnaBridge 161:aa5281ff4a02 117 HAL_USART_STATE_TIMEOUT = 0x03U, /*!< Timeout state */
AnnaBridge 161:aa5281ff4a02 118 HAL_USART_STATE_ERROR = 0x04U /*!< Error */
AnnaBridge 145:64910690c574 119 }HAL_USART_StateTypeDef;
AnnaBridge 145:64910690c574 120
AnnaBridge 145:64910690c574 121 /**
AnnaBridge 145:64910690c574 122 * @brief HAL USART Error Code structure definition
AnnaBridge 145:64910690c574 123 */
AnnaBridge 145:64910690c574 124 typedef enum
AnnaBridge 145:64910690c574 125 {
AnnaBridge 161:aa5281ff4a02 126 HAL_USART_ERROR_NONE = 0x00U, /*!< No error */
AnnaBridge 161:aa5281ff4a02 127 HAL_USART_ERROR_PE = 0x01U, /*!< Parity error */
AnnaBridge 161:aa5281ff4a02 128 HAL_USART_ERROR_NE = 0x02U, /*!< Noise error */
AnnaBridge 161:aa5281ff4a02 129 HAL_USART_ERROR_FE = 0x04U, /*!< frame error */
AnnaBridge 161:aa5281ff4a02 130 HAL_USART_ERROR_ORE = 0x08U, /*!< Overrun error */
AnnaBridge 161:aa5281ff4a02 131 HAL_USART_ERROR_DMA = 0x10U, /*!< DMA transfer error */
AnnaBridge 161:aa5281ff4a02 132 HAL_USART_ERROR_UDR = 0x20U /*!< SPI slave underrun error */
AnnaBridge 145:64910690c574 133 }HAL_USART_ErrorTypeDef;
AnnaBridge 145:64910690c574 134
AnnaBridge 145:64910690c574 135 /**
AnnaBridge 145:64910690c574 136 * @brief USART clock sources definitions
AnnaBridge 145:64910690c574 137 */
AnnaBridge 145:64910690c574 138 typedef enum
AnnaBridge 145:64910690c574 139 {
AnnaBridge 161:aa5281ff4a02 140 USART_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */
AnnaBridge 161:aa5281ff4a02 141 USART_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */
AnnaBridge 161:aa5281ff4a02 142 USART_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */
AnnaBridge 161:aa5281ff4a02 143 USART_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */
AnnaBridge 161:aa5281ff4a02 144 USART_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */
AnnaBridge 161:aa5281ff4a02 145 USART_CLOCKSOURCE_UNDEFINED = 0x10U /*!< Undefined clock source */
AnnaBridge 145:64910690c574 146 }USART_ClockSourceTypeDef;
AnnaBridge 145:64910690c574 147
AnnaBridge 145:64910690c574 148
AnnaBridge 145:64910690c574 149 /**
AnnaBridge 145:64910690c574 150 * @brief USART handle Structure definition
AnnaBridge 145:64910690c574 151 */
AnnaBridge 161:aa5281ff4a02 152 typedef struct __USART_HandleTypeDef
AnnaBridge 145:64910690c574 153 {
AnnaBridge 161:aa5281ff4a02 154 USART_TypeDef *Instance; /*!< USART registers base address */
AnnaBridge 161:aa5281ff4a02 155
AnnaBridge 161:aa5281ff4a02 156 USART_InitTypeDef Init; /*!< USART communication parameters */
AnnaBridge 145:64910690c574 157
AnnaBridge 161:aa5281ff4a02 158 uint8_t *pTxBuffPtr; /*!< Pointer to USART Tx transfer Buffer */
AnnaBridge 161:aa5281ff4a02 159
AnnaBridge 161:aa5281ff4a02 160 uint16_t TxXferSize; /*!< USART Tx Transfer size */
AnnaBridge 145:64910690c574 161
AnnaBridge 161:aa5281ff4a02 162 __IO uint16_t TxXferCount; /*!< USART Tx Transfer Counter */
AnnaBridge 145:64910690c574 163
AnnaBridge 161:aa5281ff4a02 164 uint8_t *pRxBuffPtr; /*!< Pointer to USART Rx transfer Buffer */
AnnaBridge 161:aa5281ff4a02 165
AnnaBridge 161:aa5281ff4a02 166 uint16_t RxXferSize; /*!< USART Rx Transfer size */
AnnaBridge 145:64910690c574 167
AnnaBridge 161:aa5281ff4a02 168 __IO uint16_t RxXferCount; /*!< USART Rx Transfer Counter */
AnnaBridge 145:64910690c574 169
AnnaBridge 161:aa5281ff4a02 170 uint16_t Mask; /*!< USART Rx RDR register mask */
AnnaBridge 161:aa5281ff4a02 171
AnnaBridge 161:aa5281ff4a02 172 #if defined(USART_CR1_FIFOEN)
AnnaBridge 161:aa5281ff4a02 173 uint16_t NbRxDataToProcess; /*!< Number of data to process during RX ISR execution */
AnnaBridge 145:64910690c574 174
AnnaBridge 161:aa5281ff4a02 175 uint16_t NbTxDataToProcess; /*!< Number of data to process during TX ISR execution */
AnnaBridge 145:64910690c574 176
AnnaBridge 161:aa5281ff4a02 177 uint32_t FifoMode; /*!< Specifies if the FIFO mode is being used.
AnnaBridge 161:aa5281ff4a02 178 This parameter can be a value of @ref USARTEx_FIFO_mode. */
AnnaBridge 161:aa5281ff4a02 179 #endif
AnnaBridge 145:64910690c574 180
AnnaBridge 161:aa5281ff4a02 181 #if defined(USART_CR2_SLVEN)
AnnaBridge 161:aa5281ff4a02 182 uint32_t SlaveMode; /*!< Specifies if the UART SPI Slave mode is being used.
AnnaBridge 161:aa5281ff4a02 183 This parameter can be a value of @ref USARTEx_Slave_Mode. */
AnnaBridge 161:aa5281ff4a02 184 #endif
AnnaBridge 145:64910690c574 185
AnnaBridge 161:aa5281ff4a02 186 void (*RxISR)(struct __USART_HandleTypeDef *husart); /*!< Function pointer on Rx IRQ handler */
AnnaBridge 145:64910690c574 187
AnnaBridge 161:aa5281ff4a02 188 void (*TxISR)(struct __USART_HandleTypeDef *husart); /*!< Function pointer on Tx IRQ handler */
AnnaBridge 161:aa5281ff4a02 189
AnnaBridge 161:aa5281ff4a02 190 DMA_HandleTypeDef *hdmatx; /*!< USART Tx DMA Handle parameters */
AnnaBridge 145:64910690c574 191
AnnaBridge 161:aa5281ff4a02 192 DMA_HandleTypeDef *hdmarx; /*!< USART Rx DMA Handle parameters */
AnnaBridge 161:aa5281ff4a02 193
AnnaBridge 161:aa5281ff4a02 194 HAL_LockTypeDef Lock; /*!< Locking object */
AnnaBridge 145:64910690c574 195
AnnaBridge 161:aa5281ff4a02 196 __IO HAL_USART_StateTypeDef State; /*!< USART communication state */
AnnaBridge 161:aa5281ff4a02 197
AnnaBridge 161:aa5281ff4a02 198 __IO uint32_t ErrorCode; /*!< USART Error code */
AnnaBridge 145:64910690c574 199
AnnaBridge 145:64910690c574 200 }USART_HandleTypeDef;
AnnaBridge 145:64910690c574 201
AnnaBridge 145:64910690c574 202 /**
AnnaBridge 145:64910690c574 203 * @}
AnnaBridge 145:64910690c574 204 */
AnnaBridge 145:64910690c574 205
AnnaBridge 145:64910690c574 206 /* Exported constants --------------------------------------------------------*/
AnnaBridge 145:64910690c574 207 /** @defgroup USART_Exported_Constants USART Exported Constants
AnnaBridge 145:64910690c574 208 * @{
AnnaBridge 145:64910690c574 209 */
AnnaBridge 145:64910690c574 210
AnnaBridge 145:64910690c574 211 /** @defgroup USART_Stop_Bits USART Number of Stop Bits
AnnaBridge 145:64910690c574 212 * @{
AnnaBridge 145:64910690c574 213 */
AnnaBridge 161:aa5281ff4a02 214 #define USART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< USART frame with 0.5 stop bit */
AnnaBridge 161:aa5281ff4a02 215 #define USART_STOPBITS_1 0x00000000U /*!< USART frame with 1 stop bit */
AnnaBridge 161:aa5281ff4a02 216 #define USART_STOPBITS_1_5 (USART_CR2_STOP_0 | USART_CR2_STOP_1) /*!< USART frame with 1.5 stop bits */
AnnaBridge 161:aa5281ff4a02 217 #define USART_STOPBITS_2 USART_CR2_STOP_1 /*!< USART frame with 2 stop bits */
AnnaBridge 145:64910690c574 218 /**
AnnaBridge 145:64910690c574 219 * @}
AnnaBridge 145:64910690c574 220 */
AnnaBridge 145:64910690c574 221
AnnaBridge 145:64910690c574 222 /** @defgroup USART_Parity USART Parity
AnnaBridge 145:64910690c574 223 * @{
AnnaBridge 145:64910690c574 224 */
AnnaBridge 161:aa5281ff4a02 225 #define USART_PARITY_NONE 0x00000000U /*!< No parity */
AnnaBridge 161:aa5281ff4a02 226 #define USART_PARITY_EVEN USART_CR1_PCE /*!< Even parity */
AnnaBridge 161:aa5281ff4a02 227 #define USART_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< Odd parity */
AnnaBridge 145:64910690c574 228 /**
AnnaBridge 145:64910690c574 229 * @}
AnnaBridge 145:64910690c574 230 */
AnnaBridge 145:64910690c574 231
AnnaBridge 145:64910690c574 232 /** @defgroup USART_Mode USART Mode
AnnaBridge 145:64910690c574 233 * @{
AnnaBridge 161:aa5281ff4a02 234 */
AnnaBridge 161:aa5281ff4a02 235 #define USART_MODE_RX USART_CR1_RE /*!< RX mode */
AnnaBridge 161:aa5281ff4a02 236 #define USART_MODE_TX USART_CR1_TE /*!< TX mode */
AnnaBridge 161:aa5281ff4a02 237 #define USART_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< RX and TX mode */
AnnaBridge 145:64910690c574 238 /**
AnnaBridge 145:64910690c574 239 * @}
AnnaBridge 145:64910690c574 240 */
AnnaBridge 145:64910690c574 241
AnnaBridge 145:64910690c574 242 /** @defgroup USART_Over_Sampling USART Over Sampling
AnnaBridge 145:64910690c574 243 * @{
AnnaBridge 145:64910690c574 244 */
AnnaBridge 161:aa5281ff4a02 245 #define USART_OVERSAMPLING_16 0x00000000U /*!< Oversampling by 16 */
AnnaBridge 161:aa5281ff4a02 246 #define USART_OVERSAMPLING_8 USART_CR1_OVER8 /*!< Oversampling by 8 */
AnnaBridge 145:64910690c574 247 /**
AnnaBridge 145:64910690c574 248 * @}
AnnaBridge 145:64910690c574 249 */
AnnaBridge 145:64910690c574 250
AnnaBridge 145:64910690c574 251 /** @defgroup USART_Clock USART Clock
AnnaBridge 145:64910690c574 252 * @{
AnnaBridge 145:64910690c574 253 */
AnnaBridge 161:aa5281ff4a02 254 #define USART_CLOCK_DISABLE 0x00000000U /*!< USART clock disable */
AnnaBridge 161:aa5281ff4a02 255 #define USART_CLOCK_ENABLE USART_CR2_CLKEN /*!< USART clock enable */
AnnaBridge 145:64910690c574 256 /**
AnnaBridge 145:64910690c574 257 * @}
AnnaBridge 145:64910690c574 258 */
AnnaBridge 145:64910690c574 259
AnnaBridge 145:64910690c574 260 /** @defgroup USART_Clock_Polarity USART Clock Polarity
AnnaBridge 145:64910690c574 261 * @{
AnnaBridge 145:64910690c574 262 */
AnnaBridge 161:aa5281ff4a02 263 #define USART_POLARITY_LOW 0x00000000U /*!< Driver enable signal is active high */
AnnaBridge 161:aa5281ff4a02 264 #define USART_POLARITY_HIGH USART_CR2_CPOL /*!< Driver enable signal is active low */
AnnaBridge 145:64910690c574 265 /**
AnnaBridge 145:64910690c574 266 * @}
AnnaBridge 145:64910690c574 267 */
AnnaBridge 145:64910690c574 268
AnnaBridge 145:64910690c574 269 /** @defgroup USART_Clock_Phase USART Clock Phase
AnnaBridge 145:64910690c574 270 * @{
AnnaBridge 145:64910690c574 271 */
AnnaBridge 161:aa5281ff4a02 272 #define USART_PHASE_1EDGE 0x00000000U /*!< USART frame phase on first clock transition */
AnnaBridge 161:aa5281ff4a02 273 #define USART_PHASE_2EDGE USART_CR2_CPHA /*!< USART frame phase on second clock transition */
AnnaBridge 145:64910690c574 274 /**
AnnaBridge 145:64910690c574 275 * @}
AnnaBridge 145:64910690c574 276 */
AnnaBridge 145:64910690c574 277
AnnaBridge 145:64910690c574 278 /** @defgroup USART_Last_Bit USART Last Bit
AnnaBridge 145:64910690c574 279 * @{
AnnaBridge 145:64910690c574 280 */
AnnaBridge 161:aa5281ff4a02 281 #define USART_LASTBIT_DISABLE 0x00000000U /*!< USART frame last data bit clock pulse not output to SCLK pin */
AnnaBridge 161:aa5281ff4a02 282 #define USART_LASTBIT_ENABLE USART_CR2_LBCL /*!< USART frame last data bit clock pulse output to SCLK pin */
AnnaBridge 145:64910690c574 283 /**
AnnaBridge 145:64910690c574 284 * @}
AnnaBridge 145:64910690c574 285 */
AnnaBridge 145:64910690c574 286
AnnaBridge 161:aa5281ff4a02 287 #if defined(USART_PRESC_PRESCALER)
AnnaBridge 161:aa5281ff4a02 288 /** @defgroup USART_ClockPrescaler USART Clock Prescaler
AnnaBridge 161:aa5281ff4a02 289 * @{
AnnaBridge 161:aa5281ff4a02 290 */
AnnaBridge 161:aa5281ff4a02 291 #define USART_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */
AnnaBridge 161:aa5281ff4a02 292 #define USART_PRESCALER_DIV2 0x00000001U /*!< fclk_pres = fclk/2 */
AnnaBridge 161:aa5281ff4a02 293 #define USART_PRESCALER_DIV4 0x00000002U /*!< fclk_pres = fclk/4 */
AnnaBridge 161:aa5281ff4a02 294 #define USART_PRESCALER_DIV6 0x00000003U /*!< fclk_pres = fclk/6 */
AnnaBridge 161:aa5281ff4a02 295 #define USART_PRESCALER_DIV8 0x00000004U /*!< fclk_pres = fclk/8 */
AnnaBridge 161:aa5281ff4a02 296 #define USART_PRESCALER_DIV10 0x00000005U /*!< fclk_pres = fclk/10 */
AnnaBridge 161:aa5281ff4a02 297 #define USART_PRESCALER_DIV12 0x00000006U /*!< fclk_pres = fclk/12 */
AnnaBridge 161:aa5281ff4a02 298 #define USART_PRESCALER_DIV16 0x00000007U /*!< fclk_pres = fclk/16 */
AnnaBridge 161:aa5281ff4a02 299 #define USART_PRESCALER_DIV32 0x00000008U /*!< fclk_pres = fclk/32 */
AnnaBridge 161:aa5281ff4a02 300 #define USART_PRESCALER_DIV64 0x00000009U /*!< fclk_pres = fclk/64 */
AnnaBridge 161:aa5281ff4a02 301 #define USART_PRESCALER_DIV128 0x0000000AU /*!< fclk_pres = fclk/128 */
AnnaBridge 161:aa5281ff4a02 302 #define USART_PRESCALER_DIV256 0x0000000BU /*!< fclk_pres = fclk/256 */
AnnaBridge 161:aa5281ff4a02 303 /**
AnnaBridge 161:aa5281ff4a02 304 * @}
AnnaBridge 161:aa5281ff4a02 305 */
AnnaBridge 161:aa5281ff4a02 306 #endif
AnnaBridge 161:aa5281ff4a02 307
AnnaBridge 145:64910690c574 308 /** @defgroup USART_Request_Parameters USART Request Parameters
AnnaBridge 145:64910690c574 309 * @{
AnnaBridge 145:64910690c574 310 */
AnnaBridge 161:aa5281ff4a02 311 #define USART_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */
AnnaBridge 161:aa5281ff4a02 312 #define USART_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush Request */
AnnaBridge 145:64910690c574 313 /**
AnnaBridge 145:64910690c574 314 * @}
AnnaBridge 145:64910690c574 315 */
AnnaBridge 145:64910690c574 316
AnnaBridge 145:64910690c574 317 /** @defgroup USART_Flags USART Flags
AnnaBridge 145:64910690c574 318 * Elements values convention: 0xXXXX
AnnaBridge 145:64910690c574 319 * - 0xXXXX : Flag mask in the ISR register
AnnaBridge 145:64910690c574 320 * @{
AnnaBridge 145:64910690c574 321 */
AnnaBridge 161:aa5281ff4a02 322 #if defined(USART_CR1_FIFOEN)
AnnaBridge 161:aa5281ff4a02 323 #define USART_FLAG_TXFT USART_ISR_TXFT /*!< USART TXFIFO threshold flag */
AnnaBridge 161:aa5281ff4a02 324 #define USART_FLAG_RXFT USART_ISR_RXFT /*!< USART RXFIFO threshold flag */
AnnaBridge 161:aa5281ff4a02 325 #define USART_FLAG_RXFF USART_ISR_RXFF /*!< USART RXFIFO Full flag */
AnnaBridge 161:aa5281ff4a02 326 #define USART_FLAG_TXFE USART_ISR_TXFE /*!< USART TXFIFO Empty flag */
AnnaBridge 161:aa5281ff4a02 327 #define USART_FLAG_TXE USART_ISR_TXE_TXFNF /*!< USART transmit data register empty */
AnnaBridge 161:aa5281ff4a02 328 #define USART_FLAG_TXFNF USART_ISR_TXE_TXFNF /*!< USART TXFIFO not full */
AnnaBridge 161:aa5281ff4a02 329 #define USART_FLAG_RXNE USART_ISR_RXNE_RXFNE /*!< USART read data register not empty */
AnnaBridge 161:aa5281ff4a02 330 #define USART_FLAG_RXFNE USART_ISR_RXNE_RXFNE /*!< USART RXFIFO not empty */
AnnaBridge 161:aa5281ff4a02 331 #else
AnnaBridge 161:aa5281ff4a02 332 #define USART_FLAG_TXE USART_ISR_TXE /*!< USART transmit data register empty */
AnnaBridge 161:aa5281ff4a02 333 #define USART_FLAG_RXNE USART_ISR_RXNE /*!< USART read data register not empty */
AnnaBridge 161:aa5281ff4a02 334 #endif
AnnaBridge 161:aa5281ff4a02 335 #define USART_FLAG_REACK USART_ISR_REACK /*!< USART receive enable acknowledge flag */
AnnaBridge 161:aa5281ff4a02 336 #define USART_FLAG_TEACK USART_ISR_TEACK /*!< USART transmit enable acknowledge flag */
AnnaBridge 161:aa5281ff4a02 337 #define USART_FLAG_BUSY USART_ISR_BUSY /*!< USART busy flag */
AnnaBridge 161:aa5281ff4a02 338 #define USART_FLAG_TC USART_ISR_TC /*!< USART transmission complete */
AnnaBridge 161:aa5281ff4a02 339 #define USART_FLAG_IDLE USART_ISR_IDLE /*!< USART idle flag */
AnnaBridge 161:aa5281ff4a02 340 #define USART_FLAG_ORE USART_ISR_ORE /*!< USART overrun error */
AnnaBridge 161:aa5281ff4a02 341 #define USART_FLAG_NE USART_ISR_NE /*!< USART noise error */
AnnaBridge 161:aa5281ff4a02 342 #define USART_FLAG_FE USART_ISR_FE /*!< USART frame error */
AnnaBridge 161:aa5281ff4a02 343 #define USART_FLAG_PE USART_ISR_PE /*!< USART parity error */
AnnaBridge 161:aa5281ff4a02 344 #if defined(USART_CR2_SLVEN)
AnnaBridge 161:aa5281ff4a02 345 #define USART_FLAG_UDR USART_ISR_UDR /*!< SPI slave underrun error flag */
AnnaBridge 161:aa5281ff4a02 346 #endif
AnnaBridge 145:64910690c574 347 /**
AnnaBridge 145:64910690c574 348 * @}
AnnaBridge 145:64910690c574 349 */
AnnaBridge 145:64910690c574 350
AnnaBridge 145:64910690c574 351 /** @defgroup USART_Interrupt_definition USART Interrupts Definition
AnnaBridge 145:64910690c574 352 * Elements values convention: 0000ZZZZ0XXYYYYYb
AnnaBridge 145:64910690c574 353 * - YYYYY : Interrupt source position in the XX register (5bits)
AnnaBridge 145:64910690c574 354 * - XX : Interrupt source register (2bits)
AnnaBridge 145:64910690c574 355 * - 01: CR1 register
AnnaBridge 145:64910690c574 356 * - 10: CR2 register
AnnaBridge 145:64910690c574 357 * - 11: CR3 register
AnnaBridge 145:64910690c574 358 * - ZZZZ : Flag position in the ISR register(4bits)
AnnaBridge 145:64910690c574 359 * @{
AnnaBridge 145:64910690c574 360 */
AnnaBridge 145:64910690c574 361
AnnaBridge 161:aa5281ff4a02 362 #define USART_IT_PE 0x0028U /*!< USART parity error interruption */
AnnaBridge 161:aa5281ff4a02 363 #if defined(USART_CR1_FIFOEN)
AnnaBridge 161:aa5281ff4a02 364 #define USART_IT_TXFNF 0x0727U /*!< USART TX FIFO not full interruption */
AnnaBridge 161:aa5281ff4a02 365 #define USART_IT_RXFNE 0x0525U /*!< USART RXFIFO not empty interruption */
AnnaBridge 161:aa5281ff4a02 366 #define USART_IT_RXFF 0x183FU /*!< USART RXFIFO full interruption */
AnnaBridge 161:aa5281ff4a02 367 #define USART_IT_TXFE 0x173EU /*!< USART TXFIFO empty interruption */
AnnaBridge 161:aa5281ff4a02 368 #define USART_IT_RXFT 0x1A7CU /*!< USART RXFIFO threshold reached interruption */
AnnaBridge 161:aa5281ff4a02 369 #define USART_IT_TXFT 0x1B77U /*!< USART TXFIFO threshold reached interruption */
AnnaBridge 161:aa5281ff4a02 370 #endif
AnnaBridge 161:aa5281ff4a02 371 #define USART_IT_TXE 0x0727U /*!< USART transmit data register empty interruption */
AnnaBridge 161:aa5281ff4a02 372 #define USART_IT_TC 0x0626U /*!< USART transmission complete interruption */
AnnaBridge 161:aa5281ff4a02 373 #define USART_IT_RXNE 0x0525U /*!< USART read data register not empty interruption */
AnnaBridge 161:aa5281ff4a02 374 #define USART_IT_IDLE 0x0424U /*!< USART idle interruption */
AnnaBridge 161:aa5281ff4a02 375 #define USART_IT_ERR 0x0060U /*!< USART error interruption */
AnnaBridge 161:aa5281ff4a02 376 #define USART_IT_ORE 0x0300U /*!< USART overrun error interruption */
AnnaBridge 161:aa5281ff4a02 377 #define USART_IT_NE 0x0200U /*!< USART noise error interruption */
AnnaBridge 161:aa5281ff4a02 378 #define USART_IT_FE 0x0100U /*!< USART frame error interruption */
AnnaBridge 161:aa5281ff4a02 379
AnnaBridge 145:64910690c574 380 /**
AnnaBridge 145:64910690c574 381 * @}
AnnaBridge 145:64910690c574 382 */
AnnaBridge 145:64910690c574 383
AnnaBridge 145:64910690c574 384 /** @defgroup USART_IT_CLEAR_Flags USART Interruption Clear Flags
AnnaBridge 145:64910690c574 385 * @{
AnnaBridge 145:64910690c574 386 */
AnnaBridge 161:aa5281ff4a02 387 #define USART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
AnnaBridge 161:aa5281ff4a02 388 #define USART_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
AnnaBridge 161:aa5281ff4a02 389 #define USART_CLEAR_NEF USART_ICR_NECF /*!< Noise detected Clear Flag */
AnnaBridge 161:aa5281ff4a02 390 #define USART_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */
AnnaBridge 161:aa5281ff4a02 391 #define USART_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */
AnnaBridge 161:aa5281ff4a02 392 #define USART_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
AnnaBridge 161:aa5281ff4a02 393 #if defined(USART_CR1_FIFOEN)
AnnaBridge 161:aa5281ff4a02 394 #define USART_CLEAR_TXFECF USART_ICR_TXFECF /*!< TXFIFO Empty Clear Flag */
AnnaBridge 161:aa5281ff4a02 395 #endif
AnnaBridge 161:aa5281ff4a02 396 #if defined(USART_CR2_SLVEN)
AnnaBridge 161:aa5281ff4a02 397 #define USART_CLEAR_UDRF USART_ICR_UDRCF /*!< SPI slave underrun error Clear Flag */
AnnaBridge 161:aa5281ff4a02 398 #endif
AnnaBridge 145:64910690c574 399 /**
AnnaBridge 145:64910690c574 400 * @}
AnnaBridge 145:64910690c574 401 */
AnnaBridge 145:64910690c574 402
AnnaBridge 145:64910690c574 403 /** @defgroup USART_Interruption_Mask USART Interruption Flags Mask
AnnaBridge 145:64910690c574 404 * @{
AnnaBridge 161:aa5281ff4a02 405 */
AnnaBridge 161:aa5281ff4a02 406 #define USART_IT_MASK 0x001FU /*!< USART interruptions flags mask */
AnnaBridge 145:64910690c574 407 /**
AnnaBridge 145:64910690c574 408 * @}
AnnaBridge 145:64910690c574 409 */
AnnaBridge 145:64910690c574 410
AnnaBridge 145:64910690c574 411 /**
AnnaBridge 145:64910690c574 412 * @}
AnnaBridge 145:64910690c574 413 */
AnnaBridge 145:64910690c574 414
AnnaBridge 145:64910690c574 415 /* Exported macros -----------------------------------------------------------*/
AnnaBridge 145:64910690c574 416 /** @defgroup USART_Exported_Macros USART Exported Macros
AnnaBridge 145:64910690c574 417 * @{
AnnaBridge 145:64910690c574 418 */
AnnaBridge 145:64910690c574 419
AnnaBridge 145:64910690c574 420 /** @brief Reset USART handle state.
AnnaBridge 161:aa5281ff4a02 421 * @param __HANDLE__ USART handle.
AnnaBridge 145:64910690c574 422 * @retval None
AnnaBridge 145:64910690c574 423 */
AnnaBridge 145:64910690c574 424 #define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_USART_STATE_RESET)
AnnaBridge 145:64910690c574 425
AnnaBridge 145:64910690c574 426 /** @brief Check whether the specified USART flag is set or not.
AnnaBridge 161:aa5281ff4a02 427 * @param __HANDLE__ specifies the USART Handle
AnnaBridge 161:aa5281ff4a02 428 * @param __FLAG__ specifies the flag to check.
AnnaBridge 145:64910690c574 429 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 430 * @arg @ref USART_FLAG_TXFT TXFIFO threshold flag
AnnaBridge 161:aa5281ff4a02 431 * @arg @ref USART_FLAG_RXFT RXFIFO threshold flag
AnnaBridge 161:aa5281ff4a02 432 * @arg @ref USART_FLAG_RXFF RXFIFO Full flag
AnnaBridge 161:aa5281ff4a02 433 * @arg @ref USART_FLAG_TXFE TXFIFO Empty flag
AnnaBridge 145:64910690c574 434 * @arg @ref USART_FLAG_REACK Receive enable acknowledge flag
AnnaBridge 145:64910690c574 435 * @arg @ref USART_FLAG_TEACK Transmit enable acknowledge flag
AnnaBridge 145:64910690c574 436 * @arg @ref USART_FLAG_BUSY Busy flag
AnnaBridge 161:aa5281ff4a02 437 * @arg @ref USART_FLAG_UDR SPI slave underrun error flag
AnnaBridge 145:64910690c574 438 * @arg @ref USART_FLAG_TXE Transmit data register empty flag
AnnaBridge 161:aa5281ff4a02 439 * @arg @ref USART_FLAG_TXFNF TXFIFO not full flag
AnnaBridge 145:64910690c574 440 * @arg @ref USART_FLAG_TC Transmission Complete flag
AnnaBridge 145:64910690c574 441 * @arg @ref USART_FLAG_RXNE Receive data register not empty flag
AnnaBridge 161:aa5281ff4a02 442 * @arg @ref USART_FLAG_RXFNE RXFIFO not empty flag
AnnaBridge 145:64910690c574 443 * @arg @ref USART_FLAG_IDLE Idle Line detection flag
AnnaBridge 145:64910690c574 444 * @arg @ref USART_FLAG_ORE OverRun Error flag
AnnaBridge 145:64910690c574 445 * @arg @ref USART_FLAG_NE Noise Error flag
AnnaBridge 145:64910690c574 446 * @arg @ref USART_FLAG_FE Framing Error flag
AnnaBridge 145:64910690c574 447 * @arg @ref USART_FLAG_PE Parity Error flag
AnnaBridge 145:64910690c574 448 * @retval The new state of __FLAG__ (TRUE or FALSE).
AnnaBridge 145:64910690c574 449 */
AnnaBridge 145:64910690c574 450 #define __HAL_USART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
AnnaBridge 145:64910690c574 451
AnnaBridge 145:64910690c574 452 /** @brief Clear the specified USART pending flag.
AnnaBridge 161:aa5281ff4a02 453 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 161:aa5281ff4a02 454 * @param __FLAG__ specifies the flag to check.
AnnaBridge 145:64910690c574 455 * This parameter can be any combination of the following values:
AnnaBridge 161:aa5281ff4a02 456 * @arg @ref USART_CLEAR_PEF Parity Error Clear Flag
AnnaBridge 161:aa5281ff4a02 457 * @arg @ref USART_CLEAR_FEF Framing Error Clear Flag
AnnaBridge 161:aa5281ff4a02 458 * @arg @ref USART_CLEAR_NEF Noise detected Clear Flag
AnnaBridge 161:aa5281ff4a02 459 * @arg @ref USART_CLEAR_OREF Overrun Error Clear Flag
AnnaBridge 161:aa5281ff4a02 460 * @arg @ref USART_CLEAR_IDLEF IDLE line detected Clear Flag
AnnaBridge 161:aa5281ff4a02 461 * @arg @ref USART_CLEAR_TXFECF TXFIFO empty clear Flag
AnnaBridge 161:aa5281ff4a02 462 * @arg @ref USART_CLEAR_TCF Transmission Complete Clear Flag
AnnaBridge 161:aa5281ff4a02 463 * @arg @ref USART_CLEAR_UDRF SPI slave underrun error Clear Flag
AnnaBridge 145:64910690c574 464 * @retval None
AnnaBridge 145:64910690c574 465 */
AnnaBridge 145:64910690c574 466 #define __HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
AnnaBridge 145:64910690c574 467
AnnaBridge 145:64910690c574 468 /** @brief Clear the USART PE pending flag.
AnnaBridge 161:aa5281ff4a02 469 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 145:64910690c574 470 * @retval None
AnnaBridge 145:64910690c574 471 */
AnnaBridge 145:64910690c574 472 #define __HAL_USART_CLEAR_PEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_PEF)
AnnaBridge 145:64910690c574 473
AnnaBridge 145:64910690c574 474 /** @brief Clear the USART FE pending flag.
AnnaBridge 161:aa5281ff4a02 475 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 145:64910690c574 476 * @retval None
AnnaBridge 145:64910690c574 477 */
AnnaBridge 145:64910690c574 478 #define __HAL_USART_CLEAR_FEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_FEF)
AnnaBridge 145:64910690c574 479
AnnaBridge 145:64910690c574 480 /** @brief Clear the USART NE pending flag.
AnnaBridge 161:aa5281ff4a02 481 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 145:64910690c574 482 * @retval None
AnnaBridge 145:64910690c574 483 */
AnnaBridge 145:64910690c574 484 #define __HAL_USART_CLEAR_NEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_NEF)
AnnaBridge 145:64910690c574 485
AnnaBridge 145:64910690c574 486 /** @brief Clear the USART ORE pending flag.
AnnaBridge 161:aa5281ff4a02 487 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 145:64910690c574 488 * @retval None
AnnaBridge 145:64910690c574 489 */
AnnaBridge 145:64910690c574 490 #define __HAL_USART_CLEAR_OREFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_OREF)
AnnaBridge 145:64910690c574 491
AnnaBridge 145:64910690c574 492 /** @brief Clear the USART IDLE pending flag.
AnnaBridge 161:aa5281ff4a02 493 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 145:64910690c574 494 * @retval None
AnnaBridge 145:64910690c574 495 */
AnnaBridge 145:64910690c574 496 #define __HAL_USART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_IDLEF)
AnnaBridge 145:64910690c574 497
AnnaBridge 161:aa5281ff4a02 498 #if defined(USART_CR1_FIFOEN)
AnnaBridge 161:aa5281ff4a02 499 /** @brief Clear the USART TX FIFO empty clear flag.
AnnaBridge 161:aa5281ff4a02 500 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 161:aa5281ff4a02 501 * @retval None
AnnaBridge 161:aa5281ff4a02 502 */
AnnaBridge 161:aa5281ff4a02 503 #define __HAL_USART_CLEAR_TXFECF(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_TXFECF)
AnnaBridge 161:aa5281ff4a02 504 #endif
AnnaBridge 161:aa5281ff4a02 505
AnnaBridge 161:aa5281ff4a02 506 #if defined(USART_CR2_SLVEN)
AnnaBridge 161:aa5281ff4a02 507 /** @brief Clear SPI slave underrun error flag.
AnnaBridge 161:aa5281ff4a02 508 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 145:64910690c574 509 * @retval None
AnnaBridge 145:64910690c574 510 */
AnnaBridge 161:aa5281ff4a02 511 #define __HAL_USART_CLEAR_UDRFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_UDRF)
AnnaBridge 161:aa5281ff4a02 512 #endif
AnnaBridge 161:aa5281ff4a02 513
AnnaBridge 161:aa5281ff4a02 514 /** @brief Enable the specified USART interrupt.
AnnaBridge 161:aa5281ff4a02 515 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 161:aa5281ff4a02 516 * @param __INTERRUPT__ specifies the USART interrupt source to enable.
AnnaBridge 161:aa5281ff4a02 517 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 518 * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
AnnaBridge 161:aa5281ff4a02 519 * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
AnnaBridge 161:aa5281ff4a02 520 * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
AnnaBridge 161:aa5281ff4a02 521 * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
AnnaBridge 161:aa5281ff4a02 522 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
AnnaBridge 161:aa5281ff4a02 523 * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
AnnaBridge 161:aa5281ff4a02 524 * @arg @ref USART_IT_TC Transmission complete interrupt
AnnaBridge 161:aa5281ff4a02 525 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
AnnaBridge 161:aa5281ff4a02 526 * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
AnnaBridge 161:aa5281ff4a02 527 * @arg @ref USART_IT_IDLE Idle line detection interrupt
AnnaBridge 161:aa5281ff4a02 528 * @arg @ref USART_IT_PE Parity Error interrupt
AnnaBridge 161:aa5281ff4a02 529 * @arg @ref USART_IT_ERR Error interrupt(Frame error, noise error, overrun error)
AnnaBridge 161:aa5281ff4a02 530 * @retval None
AnnaBridge 161:aa5281ff4a02 531 */
AnnaBridge 161:aa5281ff4a02 532 #define __HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
AnnaBridge 161:aa5281ff4a02 533 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
AnnaBridge 145:64910690c574 534 ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))))
AnnaBridge 145:64910690c574 535
AnnaBridge 145:64910690c574 536 /** @brief Disable the specified USART interrupt.
AnnaBridge 161:aa5281ff4a02 537 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 161:aa5281ff4a02 538 * @param __INTERRUPT__ specifies the USART interrupt source to disable.
AnnaBridge 145:64910690c574 539 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 540 * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
AnnaBridge 161:aa5281ff4a02 541 * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
AnnaBridge 161:aa5281ff4a02 542 * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
AnnaBridge 161:aa5281ff4a02 543 * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
AnnaBridge 161:aa5281ff4a02 544 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
AnnaBridge 161:aa5281ff4a02 545 * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
AnnaBridge 161:aa5281ff4a02 546 * @arg @ref USART_IT_TC Transmission complete interrupt
AnnaBridge 161:aa5281ff4a02 547 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
AnnaBridge 161:aa5281ff4a02 548 * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
AnnaBridge 161:aa5281ff4a02 549 * @arg @ref USART_IT_IDLE Idle line detection interrupt
AnnaBridge 161:aa5281ff4a02 550 * @arg @ref USART_IT_PE Parity Error interrupt
AnnaBridge 161:aa5281ff4a02 551 * @arg @ref USART_IT_ERR Error interrupt(Frame error, noise error, overrun error)
AnnaBridge 145:64910690c574 552 * @retval None
AnnaBridge 145:64910690c574 553 */
AnnaBridge 161:aa5281ff4a02 554 #define __HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
AnnaBridge 161:aa5281ff4a02 555 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
AnnaBridge 145:64910690c574 556 ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))))
AnnaBridge 145:64910690c574 557
AnnaBridge 145:64910690c574 558
AnnaBridge 145:64910690c574 559 /** @brief Check whether the specified USART interrupt has occurred or not.
AnnaBridge 161:aa5281ff4a02 560 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 161:aa5281ff4a02 561 * @param __INTERRUPT__ specifies the USART interrupt source to check.
AnnaBridge 145:64910690c574 562 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 563 * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
AnnaBridge 161:aa5281ff4a02 564 * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
AnnaBridge 161:aa5281ff4a02 565 * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
AnnaBridge 161:aa5281ff4a02 566 * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
AnnaBridge 161:aa5281ff4a02 567 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
AnnaBridge 161:aa5281ff4a02 568 * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
AnnaBridge 161:aa5281ff4a02 569 * @arg @ref USART_IT_TC Transmission complete interrupt
AnnaBridge 161:aa5281ff4a02 570 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
AnnaBridge 161:aa5281ff4a02 571 * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
AnnaBridge 161:aa5281ff4a02 572 * @arg @ref USART_IT_IDLE Idle line detection interrupt
AnnaBridge 161:aa5281ff4a02 573 * @arg @ref USART_IT_ORE OverRun Error interrupt
AnnaBridge 161:aa5281ff4a02 574 * @arg @ref USART_IT_NE Noise Error interrupt
AnnaBridge 161:aa5281ff4a02 575 * @arg @ref USART_IT_FE Framing Error interrupt
AnnaBridge 161:aa5281ff4a02 576 * @arg @ref USART_IT_PE Parity Error interrupt
AnnaBridge 161:aa5281ff4a02 577 * @retval The new state of __INTERRUPT__ (SET or RESET).
AnnaBridge 145:64910690c574 578 */
AnnaBridge 161:aa5281ff4a02 579 #define __HAL_USART_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR & ((uint32_t)1 << ((__INTERRUPT__)>> 0x08))) != RESET) ? SET : RESET)
AnnaBridge 145:64910690c574 580
AnnaBridge 145:64910690c574 581 /** @brief Check whether the specified USART interrupt source is enabled or not.
AnnaBridge 161:aa5281ff4a02 582 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 161:aa5281ff4a02 583 * @param __INTERRUPT__ specifies the USART interrupt source to check.
AnnaBridge 145:64910690c574 584 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 585 * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
AnnaBridge 161:aa5281ff4a02 586 * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
AnnaBridge 161:aa5281ff4a02 587 * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
AnnaBridge 161:aa5281ff4a02 588 * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
AnnaBridge 161:aa5281ff4a02 589 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
AnnaBridge 161:aa5281ff4a02 590 * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
AnnaBridge 161:aa5281ff4a02 591 * @arg @ref USART_IT_TC Transmission complete interrupt
AnnaBridge 161:aa5281ff4a02 592 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
AnnaBridge 161:aa5281ff4a02 593 * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
AnnaBridge 161:aa5281ff4a02 594 * @arg @ref USART_IT_IDLE Idle line detection interrupt
AnnaBridge 161:aa5281ff4a02 595 * @arg @ref USART_IT_ORE OverRun Error interrupt
AnnaBridge 161:aa5281ff4a02 596 * @arg @ref USART_IT_NE Noise Error interrupt
AnnaBridge 161:aa5281ff4a02 597 * @arg @ref USART_IT_FE Framing Error interrupt
AnnaBridge 161:aa5281ff4a02 598 * @arg @ref USART_IT_PE Parity Error interrupt
AnnaBridge 161:aa5281ff4a02 599 * @retval The new state of __INTERRUPT__ (SET or RESET).
AnnaBridge 145:64910690c574 600 */
AnnaBridge 161:aa5281ff4a02 601 #define __HAL_USART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((uint8_t)(__INTERRUPT__)) >> 0x05U) == 0x01U) ? (__HANDLE__)->Instance->CR1 : \
AnnaBridge 161:aa5281ff4a02 602 (((((uint8_t)(__INTERRUPT__)) >> 0x05U) == 0x02U) ? (__HANDLE__)->Instance->CR2 : \
AnnaBridge 161:aa5281ff4a02 603 (__HANDLE__)->Instance->CR3)) & (0x01U << (((uint16_t)(__INTERRUPT__)) & USART_IT_MASK))) != RESET) ? SET : RESET)
AnnaBridge 145:64910690c574 604
AnnaBridge 145:64910690c574 605
AnnaBridge 145:64910690c574 606 /** @brief Clear the specified USART ISR flag, in setting the proper ICR register flag.
AnnaBridge 161:aa5281ff4a02 607 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 161:aa5281ff4a02 608 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
AnnaBridge 145:64910690c574 609 * to clear the corresponding interrupt.
AnnaBridge 145:64910690c574 610 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 611 * @arg @ref USART_CLEAR_PEF Parity Error Clear Flag
AnnaBridge 161:aa5281ff4a02 612 * @arg @ref USART_CLEAR_FEF Framing Error Clear Flag
AnnaBridge 161:aa5281ff4a02 613 * @arg @ref USART_CLEAR_NEF Noise detected Clear Flag
AnnaBridge 161:aa5281ff4a02 614 * @arg @ref USART_CLEAR_OREF Overrun Error Clear Flag
AnnaBridge 161:aa5281ff4a02 615 * @arg @ref USART_CLEAR_IDLEF IDLE line detected Clear Flag
AnnaBridge 161:aa5281ff4a02 616 * @arg @ref USART_CLEAR_TXFECF TXFIFO empty clear Flag
AnnaBridge 161:aa5281ff4a02 617 * @arg @ref USART_CLEAR_TCF Transmission Complete Clear Flag
AnnaBridge 145:64910690c574 618 * @retval None
AnnaBridge 145:64910690c574 619 */
AnnaBridge 145:64910690c574 620 #define __HAL_USART_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
AnnaBridge 145:64910690c574 621
AnnaBridge 145:64910690c574 622 /** @brief Set a specific USART request flag.
AnnaBridge 161:aa5281ff4a02 623 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 161:aa5281ff4a02 624 * @param __REQ__ specifies the request flag to set.
AnnaBridge 145:64910690c574 625 * This parameter can be one of the following values:
AnnaBridge 145:64910690c574 626 * @arg @ref USART_RXDATA_FLUSH_REQUEST Receive Data flush Request
AnnaBridge 145:64910690c574 627 * @arg @ref USART_TXDATA_FLUSH_REQUEST Transmit data flush Request
AnnaBridge 145:64910690c574 628 *
AnnaBridge 145:64910690c574 629 * @retval None
AnnaBridge 145:64910690c574 630 */
AnnaBridge 145:64910690c574 631 #define __HAL_USART_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (__REQ__))
AnnaBridge 145:64910690c574 632
AnnaBridge 145:64910690c574 633 /** @brief Enable the USART one bit sample method.
AnnaBridge 161:aa5281ff4a02 634 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 145:64910690c574 635 * @retval None
AnnaBridge 161:aa5281ff4a02 636 */
AnnaBridge 145:64910690c574 637 #define __HAL_USART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
AnnaBridge 145:64910690c574 638
AnnaBridge 145:64910690c574 639 /** @brief Disable the USART one bit sample method.
AnnaBridge 161:aa5281ff4a02 640 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 145:64910690c574 641 * @retval None
AnnaBridge 161:aa5281ff4a02 642 */
AnnaBridge 161:aa5281ff4a02 643 #define __HAL_USART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT)
AnnaBridge 145:64910690c574 644
AnnaBridge 145:64910690c574 645 /** @brief Enable USART.
AnnaBridge 161:aa5281ff4a02 646 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 145:64910690c574 647 * @retval None
AnnaBridge 145:64910690c574 648 */
AnnaBridge 161:aa5281ff4a02 649 #define __HAL_USART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
AnnaBridge 145:64910690c574 650
AnnaBridge 145:64910690c574 651 /** @brief Disable USART.
AnnaBridge 161:aa5281ff4a02 652 * @param __HANDLE__ specifies the USART Handle.
AnnaBridge 145:64910690c574 653 * @retval None
AnnaBridge 145:64910690c574 654 */
AnnaBridge 161:aa5281ff4a02 655 #define __HAL_USART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
AnnaBridge 145:64910690c574 656
AnnaBridge 145:64910690c574 657 /**
AnnaBridge 145:64910690c574 658 * @}
AnnaBridge 145:64910690c574 659 */
AnnaBridge 145:64910690c574 660
AnnaBridge 161:aa5281ff4a02 661 /* Private variables -----------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 662 #if defined(USART_PRESC_PRESCALER)
AnnaBridge 161:aa5281ff4a02 663 /** @defgroup USART_Private_Variables USART Private Variables
AnnaBridge 161:aa5281ff4a02 664 * @{
AnnaBridge 161:aa5281ff4a02 665 */
AnnaBridge 161:aa5281ff4a02 666 static const uint16_t USARTPrescTable[12] = {1, 2, 4, 6, 8, 10, 12, 16, 32, 64, 128, 256};
AnnaBridge 161:aa5281ff4a02 667 /**
AnnaBridge 161:aa5281ff4a02 668 * @}
AnnaBridge 161:aa5281ff4a02 669 */
AnnaBridge 161:aa5281ff4a02 670 #endif
AnnaBridge 161:aa5281ff4a02 671
AnnaBridge 145:64910690c574 672 /* Private macros --------------------------------------------------------*/
AnnaBridge 145:64910690c574 673 /** @defgroup USART_Private_Macros USART Private Macros
AnnaBridge 145:64910690c574 674 * @{
AnnaBridge 145:64910690c574 675 */
AnnaBridge 145:64910690c574 676
AnnaBridge 161:aa5281ff4a02 677 #if defined(USART_PRESC_PRESCALER)
AnnaBridge 161:aa5281ff4a02 678 /** @brief BRR division operation to set BRR register in 8-bit oversampling mode.
AnnaBridge 161:aa5281ff4a02 679 * @param __PCLK__ USART clock.
AnnaBridge 161:aa5281ff4a02 680 * @param __BAUD__ Baud rate set by the user.
AnnaBridge 161:aa5281ff4a02 681 * @param __CLOCKPRESCALER__ UART prescaler value.
AnnaBridge 161:aa5281ff4a02 682 * @retval Division result
AnnaBridge 161:aa5281ff4a02 683 */
AnnaBridge 161:aa5281ff4a02 684 #define USART_DIV_SAMPLING8(__PCLK__, __BAUD__, __CLOCKPRESCALER__) (((((__PCLK__)/USARTPrescTable[(__CLOCKPRESCALER__)])*2) + ((__BAUD__)/2)) / (__BAUD__))
AnnaBridge 161:aa5281ff4a02 685 #else
AnnaBridge 161:aa5281ff4a02 686 /** @brief BRR division operation to set BRR register in 8-bit oversampling mode.
AnnaBridge 161:aa5281ff4a02 687 * @param __PCLK__ USART clock.
AnnaBridge 161:aa5281ff4a02 688 * @param __BAUD__ Baud rate set by the user.
AnnaBridge 161:aa5281ff4a02 689 * @retval Division result
AnnaBridge 161:aa5281ff4a02 690 */
AnnaBridge 161:aa5281ff4a02 691 #define USART_DIV_SAMPLING8(__PCLK__, __BAUD__) ((((__PCLK__)*2) + ((__BAUD__)/2)) / (__BAUD__))
AnnaBridge 161:aa5281ff4a02 692 #endif
AnnaBridge 161:aa5281ff4a02 693
AnnaBridge 145:64910690c574 694 /** @brief Check USART Baud rate.
AnnaBridge 161:aa5281ff4a02 695 * @param __BAUDRATE__ Baudrate specified by the user.
AnnaBridge 161:aa5281ff4a02 696 * The maximum Baud Rate is derived from the maximum clock on L4
AnnaBridge 161:aa5281ff4a02 697 * divided by the smallest oversampling used on the USART (i.e. 8)
AnnaBridge 161:aa5281ff4a02 698 * (i.e. 120 MHz on STM32L4Rx/L4Sx, 80 Mhz otherwise)
AnnaBridge 161:aa5281ff4a02 699 * @retval SET (__BAUDRATE__ is valid) or RESET (__BAUDRATE__ is invalid) */
AnnaBridge 161:aa5281ff4a02 700 #if defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
AnnaBridge 161:aa5281ff4a02 701 #define IS_USART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 15000001U)
AnnaBridge 161:aa5281ff4a02 702 #else
AnnaBridge 161:aa5281ff4a02 703 #define IS_USART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 10000001U)
AnnaBridge 161:aa5281ff4a02 704 #endif
AnnaBridge 145:64910690c574 705
AnnaBridge 145:64910690c574 706 /**
AnnaBridge 145:64910690c574 707 * @brief Ensure that USART frame number of stop bits is valid.
AnnaBridge 161:aa5281ff4a02 708 * @param __STOPBITS__ USART frame number of stop bits.
AnnaBridge 145:64910690c574 709 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
AnnaBridge 145:64910690c574 710 */
AnnaBridge 145:64910690c574 711 #define IS_USART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == USART_STOPBITS_0_5) || \
AnnaBridge 145:64910690c574 712 ((__STOPBITS__) == USART_STOPBITS_1) || \
AnnaBridge 145:64910690c574 713 ((__STOPBITS__) == USART_STOPBITS_1_5) || \
AnnaBridge 145:64910690c574 714 ((__STOPBITS__) == USART_STOPBITS_2))
AnnaBridge 145:64910690c574 715
AnnaBridge 145:64910690c574 716 /**
AnnaBridge 145:64910690c574 717 * @brief Ensure that USART frame parity is valid.
AnnaBridge 161:aa5281ff4a02 718 * @param __PARITY__ USART frame parity.
AnnaBridge 145:64910690c574 719 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
AnnaBridge 145:64910690c574 720 */
AnnaBridge 145:64910690c574 721 #define IS_USART_PARITY(__PARITY__) (((__PARITY__) == USART_PARITY_NONE) || \
AnnaBridge 145:64910690c574 722 ((__PARITY__) == USART_PARITY_EVEN) || \
AnnaBridge 161:aa5281ff4a02 723 ((__PARITY__) == USART_PARITY_ODD))
AnnaBridge 145:64910690c574 724
AnnaBridge 145:64910690c574 725 /**
AnnaBridge 145:64910690c574 726 * @brief Ensure that USART communication mode is valid.
AnnaBridge 161:aa5281ff4a02 727 * @param __MODE__ USART communication mode.
AnnaBridge 145:64910690c574 728 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
AnnaBridge 145:64910690c574 729 */
AnnaBridge 145:64910690c574 730 #define IS_USART_MODE(__MODE__) ((((__MODE__) & (uint32_t)0xFFFFFFF3U) == 0x00U) && ((__MODE__) != (uint32_t)0x00U))
AnnaBridge 145:64910690c574 731
AnnaBridge 145:64910690c574 732 /**
AnnaBridge 145:64910690c574 733 * @brief Ensure that USART oversampling is valid.
AnnaBridge 161:aa5281ff4a02 734 * @param __SAMPLING__ USART oversampling.
AnnaBridge 145:64910690c574 735 * @retval SET (__SAMPLING__ is valid) or RESET (__SAMPLING__ is invalid)
AnnaBridge 145:64910690c574 736 */
AnnaBridge 145:64910690c574 737 #define IS_USART_OVERSAMPLING(__SAMPLING__) (((__SAMPLING__) == USART_OVERSAMPLING_16) || \
AnnaBridge 145:64910690c574 738 ((__SAMPLING__) == USART_OVERSAMPLING_8))
AnnaBridge 145:64910690c574 739
AnnaBridge 145:64910690c574 740 /**
AnnaBridge 145:64910690c574 741 * @brief Ensure that USART clock state is valid.
AnnaBridge 161:aa5281ff4a02 742 * @param __CLOCK__ USART clock state.
AnnaBridge 145:64910690c574 743 * @retval SET (__CLOCK__ is valid) or RESET (__CLOCK__ is invalid)
AnnaBridge 145:64910690c574 744 */
AnnaBridge 145:64910690c574 745 #define IS_USART_CLOCK(__CLOCK__) (((__CLOCK__) == USART_CLOCK_DISABLE) || \
AnnaBridge 145:64910690c574 746 ((__CLOCK__) == USART_CLOCK_ENABLE))
AnnaBridge 145:64910690c574 747
AnnaBridge 145:64910690c574 748 /**
AnnaBridge 145:64910690c574 749 * @brief Ensure that USART frame polarity is valid.
AnnaBridge 161:aa5281ff4a02 750 * @param __CPOL__ USART frame polarity.
AnnaBridge 145:64910690c574 751 * @retval SET (__CPOL__ is valid) or RESET (__CPOL__ is invalid)
AnnaBridge 145:64910690c574 752 */
AnnaBridge 145:64910690c574 753 #define IS_USART_POLARITY(__CPOL__) (((__CPOL__) == USART_POLARITY_LOW) || ((__CPOL__) == USART_POLARITY_HIGH))
AnnaBridge 145:64910690c574 754
AnnaBridge 145:64910690c574 755 /**
AnnaBridge 145:64910690c574 756 * @brief Ensure that USART frame phase is valid.
AnnaBridge 161:aa5281ff4a02 757 * @param __CPHA__ USART frame phase.
AnnaBridge 145:64910690c574 758 * @retval SET (__CPHA__ is valid) or RESET (__CPHA__ is invalid)
AnnaBridge 145:64910690c574 759 */
AnnaBridge 145:64910690c574 760 #define IS_USART_PHASE(__CPHA__) (((__CPHA__) == USART_PHASE_1EDGE) || ((__CPHA__) == USART_PHASE_2EDGE))
AnnaBridge 145:64910690c574 761
AnnaBridge 145:64910690c574 762 /**
AnnaBridge 145:64910690c574 763 * @brief Ensure that USART frame last bit clock pulse setting is valid.
AnnaBridge 161:aa5281ff4a02 764 * @param __LASTBIT__ USART frame last bit clock pulse setting.
AnnaBridge 145:64910690c574 765 * @retval SET (__LASTBIT__ is valid) or RESET (__LASTBIT__ is invalid)
AnnaBridge 145:64910690c574 766 */
AnnaBridge 145:64910690c574 767 #define IS_USART_LASTBIT(__LASTBIT__) (((__LASTBIT__) == USART_LASTBIT_DISABLE) || \
AnnaBridge 145:64910690c574 768 ((__LASTBIT__) == USART_LASTBIT_ENABLE))
AnnaBridge 145:64910690c574 769
AnnaBridge 145:64910690c574 770 /**
AnnaBridge 145:64910690c574 771 * @brief Ensure that USART request parameter is valid.
AnnaBridge 161:aa5281ff4a02 772 * @param __PARAM__ USART request parameter.
AnnaBridge 145:64910690c574 773 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
AnnaBridge 145:64910690c574 774 */
AnnaBridge 145:64910690c574 775 #define IS_USART_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == USART_RXDATA_FLUSH_REQUEST) || \
AnnaBridge 145:64910690c574 776 ((__PARAM__) == USART_TXDATA_FLUSH_REQUEST))
AnnaBridge 145:64910690c574 777
AnnaBridge 161:aa5281ff4a02 778 #if defined(USART_PRESC_PRESCALER)
AnnaBridge 161:aa5281ff4a02 779 /**
AnnaBridge 161:aa5281ff4a02 780 * @brief Ensure that USART Prescaler is valid.
AnnaBridge 161:aa5281ff4a02 781 * @param __CLOCKPRESCALER__ USART Prescaler value.
AnnaBridge 161:aa5281ff4a02 782 * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid)
AnnaBridge 161:aa5281ff4a02 783 */
AnnaBridge 161:aa5281ff4a02 784 #define IS_USART_PRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == USART_PRESCALER_DIV1) || \
AnnaBridge 161:aa5281ff4a02 785 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV2) || \
AnnaBridge 161:aa5281ff4a02 786 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV4) || \
AnnaBridge 161:aa5281ff4a02 787 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV6) || \
AnnaBridge 161:aa5281ff4a02 788 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV8) || \
AnnaBridge 161:aa5281ff4a02 789 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV10) || \
AnnaBridge 161:aa5281ff4a02 790 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV12) || \
AnnaBridge 161:aa5281ff4a02 791 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV16) || \
AnnaBridge 161:aa5281ff4a02 792 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV32) || \
AnnaBridge 161:aa5281ff4a02 793 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV64) || \
AnnaBridge 161:aa5281ff4a02 794 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV128) || \
AnnaBridge 161:aa5281ff4a02 795 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV256))
AnnaBridge 161:aa5281ff4a02 796
AnnaBridge 161:aa5281ff4a02 797 #endif
AnnaBridge 145:64910690c574 798 /**
AnnaBridge 145:64910690c574 799 * @}
AnnaBridge 145:64910690c574 800 */
AnnaBridge 145:64910690c574 801
AnnaBridge 145:64910690c574 802 /* Include USART HAL Extended module */
AnnaBridge 145:64910690c574 803 #include "stm32l4xx_hal_usart_ex.h"
AnnaBridge 145:64910690c574 804
AnnaBridge 145:64910690c574 805 /* Exported functions --------------------------------------------------------*/
AnnaBridge 145:64910690c574 806 /** @addtogroup USART_Exported_Functions USART Exported Functions
AnnaBridge 145:64910690c574 807 * @{
AnnaBridge 145:64910690c574 808 */
AnnaBridge 145:64910690c574 809
AnnaBridge 145:64910690c574 810 /** @addtogroup USART_Exported_Functions_Group1 Initialization and de-initialization functions
AnnaBridge 145:64910690c574 811 * @{
AnnaBridge 145:64910690c574 812 */
AnnaBridge 145:64910690c574 813
AnnaBridge 145:64910690c574 814 /* Initialization and de-initialization functions ****************************/
AnnaBridge 145:64910690c574 815 HAL_StatusTypeDef HAL_USART_Init(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 816 HAL_StatusTypeDef HAL_USART_DeInit(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 817 void HAL_USART_MspInit(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 818 void HAL_USART_MspDeInit(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 819
AnnaBridge 145:64910690c574 820 /**
AnnaBridge 145:64910690c574 821 * @}
AnnaBridge 145:64910690c574 822 */
AnnaBridge 145:64910690c574 823
AnnaBridge 145:64910690c574 824 /** @addtogroup USART_Exported_Functions_Group2 IO operation functions
AnnaBridge 145:64910690c574 825 * @{
AnnaBridge 145:64910690c574 826 */
AnnaBridge 145:64910690c574 827
AnnaBridge 145:64910690c574 828 /* IO operation functions *****************************************************/
AnnaBridge 145:64910690c574 829 HAL_StatusTypeDef HAL_USART_Transmit(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size, uint32_t Timeout);
AnnaBridge 145:64910690c574 830 HAL_StatusTypeDef HAL_USART_Receive(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
AnnaBridge 145:64910690c574 831 HAL_StatusTypeDef HAL_USART_TransmitReceive(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
AnnaBridge 145:64910690c574 832 HAL_StatusTypeDef HAL_USART_Transmit_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
AnnaBridge 145:64910690c574 833 HAL_StatusTypeDef HAL_USART_Receive_IT(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
AnnaBridge 145:64910690c574 834 HAL_StatusTypeDef HAL_USART_TransmitReceive_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
AnnaBridge 145:64910690c574 835 HAL_StatusTypeDef HAL_USART_Transmit_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
AnnaBridge 145:64910690c574 836 HAL_StatusTypeDef HAL_USART_Receive_DMA(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
AnnaBridge 145:64910690c574 837 HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
AnnaBridge 145:64910690c574 838 HAL_StatusTypeDef HAL_USART_DMAPause(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 839 HAL_StatusTypeDef HAL_USART_DMAResume(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 840 HAL_StatusTypeDef HAL_USART_DMAStop(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 841 /* Transfer Abort functions */
AnnaBridge 145:64910690c574 842 HAL_StatusTypeDef HAL_USART_Abort(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 843 HAL_StatusTypeDef HAL_USART_Abort_IT(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 844
AnnaBridge 145:64910690c574 845 void HAL_USART_IRQHandler(USART_HandleTypeDef *husart);
AnnaBridge 161:aa5281ff4a02 846 void HAL_USART_TxHalfCpltCallback(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 847 void HAL_USART_TxCpltCallback(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 848 void HAL_USART_RxCpltCallback(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 849 void HAL_USART_RxHalfCpltCallback(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 850 void HAL_USART_TxRxCpltCallback(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 851 void HAL_USART_ErrorCallback(USART_HandleTypeDef *husart);
AnnaBridge 161:aa5281ff4a02 852 void HAL_USART_AbortCpltCallback(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 853
AnnaBridge 145:64910690c574 854 /**
AnnaBridge 145:64910690c574 855 * @}
AnnaBridge 145:64910690c574 856 */
AnnaBridge 145:64910690c574 857
AnnaBridge 145:64910690c574 858 /** @addtogroup USART_Exported_Functions_Group4 Peripheral State and Error functions
AnnaBridge 145:64910690c574 859 * @{
AnnaBridge 145:64910690c574 860 */
AnnaBridge 145:64910690c574 861
AnnaBridge 145:64910690c574 862 /* Peripheral State and Error functions ***************************************/
AnnaBridge 145:64910690c574 863 HAL_USART_StateTypeDef HAL_USART_GetState(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 864 uint32_t HAL_USART_GetError(USART_HandleTypeDef *husart);
AnnaBridge 145:64910690c574 865
AnnaBridge 145:64910690c574 866 /**
AnnaBridge 145:64910690c574 867 * @}
AnnaBridge 145:64910690c574 868 */
AnnaBridge 145:64910690c574 869
AnnaBridge 145:64910690c574 870 /**
AnnaBridge 145:64910690c574 871 * @}
AnnaBridge 145:64910690c574 872 */
AnnaBridge 145:64910690c574 873
AnnaBridge 145:64910690c574 874 /**
AnnaBridge 145:64910690c574 875 * @}
AnnaBridge 145:64910690c574 876 */
AnnaBridge 145:64910690c574 877
AnnaBridge 145:64910690c574 878 /**
AnnaBridge 145:64910690c574 879 * @}
AnnaBridge 145:64910690c574 880 */
AnnaBridge 145:64910690c574 881
AnnaBridge 145:64910690c574 882 #ifdef __cplusplus
AnnaBridge 145:64910690c574 883 }
AnnaBridge 145:64910690c574 884 #endif
AnnaBridge 145:64910690c574 885
AnnaBridge 145:64910690c574 886 #endif /* __STM32L4xx_HAL_USART_H */
AnnaBridge 145:64910690c574 887
AnnaBridge 145:64910690c574 888 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/