mbed official / mbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

TARGET_NUCLEO_F401RE/stm32f4xx_hal_uart.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
110:165afa46840b 
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

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