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.

Committer:
Kojto
Date:
Tue Feb 14 11:24:20 2017 +0000
Revision:
136:ef9c61f8c49f
Parent:
135:176b8275d35d
Release 136 of the mbed library

Ports for Upcoming Targets


Fixes and Changes

3432: Target STM USBHOST support https://github.com/ARMmbed/mbed-os/pull/3432
3181: NUCLEO_F207ZG extending PeripheralPins.c: all available alternate functions can be used now https://github.com/ARMmbed/mbed-os/pull/3181
3626: NUCLEO_F412ZG : Add USB Device +Host https://github.com/ARMmbed/mbed-os/pull/3626
3628: Fix warnings https://github.com/ARMmbed/mbed-os/pull/3628
3629: STM32: L0 LL layer https://github.com/ARMmbed/mbed-os/pull/3629
3632: IDE Export support for platform VK_RZ_A1H https://github.com/ARMmbed/mbed-os/pull/3632
3642: Missing IRQ pin fix for platform VK_RZ_A1H https://github.com/ARMmbed/mbed-os/pull/3642
3664: Fix ncs36510 sleep definitions https://github.com/ARMmbed/mbed-os/pull/3664
3655: [STM32F4] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3655
3657: [STM32L4] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3657
3658: [STM32F3] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3658
3685: STM32: I2C: reset state machine https://github.com/ARMmbed/mbed-os/pull/3685
3692: uVisor: Standardize available legacy heap and stack https://github.com/ARMmbed/mbed-os/pull/3692
3621: Fix for #2884, LPC824: export to LPCXpresso, target running with wron https://github.com/ARMmbed/mbed-os/pull/3621
3649: [STM32F7] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3649
3695: Enforce device_name is valid in targets.json https://github.com/ARMmbed/mbed-os/pull/3695
3723: NCS36510: spi_format function bug fix https://github.com/ARMmbed/mbed-os/pull/3723

Who changed what in which revision?

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