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_F446ZE/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_uart.h@134:ad3be0349dc5, 2017-01-16 (annotated)

Committer:
<>
Date:
Mon Jan 16 12:05:23 2017 +0000
Revision:
134:ad3be0349dc5
Parent:
128:9bcdf88f62b0
Child:
145:64910690c574
Release 134 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



3488: Dev stm i2c v2 unitary functions https://github.com/ARMmbed/mbed-os/pull/3488

3492: Fix #3463 CAN read() return value https://github.com/ARMmbed/mbed-os/pull/3492

3503: [LPC15xx] Ensure that PWM=1 is resolved correctly https://github.com/ARMmbed/mbed-os/pull/3503

3504: [LPC15xx] CAN implementation improvements https://github.com/ARMmbed/mbed-os/pull/3504

3539: NUCLEO_F412ZG - Add support of TRNG peripheral https://github.com/ARMmbed/mbed-os/pull/3539

3540: STM: SPI: Initialize Rx in spi_master_write https://github.com/ARMmbed/mbed-os/pull/3540

3438: K64F: Add support for SERIAL ASYNCH API https://github.com/ARMmbed/mbed-os/pull/3438

3519: MCUXpresso: Fix ENET driver to enable interrupts after interrupt handler is set https://github.com/ARMmbed/mbed-os/pull/3519

3544: STM32L4 deepsleep improvement https://github.com/ARMmbed/mbed-os/pull/3544

3546: NUCLEO-F412ZG - Add CAN peripheral https://github.com/ARMmbed/mbed-os/pull/3546

3551: Fix I2C driver for RZ/A1H https://github.com/ARMmbed/mbed-os/pull/3551

3558: K64F UART Asynch API: Fix synchronization issue https://github.com/ARMmbed/mbed-os/pull/3558

3563: LPC4088 - Fix vector checksum https://github.com/ARMmbed/mbed-os/pull/3563

3567: Dev stm32 F0 v1.7.0 https://github.com/ARMmbed/mbed-os/pull/3567

3577: Fixes linking errors when building with debug profile https://github.com/ARMmbed/mbed-os/pull/3577

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 122:f9eeca106725 1 /**
Kojto 122:f9eeca106725 2 ******************************************************************************
Kojto 122:f9eeca106725 3 * @file stm32f4xx_hal_uart.h
Kojto 122:f9eeca106725 4 * @author MCD Application Team
Kojto 122:f9eeca106725 5 * @version V1.5.0
Kojto 122:f9eeca106725 6 * @date 06-May-2016
Kojto 122:f9eeca106725 7 * @brief Header file of UART HAL module.
Kojto 122:f9eeca106725 8 ******************************************************************************
Kojto 122:f9eeca106725 9 * @attention
Kojto 122:f9eeca106725 10 *
Kojto 122:f9eeca106725 11 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
Kojto 122:f9eeca106725 12 *
Kojto 122:f9eeca106725 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 122:f9eeca106725 14 * are permitted provided that the following conditions are met:
Kojto 122:f9eeca106725 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 122:f9eeca106725 16 * this list of conditions and the following disclaimer.
Kojto 122:f9eeca106725 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 122:f9eeca106725 18 * this list of conditions and the following disclaimer in the documentation
Kojto 122:f9eeca106725 19 * and/or other materials provided with the distribution.
Kojto 122:f9eeca106725 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 122:f9eeca106725 21 * may be used to endorse or promote products derived from this software
Kojto 122:f9eeca106725 22 * without specific prior written permission.
Kojto 122:f9eeca106725 23 *
Kojto 122:f9eeca106725 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 122:f9eeca106725 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 122:f9eeca106725 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 122:f9eeca106725 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 122:f9eeca106725 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 122:f9eeca106725 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 122:f9eeca106725 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 122:f9eeca106725 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 122:f9eeca106725 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 122:f9eeca106725 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 122:f9eeca106725 34 *
Kojto 122:f9eeca106725 35 ******************************************************************************
Kojto 122:f9eeca106725 36 */
Kojto 122:f9eeca106725 37
Kojto 122:f9eeca106725 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 122:f9eeca106725 39 #ifndef __STM32F4xx_HAL_UART_H
Kojto 122:f9eeca106725 40 #define __STM32F4xx_HAL_UART_H
Kojto 122:f9eeca106725 41
Kojto 122:f9eeca106725 42 #ifdef __cplusplus
Kojto 122:f9eeca106725 43 extern "C" {
Kojto 122:f9eeca106725 44 #endif
Kojto 122:f9eeca106725 45
Kojto 122:f9eeca106725 46 /* Includes ------------------------------------------------------------------*/
Kojto 122:f9eeca106725 47 #include "stm32f4xx_hal_def.h"
Kojto 122:f9eeca106725 48
Kojto 122:f9eeca106725 49 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 122:f9eeca106725 50 * @{
Kojto 122:f9eeca106725 51 */
Kojto 122:f9eeca106725 52
Kojto 122:f9eeca106725 53 /** @addtogroup UART
Kojto 122:f9eeca106725 54 * @{
Kojto 122:f9eeca106725 55 */
Kojto 122:f9eeca106725 56
Kojto 122:f9eeca106725 57 /* Exported types ------------------------------------------------------------*/
Kojto 122:f9eeca106725 58 /** @defgroup UART_Exported_Types UART Exported Types
Kojto 122:f9eeca106725 59 * @{
Kojto 122:f9eeca106725 60 */
Kojto 122:f9eeca106725 61
Kojto 122:f9eeca106725 62 /**
Kojto 122:f9eeca106725 63 * @brief UART Init Structure definition
Kojto 122:f9eeca106725 64 */
Kojto 122:f9eeca106725 65 typedef struct
Kojto 122:f9eeca106725 66 {
Kojto 122:f9eeca106725 67 uint32_t BaudRate; /*!< This member configures the UART communication baud rate.
Kojto 122:f9eeca106725 68 The baud rate is computed using the following formula:
Kojto 122:f9eeca106725 69 - IntegerDivider = ((PCLKx) / (8 * (OVR8+1) * (huart->Init.BaudRate)))
Kojto 122:f9eeca106725 70 - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8 * (OVR8+1)) + 0.5
Kojto 122:f9eeca106725 71 Where OVR8 is the "oversampling by 8 mode" configuration bit in the CR1 register. */
Kojto 122:f9eeca106725 72
Kojto 122:f9eeca106725 73 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
Kojto 122:f9eeca106725 74 This parameter can be a value of @ref UART_Word_Length */
Kojto 122:f9eeca106725 75
Kojto 122:f9eeca106725 76 uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
Kojto 122:f9eeca106725 77 This parameter can be a value of @ref UART_Stop_Bits */
Kojto 122:f9eeca106725 78
Kojto 122:f9eeca106725 79 uint32_t Parity; /*!< Specifies the parity mode.
Kojto 122:f9eeca106725 80 This parameter can be a value of @ref UART_Parity
Kojto 122:f9eeca106725 81 @note When parity is enabled, the computed parity is inserted
Kojto 122:f9eeca106725 82 at the MSB position of the transmitted data (9th bit when
Kojto 122:f9eeca106725 83 the word length is set to 9 data bits; 8th bit when the
Kojto 122:f9eeca106725 84 word length is set to 8 data bits). */
Kojto 122:f9eeca106725 85
Kojto 122:f9eeca106725 86 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
Kojto 122:f9eeca106725 87 This parameter can be a value of @ref UART_Mode */
Kojto 122:f9eeca106725 88
Kojto 122:f9eeca106725 89 uint32_t HwFlowCtl; /*!< Specifies whether the hardware flow control mode is enabled
Kojto 122:f9eeca106725 90 or disabled.
Kojto 122:f9eeca106725 91 This parameter can be a value of @ref UART_Hardware_Flow_Control */
Kojto 122:f9eeca106725 92
Kojto 122:f9eeca106725 93 uint32_t OverSampling; /*!< Specifies whether the Over sampling 8 is enabled or disabled, to achieve higher speed (up to fPCLK/8).
Kojto 122:f9eeca106725 94 This parameter can be a value of @ref UART_Over_Sampling */
Kojto 122:f9eeca106725 95 }UART_InitTypeDef;
Kojto 122:f9eeca106725 96
Kojto 122:f9eeca106725 97 /**
Kojto 122:f9eeca106725 98 * @brief HAL UART State structures definition
Kojto 122:f9eeca106725 99 * @note HAL UART State value is a combination of 2 different substates: gState and RxState.
Kojto 122:f9eeca106725 100 * - gState contains UART state information related to global Handle management
Kojto 122:f9eeca106725 101 * and also information related to Tx operations.
Kojto 122:f9eeca106725 102 * gState value coding follow below described bitmap :
Kojto 122:f9eeca106725 103 * b7-b6 Error information
Kojto 122:f9eeca106725 104 * 00 : No Error
Kojto 122:f9eeca106725 105 * 01 : (Not Used)
Kojto 122:f9eeca106725 106 * 10 : Timeout
Kojto 122:f9eeca106725 107 * 11 : Error
Kojto 122:f9eeca106725 108 * b5 IP initilisation status
Kojto 122:f9eeca106725 109 * 0 : Reset (IP not initialized)
Kojto 122:f9eeca106725 110 * 1 : Init done (IP not initialized. HAL UART Init function already called)
Kojto 122:f9eeca106725 111 * b4-b3 (not used)
Kojto 122:f9eeca106725 112 * xx : Should be set to 00
Kojto 122:f9eeca106725 113 * b2 Intrinsic process state
Kojto 122:f9eeca106725 114 * 0 : Ready
Kojto 122:f9eeca106725 115 * 1 : Busy (IP busy with some configuration or internal operations)
Kojto 122:f9eeca106725 116 * b1 (not used)
Kojto 122:f9eeca106725 117 * x : Should be set to 0
Kojto 122:f9eeca106725 118 * b0 Tx state
Kojto 122:f9eeca106725 119 * 0 : Ready (no Tx operation ongoing)
Kojto 122:f9eeca106725 120 * 1 : Busy (Tx operation ongoing)
Kojto 122:f9eeca106725 121 * - RxState contains information related to Rx operations.
Kojto 122:f9eeca106725 122 * RxState value coding follow below described bitmap :
Kojto 122:f9eeca106725 123 * b7-b6 (not used)
Kojto 122:f9eeca106725 124 * xx : Should be set to 00
Kojto 122:f9eeca106725 125 * b5 IP initilisation status
Kojto 122:f9eeca106725 126 * 0 : Reset (IP not initialized)
Kojto 122:f9eeca106725 127 * 1 : Init done (IP not initialized)
Kojto 122:f9eeca106725 128 * b4-b2 (not used)
Kojto 122:f9eeca106725 129 * xxx : Should be set to 000
Kojto 122:f9eeca106725 130 * b1 Rx state
Kojto 122:f9eeca106725 131 * 0 : Ready (no Rx operation ongoing)
Kojto 122:f9eeca106725 132 * 1 : Busy (Rx operation ongoing)
Kojto 122:f9eeca106725 133 * b0 (not used)
Kojto 122:f9eeca106725 134 * x : Should be set to 0.
Kojto 122:f9eeca106725 135 */
Kojto 122:f9eeca106725 136 typedef enum
Kojto 122:f9eeca106725 137 {
Kojto 122:f9eeca106725 138 HAL_UART_STATE_RESET = 0x00U, /*!< Peripheral is not yet Initialized
Kojto 122:f9eeca106725 139 Value is allowed for gState and RxState */
Kojto 122:f9eeca106725 140 HAL_UART_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use
Kojto 122:f9eeca106725 141 Value is allowed for gState and RxState */
Kojto 122:f9eeca106725 142 HAL_UART_STATE_BUSY = 0x24U, /*!< an internal process is ongoing
Kojto 122:f9eeca106725 143 Value is allowed for gState only */
Kojto 122:f9eeca106725 144 HAL_UART_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing
Kojto 122:f9eeca106725 145 Value is allowed for gState only */
Kojto 122:f9eeca106725 146 HAL_UART_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing
Kojto 122:f9eeca106725 147 Value is allowed for RxState only */
Kojto 122:f9eeca106725 148 HAL_UART_STATE_BUSY_TX_RX = 0x23U, /*!< Data Transmission and Reception process is ongoing
Kojto 122:f9eeca106725 149 Not to be used for neither gState nor RxState.
Kojto 122:f9eeca106725 150 Value is result of combination (Or) between gState and RxState values */
Kojto 122:f9eeca106725 151 HAL_UART_STATE_TIMEOUT = 0xA0U, /*!< Timeout state
Kojto 122:f9eeca106725 152 Value is allowed for gState only */
Kojto 122:f9eeca106725 153 HAL_UART_STATE_ERROR = 0xE0U /*!< Error
Kojto 122:f9eeca106725 154 Value is allowed for gState only */
Kojto 122:f9eeca106725 155 }HAL_UART_StateTypeDef;
Kojto 122:f9eeca106725 156
Kojto 122:f9eeca106725 157 /**
Kojto 122:f9eeca106725 158 * @brief UART handle Structure definition
Kojto 122:f9eeca106725 159 */
Kojto 122:f9eeca106725 160 typedef struct
Kojto 122:f9eeca106725 161 {
Kojto 122:f9eeca106725 162 USART_TypeDef *Instance; /*!< UART registers base address */
Kojto 122:f9eeca106725 163
Kojto 122:f9eeca106725 164 UART_InitTypeDef Init; /*!< UART communication parameters */
Kojto 122:f9eeca106725 165
Kojto 122:f9eeca106725 166 uint8_t *pTxBuffPtr; /*!< Pointer to UART Tx transfer Buffer */
Kojto 122:f9eeca106725 167
Kojto 122:f9eeca106725 168 uint16_t TxXferSize; /*!< UART Tx Transfer size */
Kojto 122:f9eeca106725 169
Kojto 122:f9eeca106725 170 uint16_t TxXferCount; /*!< UART Tx Transfer Counter */
Kojto 122:f9eeca106725 171
Kojto 122:f9eeca106725 172 uint8_t *pRxBuffPtr; /*!< Pointer to UART Rx transfer Buffer */
Kojto 122:f9eeca106725 173
Kojto 122:f9eeca106725 174 uint16_t RxXferSize; /*!< UART Rx Transfer size */
Kojto 122:f9eeca106725 175
Kojto 122:f9eeca106725 176 uint16_t RxXferCount; /*!< UART Rx Transfer Counter */
Kojto 122:f9eeca106725 177
Kojto 122:f9eeca106725 178 DMA_HandleTypeDef *hdmatx; /*!< UART Tx DMA Handle parameters */
Kojto 122:f9eeca106725 179
Kojto 122:f9eeca106725 180 DMA_HandleTypeDef *hdmarx; /*!< UART Rx DMA Handle parameters */
Kojto 122:f9eeca106725 181
Kojto 122:f9eeca106725 182 HAL_LockTypeDef Lock; /*!< Locking object */
Kojto 122:f9eeca106725 183
Kojto 122:f9eeca106725 184 __IO HAL_UART_StateTypeDef gState; /*!< UART state information related to global Handle management
Kojto 122:f9eeca106725 185 and also related to Tx operations.
Kojto 122:f9eeca106725 186 This parameter can be a value of @ref HAL_UART_StateTypeDef */
Kojto 122:f9eeca106725 187
Kojto 122:f9eeca106725 188 __IO HAL_UART_StateTypeDef RxState; /*!< UART state information related to Rx operations.
Kojto 122:f9eeca106725 189 This parameter can be a value of @ref HAL_UART_StateTypeDef */
Kojto 122:f9eeca106725 190
Kojto 122:f9eeca106725 191 __IO uint32_t ErrorCode; /*!< UART Error code */
Kojto 122:f9eeca106725 192
Kojto 122:f9eeca106725 193 }UART_HandleTypeDef;
Kojto 122:f9eeca106725 194 /**
Kojto 122:f9eeca106725 195 * @}
Kojto 122:f9eeca106725 196 */
Kojto 122:f9eeca106725 197
Kojto 122:f9eeca106725 198 /* Exported constants --------------------------------------------------------*/
Kojto 122:f9eeca106725 199 /** @defgroup UART_Exported_Constants UART Exported constants
Kojto 122:f9eeca106725 200 * @{
Kojto 122:f9eeca106725 201 */
Kojto 122:f9eeca106725 202
Kojto 122:f9eeca106725 203 /** @defgroup UART_Error_Code UART Error Code
Kojto 122:f9eeca106725 204 * @brief UART Error Code
Kojto 122:f9eeca106725 205 * @{
Kojto 122:f9eeca106725 206 */
Kojto 122:f9eeca106725 207 #define HAL_UART_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
Kojto 122:f9eeca106725 208 #define HAL_UART_ERROR_PE ((uint32_t)0x00000001U) /*!< Parity error */
Kojto 122:f9eeca106725 209 #define HAL_UART_ERROR_NE ((uint32_t)0x00000002U) /*!< Noise error */
Kojto 122:f9eeca106725 210 #define HAL_UART_ERROR_FE ((uint32_t)0x00000004U) /*!< Frame error */
Kojto 122:f9eeca106725 211 #define HAL_UART_ERROR_ORE ((uint32_t)0x00000008U) /*!< Overrun error */
Kojto 122:f9eeca106725 212 #define HAL_UART_ERROR_DMA ((uint32_t)0x00000010U) /*!< DMA transfer error */
Kojto 122:f9eeca106725 213 /**
Kojto 122:f9eeca106725 214 * @}
Kojto 122:f9eeca106725 215 */
Kojto 122:f9eeca106725 216
Kojto 122:f9eeca106725 217 /** @defgroup UART_Word_Length UART Word Length
Kojto 122:f9eeca106725 218 * @{
Kojto 122:f9eeca106725 219 */
Kojto 122:f9eeca106725 220 #define UART_WORDLENGTH_8B ((uint32_t)0x00000000U)
Kojto 122:f9eeca106725 221 #define UART_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
Kojto 122:f9eeca106725 222 /**
Kojto 122:f9eeca106725 223 * @}
Kojto 122:f9eeca106725 224 */
Kojto 122:f9eeca106725 225
Kojto 122:f9eeca106725 226 /** @defgroup UART_Stop_Bits UART Number of Stop Bits
Kojto 122:f9eeca106725 227 * @{
Kojto 122:f9eeca106725 228 */
Kojto 122:f9eeca106725 229 #define UART_STOPBITS_1 ((uint32_t)0x00000000U)
Kojto 122:f9eeca106725 230 #define UART_STOPBITS_2 ((uint32_t)USART_CR2_STOP_1)
Kojto 122:f9eeca106725 231 /**
Kojto 122:f9eeca106725 232 * @}
Kojto 122:f9eeca106725 233 */
Kojto 122:f9eeca106725 234
Kojto 122:f9eeca106725 235 /** @defgroup UART_Parity UART Parity
Kojto 122:f9eeca106725 236 * @{
Kojto 122:f9eeca106725 237 */
Kojto 122:f9eeca106725 238 #define UART_PARITY_NONE ((uint32_t)0x00000000U)
Kojto 122:f9eeca106725 239 #define UART_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
Kojto 122:f9eeca106725 240 #define UART_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
Kojto 122:f9eeca106725 241 /**
Kojto 122:f9eeca106725 242 * @}
Kojto 122:f9eeca106725 243 */
Kojto 122:f9eeca106725 244
Kojto 122:f9eeca106725 245 /** @defgroup UART_Hardware_Flow_Control UART Hardware Flow Control
Kojto 122:f9eeca106725 246 * @{
Kojto 122:f9eeca106725 247 */
Kojto 122:f9eeca106725 248 #define UART_HWCONTROL_NONE ((uint32_t)0x00000000U)
Kojto 122:f9eeca106725 249 #define UART_HWCONTROL_RTS ((uint32_t)USART_CR3_RTSE)
Kojto 122:f9eeca106725 250 #define UART_HWCONTROL_CTS ((uint32_t)USART_CR3_CTSE)
Kojto 122:f9eeca106725 251 #define UART_HWCONTROL_RTS_CTS ((uint32_t)(USART_CR3_RTSE | USART_CR3_CTSE))
Kojto 122:f9eeca106725 252 /**
Kojto 122:f9eeca106725 253 * @}
Kojto 122:f9eeca106725 254 */
Kojto 122:f9eeca106725 255
Kojto 122:f9eeca106725 256 /** @defgroup UART_Mode UART Transfer Mode
Kojto 122:f9eeca106725 257 * @{
Kojto 122:f9eeca106725 258 */
Kojto 122:f9eeca106725 259 #define UART_MODE_RX ((uint32_t)USART_CR1_RE)
Kojto 122:f9eeca106725 260 #define UART_MODE_TX ((uint32_t)USART_CR1_TE)
Kojto 122:f9eeca106725 261 #define UART_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
Kojto 122:f9eeca106725 262 /**
Kojto 122:f9eeca106725 263 * @}
Kojto 122:f9eeca106725 264 */
Kojto 122:f9eeca106725 265
Kojto 122:f9eeca106725 266 /** @defgroup UART_State UART State
Kojto 122:f9eeca106725 267 * @{
Kojto 122:f9eeca106725 268 */
Kojto 122:f9eeca106725 269 #define UART_STATE_DISABLE ((uint32_t)0x00000000U)
Kojto 122:f9eeca106725 270 #define UART_STATE_ENABLE ((uint32_t)USART_CR1_UE)
Kojto 122:f9eeca106725 271 /**
Kojto 122:f9eeca106725 272 * @}
Kojto 122:f9eeca106725 273 */
Kojto 122:f9eeca106725 274
Kojto 122:f9eeca106725 275 /** @defgroup UART_Over_Sampling UART Over Sampling
Kojto 122:f9eeca106725 276 * @{
Kojto 122:f9eeca106725 277 */
Kojto 122:f9eeca106725 278 #define UART_OVERSAMPLING_16 ((uint32_t)0x00000000U)
Kojto 122:f9eeca106725 279 #define UART_OVERSAMPLING_8 ((uint32_t)USART_CR1_OVER8)
Kojto 122:f9eeca106725 280 /**
Kojto 122:f9eeca106725 281 * @}
Kojto 122:f9eeca106725 282 */
Kojto 122:f9eeca106725 283
Kojto 122:f9eeca106725 284 /** @defgroup UART_LIN_Break_Detection_Length UART LIN Break Detection Length
Kojto 122:f9eeca106725 285 * @{
Kojto 122:f9eeca106725 286 */
Kojto 122:f9eeca106725 287 #define UART_LINBREAKDETECTLENGTH_10B ((uint32_t)0x00000000U)
Kojto 122:f9eeca106725 288 #define UART_LINBREAKDETECTLENGTH_11B ((uint32_t)0x00000020U)
Kojto 122:f9eeca106725 289 /**
Kojto 122:f9eeca106725 290 * @}
Kojto 122:f9eeca106725 291 */
Kojto 122:f9eeca106725 292
Kojto 122:f9eeca106725 293 /** @defgroup UART_WakeUp_functions UART Wakeup Functions
Kojto 122:f9eeca106725 294 * @{
Kojto 122:f9eeca106725 295 */
Kojto 122:f9eeca106725 296 #define UART_WAKEUPMETHOD_IDLELINE ((uint32_t)0x00000000U)
Kojto 122:f9eeca106725 297 #define UART_WAKEUPMETHOD_ADDRESSMARK ((uint32_t)0x00000800U)
Kojto 122:f9eeca106725 298 /**
Kojto 122:f9eeca106725 299 * @}
Kojto 122:f9eeca106725 300 */
Kojto 122:f9eeca106725 301
Kojto 122:f9eeca106725 302 /** @defgroup UART_Flags UART FLags
Kojto 122:f9eeca106725 303 * Elements values convention: 0xXXXX
Kojto 122:f9eeca106725 304 * - 0xXXXX : Flag mask in the SR register
Kojto 122:f9eeca106725 305 * @{
Kojto 122:f9eeca106725 306 */
Kojto 122:f9eeca106725 307 #define UART_FLAG_CTS ((uint32_t)USART_SR_CTS)
Kojto 122:f9eeca106725 308 #define UART_FLAG_LBD ((uint32_t)USART_SR_LBD)
Kojto 122:f9eeca106725 309 #define UART_FLAG_TXE ((uint32_t)USART_SR_TXE)
Kojto 122:f9eeca106725 310 #define UART_FLAG_TC ((uint32_t)USART_SR_TC)
Kojto 122:f9eeca106725 311 #define UART_FLAG_RXNE ((uint32_t)USART_SR_RXNE)
Kojto 122:f9eeca106725 312 #define UART_FLAG_IDLE ((uint32_t)USART_SR_IDLE)
Kojto 122:f9eeca106725 313 #define UART_FLAG_ORE ((uint32_t)USART_SR_ORE)
Kojto 122:f9eeca106725 314 #define UART_FLAG_NE ((uint32_t)USART_SR_NE)
Kojto 122:f9eeca106725 315 #define UART_FLAG_FE ((uint32_t)USART_SR_FE)
Kojto 122:f9eeca106725 316 #define UART_FLAG_PE ((uint32_t)USART_SR_PE)
Kojto 122:f9eeca106725 317 /**
Kojto 122:f9eeca106725 318 * @}
Kojto 122:f9eeca106725 319 */
Kojto 122:f9eeca106725 320
Kojto 122:f9eeca106725 321 /** @defgroup UART_Interrupt_definition UART Interrupt Definitions
Kojto 122:f9eeca106725 322 * Elements values convention: 0xY000XXXX
Kojto 122:f9eeca106725 323 * - XXXX : Interrupt mask (16 bits) in the Y register
Kojto 122:f9eeca106725 324 * - Y : Interrupt source register (2bits)
Kojto 122:f9eeca106725 325 * - 0001: CR1 register
Kojto 122:f9eeca106725 326 * - 0010: CR2 register
Kojto 122:f9eeca106725 327 * - 0011: CR3 register
Kojto 122:f9eeca106725 328 *
Kojto 122:f9eeca106725 329 * @{
Kojto 122:f9eeca106725 330 */
Kojto 122:f9eeca106725 331
Kojto 122:f9eeca106725 332 #define UART_IT_PE ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_PEIE))
Kojto 122:f9eeca106725 333 #define UART_IT_TXE ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_TXEIE))
Kojto 122:f9eeca106725 334 #define UART_IT_TC ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_TCIE))
Kojto 122:f9eeca106725 335 #define UART_IT_RXNE ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_RXNEIE))
Kojto 122:f9eeca106725 336 #define UART_IT_IDLE ((uint32_t)(UART_CR1_REG_INDEX << 28U | USART_CR1_IDLEIE))
Kojto 122:f9eeca106725 337
Kojto 122:f9eeca106725 338 #define UART_IT_LBD ((uint32_t)(UART_CR2_REG_INDEX << 28U | USART_CR2_LBDIE))
Kojto 122:f9eeca106725 339
Kojto 122:f9eeca106725 340 #define UART_IT_CTS ((uint32_t)(UART_CR3_REG_INDEX << 28U | USART_CR3_CTSIE))
Kojto 122:f9eeca106725 341 #define UART_IT_ERR ((uint32_t)(UART_CR3_REG_INDEX << 28U | USART_CR3_EIE))
Kojto 122:f9eeca106725 342 /**
Kojto 122:f9eeca106725 343 * @}
Kojto 122:f9eeca106725 344 */
Kojto 122:f9eeca106725 345
Kojto 122:f9eeca106725 346 /**
Kojto 122:f9eeca106725 347 * @}
Kojto 122:f9eeca106725 348 */
Kojto 122:f9eeca106725 349
Kojto 122:f9eeca106725 350 /* Exported macro ------------------------------------------------------------*/
Kojto 122:f9eeca106725 351 /** @defgroup UART_Exported_Macros UART Exported Macros
Kojto 122:f9eeca106725 352 * @{
Kojto 122:f9eeca106725 353 */
Kojto 122:f9eeca106725 354
Kojto 122:f9eeca106725 355 /** @brief Reset UART handle gstate & RxState
Kojto 122:f9eeca106725 356 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 357 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 122:f9eeca106725 358 * UART peripheral.
Kojto 122:f9eeca106725 359 * @retval None
Kojto 122:f9eeca106725 360 */
Kojto 122:f9eeca106725 361 #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \
Kojto 122:f9eeca106725 362 (__HANDLE__)->gState = HAL_UART_STATE_RESET; \
Kojto 122:f9eeca106725 363 (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \
Kojto 122:f9eeca106725 364 } while(0)
Kojto 122:f9eeca106725 365
Kojto 122:f9eeca106725 366 /** @brief Flushes the UART DR register
Kojto 122:f9eeca106725 367 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 368 */
Kojto 122:f9eeca106725 369 #define __HAL_UART_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
Kojto 122:f9eeca106725 370
Kojto 122:f9eeca106725 371 /** @brief Checks whether the specified UART flag is set or not.
Kojto 122:f9eeca106725 372 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 373 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 122:f9eeca106725 374 * UART peripheral.
Kojto 122:f9eeca106725 375 * @param __FLAG__: specifies the flag to check.
Kojto 122:f9eeca106725 376 * This parameter can be one of the following values:
Kojto 122:f9eeca106725 377 * @arg UART_FLAG_CTS: CTS Change flag (not available for UART4 and UART5)
Kojto 122:f9eeca106725 378 * @arg UART_FLAG_LBD: LIN Break detection flag
Kojto 122:f9eeca106725 379 * @arg UART_FLAG_TXE: Transmit data register empty flag
Kojto 122:f9eeca106725 380 * @arg UART_FLAG_TC: Transmission Complete flag
Kojto 122:f9eeca106725 381 * @arg UART_FLAG_RXNE: Receive data register not empty flag
Kojto 122:f9eeca106725 382 * @arg UART_FLAG_IDLE: Idle Line detection flag
Kojto 122:f9eeca106725 383 * @arg UART_FLAG_ORE: Overrun Error flag
Kojto 122:f9eeca106725 384 * @arg UART_FLAG_NE: Noise Error flag
Kojto 122:f9eeca106725 385 * @arg UART_FLAG_FE: Framing Error flag
Kojto 122:f9eeca106725 386 * @arg UART_FLAG_PE: Parity Error flag
Kojto 122:f9eeca106725 387 * @retval The new state of __FLAG__ (TRUE or FALSE).
Kojto 122:f9eeca106725 388 */
Kojto 122:f9eeca106725 389
Kojto 122:f9eeca106725 390 #define __HAL_UART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
Kojto 122:f9eeca106725 391
Kojto 122:f9eeca106725 392 /** @brief Clears the specified UART pending flag.
Kojto 122:f9eeca106725 393 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 394 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 122:f9eeca106725 395 * UART peripheral.
Kojto 122:f9eeca106725 396 * @param __FLAG__: specifies the flag to check.
Kojto 122:f9eeca106725 397 * This parameter can be any combination of the following values:
Kojto 122:f9eeca106725 398 * @arg UART_FLAG_CTS: CTS Change flag (not available for UART4 and UART5).
Kojto 122:f9eeca106725 399 * @arg UART_FLAG_LBD: LIN Break detection flag.
Kojto 122:f9eeca106725 400 * @arg UART_FLAG_TC: Transmission Complete flag.
Kojto 122:f9eeca106725 401 * @arg UART_FLAG_RXNE: Receive data register not empty flag.
Kojto 122:f9eeca106725 402 *
Kojto 122:f9eeca106725 403 * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (Overrun
Kojto 122:f9eeca106725 404 * error) and IDLE (Idle line detected) flags are cleared by software
Kojto 122:f9eeca106725 405 * sequence: a read operation to USART_SR register followed by a read
Kojto 122:f9eeca106725 406 * operation to USART_DR register.
Kojto 122:f9eeca106725 407 * @note RXNE flag can be also cleared by a read to the USART_DR register.
Kojto 122:f9eeca106725 408 * @note TC flag can be also cleared by software sequence: a read operation to
Kojto 122:f9eeca106725 409 * USART_SR register followed by a write operation to USART_DR register.
Kojto 122:f9eeca106725 410 * @note TXE flag is cleared only by a write to the USART_DR register.
Kojto 122:f9eeca106725 411 *
Kojto 122:f9eeca106725 412 * @retval None
Kojto 122:f9eeca106725 413 */
Kojto 122:f9eeca106725 414 #define __HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
Kojto 122:f9eeca106725 415
Kojto 122:f9eeca106725 416 /** @brief Clear the UART PE pending flag.
Kojto 122:f9eeca106725 417 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 418 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 122:f9eeca106725 419 * UART peripheral.
Kojto 122:f9eeca106725 420 * @retval None
Kojto 122:f9eeca106725 421 */
Kojto 122:f9eeca106725 422 #define __HAL_UART_CLEAR_PEFLAG(__HANDLE__) \
Kojto 122:f9eeca106725 423 do{ \
Kojto 122:f9eeca106725 424 __IO uint32_t tmpreg = 0x00U; \
Kojto 122:f9eeca106725 425 tmpreg = (__HANDLE__)->Instance->SR; \
Kojto 122:f9eeca106725 426 tmpreg = (__HANDLE__)->Instance->DR; \
Kojto 122:f9eeca106725 427 UNUSED(tmpreg); \
Kojto 122:f9eeca106725 428 } while(0)
Kojto 122:f9eeca106725 429
Kojto 122:f9eeca106725 430 /** @brief Clear the UART FE pending flag.
Kojto 122:f9eeca106725 431 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 432 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 122:f9eeca106725 433 * UART peripheral.
Kojto 122:f9eeca106725 434 * @retval None
Kojto 122:f9eeca106725 435 */
Kojto 122:f9eeca106725 436 #define __HAL_UART_CLEAR_FEFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
Kojto 122:f9eeca106725 437
Kojto 122:f9eeca106725 438 /** @brief Clear the UART NE pending flag.
Kojto 122:f9eeca106725 439 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 440 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 122:f9eeca106725 441 * UART peripheral.
Kojto 122:f9eeca106725 442 * @retval None
Kojto 122:f9eeca106725 443 */
Kojto 122:f9eeca106725 444 #define __HAL_UART_CLEAR_NEFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
Kojto 122:f9eeca106725 445
Kojto 122:f9eeca106725 446 /** @brief Clear the UART ORE pending flag.
Kojto 122:f9eeca106725 447 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 448 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 122:f9eeca106725 449 * UART peripheral.
Kojto 122:f9eeca106725 450 * @retval None
Kojto 122:f9eeca106725 451 */
Kojto 122:f9eeca106725 452 #define __HAL_UART_CLEAR_OREFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
Kojto 122:f9eeca106725 453
Kojto 122:f9eeca106725 454 /** @brief Clear the UART IDLE pending flag.
Kojto 122:f9eeca106725 455 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 456 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 122:f9eeca106725 457 * UART peripheral.
Kojto 122:f9eeca106725 458 * @retval None
Kojto 122:f9eeca106725 459 */
Kojto 122:f9eeca106725 460 #define __HAL_UART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_UART_CLEAR_PEFLAG(__HANDLE__)
Kojto 122:f9eeca106725 461
Kojto 122:f9eeca106725 462 /** @brief Enable the specified UART interrupt.
Kojto 122:f9eeca106725 463 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 464 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 122:f9eeca106725 465 * UART peripheral.
Kojto 122:f9eeca106725 466 * @param __INTERRUPT__: specifies the UART interrupt source to enable.
Kojto 122:f9eeca106725 467 * This parameter can be one of the following values:
Kojto 122:f9eeca106725 468 * @arg UART_IT_CTS: CTS change interrupt
Kojto 122:f9eeca106725 469 * @arg UART_IT_LBD: LIN Break detection interrupt
Kojto 122:f9eeca106725 470 * @arg UART_IT_TXE: Transmit Data Register empty interrupt
Kojto 122:f9eeca106725 471 * @arg UART_IT_TC: Transmission complete interrupt
Kojto 122:f9eeca106725 472 * @arg UART_IT_RXNE: Receive Data register not empty interrupt
Kojto 122:f9eeca106725 473 * @arg UART_IT_IDLE: Idle line detection interrupt
Kojto 122:f9eeca106725 474 * @arg UART_IT_PE: Parity Error interrupt
Kojto 122:f9eeca106725 475 * @arg UART_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
Kojto 122:f9eeca106725 476 * @retval None
Kojto 122:f9eeca106725 477 */
Kojto 122:f9eeca106725 478 #define UART_IT_MASK ((uint32_t)0x0000FFFFU)
Kojto 122:f9eeca106725 479 #define __HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28U) == 1U)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & UART_IT_MASK)): \
Kojto 122:f9eeca106725 480 (((__INTERRUPT__) >> 28U) == 2U)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & UART_IT_MASK)): \
Kojto 122:f9eeca106725 481 ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & UART_IT_MASK)))
Kojto 122:f9eeca106725 482 /** @brief Disable the specified UART interrupt.
Kojto 122:f9eeca106725 483 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 484 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 122:f9eeca106725 485 * UART peripheral.
Kojto 122:f9eeca106725 486 * @param __INTERRUPT__: specifies the UART interrupt source to disable.
Kojto 122:f9eeca106725 487 * This parameter can be one of the following values:
Kojto 122:f9eeca106725 488 * @arg UART_IT_CTS: CTS change interrupt
Kojto 122:f9eeca106725 489 * @arg UART_IT_LBD: LIN Break detection interrupt
Kojto 122:f9eeca106725 490 * @arg UART_IT_TXE: Transmit Data Register empty interrupt
Kojto 122:f9eeca106725 491 * @arg UART_IT_TC: Transmission complete interrupt
Kojto 122:f9eeca106725 492 * @arg UART_IT_RXNE: Receive Data register not empty interrupt
Kojto 122:f9eeca106725 493 * @arg UART_IT_IDLE: Idle line detection interrupt
Kojto 122:f9eeca106725 494 * @arg UART_IT_PE: Parity Error interrupt
Kojto 122:f9eeca106725 495 * @arg UART_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
Kojto 122:f9eeca106725 496 * @retval None
Kojto 122:f9eeca106725 497 */
Kojto 122:f9eeca106725 498 #define __HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28U) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & UART_IT_MASK)): \
Kojto 122:f9eeca106725 499 (((__INTERRUPT__) >> 28U) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & UART_IT_MASK)): \
Kojto 122:f9eeca106725 500 ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & UART_IT_MASK)))
Kojto 122:f9eeca106725 501
Kojto 122:f9eeca106725 502 /** @brief Checks whether the specified UART interrupt has occurred or not.
Kojto 122:f9eeca106725 503 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 504 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 122:f9eeca106725 505 * UART peripheral.
Kojto 122:f9eeca106725 506 * @param __IT__: specifies the UART interrupt source to check.
Kojto 122:f9eeca106725 507 * This parameter can be one of the following values:
Kojto 122:f9eeca106725 508 * @arg UART_IT_CTS: CTS change interrupt (not available for UART4 and UART5)
Kojto 122:f9eeca106725 509 * @arg UART_IT_LBD: LIN Break detection interrupt
Kojto 122:f9eeca106725 510 * @arg UART_IT_TXE: Transmit Data Register empty interrupt
Kojto 122:f9eeca106725 511 * @arg UART_IT_TC: Transmission complete interrupt
Kojto 122:f9eeca106725 512 * @arg UART_IT_RXNE: Receive Data register not empty interrupt
Kojto 122:f9eeca106725 513 * @arg UART_IT_IDLE: Idle line detection interrupt
Kojto 122:f9eeca106725 514 * @arg USART_IT_ERR: Error interrupt
Kojto 122:f9eeca106725 515 * @retval The new state of __IT__ (TRUE or FALSE).
Kojto 122:f9eeca106725 516 */
Kojto 122:f9eeca106725 517 #define __HAL_UART_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28U) == 1U)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28U) == 2U)? \
Kojto 122:f9eeca106725 518 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & UART_IT_MASK))
Kojto 122:f9eeca106725 519
Kojto 122:f9eeca106725 520 /** @brief Enable CTS flow control
Kojto 122:f9eeca106725 521 * This macro allows to enable CTS hardware flow control for a given UART instance,
Kojto 122:f9eeca106725 522 * without need to call HAL_UART_Init() function.
Kojto 122:f9eeca106725 523 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
Kojto 122:f9eeca106725 524 * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
Kojto 122:f9eeca106725 525 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
Kojto 122:f9eeca106725 526 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
Kojto 122:f9eeca106725 527 * - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
Kojto 122:f9eeca106725 528 * and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
Kojto 122:f9eeca106725 529 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 530 * The Handle Instance can be USART1, USART2 or LPUART.
Kojto 122:f9eeca106725 531 * @retval None
Kojto 122:f9eeca106725 532 */
Kojto 122:f9eeca106725 533 #define __HAL_UART_HWCONTROL_CTS_ENABLE(__HANDLE__) \
Kojto 122:f9eeca106725 534 do{ \
Kojto 122:f9eeca106725 535 SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
Kojto 122:f9eeca106725 536 (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_CTSE; \
Kojto 122:f9eeca106725 537 } while(0)
Kojto 122:f9eeca106725 538
Kojto 122:f9eeca106725 539 /** @brief Disable CTS flow control
Kojto 122:f9eeca106725 540 * This macro allows to disable CTS hardware flow control for a given UART instance,
Kojto 122:f9eeca106725 541 * without need to call HAL_UART_Init() function.
Kojto 122:f9eeca106725 542 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
Kojto 122:f9eeca106725 543 * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
Kojto 122:f9eeca106725 544 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
Kojto 122:f9eeca106725 545 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
Kojto 122:f9eeca106725 546 * - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
Kojto 122:f9eeca106725 547 * and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
Kojto 122:f9eeca106725 548 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 549 * The Handle Instance can be USART1, USART2 or LPUART.
Kojto 122:f9eeca106725 550 * @retval None
Kojto 122:f9eeca106725 551 */
Kojto 122:f9eeca106725 552 #define __HAL_UART_HWCONTROL_CTS_DISABLE(__HANDLE__) \
Kojto 122:f9eeca106725 553 do{ \
Kojto 122:f9eeca106725 554 CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
Kojto 122:f9eeca106725 555 (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_CTSE); \
Kojto 122:f9eeca106725 556 } while(0)
Kojto 122:f9eeca106725 557
Kojto 122:f9eeca106725 558 /** @brief Enable RTS flow control
Kojto 122:f9eeca106725 559 * This macro allows to enable RTS hardware flow control for a given UART instance,
Kojto 122:f9eeca106725 560 * without need to call HAL_UART_Init() function.
Kojto 122:f9eeca106725 561 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
Kojto 122:f9eeca106725 562 * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
Kojto 122:f9eeca106725 563 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
Kojto 122:f9eeca106725 564 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
Kojto 122:f9eeca106725 565 * - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
Kojto 122:f9eeca106725 566 * and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
Kojto 122:f9eeca106725 567 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 568 * The Handle Instance can be USART1, USART2 or LPUART.
Kojto 122:f9eeca106725 569 * @retval None
Kojto 122:f9eeca106725 570 */
Kojto 122:f9eeca106725 571 #define __HAL_UART_HWCONTROL_RTS_ENABLE(__HANDLE__) \
Kojto 122:f9eeca106725 572 do{ \
Kojto 122:f9eeca106725 573 SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE); \
Kojto 122:f9eeca106725 574 (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_RTSE; \
Kojto 122:f9eeca106725 575 } while(0)
Kojto 122:f9eeca106725 576
Kojto 122:f9eeca106725 577 /** @brief Disable RTS flow control
Kojto 122:f9eeca106725 578 * This macro allows to disable RTS hardware flow control for a given UART instance,
Kojto 122:f9eeca106725 579 * without need to call HAL_UART_Init() function.
Kojto 122:f9eeca106725 580 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
Kojto 122:f9eeca106725 581 * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
Kojto 122:f9eeca106725 582 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
Kojto 122:f9eeca106725 583 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
Kojto 122:f9eeca106725 584 * - macro could only be called when corresponding UART instance is disabled (i.e __HAL_UART_DISABLE(__HANDLE__))
Kojto 122:f9eeca106725 585 * and should be followed by an Enable macro (i.e __HAL_UART_ENABLE(__HANDLE__)).
Kojto 122:f9eeca106725 586 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 587 * The Handle Instance can be USART1, USART2 or LPUART.
Kojto 122:f9eeca106725 588 * @retval None
Kojto 122:f9eeca106725 589 */
Kojto 122:f9eeca106725 590 #define __HAL_UART_HWCONTROL_RTS_DISABLE(__HANDLE__) \
Kojto 122:f9eeca106725 591 do{ \
Kojto 122:f9eeca106725 592 CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE);\
Kojto 122:f9eeca106725 593 (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_RTSE); \
Kojto 122:f9eeca106725 594 } while(0)
Kojto 122:f9eeca106725 595
Kojto 122:f9eeca106725 596 /** @brief macros to enables the UART's one bit sample method
Kojto 122:f9eeca106725 597 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 598 * @retval None
Kojto 122:f9eeca106725 599 */
Kojto 122:f9eeca106725 600 #define __HAL_UART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
Kojto 122:f9eeca106725 601
Kojto 122:f9eeca106725 602 /** @brief macros to disables the UART's one bit sample method
Kojto 122:f9eeca106725 603 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 604 * @retval None
Kojto 122:f9eeca106725 605 */
Kojto 122:f9eeca106725 606 #define __HAL_UART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
Kojto 122:f9eeca106725 607
Kojto 122:f9eeca106725 608 /** @brief Enable UART
Kojto 122:f9eeca106725 609 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 610 * @retval None
Kojto 122:f9eeca106725 611 */
Kojto 122:f9eeca106725 612 #define __HAL_UART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
Kojto 122:f9eeca106725 613
Kojto 122:f9eeca106725 614 /** @brief Disable UART
Kojto 122:f9eeca106725 615 * @param __HANDLE__: specifies the UART Handle.
Kojto 122:f9eeca106725 616 * @retval None
Kojto 122:f9eeca106725 617 */
Kojto 122:f9eeca106725 618 #define __HAL_UART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
Kojto 122:f9eeca106725 619 /**
Kojto 122:f9eeca106725 620 * @}
Kojto 122:f9eeca106725 621 */
Kojto 122:f9eeca106725 622
Kojto 122:f9eeca106725 623 /* Exported functions --------------------------------------------------------*/
Kojto 122:f9eeca106725 624 /** @addtogroup UART_Exported_Functions
Kojto 122:f9eeca106725 625 * @{
Kojto 122:f9eeca106725 626 */
Kojto 122:f9eeca106725 627
Kojto 122:f9eeca106725 628 /** @addtogroup UART_Exported_Functions_Group1
Kojto 122:f9eeca106725 629 * @{
Kojto 122:f9eeca106725 630 */
Kojto 122:f9eeca106725 631 /* Initialization/de-initialization functions **********************************/
Kojto 122:f9eeca106725 632 HAL_StatusTypeDef HAL_UART_Init(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 633 HAL_StatusTypeDef HAL_HalfDuplex_Init(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 634 HAL_StatusTypeDef HAL_LIN_Init(UART_HandleTypeDef *huart, uint32_t BreakDetectLength);
Kojto 122:f9eeca106725 635 HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod);
Kojto 122:f9eeca106725 636 HAL_StatusTypeDef HAL_UART_DeInit (UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 637 void HAL_UART_MspInit(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 638 void HAL_UART_MspDeInit(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 639 /**
Kojto 122:f9eeca106725 640 * @}
Kojto 122:f9eeca106725 641 */
Kojto 122:f9eeca106725 642
Kojto 122:f9eeca106725 643 /** @addtogroup UART_Exported_Functions_Group2
Kojto 122:f9eeca106725 644 * @{
Kojto 122:f9eeca106725 645 */
Kojto 122:f9eeca106725 646 /* IO operation functions *******************************************************/
Kojto 122:f9eeca106725 647 HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
Kojto 122:f9eeca106725 648 HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
Kojto 122:f9eeca106725 649 HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
Kojto 122:f9eeca106725 650 HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
Kojto 122:f9eeca106725 651 HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
Kojto 122:f9eeca106725 652 HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
Kojto 122:f9eeca106725 653 HAL_StatusTypeDef HAL_UART_DMAPause(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 654 HAL_StatusTypeDef HAL_UART_DMAResume(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 655 HAL_StatusTypeDef HAL_UART_DMAStop(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 656
Kojto 122:f9eeca106725 657 void HAL_UART_IRQHandler(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 658 void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 659 void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 660 void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 661 void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 662 void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 663 /**
Kojto 122:f9eeca106725 664 * @}
Kojto 122:f9eeca106725 665 */
Kojto 122:f9eeca106725 666
Kojto 122:f9eeca106725 667 /** @addtogroup UART_Exported_Functions_Group3
Kojto 122:f9eeca106725 668 * @{
Kojto 122:f9eeca106725 669 */
Kojto 122:f9eeca106725 670 /* Peripheral Control functions ************************************************/
Kojto 122:f9eeca106725 671 HAL_StatusTypeDef HAL_LIN_SendBreak(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 672 HAL_StatusTypeDef HAL_MultiProcessor_EnterMuteMode(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 673 HAL_StatusTypeDef HAL_MultiProcessor_ExitMuteMode(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 674 HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 675 HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 676 /**
Kojto 122:f9eeca106725 677 * @}
Kojto 122:f9eeca106725 678 */
Kojto 122:f9eeca106725 679
Kojto 122:f9eeca106725 680 /** @addtogroup UART_Exported_Functions_Group4
Kojto 122:f9eeca106725 681 * @{
Kojto 122:f9eeca106725 682 */
Kojto 122:f9eeca106725 683 /* Peripheral State functions **************************************************/
Kojto 122:f9eeca106725 684 HAL_UART_StateTypeDef HAL_UART_GetState(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 685 uint32_t HAL_UART_GetError(UART_HandleTypeDef *huart);
Kojto 122:f9eeca106725 686 /**
Kojto 122:f9eeca106725 687 * @}
Kojto 122:f9eeca106725 688 */
Kojto 122:f9eeca106725 689
Kojto 122:f9eeca106725 690 /**
Kojto 122:f9eeca106725 691 * @}
Kojto 122:f9eeca106725 692 */
Kojto 122:f9eeca106725 693 /* Private types -------------------------------------------------------------*/
Kojto 122:f9eeca106725 694 /* Private variables ---------------------------------------------------------*/
Kojto 122:f9eeca106725 695 /* Private constants ---------------------------------------------------------*/
Kojto 122:f9eeca106725 696 /** @defgroup UART_Private_Constants UART Private Constants
Kojto 122:f9eeca106725 697 * @{
Kojto 122:f9eeca106725 698 */
Kojto 122:f9eeca106725 699 /** @brief UART interruptions flag mask
Kojto 122:f9eeca106725 700 *
Kojto 122:f9eeca106725 701 */
Kojto 122:f9eeca106725 702 #define UART_CR1_REG_INDEX 1U
Kojto 122:f9eeca106725 703 #define UART_CR2_REG_INDEX 2U
Kojto 122:f9eeca106725 704 #define UART_CR3_REG_INDEX 3U
Kojto 122:f9eeca106725 705 /**
Kojto 122:f9eeca106725 706 * @}
Kojto 122:f9eeca106725 707 */
Kojto 122:f9eeca106725 708
Kojto 122:f9eeca106725 709 /* Private macros ------------------------------------------------------------*/
Kojto 122:f9eeca106725 710 /** @defgroup UART_Private_Macros UART Private Macros
Kojto 122:f9eeca106725 711 * @{
Kojto 122:f9eeca106725 712 */
Kojto 122:f9eeca106725 713 #define IS_UART_WORD_LENGTH(LENGTH) (((LENGTH) == UART_WORDLENGTH_8B) || \
Kojto 122:f9eeca106725 714 ((LENGTH) == UART_WORDLENGTH_9B))
Kojto 122:f9eeca106725 715 #define IS_UART_LIN_WORD_LENGTH(LENGTH) (((LENGTH) == UART_WORDLENGTH_8B))
Kojto 122:f9eeca106725 716 #define IS_UART_STOPBITS(STOPBITS) (((STOPBITS) == UART_STOPBITS_1) || \
Kojto 122:f9eeca106725 717 ((STOPBITS) == UART_STOPBITS_2))
Kojto 122:f9eeca106725 718 #define IS_UART_PARITY(PARITY) (((PARITY) == UART_PARITY_NONE) || \
Kojto 122:f9eeca106725 719 ((PARITY) == UART_PARITY_EVEN) || \
Kojto 122:f9eeca106725 720 ((PARITY) == UART_PARITY_ODD))
Kojto 122:f9eeca106725 721 #define IS_UART_HARDWARE_FLOW_CONTROL(CONTROL)\
Kojto 122:f9eeca106725 722 (((CONTROL) == UART_HWCONTROL_NONE) || \
Kojto 122:f9eeca106725 723 ((CONTROL) == UART_HWCONTROL_RTS) || \
Kojto 122:f9eeca106725 724 ((CONTROL) == UART_HWCONTROL_CTS) || \
Kojto 122:f9eeca106725 725 ((CONTROL) == UART_HWCONTROL_RTS_CTS))
Kojto 122:f9eeca106725 726 #define IS_UART_MODE(MODE) ((((MODE) & (uint32_t)0x0000FFF3U) == 0x00U) && ((MODE) != (uint32_t)0x00U))
Kojto 122:f9eeca106725 727 #define IS_UART_STATE(STATE) (((STATE) == UART_STATE_DISABLE) || \
Kojto 122:f9eeca106725 728 ((STATE) == UART_STATE_ENABLE))
Kojto 122:f9eeca106725 729 #define IS_UART_OVERSAMPLING(SAMPLING) (((SAMPLING) == UART_OVERSAMPLING_16) || \
Kojto 122:f9eeca106725 730 ((SAMPLING) == UART_OVERSAMPLING_8))
Kojto 122:f9eeca106725 731 #define IS_UART_LIN_OVERSAMPLING(SAMPLING) (((SAMPLING) == UART_OVERSAMPLING_16))
Kojto 122:f9eeca106725 732 #define IS_UART_LIN_BREAK_DETECT_LENGTH(LENGTH) (((LENGTH) == UART_LINBREAKDETECTLENGTH_10B) || \
Kojto 122:f9eeca106725 733 ((LENGTH) == UART_LINBREAKDETECTLENGTH_11B))
Kojto 122:f9eeca106725 734 #define IS_UART_WAKEUPMETHOD(WAKEUP) (((WAKEUP) == UART_WAKEUPMETHOD_IDLELINE) || \
Kojto 122:f9eeca106725 735 ((WAKEUP) == UART_WAKEUPMETHOD_ADDRESSMARK))
Kojto 122:f9eeca106725 736 #define IS_UART_BAUDRATE(BAUDRATE) ((BAUDRATE) < 10500001U)
Kojto 122:f9eeca106725 737 #define IS_UART_ADDRESS(ADDRESS) ((ADDRESS) <= 0x0FU)
Kojto 122:f9eeca106725 738
Kojto 122:f9eeca106725 739 #define UART_DIV_SAMPLING16(_PCLK_, _BAUD_) (((_PCLK_)*25U)/(4U*(_BAUD_)))
Kojto 122:f9eeca106725 740 #define UART_DIVMANT_SAMPLING16(_PCLK_, _BAUD_) (UART_DIV_SAMPLING16((_PCLK_), (_BAUD_))/100U)
Kojto 122:f9eeca106725 741 #define UART_DIVFRAQ_SAMPLING16(_PCLK_, _BAUD_) (((UART_DIV_SAMPLING16((_PCLK_), (_BAUD_)) - (UART_DIVMANT_SAMPLING16((_PCLK_), (_BAUD_)) * 100U)) * 16U + 50U) / 100U)
Kojto 122:f9eeca106725 742 /* UART BRR = mantissa + overflow + fraction
Kojto 122:f9eeca106725 743 = (UART DIVMANT << 4) + (UART DIVFRAQ & 0xF0) + (UART DIVFRAQ & 0x0FU) */
Kojto 122:f9eeca106725 744 #define UART_BRR_SAMPLING16(_PCLK_, _BAUD_) (((UART_DIVMANT_SAMPLING16((_PCLK_), (_BAUD_)) << 4U) + \
Kojto 122:f9eeca106725 745 (UART_DIVFRAQ_SAMPLING16((_PCLK_), (_BAUD_)) & 0xF0U)) + \
Kojto 122:f9eeca106725 746 (UART_DIVFRAQ_SAMPLING16((_PCLK_), (_BAUD_)) & 0x0FU))
Kojto 122:f9eeca106725 747
Kojto 122:f9eeca106725 748 #define UART_DIV_SAMPLING8(_PCLK_, _BAUD_) (((_PCLK_)*25U)/(2U*(_BAUD_)))
Kojto 122:f9eeca106725 749 #define UART_DIVMANT_SAMPLING8(_PCLK_, _BAUD_) (UART_DIV_SAMPLING8((_PCLK_), (_BAUD_))/100U)
Kojto 122:f9eeca106725 750 #define UART_DIVFRAQ_SAMPLING8(_PCLK_, _BAUD_) (((UART_DIV_SAMPLING8((_PCLK_), (_BAUD_)) - (UART_DIVMANT_SAMPLING8((_PCLK_), (_BAUD_)) * 100U)) * 8U + 50U) / 100U)
Kojto 122:f9eeca106725 751 /* UART BRR = mantissa + overflow + fraction
Kojto 122:f9eeca106725 752 = (UART DIVMANT << 4) + ((UART DIVFRAQ & 0xF8) << 1) + (UART DIVFRAQ & 0x07U) */
Kojto 122:f9eeca106725 753 #define UART_BRR_SAMPLING8(_PCLK_, _BAUD_) (((UART_DIVMANT_SAMPLING8((_PCLK_), (_BAUD_)) << 4U) + \
Kojto 122:f9eeca106725 754 ((UART_DIVFRAQ_SAMPLING8((_PCLK_), (_BAUD_)) & 0xF8U) << 1U)) + \
Kojto 122:f9eeca106725 755 (UART_DIVFRAQ_SAMPLING8((_PCLK_), (_BAUD_)) & 0x07U))
Kojto 122:f9eeca106725 756
Kojto 122:f9eeca106725 757 /**
Kojto 122:f9eeca106725 758 * @}
Kojto 122:f9eeca106725 759 */
Kojto 122:f9eeca106725 760
Kojto 122:f9eeca106725 761 /* Private functions ---------------------------------------------------------*/
Kojto 122:f9eeca106725 762 /** @defgroup UART_Private_Functions UART Private Functions
Kojto 122:f9eeca106725 763 * @{
Kojto 122:f9eeca106725 764 */
Kojto 122:f9eeca106725 765
Kojto 122:f9eeca106725 766 /**
Kojto 122:f9eeca106725 767 * @}
Kojto 122:f9eeca106725 768 */
Kojto 122:f9eeca106725 769
Kojto 122:f9eeca106725 770 /**
Kojto 122:f9eeca106725 771 * @}
Kojto 122:f9eeca106725 772 */
Kojto 122:f9eeca106725 773
Kojto 122:f9eeca106725 774 /**
Kojto 122:f9eeca106725 775 * @}
Kojto 122:f9eeca106725 776 */
Kojto 122:f9eeca106725 777
Kojto 122:f9eeca106725 778 #ifdef __cplusplus
Kojto 122:f9eeca106725 779 }
Kojto 122:f9eeca106725 780 #endif
Kojto 122:f9eeca106725 781
Kojto 122:f9eeca106725 782 #endif /* __STM32F4xx_HAL_UART_H */
Kojto 122:f9eeca106725 783
Kojto 122:f9eeca106725 784 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/