Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_NUCLEO_F042K6/stm32f0xx_hal_uart.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
109:9296ab0bfc11 
.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 109:9296ab0bfc11 1 /**
Kojto 109:9296ab0bfc11 2 ******************************************************************************
Kojto 109:9296ab0bfc11 3 * @file stm32f0xx_hal_uart.h
Kojto 109:9296ab0bfc11 4 * @author MCD Application Team
Kojto 109:9296ab0bfc11 5 * @version V1.3.0
Kojto 109:9296ab0bfc11 6 * @date 26-June-2015
Kojto 109:9296ab0bfc11 7 * @brief Header file of UART HAL module.
Kojto 109:9296ab0bfc11 8 ******************************************************************************
Kojto 109:9296ab0bfc11 9 * @attention
Kojto 109:9296ab0bfc11 10 *
Kojto 109:9296ab0bfc11 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Kojto 109:9296ab0bfc11 12 *
Kojto 109:9296ab0bfc11 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 109:9296ab0bfc11 14 * are permitted provided that the following conditions are met:
Kojto 109:9296ab0bfc11 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 109:9296ab0bfc11 16 * this list of conditions and the following disclaimer.
Kojto 109:9296ab0bfc11 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 109:9296ab0bfc11 18 * this list of conditions and the following disclaimer in the documentation
Kojto 109:9296ab0bfc11 19 * and/or other materials provided with the distribution.
Kojto 109:9296ab0bfc11 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 109:9296ab0bfc11 21 * may be used to endorse or promote products derived from this software
Kojto 109:9296ab0bfc11 22 * without specific prior written permission.
Kojto 109:9296ab0bfc11 23 *
Kojto 109:9296ab0bfc11 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 109:9296ab0bfc11 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 109:9296ab0bfc11 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 109:9296ab0bfc11 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 109:9296ab0bfc11 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 109:9296ab0bfc11 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 109:9296ab0bfc11 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 109:9296ab0bfc11 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 109:9296ab0bfc11 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 109:9296ab0bfc11 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 109:9296ab0bfc11 34 *
Kojto 109:9296ab0bfc11 35 ******************************************************************************
Kojto 109:9296ab0bfc11 36 */
Kojto 109:9296ab0bfc11 37
Kojto 109:9296ab0bfc11 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 109:9296ab0bfc11 39 #ifndef __STM32F0xx_HAL_UART_H
Kojto 109:9296ab0bfc11 40 #define __STM32F0xx_HAL_UART_H
Kojto 109:9296ab0bfc11 41
Kojto 109:9296ab0bfc11 42 #ifdef __cplusplus
Kojto 109:9296ab0bfc11 43 extern "C" {
Kojto 109:9296ab0bfc11 44 #endif
Kojto 109:9296ab0bfc11 45
Kojto 109:9296ab0bfc11 46 /* Includes ------------------------------------------------------------------*/
Kojto 109:9296ab0bfc11 47 #include "stm32f0xx_hal_def.h"
Kojto 109:9296ab0bfc11 48
Kojto 109:9296ab0bfc11 49 /** @addtogroup STM32F0xx_HAL_Driver
Kojto 109:9296ab0bfc11 50 * @{
Kojto 109:9296ab0bfc11 51 */
Kojto 109:9296ab0bfc11 52
Kojto 109:9296ab0bfc11 53 /** @addtogroup UART
Kojto 109:9296ab0bfc11 54 * @{
Kojto 109:9296ab0bfc11 55 */
Kojto 109:9296ab0bfc11 56
Kojto 109:9296ab0bfc11 57 /* Exported types ------------------------------------------------------------*/
Kojto 109:9296ab0bfc11 58 /** @defgroup UART_Exported_Types UART Exported Types
Kojto 109:9296ab0bfc11 59 * @{
Kojto 109:9296ab0bfc11 60 */
Kojto 109:9296ab0bfc11 61
Kojto 109:9296ab0bfc11 62 /**
Kojto 109:9296ab0bfc11 63 * @brief UART Init Structure definition
Kojto 109:9296ab0bfc11 64 */
Kojto 109:9296ab0bfc11 65 typedef struct
Kojto 109:9296ab0bfc11 66 {
Kojto 109:9296ab0bfc11 67 uint32_t BaudRate; /*!< This member configures the UART communication baud rate.
Kojto 109:9296ab0bfc11 68 The baud rate register is computed using the following formula:
Kojto 109:9296ab0bfc11 69 - If oversampling is 16 or in LIN mode (LIN mode not available on F030xx devices),
Kojto 109:9296ab0bfc11 70 Baud Rate Register = ((PCLKx) / ((huart->Init.BaudRate)))
Kojto 109:9296ab0bfc11 71 - If oversampling is 8,
Kojto 109:9296ab0bfc11 72 Baud Rate Register[15:4] = ((2 * PCLKx) / ((huart->Init.BaudRate)))[15:4]
Kojto 109:9296ab0bfc11 73 Baud Rate Register[3] = 0
Kojto 109:9296ab0bfc11 74 Baud Rate Register[2:0] = (((2 * PCLKx) / ((huart->Init.BaudRate)))[3:0]) >> 1 */
Kojto 109:9296ab0bfc11 75
Kojto 109:9296ab0bfc11 76 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
Kojto 109:9296ab0bfc11 77 This parameter can be a value of @ref UARTEx_Word_Length */
Kojto 109:9296ab0bfc11 78
Kojto 109:9296ab0bfc11 79 uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
Kojto 109:9296ab0bfc11 80 This parameter can be a value of @ref UART_Stop_Bits */
Kojto 109:9296ab0bfc11 81
Kojto 109:9296ab0bfc11 82 uint32_t Parity; /*!< Specifies the parity mode.
Kojto 109:9296ab0bfc11 83 This parameter can be a value of @ref UART_Parity
Kojto 109:9296ab0bfc11 84 @note When parity is enabled, the computed parity is inserted
Kojto 109:9296ab0bfc11 85 at the MSB position of the transmitted data (9th bit when
Kojto 109:9296ab0bfc11 86 the word length is set to 9 data bits; 8th bit when the
Kojto 109:9296ab0bfc11 87 word length is set to 8 data bits). */
Kojto 109:9296ab0bfc11 88
Kojto 109:9296ab0bfc11 89 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
Kojto 109:9296ab0bfc11 90 This parameter can be a value of @ref UART_Mode */
Kojto 109:9296ab0bfc11 91
Kojto 109:9296ab0bfc11 92 uint32_t HwFlowCtl; /*!< Specifies whether the hardware flow control mode is enabled
Kojto 109:9296ab0bfc11 93 or disabled.
Kojto 109:9296ab0bfc11 94 This parameter can be a value of @ref UART_Hardware_Flow_Control */
Kojto 109:9296ab0bfc11 95
Kojto 109:9296ab0bfc11 96 uint32_t OverSampling; /*!< Specifies whether the Over sampling 8 is enabled or disabled, to achieve higher speed (up to f_PCLK/8).
Kojto 109:9296ab0bfc11 97 This parameter can be a value of @ref UART_Over_Sampling */
Kojto 109:9296ab0bfc11 98
Kojto 109:9296ab0bfc11 99 uint32_t OneBitSampling; /*!< Specifies whether a single sample or three samples' majority vote is selected.
Kojto 109:9296ab0bfc11 100 Selecting the single sample method increases the receiver tolerance to clock
Kojto 109:9296ab0bfc11 101 deviations. This parameter can be a value of @ref UART_OneBit_Sampling. */
Kojto 109:9296ab0bfc11 102 }UART_InitTypeDef;
Kojto 109:9296ab0bfc11 103
Kojto 109:9296ab0bfc11 104 /**
Kojto 109:9296ab0bfc11 105 * @brief UART Advanced Features initalization structure definition
Kojto 109:9296ab0bfc11 106 */
Kojto 109:9296ab0bfc11 107 typedef struct
Kojto 109:9296ab0bfc11 108 {
Kojto 109:9296ab0bfc11 109 uint32_t AdvFeatureInit; /*!< Specifies which advanced UART features is initialized. Several
Kojto 109:9296ab0bfc11 110 Advanced Features may be initialized at the same time .
Kojto 109:9296ab0bfc11 111 This parameter can be a value of @ref UART_Advanced_Features_Initialization_Type */
Kojto 109:9296ab0bfc11 112
Kojto 109:9296ab0bfc11 113 uint32_t TxPinLevelInvert; /*!< Specifies whether the TX pin active level is inverted.
Kojto 109:9296ab0bfc11 114 This parameter can be a value of @ref UART_Tx_Inv */
Kojto 109:9296ab0bfc11 115
Kojto 109:9296ab0bfc11 116 uint32_t RxPinLevelInvert; /*!< Specifies whether the RX pin active level is inverted.
Kojto 109:9296ab0bfc11 117 This parameter can be a value of @ref UART_Rx_Inv */
Kojto 109:9296ab0bfc11 118
Kojto 109:9296ab0bfc11 119 uint32_t DataInvert; /*!< Specifies whether data are inverted (positive/direct logic
Kojto 109:9296ab0bfc11 120 vs negative/inverted logic).
Kojto 109:9296ab0bfc11 121 This parameter can be a value of @ref UART_Data_Inv */
Kojto 109:9296ab0bfc11 122
Kojto 109:9296ab0bfc11 123 uint32_t Swap; /*!< Specifies whether TX and RX pins are swapped.
Kojto 109:9296ab0bfc11 124 This parameter can be a value of @ref UART_Rx_Tx_Swap */
Kojto 109:9296ab0bfc11 125
Kojto 109:9296ab0bfc11 126 uint32_t OverrunDisable; /*!< Specifies whether the reception overrun detection is disabled.
Kojto 109:9296ab0bfc11 127 This parameter can be a value of @ref UART_Overrun_Disable */
Kojto 109:9296ab0bfc11 128
Kojto 109:9296ab0bfc11 129 uint32_t DMADisableonRxError; /*!< Specifies whether the DMA is disabled in case of reception error.
Kojto 109:9296ab0bfc11 130 This parameter can be a value of @ref UART_DMA_Disable_on_Rx_Error */
Kojto 109:9296ab0bfc11 131
Kojto 109:9296ab0bfc11 132 uint32_t AutoBaudRateEnable; /*!< Specifies whether auto Baud rate detection is enabled.
Kojto 109:9296ab0bfc11 133 This parameter can be a value of @ref UART_AutoBaudRate_Enable */
Kojto 109:9296ab0bfc11 134
Kojto 109:9296ab0bfc11 135 uint32_t AutoBaudRateMode; /*!< If auto Baud rate detection is enabled, specifies how the rate
Kojto 109:9296ab0bfc11 136 detection is carried out.
Kojto 109:9296ab0bfc11 137 This parameter can be a value of @ref UARTEx_AutoBaud_Rate_Mode */
Kojto 109:9296ab0bfc11 138
Kojto 109:9296ab0bfc11 139 uint32_t MSBFirst; /*!< Specifies whether MSB is sent first on UART line.
Kojto 109:9296ab0bfc11 140 This parameter can be a value of @ref UART_MSB_First */
Kojto 109:9296ab0bfc11 141 } UART_AdvFeatureInitTypeDef;
Kojto 109:9296ab0bfc11 142
Kojto 109:9296ab0bfc11 143
Kojto 109:9296ab0bfc11 144
Kojto 109:9296ab0bfc11 145 /**
Kojto 109:9296ab0bfc11 146 * @brief HAL UART State structures definition
Kojto 109:9296ab0bfc11 147 */
Kojto 109:9296ab0bfc11 148 typedef enum
Kojto 109:9296ab0bfc11 149 {
Kojto 109:9296ab0bfc11 150 HAL_UART_STATE_RESET = 0x00, /*!< Peripheral is not initialized */
Kojto 109:9296ab0bfc11 151 HAL_UART_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
Kojto 109:9296ab0bfc11 152 HAL_UART_STATE_BUSY = 0x02, /*!< an internal process is ongoing */
Kojto 109:9296ab0bfc11 153 HAL_UART_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
Kojto 109:9296ab0bfc11 154 HAL_UART_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
Kojto 109:9296ab0bfc11 155 HAL_UART_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
Kojto 109:9296ab0bfc11 156 HAL_UART_STATE_TIMEOUT = 0x03, /*!< Timeout state */
Kojto 109:9296ab0bfc11 157 HAL_UART_STATE_ERROR = 0x04 /*!< Error */
Kojto 109:9296ab0bfc11 158 }HAL_UART_StateTypeDef;
Kojto 109:9296ab0bfc11 159
Kojto 109:9296ab0bfc11 160 /**
Kojto 109:9296ab0bfc11 161 * @brief UART clock sources definition
Kojto 109:9296ab0bfc11 162 */
Kojto 109:9296ab0bfc11 163 typedef enum
Kojto 109:9296ab0bfc11 164 {
Kojto 109:9296ab0bfc11 165 UART_CLOCKSOURCE_PCLK1 = 0x00, /*!< PCLK1 clock source */
Kojto 109:9296ab0bfc11 166 UART_CLOCKSOURCE_HSI = 0x02, /*!< HSI clock source */
Kojto 109:9296ab0bfc11 167 UART_CLOCKSOURCE_SYSCLK = 0x04, /*!< SYSCLK clock source */
Kojto 109:9296ab0bfc11 168 UART_CLOCKSOURCE_LSE = 0x08, /*!< LSE clock source */
Kojto 109:9296ab0bfc11 169 UART_CLOCKSOURCE_UNDEFINED = 0x10 /*!< Undefined clock source */
Kojto 109:9296ab0bfc11 170 }UART_ClockSourceTypeDef;
Kojto 109:9296ab0bfc11 171
Kojto 109:9296ab0bfc11 172 /**
Kojto 109:9296ab0bfc11 173 * @brief UART handle Structure definition
Kojto 109:9296ab0bfc11 174 */
Kojto 109:9296ab0bfc11 175 typedef struct
Kojto 109:9296ab0bfc11 176 {
Kojto 109:9296ab0bfc11 177 USART_TypeDef *Instance; /*!< UART registers base address */
Kojto 109:9296ab0bfc11 178
Kojto 109:9296ab0bfc11 179 UART_InitTypeDef Init; /*!< UART communication parameters */
Kojto 109:9296ab0bfc11 180
Kojto 109:9296ab0bfc11 181 UART_AdvFeatureInitTypeDef AdvancedInit; /*!< UART Advanced Features initialization parameters */
Kojto 109:9296ab0bfc11 182
Kojto 109:9296ab0bfc11 183 uint8_t *pTxBuffPtr; /*!< Pointer to UART Tx transfer Buffer */
Kojto 109:9296ab0bfc11 184
Kojto 109:9296ab0bfc11 185 uint16_t TxXferSize; /*!< UART Tx Transfer size */
Kojto 109:9296ab0bfc11 186
Kojto 109:9296ab0bfc11 187 uint16_t TxXferCount; /*!< UART Tx Transfer Counter */
Kojto 109:9296ab0bfc11 188
Kojto 109:9296ab0bfc11 189 uint8_t *pRxBuffPtr; /*!< Pointer to UART Rx transfer Buffer */
Kojto 109:9296ab0bfc11 190
Kojto 109:9296ab0bfc11 191 uint16_t RxXferSize; /*!< UART Rx Transfer size */
Kojto 109:9296ab0bfc11 192
Kojto 109:9296ab0bfc11 193 uint16_t RxXferCount; /*!< UART Rx Transfer Counter */
Kojto 109:9296ab0bfc11 194
Kojto 109:9296ab0bfc11 195 uint16_t Mask; /*!< UART Rx RDR register mask */
Kojto 109:9296ab0bfc11 196
Kojto 109:9296ab0bfc11 197 DMA_HandleTypeDef *hdmatx; /*!< UART Tx DMA Handle parameters */
Kojto 109:9296ab0bfc11 198
Kojto 109:9296ab0bfc11 199 DMA_HandleTypeDef *hdmarx; /*!< UART Rx DMA Handle parameters */
Kojto 109:9296ab0bfc11 200
Kojto 109:9296ab0bfc11 201 HAL_LockTypeDef Lock; /*!< Locking object */
Kojto 109:9296ab0bfc11 202
Kojto 109:9296ab0bfc11 203 __IO HAL_UART_StateTypeDef State; /*!< UART communication state */
Kojto 109:9296ab0bfc11 204
Kojto 109:9296ab0bfc11 205 __IO uint32_t ErrorCode; /*!< UART Error code */
Kojto 109:9296ab0bfc11 206
Kojto 109:9296ab0bfc11 207 }UART_HandleTypeDef;
Kojto 109:9296ab0bfc11 208
Kojto 109:9296ab0bfc11 209 /**
Kojto 109:9296ab0bfc11 210 * @}
Kojto 109:9296ab0bfc11 211 */
Kojto 109:9296ab0bfc11 212
Kojto 109:9296ab0bfc11 213 /* Exported constants --------------------------------------------------------*/
Kojto 109:9296ab0bfc11 214 /** @defgroup UART_Exported_Constants UART Exported Constants
Kojto 109:9296ab0bfc11 215 * @{
Kojto 109:9296ab0bfc11 216 */
Kojto 109:9296ab0bfc11 217
Kojto 109:9296ab0bfc11 218 /** @defgroup UART_Error UART Error
Kojto 109:9296ab0bfc11 219 * @{
Kojto 109:9296ab0bfc11 220 */
Kojto 109:9296ab0bfc11 221 #define HAL_UART_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
Kojto 109:9296ab0bfc11 222 #define HAL_UART_ERROR_PE ((uint32_t)0x00000001) /*!< Parity error */
Kojto 109:9296ab0bfc11 223 #define HAL_UART_ERROR_NE ((uint32_t)0x00000002) /*!< Noise error */
Kojto 109:9296ab0bfc11 224 #define HAL_UART_ERROR_FE ((uint32_t)0x00000004) /*!< frame error */
Kojto 109:9296ab0bfc11 225 #define HAL_UART_ERROR_ORE ((uint32_t)0x00000008) /*!< Overrun error */
Kojto 109:9296ab0bfc11 226 #define HAL_UART_ERROR_DMA ((uint32_t)0x00000010) /*!< DMA transfer error */
Kojto 109:9296ab0bfc11 227 /**
Kojto 109:9296ab0bfc11 228 * @}
Kojto 109:9296ab0bfc11 229 */
Kojto 109:9296ab0bfc11 230
Kojto 109:9296ab0bfc11 231 /** @defgroup UART_Stop_Bits UART Number of Stop Bits
Kojto 109:9296ab0bfc11 232 * @{
Kojto 109:9296ab0bfc11 233 */
Kojto 109:9296ab0bfc11 234 #define UART_STOPBITS_1 ((uint32_t)0x0000)
Kojto 109:9296ab0bfc11 235 #define UART_STOPBITS_2 ((uint32_t)USART_CR2_STOP_1)
Kojto 109:9296ab0bfc11 236 #define UART_STOPBITS_1_5 ((uint32_t)(USART_CR2_STOP_0 | USART_CR2_STOP_1))
Kojto 109:9296ab0bfc11 237 /**
Kojto 109:9296ab0bfc11 238 * @}
Kojto 109:9296ab0bfc11 239 */
Kojto 109:9296ab0bfc11 240
Kojto 109:9296ab0bfc11 241 /** @defgroup UART_Parity UART Parity
Kojto 109:9296ab0bfc11 242 * @{
Kojto 109:9296ab0bfc11 243 */
Kojto 109:9296ab0bfc11 244 #define UART_PARITY_NONE ((uint32_t)0x00000000) /*!< No parity */
Kojto 109:9296ab0bfc11 245 #define UART_PARITY_EVEN ((uint32_t)USART_CR1_PCE) /*!< Even parity */
Kojto 109:9296ab0bfc11 246 #define UART_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS)) /*!< Odd parity */
Kojto 109:9296ab0bfc11 247 /**
Kojto 109:9296ab0bfc11 248 * @}
Kojto 109:9296ab0bfc11 249 */
Kojto 109:9296ab0bfc11 250
Kojto 109:9296ab0bfc11 251 /** @defgroup UART_Hardware_Flow_Control UART Hardware Flow Control
Kojto 109:9296ab0bfc11 252 * @{
Kojto 109:9296ab0bfc11 253 */
Kojto 109:9296ab0bfc11 254 #define UART_HWCONTROL_NONE ((uint32_t)0x00000000) /*!< No hardware control */
Kojto 109:9296ab0bfc11 255 #define UART_HWCONTROL_RTS ((uint32_t)USART_CR3_RTSE) /*!< Request To Send */
Kojto 109:9296ab0bfc11 256 #define UART_HWCONTROL_CTS ((uint32_t)USART_CR3_CTSE) /*!< Clear To Send */
Kojto 109:9296ab0bfc11 257 #define UART_HWCONTROL_RTS_CTS ((uint32_t)(USART_CR3_RTSE | USART_CR3_CTSE)) /*!< Request and Clear To Send */
Kojto 109:9296ab0bfc11 258 /**
Kojto 109:9296ab0bfc11 259 * @}
Kojto 109:9296ab0bfc11 260 */
Kojto 109:9296ab0bfc11 261
Kojto 109:9296ab0bfc11 262 /** @defgroup UART_Mode UART Transfer Mode
Kojto 109:9296ab0bfc11 263 * @{
Kojto 109:9296ab0bfc11 264 */
Kojto 109:9296ab0bfc11 265 #define UART_MODE_RX ((uint32_t)USART_CR1_RE) /*!< RX mode */
Kojto 109:9296ab0bfc11 266 #define UART_MODE_TX ((uint32_t)USART_CR1_TE) /*!< TX mode */
Kojto 109:9296ab0bfc11 267 #define UART_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE)) /*!< RX and TX mode */
Kojto 109:9296ab0bfc11 268 /**
Kojto 109:9296ab0bfc11 269 * @}
Kojto 109:9296ab0bfc11 270 */
Kojto 109:9296ab0bfc11 271
Kojto 109:9296ab0bfc11 272 /** @defgroup UART_State UART State
Kojto 109:9296ab0bfc11 273 * @{
Kojto 109:9296ab0bfc11 274 */
Kojto 109:9296ab0bfc11 275 #define UART_STATE_DISABLE ((uint32_t)0x00000000) /*!< UART disabled */
Kojto 109:9296ab0bfc11 276 #define UART_STATE_ENABLE ((uint32_t)USART_CR1_UE) /*!< UART enabled */
Kojto 109:9296ab0bfc11 277 /**
Kojto 109:9296ab0bfc11 278 * @}
Kojto 109:9296ab0bfc11 279 */
Kojto 109:9296ab0bfc11 280
Kojto 109:9296ab0bfc11 281 /** @defgroup UART_Over_Sampling UART Over Sampling
Kojto 109:9296ab0bfc11 282 * @{
Kojto 109:9296ab0bfc11 283 */
Kojto 109:9296ab0bfc11 284 #define UART_OVERSAMPLING_16 ((uint32_t)0x00000000) /*!< Oversampling by 16 */
Kojto 109:9296ab0bfc11 285 #define UART_OVERSAMPLING_8 ((uint32_t)USART_CR1_OVER8) /*!< Oversampling by 8 */
Kojto 109:9296ab0bfc11 286 /**
Kojto 109:9296ab0bfc11 287 * @}
Kojto 109:9296ab0bfc11 288 */
Kojto 109:9296ab0bfc11 289
Kojto 109:9296ab0bfc11 290 /** @defgroup UART_OneBit_Sampling UART One Bit Sampling Method
Kojto 109:9296ab0bfc11 291 * @{
Kojto 109:9296ab0bfc11 292 */
Kojto 109:9296ab0bfc11 293 #define UART_ONE_BIT_SAMPLE_DISABLE ((uint32_t)0x00000000) /*!< One-bit sampling disable */
Kojto 109:9296ab0bfc11 294 #define UART_ONE_BIT_SAMPLE_ENABLE ((uint32_t)USART_CR3_ONEBIT) /*!< One-bit sampling enable */
Kojto 109:9296ab0bfc11 295 /**
Kojto 109:9296ab0bfc11 296 * @}
Kojto 109:9296ab0bfc11 297 */
Kojto 109:9296ab0bfc11 298
Kojto 109:9296ab0bfc11 299 /** @defgroup UART_Receiver_TimeOut UART Receiver TimeOut
Kojto 109:9296ab0bfc11 300 * @{
Kojto 109:9296ab0bfc11 301 */
Kojto 109:9296ab0bfc11 302 #define UART_RECEIVER_TIMEOUT_DISABLE ((uint32_t)0x00000000) /*!< UART receiver timeout disable */
Kojto 109:9296ab0bfc11 303 #define UART_RECEIVER_TIMEOUT_ENABLE ((uint32_t)USART_CR2_RTOEN) /*!< UART receiver timeout enable */
Kojto 109:9296ab0bfc11 304 /**
Kojto 109:9296ab0bfc11 305 * @}
Kojto 109:9296ab0bfc11 306 */
Kojto 109:9296ab0bfc11 307
Kojto 109:9296ab0bfc11 308 /** @defgroup UART_DMA_Tx UART DMA Tx
Kojto 109:9296ab0bfc11 309 * @{
Kojto 109:9296ab0bfc11 310 */
Kojto 109:9296ab0bfc11 311 #define UART_DMA_TX_DISABLE ((uint32_t)0x00000000) /*!< UART DMA TX disabled */
Kojto 109:9296ab0bfc11 312 #define UART_DMA_TX_ENABLE ((uint32_t)USART_CR3_DMAT) /*!< UART DMA TX enabled */
Kojto 109:9296ab0bfc11 313 /**
Kojto 109:9296ab0bfc11 314 * @}
Kojto 109:9296ab0bfc11 315 */
Kojto 109:9296ab0bfc11 316
Kojto 109:9296ab0bfc11 317 /** @defgroup UART_DMA_Rx UART DMA Rx
Kojto 109:9296ab0bfc11 318 * @{
Kojto 109:9296ab0bfc11 319 */
Kojto 109:9296ab0bfc11 320 #define UART_DMA_RX_DISABLE ((uint32_t)0x00000000) /*!< UART DMA RX disabled */
Kojto 109:9296ab0bfc11 321 #define UART_DMA_RX_ENABLE ((uint32_t)USART_CR3_DMAR) /*!< UART DMA RX enabled */
Kojto 109:9296ab0bfc11 322 /**
Kojto 109:9296ab0bfc11 323 * @}
Kojto 109:9296ab0bfc11 324 */
Kojto 109:9296ab0bfc11 325
Kojto 109:9296ab0bfc11 326 /** @defgroup UART_Half_Duplex_Selection UART Half Duplex Selection
Kojto 109:9296ab0bfc11 327 * @{
Kojto 109:9296ab0bfc11 328 */
Kojto 109:9296ab0bfc11 329 #define UART_HALF_DUPLEX_DISABLE ((uint32_t)0x00000000) /*!< UART half-duplex disabled */
Kojto 109:9296ab0bfc11 330 #define UART_HALF_DUPLEX_ENABLE ((uint32_t)USART_CR3_HDSEL) /*!< UART half-duplex enabled */
Kojto 109:9296ab0bfc11 331 /**
Kojto 109:9296ab0bfc11 332 * @}
Kojto 109:9296ab0bfc11 333 */
Kojto 109:9296ab0bfc11 334
Kojto 109:9296ab0bfc11 335 /** @defgroup UART_WakeUp_Address_Length UART WakeUp Address Length
Kojto 109:9296ab0bfc11 336 * @{
Kojto 109:9296ab0bfc11 337 */
Kojto 109:9296ab0bfc11 338 #define UART_ADDRESS_DETECT_4B ((uint32_t)0x00000000) /*!< 4-bit long wake-up address */
Kojto 109:9296ab0bfc11 339 #define UART_ADDRESS_DETECT_7B ((uint32_t)USART_CR2_ADDM7) /*!< 7-bit long wake-up address */
Kojto 109:9296ab0bfc11 340 /**
Kojto 109:9296ab0bfc11 341 * @}
Kojto 109:9296ab0bfc11 342 */
Kojto 109:9296ab0bfc11 343
Kojto 109:9296ab0bfc11 344 /** @defgroup UART_WakeUp_Methods UART WakeUp Methods
Kojto 109:9296ab0bfc11 345 * @{
Kojto 109:9296ab0bfc11 346 */
Kojto 109:9296ab0bfc11 347 #define UART_WAKEUPMETHOD_IDLELINE ((uint32_t)0x00000000) /*!< UART wake-up on idle line */
Kojto 109:9296ab0bfc11 348 #define UART_WAKEUPMETHOD_ADDRESSMARK ((uint32_t)USART_CR1_WAKE) /*!< UART wake-up on address mark */
Kojto 109:9296ab0bfc11 349 /**
Kojto 109:9296ab0bfc11 350 * @}
Kojto 109:9296ab0bfc11 351 */
Kojto 109:9296ab0bfc11 352
Kojto 109:9296ab0bfc11 353 /** @defgroup UART_IT UART IT
Kojto 109:9296ab0bfc11 354 * Elements values convention: 000000000XXYYYYYb
Kojto 109:9296ab0bfc11 355 * - YYYYY : Interrupt source position in the XX register (5bits)
Kojto 109:9296ab0bfc11 356 * - XX : Interrupt source register (2bits)
Kojto 109:9296ab0bfc11 357 * - 01: CR1 register
Kojto 109:9296ab0bfc11 358 * - 10: CR2 register
Kojto 109:9296ab0bfc11 359 * - 11: CR3 register
Kojto 109:9296ab0bfc11 360 * @{
Kojto 109:9296ab0bfc11 361 */
Kojto 109:9296ab0bfc11 362 #define UART_IT_ERR ((uint16_t)0x0060)
Kojto 109:9296ab0bfc11 363
Kojto 109:9296ab0bfc11 364 /** Elements values convention: 0000ZZZZ00000000b
Kojto 109:9296ab0bfc11 365 * - ZZZZ : Flag position in the ISR register(4bits)
Kojto 109:9296ab0bfc11 366 */
Kojto 109:9296ab0bfc11 367 #define UART_IT_ORE ((uint16_t)0x0300)
Kojto 109:9296ab0bfc11 368 #define UART_IT_NE ((uint16_t)0x0200)
Kojto 109:9296ab0bfc11 369 #define UART_IT_FE ((uint16_t)0x0100)
Kojto 109:9296ab0bfc11 370 /**
Kojto 109:9296ab0bfc11 371 * @}
Kojto 109:9296ab0bfc11 372 */
Kojto 109:9296ab0bfc11 373
Kojto 109:9296ab0bfc11 374 /** @defgroup UART_Advanced_Features_Initialization_Type UART Advanced Feature Initialization Type
Kojto 109:9296ab0bfc11 375 * @{
Kojto 109:9296ab0bfc11 376 */
Kojto 109:9296ab0bfc11 377 #define UART_ADVFEATURE_NO_INIT ((uint32_t)0x00000000) /*!< No advanced feature initialization */
Kojto 109:9296ab0bfc11 378 #define UART_ADVFEATURE_TXINVERT_INIT ((uint32_t)0x00000001) /*!< TX pin active level inversion */
Kojto 109:9296ab0bfc11 379 #define UART_ADVFEATURE_RXINVERT_INIT ((uint32_t)0x00000002) /*!< RX pin active level inversion */
Kojto 109:9296ab0bfc11 380 #define UART_ADVFEATURE_DATAINVERT_INIT ((uint32_t)0x00000004) /*!< Binary data inversion */
Kojto 109:9296ab0bfc11 381 #define UART_ADVFEATURE_SWAP_INIT ((uint32_t)0x00000008) /*!< TX/RX pins swap */
Kojto 109:9296ab0bfc11 382 #define UART_ADVFEATURE_RXOVERRUNDISABLE_INIT ((uint32_t)0x00000010) /*!< RX overrun disable */
Kojto 109:9296ab0bfc11 383 #define UART_ADVFEATURE_DMADISABLEONERROR_INIT ((uint32_t)0x00000020) /*!< DMA disable on Reception Error */
Kojto 109:9296ab0bfc11 384 #define UART_ADVFEATURE_AUTOBAUDRATE_INIT ((uint32_t)0x00000040) /*!< Auto Baud rate detection initialization */
Kojto 109:9296ab0bfc11 385 #define UART_ADVFEATURE_MSBFIRST_INIT ((uint32_t)0x00000080) /*!< Most significant bit sent/received first */
Kojto 109:9296ab0bfc11 386 /**
Kojto 109:9296ab0bfc11 387 * @}
Kojto 109:9296ab0bfc11 388 */
Kojto 109:9296ab0bfc11 389
Kojto 109:9296ab0bfc11 390 /** @defgroup UART_Tx_Inv UART Advanced Feature TX Pin Active Level Inversion
Kojto 109:9296ab0bfc11 391 * @{
Kojto 109:9296ab0bfc11 392 */
Kojto 109:9296ab0bfc11 393 #define UART_ADVFEATURE_TXINV_DISABLE ((uint32_t)0x00000000) /*!< TX pin active level inversion disable */
Kojto 109:9296ab0bfc11 394 #define UART_ADVFEATURE_TXINV_ENABLE ((uint32_t)USART_CR2_TXINV) /*!< TX pin active level inversion enable */
Kojto 109:9296ab0bfc11 395 /**
Kojto 109:9296ab0bfc11 396 * @}
Kojto 109:9296ab0bfc11 397 */
Kojto 109:9296ab0bfc11 398
Kojto 109:9296ab0bfc11 399 /** @defgroup UART_Rx_Inv UART Advanced Feature RX Pin Active Level Inversion
Kojto 109:9296ab0bfc11 400 * @{
Kojto 109:9296ab0bfc11 401 */
Kojto 109:9296ab0bfc11 402 #define UART_ADVFEATURE_RXINV_DISABLE ((uint32_t)0x00000000) /*!< RX pin active level inversion disable */
Kojto 109:9296ab0bfc11 403 #define UART_ADVFEATURE_RXINV_ENABLE ((uint32_t)USART_CR2_RXINV) /*!< RX pin active level inversion enable */
Kojto 109:9296ab0bfc11 404 /**
Kojto 109:9296ab0bfc11 405 * @}
Kojto 109:9296ab0bfc11 406 */
Kojto 109:9296ab0bfc11 407
Kojto 109:9296ab0bfc11 408 /** @defgroup UART_Data_Inv UART Advanced Feature Binary Data Inversion
Kojto 109:9296ab0bfc11 409 * @{
Kojto 109:9296ab0bfc11 410 */
Kojto 109:9296ab0bfc11 411 #define UART_ADVFEATURE_DATAINV_DISABLE ((uint32_t)0x00000000) /*!< Binary data inversion disable */
Kojto 109:9296ab0bfc11 412 #define UART_ADVFEATURE_DATAINV_ENABLE ((uint32_t)USART_CR2_DATAINV) /*!< Binary data inversion enable */
Kojto 109:9296ab0bfc11 413 /**
Kojto 109:9296ab0bfc11 414 * @}
Kojto 109:9296ab0bfc11 415 */
Kojto 109:9296ab0bfc11 416
Kojto 109:9296ab0bfc11 417 /** @defgroup UART_Rx_Tx_Swap UART Advanced Feature RX TX Pins Swap
Kojto 109:9296ab0bfc11 418 * @{
Kojto 109:9296ab0bfc11 419 */
Kojto 109:9296ab0bfc11 420 #define UART_ADVFEATURE_SWAP_DISABLE ((uint32_t)0x00000000) /*!< TX/RX pins swap disable */
Kojto 109:9296ab0bfc11 421 #define UART_ADVFEATURE_SWAP_ENABLE ((uint32_t)USART_CR2_SWAP) /*!< TX/RX pins swap enable */
Kojto 109:9296ab0bfc11 422 /**
Kojto 109:9296ab0bfc11 423 * @}
Kojto 109:9296ab0bfc11 424 */
Kojto 109:9296ab0bfc11 425
Kojto 109:9296ab0bfc11 426 /** @defgroup UART_Overrun_Disable UART Advanced Feature Overrun Disable
Kojto 109:9296ab0bfc11 427 * @{
Kojto 109:9296ab0bfc11 428 */
Kojto 109:9296ab0bfc11 429 #define UART_ADVFEATURE_OVERRUN_ENABLE ((uint32_t)0x00000000) /*!< RX overrun enable */
Kojto 109:9296ab0bfc11 430 #define UART_ADVFEATURE_OVERRUN_DISABLE ((uint32_t)USART_CR3_OVRDIS) /*!< RX overrun disable */
Kojto 109:9296ab0bfc11 431 /**
Kojto 109:9296ab0bfc11 432 * @}
Kojto 109:9296ab0bfc11 433 */
Kojto 109:9296ab0bfc11 434
Kojto 109:9296ab0bfc11 435 /** @defgroup UART_AutoBaudRate_Enable UART Advanced Feature Auto BaudRate Enable
Kojto 109:9296ab0bfc11 436 * @{
Kojto 109:9296ab0bfc11 437 */
Kojto 109:9296ab0bfc11 438 #define UART_ADVFEATURE_AUTOBAUDRATE_DISABLE ((uint32_t)0x00000000) /*!< RX Auto Baud rate detection enable */
Kojto 109:9296ab0bfc11 439 #define UART_ADVFEATURE_AUTOBAUDRATE_ENABLE ((uint32_t)USART_CR2_ABREN) /*!< RX Auto Baud rate detection disable */
Kojto 109:9296ab0bfc11 440 /**
Kojto 109:9296ab0bfc11 441 * @}
Kojto 109:9296ab0bfc11 442 */
Kojto 109:9296ab0bfc11 443
Kojto 109:9296ab0bfc11 444 /** @defgroup UART_DMA_Disable_on_Rx_Error UART Advanced Feature DMA Disable On Rx Error
Kojto 109:9296ab0bfc11 445 * @{
Kojto 109:9296ab0bfc11 446 */
Kojto 109:9296ab0bfc11 447 #define UART_ADVFEATURE_DMA_ENABLEONRXERROR ((uint32_t)0x00000000) /*!< DMA enable on Reception Error */
Kojto 109:9296ab0bfc11 448 #define UART_ADVFEATURE_DMA_DISABLEONRXERROR ((uint32_t)USART_CR3_DDRE) /*!< DMA disable on Reception Error */
Kojto 109:9296ab0bfc11 449 /**
Kojto 109:9296ab0bfc11 450 * @}
Kojto 109:9296ab0bfc11 451 */
Kojto 109:9296ab0bfc11 452
Kojto 109:9296ab0bfc11 453 /** @defgroup UART_MSB_First UART Advanced Feature MSB First
Kojto 109:9296ab0bfc11 454 * @{
Kojto 109:9296ab0bfc11 455 */
Kojto 109:9296ab0bfc11 456 #define UART_ADVFEATURE_MSBFIRST_DISABLE ((uint32_t)0x00000000) /*!< Most significant bit sent/received first disable */
Kojto 109:9296ab0bfc11 457 #define UART_ADVFEATURE_MSBFIRST_ENABLE ((uint32_t)USART_CR2_MSBFIRST) /*!< Most significant bit sent/received first enable */
Kojto 109:9296ab0bfc11 458 /**
Kojto 109:9296ab0bfc11 459 * @}
Kojto 109:9296ab0bfc11 460 */
Kojto 109:9296ab0bfc11 461
Kojto 109:9296ab0bfc11 462 /** @defgroup UART_Mute_Mode UART Advanced Feature Mute Mode Enable
Kojto 109:9296ab0bfc11 463 * @{
Kojto 109:9296ab0bfc11 464 */
Kojto 109:9296ab0bfc11 465 #define UART_ADVFEATURE_MUTEMODE_DISABLE ((uint32_t)0x00000000) /*!< UART mute mode disable */
Kojto 109:9296ab0bfc11 466 #define UART_ADVFEATURE_MUTEMODE_ENABLE ((uint32_t)USART_CR1_MME) /*!< UART mute mode enable */
Kojto 109:9296ab0bfc11 467 /**
Kojto 109:9296ab0bfc11 468 * @}
Kojto 109:9296ab0bfc11 469 */
Kojto 109:9296ab0bfc11 470
Kojto 109:9296ab0bfc11 471 /** @defgroup UART_CR2_ADDRESS_LSB_POS UART Address-matching LSB Position In CR2 Register
Kojto 109:9296ab0bfc11 472 * @{
Kojto 109:9296ab0bfc11 473 */
Kojto 109:9296ab0bfc11 474 #define UART_CR2_ADDRESS_LSB_POS ((uint32_t) 24)
Kojto 109:9296ab0bfc11 475 /**
Kojto 109:9296ab0bfc11 476 * @}
Kojto 109:9296ab0bfc11 477 */
Kojto 109:9296ab0bfc11 478
Kojto 109:9296ab0bfc11 479 /** @defgroup UART_DriverEnable_Polarity UART DriverEnable Polarity
Kojto 109:9296ab0bfc11 480 * @{
Kojto 109:9296ab0bfc11 481 */
Kojto 109:9296ab0bfc11 482 #define UART_DE_POLARITY_HIGH ((uint32_t)0x00000000) /*!< Driver enable signal is active high */
Kojto 109:9296ab0bfc11 483 #define UART_DE_POLARITY_LOW ((uint32_t)USART_CR3_DEP) /*!< Driver enable signal is active low */
Kojto 109:9296ab0bfc11 484 /**
Kojto 109:9296ab0bfc11 485 * @}
Kojto 109:9296ab0bfc11 486 */
Kojto 109:9296ab0bfc11 487
Kojto 109:9296ab0bfc11 488 /** @defgroup UART_CR1_DEAT_ADDRESS_LSB_POS UART Driver Enable Assertion Time LSB Position In CR1 Register
Kojto 109:9296ab0bfc11 489 * @{
Kojto 109:9296ab0bfc11 490 */
Kojto 109:9296ab0bfc11 491 #define UART_CR1_DEAT_ADDRESS_LSB_POS ((uint32_t) 21)
Kojto 109:9296ab0bfc11 492 /**
Kojto 109:9296ab0bfc11 493 * @}
Kojto 109:9296ab0bfc11 494 */
Kojto 109:9296ab0bfc11 495
Kojto 109:9296ab0bfc11 496 /** @defgroup UART_CR1_DEDT_ADDRESS_LSB_POS UART Driver Enable DeAssertion Time LSB Position In CR1 Register
Kojto 109:9296ab0bfc11 497 * @{
Kojto 109:9296ab0bfc11 498 */
Kojto 109:9296ab0bfc11 499 #define UART_CR1_DEDT_ADDRESS_LSB_POS ((uint32_t) 16)
Kojto 109:9296ab0bfc11 500 /**
Kojto 109:9296ab0bfc11 501 * @}
Kojto 109:9296ab0bfc11 502 */
Kojto 109:9296ab0bfc11 503
Kojto 109:9296ab0bfc11 504 /** @defgroup UART_Interruption_Mask UART Interruptions Flag Mask
Kojto 109:9296ab0bfc11 505 * @{
Kojto 109:9296ab0bfc11 506 */
Kojto 109:9296ab0bfc11 507 #define UART_IT_MASK ((uint32_t)0x001F)
Kojto 109:9296ab0bfc11 508 /**
Kojto 109:9296ab0bfc11 509 * @}
Kojto 109:9296ab0bfc11 510 */
Kojto 109:9296ab0bfc11 511
Kojto 109:9296ab0bfc11 512 /** @defgroup UART_TimeOut_Value UART polling-based communications time-out value
Kojto 109:9296ab0bfc11 513 * @{
Kojto 109:9296ab0bfc11 514 */
Kojto 109:9296ab0bfc11 515 #define HAL_UART_TIMEOUT_VALUE 0x1FFFFFF
Kojto 109:9296ab0bfc11 516 /**
Kojto 109:9296ab0bfc11 517 * @}
Kojto 109:9296ab0bfc11 518 */
Kojto 109:9296ab0bfc11 519
Kojto 109:9296ab0bfc11 520
Kojto 109:9296ab0bfc11 521 /**
Kojto 109:9296ab0bfc11 522 * @}
Kojto 109:9296ab0bfc11 523 */
Kojto 109:9296ab0bfc11 524
Kojto 109:9296ab0bfc11 525 /* Exported macros -----------------------------------------------------------*/
Kojto 109:9296ab0bfc11 526 /** @defgroup UART_Exported_Macros UART Exported Macros
Kojto 109:9296ab0bfc11 527 * @{
Kojto 109:9296ab0bfc11 528 */
Kojto 109:9296ab0bfc11 529
Kojto 109:9296ab0bfc11 530 /** @brief Reset UART handle state.
Kojto 109:9296ab0bfc11 531 * @param __HANDLE__: UART handle.
Kojto 109:9296ab0bfc11 532 * @retval None
Kojto 109:9296ab0bfc11 533 */
Kojto 109:9296ab0bfc11 534 #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_UART_STATE_RESET)
Kojto 109:9296ab0bfc11 535
Kojto 109:9296ab0bfc11 536 /** @brief Clear the specified UART pending flag.
Kojto 109:9296ab0bfc11 537 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 538 * @param __FLAG__: specifies the flag to check.
Kojto 109:9296ab0bfc11 539 * This parameter can be any combination of the following values:
Kojto 109:9296ab0bfc11 540 * @arg UART_CLEAR_PEF, Parity Error Clear Flag
Kojto 109:9296ab0bfc11 541 * @arg UART_CLEAR_FEF, Framing Error Clear Flag
Kojto 109:9296ab0bfc11 542 * @arg UART_CLEAR_NEF, Noise detected Clear Flag
Kojto 109:9296ab0bfc11 543 * @arg UART_CLEAR_OREF, OverRun Error Clear Flag
Kojto 109:9296ab0bfc11 544 * @arg UART_CLEAR_IDLEF, IDLE line detected Clear Flag
Kojto 109:9296ab0bfc11 545 * @arg UART_CLEAR_TCF, Transmission Complete Clear Flag
Kojto 109:9296ab0bfc11 546 * @arg UART_CLEAR_LBDF, LIN Break Detection Clear Flag (not available on all devices)
Kojto 109:9296ab0bfc11 547 * @arg UART_CLEAR_CTSF, CTS Interrupt Clear Flag
Kojto 109:9296ab0bfc11 548 * @arg UART_CLEAR_RTOF, Receiver Time Out Clear Flag
Kojto 109:9296ab0bfc11 549 * @arg UART_CLEAR_EOBF, End Of Block Clear Flag (not available on all devices)
Kojto 109:9296ab0bfc11 550 * @arg UART_CLEAR_CMF, Character Match Clear Flag
Kojto 109:9296ab0bfc11 551 * @arg UART_CLEAR_WUF, Wake Up from stop mode Clear Flag (not available on all devices)
Kojto 109:9296ab0bfc11 552 * @retval None
Kojto 109:9296ab0bfc11 553 */
Kojto 109:9296ab0bfc11 554 #define __HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
Kojto 109:9296ab0bfc11 555
Kojto 109:9296ab0bfc11 556 /** @brief Clear the UART PE pending flag.
Kojto 109:9296ab0bfc11 557 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 558 * @retval None
Kojto 109:9296ab0bfc11 559 */
Kojto 109:9296ab0bfc11 560 #define __HAL_UART_CLEAR_PEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_PEF)
Kojto 109:9296ab0bfc11 561
Kojto 109:9296ab0bfc11 562 /** @brief Clear the UART FE pending flag.
Kojto 109:9296ab0bfc11 563 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 564 * @retval None
Kojto 109:9296ab0bfc11 565 */
Kojto 109:9296ab0bfc11 566 #define __HAL_UART_CLEAR_FEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_FEF)
Kojto 109:9296ab0bfc11 567
Kojto 109:9296ab0bfc11 568 /** @brief Clear the UART NE pending flag.
Kojto 109:9296ab0bfc11 569 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 570 * @retval None
Kojto 109:9296ab0bfc11 571 */
Kojto 109:9296ab0bfc11 572 #define __HAL_UART_CLEAR_NEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_NEF)
Kojto 109:9296ab0bfc11 573
Kojto 109:9296ab0bfc11 574 /** @brief Clear the UART ORE pending flag.
Kojto 109:9296ab0bfc11 575 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 576 * @retval None
Kojto 109:9296ab0bfc11 577 */
Kojto 109:9296ab0bfc11 578 #define __HAL_UART_CLEAR_OREFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_OREF)
Kojto 109:9296ab0bfc11 579
Kojto 109:9296ab0bfc11 580 /** @brief Clear the UART IDLE pending flag.
Kojto 109:9296ab0bfc11 581 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 582 * @retval None
Kojto 109:9296ab0bfc11 583 */
Kojto 109:9296ab0bfc11 584 #define __HAL_UART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_IDLEF)
Kojto 109:9296ab0bfc11 585
Kojto 109:9296ab0bfc11 586 /** @brief Check whether the specified UART flag is set or not.
Kojto 109:9296ab0bfc11 587 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 588 * This parameter can be UARTx where x: 1, 2, 3 or 4 to select the USART or
Kojto 109:9296ab0bfc11 589 * UART peripheral (datasheet: up to four USART/UARTs)
Kojto 109:9296ab0bfc11 590 * @param __FLAG__: specifies the flag to check.
Kojto 109:9296ab0bfc11 591 * This parameter can be one of the following values:
Kojto 109:9296ab0bfc11 592 * @arg UART_FLAG_REACK: Receive enable acknowledge flag
Kojto 109:9296ab0bfc11 593 * @arg UART_FLAG_TEACK: Transmit enable acknowledge flag
Kojto 109:9296ab0bfc11 594 * @arg UART_FLAG_WUF: Wake up from stop mode flag (not available on F030xx devices)
Kojto 109:9296ab0bfc11 595 * @arg UART_FLAG_RWU: Receiver wake up flag (not available on F030xx devices)
Kojto 109:9296ab0bfc11 596 * @arg UART_FLAG_SBKF: Send Break flag
Kojto 109:9296ab0bfc11 597 * @arg UART_FLAG_CMF: Character match flag
Kojto 109:9296ab0bfc11 598 * @arg UART_FLAG_BUSY: Busy flag
Kojto 109:9296ab0bfc11 599 * @arg UART_FLAG_ABRF: Auto Baud rate detection flag
Kojto 109:9296ab0bfc11 600 * @arg UART_FLAG_ABRE: Auto Baud rate detection error flag
Kojto 109:9296ab0bfc11 601 * @arg UART_FLAG_EOBF: End of block flag (not available on F030xx devices)
Kojto 109:9296ab0bfc11 602 * @arg UART_FLAG_RTOF: Receiver timeout flag
Kojto 109:9296ab0bfc11 603 * @arg UART_FLAG_CTS: CTS Change flag
Kojto 109:9296ab0bfc11 604 * @arg UART_FLAG_LBD: LIN Break detection flag (not available on F030xx devices)
Kojto 109:9296ab0bfc11 605 * @arg UART_FLAG_TXE: Transmit data register empty flag
Kojto 109:9296ab0bfc11 606 * @arg UART_FLAG_TC: Transmission Complete flag
Kojto 109:9296ab0bfc11 607 * @arg UART_FLAG_RXNE: Receive data register not empty flag
Kojto 109:9296ab0bfc11 608 * @arg UART_FLAG_IDLE: Idle Line detection flag
Kojto 109:9296ab0bfc11 609 * @arg UART_FLAG_ORE: OverRun Error flag
Kojto 109:9296ab0bfc11 610 * @arg UART_FLAG_NE: Noise Error flag
Kojto 109:9296ab0bfc11 611 * @arg UART_FLAG_FE: Framing Error flag
Kojto 109:9296ab0bfc11 612 * @arg UART_FLAG_PE: Parity Error flag
Kojto 109:9296ab0bfc11 613 * @retval The new state of __FLAG__ (TRUE or FALSE).
Kojto 109:9296ab0bfc11 614 */
Kojto 109:9296ab0bfc11 615 #define __HAL_UART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
Kojto 109:9296ab0bfc11 616
Kojto 109:9296ab0bfc11 617 /** @brief Enable the specified UART interrupt.
Kojto 109:9296ab0bfc11 618 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 619 * This parameter can be UARTx where x: 1, 2, 3 or 4 to select the USART or
Kojto 109:9296ab0bfc11 620 * UART peripheral. (datasheet: up to four USART/UARTs)
Kojto 109:9296ab0bfc11 621 * @param __INTERRUPT__: specifies the UART interrupt source to enable.
Kojto 109:9296ab0bfc11 622 * This parameter can be one of the following values:
Kojto 109:9296ab0bfc11 623 * @arg UART_IT_WUF: Wakeup from stop mode interrupt (not available on F030xx devices)
Kojto 109:9296ab0bfc11 624 * @arg UART_IT_CM: Character match interrupt
Kojto 109:9296ab0bfc11 625 * @arg UART_IT_CTS: CTS change interrupt
Kojto 109:9296ab0bfc11 626 * @arg UART_IT_LBD: LIN Break detection interrupt (not available on F030xx devices)
Kojto 109:9296ab0bfc11 627 * @arg UART_IT_TXE: Transmit Data Register empty interrupt
Kojto 109:9296ab0bfc11 628 * @arg UART_IT_TC: Transmission complete interrupt
Kojto 109:9296ab0bfc11 629 * @arg UART_IT_RXNE: Receive Data register not empty interrupt
Kojto 109:9296ab0bfc11 630 * @arg UART_IT_IDLE: Idle line detection interrupt
Kojto 109:9296ab0bfc11 631 * @arg UART_IT_PE: Parity Error interrupt
Kojto 109:9296ab0bfc11 632 * @arg UART_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
Kojto 109:9296ab0bfc11 633 * @retval None
Kojto 109:9296ab0bfc11 634 */
Kojto 109:9296ab0bfc11 635 #define __HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
Kojto 109:9296ab0bfc11 636 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
Kojto 109:9296ab0bfc11 637 ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & UART_IT_MASK))))
Kojto 109:9296ab0bfc11 638
Kojto 109:9296ab0bfc11 639
Kojto 109:9296ab0bfc11 640 /** @brief Disable the specified UART interrupt.
Kojto 109:9296ab0bfc11 641 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 642 * This parameter can be UARTx where x: 1, 2, 3 or 4 to select the USART or
Kojto 109:9296ab0bfc11 643 * UART peripheral. (datasheet: up to four USART/UARTs)
Kojto 109:9296ab0bfc11 644 * @param __INTERRUPT__: specifies the UART interrupt source to disable.
Kojto 109:9296ab0bfc11 645 * This parameter can be one of the following values:
Kojto 109:9296ab0bfc11 646 * @arg UART_IT_WUF: Wakeup from stop mode interrupt (not available on F030xx devices)
Kojto 109:9296ab0bfc11 647 * @arg UART_IT_CM: Character match interrupt
Kojto 109:9296ab0bfc11 648 * @arg UART_IT_CTS: CTS change interrupt
Kojto 109:9296ab0bfc11 649 * @arg UART_IT_LBD: LIN Break detection interrupt (not available on F030xx devices)
Kojto 109:9296ab0bfc11 650 * @arg UART_IT_TXE: Transmit Data Register empty interrupt
Kojto 109:9296ab0bfc11 651 * @arg UART_IT_TC: Transmission complete interrupt
Kojto 109:9296ab0bfc11 652 * @arg UART_IT_RXNE: Receive Data register not empty interrupt
Kojto 109:9296ab0bfc11 653 * @arg UART_IT_IDLE: Idle line detection interrupt
Kojto 109:9296ab0bfc11 654 * @arg UART_IT_PE: Parity Error interrupt
Kojto 109:9296ab0bfc11 655 * @arg UART_IT_ERR: Error interrupt (Frame error, noise error, overrun error)
Kojto 109:9296ab0bfc11 656 * @retval None
Kojto 109:9296ab0bfc11 657 */
Kojto 109:9296ab0bfc11 658 #define __HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
Kojto 109:9296ab0bfc11 659 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
Kojto 109:9296ab0bfc11 660 ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & UART_IT_MASK))))
Kojto 109:9296ab0bfc11 661
Kojto 109:9296ab0bfc11 662 /** @brief Check whether the specified UART interrupt has occurred or not.
Kojto 109:9296ab0bfc11 663 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 664 * This parameter can be UARTx where x: 1, 2, 3 or 4 to select the USART or
Kojto 109:9296ab0bfc11 665 * UART peripheral. (datasheet: up to four USART/UARTs)
Kojto 109:9296ab0bfc11 666 * @param __IT__: specifies the UART interrupt to check.
Kojto 109:9296ab0bfc11 667 * This parameter can be one of the following values:
Kojto 109:9296ab0bfc11 668 * @arg UART_IT_WUF: Wakeup from stop mode interrupt (not available on F030xx devices)
Kojto 109:9296ab0bfc11 669 * @arg UART_IT_CM: Character match interrupt
Kojto 109:9296ab0bfc11 670 * @arg UART_IT_CTS: CTS change interrupt
Kojto 109:9296ab0bfc11 671 * @arg UART_IT_LBD: LIN Break detection interrupt (not available on F030xx devices)
Kojto 109:9296ab0bfc11 672 * @arg UART_IT_TXE: Transmit Data Register empty interrupt
Kojto 109:9296ab0bfc11 673 * @arg UART_IT_TC: Transmission complete interrupt
Kojto 109:9296ab0bfc11 674 * @arg UART_IT_RXNE: Receive Data register not empty interrupt
Kojto 109:9296ab0bfc11 675 * @arg UART_IT_IDLE: Idle line detection interrupt
Kojto 109:9296ab0bfc11 676 * @arg UART_IT_ORE: OverRun Error interrupt
Kojto 109:9296ab0bfc11 677 * @arg UART_IT_NE: Noise Error interrupt
Kojto 109:9296ab0bfc11 678 * @arg UART_IT_FE: Framing Error interrupt
Kojto 109:9296ab0bfc11 679 * @arg UART_IT_PE: Parity Error interrupt
Kojto 109:9296ab0bfc11 680 * @retval The new state of __IT__ (TRUE or FALSE).
Kojto 109:9296ab0bfc11 681 */
Kojto 109:9296ab0bfc11 682 #define __HAL_UART_GET_IT(__HANDLE__, __IT__) ((__HANDLE__)->Instance->ISR & ((uint32_t)1 << ((__IT__)>> 0x08)))
Kojto 109:9296ab0bfc11 683
Kojto 109:9296ab0bfc11 684 /** @brief Check whether the specified UART interrupt source is enabled or not.
Kojto 109:9296ab0bfc11 685 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 686 * This parameter can be UARTx where x: 1, 2, 3 or 4 to select the USART or
Kojto 109:9296ab0bfc11 687 * UART peripheral. (datasheet: up to four USART/UARTs)
Kojto 109:9296ab0bfc11 688 * @param __IT__: specifies the UART interrupt source to check.
Kojto 109:9296ab0bfc11 689 * This parameter can be one of the following values:
Kojto 109:9296ab0bfc11 690 * @arg UART_IT_WUF: Wakeup from stop mode interrupt (not available on F030xx devices)
Kojto 109:9296ab0bfc11 691 * @arg UART_IT_CM: Character match interrupt
Kojto 109:9296ab0bfc11 692 * @arg UART_IT_CTS: CTS change interrupt
Kojto 109:9296ab0bfc11 693 * @arg UART_IT_LBD: LIN Break detection interrupt (not available on F030xx devices)
Kojto 109:9296ab0bfc11 694 * @arg UART_IT_TXE: Transmit Data Register empty interrupt
Kojto 109:9296ab0bfc11 695 * @arg UART_IT_TC: Transmission complete interrupt
Kojto 109:9296ab0bfc11 696 * @arg UART_IT_RXNE: Receive Data register not empty interrupt
Kojto 109:9296ab0bfc11 697 * @arg UART_IT_IDLE: Idle line detection interrupt
Kojto 109:9296ab0bfc11 698 * @arg UART_IT_ORE: OverRun Error interrupt
Kojto 109:9296ab0bfc11 699 * @arg UART_IT_NE: Noise Error interrupt
Kojto 109:9296ab0bfc11 700 * @arg UART_IT_FE: Framing Error interrupt
Kojto 109:9296ab0bfc11 701 * @arg UART_IT_PE: Parity Error interrupt
Kojto 109:9296ab0bfc11 702 * @retval The new state of __IT__ (TRUE or FALSE).
Kojto 109:9296ab0bfc11 703 */
Kojto 109:9296ab0bfc11 704 #define __HAL_UART_GET_IT_SOURCE(__HANDLE__, __IT__) ((((((uint8_t)(__IT__)) >> 5U) == 1)? (__HANDLE__)->Instance->CR1:(((((uint8_t)(__IT__)) >> 5U) == 2)? \
Kojto 109:9296ab0bfc11 705 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & ((uint32_t)1 << (((uint16_t)(__IT__)) & UART_IT_MASK)))
Kojto 109:9296ab0bfc11 706
Kojto 109:9296ab0bfc11 707 /** @brief Clear the specified UART ISR flag, in setting the proper ICR register flag.
Kojto 109:9296ab0bfc11 708 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 709 * This parameter can be UARTx where x: 1, 2, 3 or 4 to select the USART or
Kojto 109:9296ab0bfc11 710 * UART peripheral. (datasheet: up to four USART/UARTs)
Kojto 109:9296ab0bfc11 711 * @param __IT_CLEAR__: specifies the interrupt clear register flag that needs to be set
Kojto 109:9296ab0bfc11 712 * to clear the corresponding interrupt
Kojto 109:9296ab0bfc11 713 * This parameter can be one of the following values:
Kojto 109:9296ab0bfc11 714 * @arg UART_CLEAR_PEF: Parity Error Clear Flag
Kojto 109:9296ab0bfc11 715 * @arg UART_CLEAR_FEF: Framing Error Clear Flag
Kojto 109:9296ab0bfc11 716 * @arg UART_CLEAR_NEF: Noise detected Clear Flag
Kojto 109:9296ab0bfc11 717 * @arg UART_CLEAR_OREF: OverRun Error Clear Flag
Kojto 109:9296ab0bfc11 718 * @arg UART_CLEAR_IDLEF: IDLE line detected Clear Flag
Kojto 109:9296ab0bfc11 719 * @arg UART_CLEAR_TCF: Transmission Complete Clear Flag
Kojto 109:9296ab0bfc11 720 * @arg UART_CLEAR_LBDF: LIN Break Detection Clear Flag (not available on F030xx devices)
Kojto 109:9296ab0bfc11 721 * @arg UART_CLEAR_CTSF: CTS Interrupt Clear Flag
Kojto 109:9296ab0bfc11 722 * @arg UART_CLEAR_RTOF: Receiver Time Out Clear Flag
Kojto 109:9296ab0bfc11 723 * @arg UART_CLEAR_EOBF: End Of Block Clear Flag (not available on F030xx devices)
Kojto 109:9296ab0bfc11 724 * @arg UART_CLEAR_CMF: Character Match Clear Flag
Kojto 109:9296ab0bfc11 725 * @arg UART_CLEAR_WUF: Wake Up from stop mode Clear Flag (not available on F030xx devices)
Kojto 109:9296ab0bfc11 726 * @retval None
Kojto 109:9296ab0bfc11 727 */
Kojto 109:9296ab0bfc11 728 #define __HAL_UART_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
Kojto 109:9296ab0bfc11 729
Kojto 109:9296ab0bfc11 730 /** @brief Set a specific UART request flag.
Kojto 109:9296ab0bfc11 731 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 732 * This parameter can be UARTx where x: 1, 2, 3 or 4 to select the USART or
Kojto 109:9296ab0bfc11 733 * UART peripheral. (datasheet: up to four USART/UARTs)
Kojto 109:9296ab0bfc11 734 * @param __REQ__: specifies the request flag to set
Kojto 109:9296ab0bfc11 735 * This parameter can be one of the following values:
Kojto 109:9296ab0bfc11 736 * @arg UART_AUTOBAUD_REQUEST: Auto-Baud Rate Request
Kojto 109:9296ab0bfc11 737 * @arg UART_SENDBREAK_REQUEST: Send Break Request
Kojto 109:9296ab0bfc11 738 * @arg UART_MUTE_MODE_REQUEST: Mute Mode Request
Kojto 109:9296ab0bfc11 739 * @arg UART_RXDATA_FLUSH_REQUEST: Receive Data flush Request
Kojto 109:9296ab0bfc11 740 * @arg UART_TXDATA_FLUSH_REQUEST: Transmit data flush Request (not available on F030xx devices)
Kojto 109:9296ab0bfc11 741 * @retval None
Kojto 109:9296ab0bfc11 742 */
Kojto 109:9296ab0bfc11 743 #define __HAL_UART_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
Kojto 109:9296ab0bfc11 744
Kojto 109:9296ab0bfc11 745 /** @brief Enable the UART one bit sample method.
Kojto 109:9296ab0bfc11 746 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 747 * @retval None
Kojto 109:9296ab0bfc11 748 */
Kojto 109:9296ab0bfc11 749 #define __HAL_UART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
Kojto 109:9296ab0bfc11 750
Kojto 109:9296ab0bfc11 751 /** @brief Disable the UART one bit sample method.
Kojto 109:9296ab0bfc11 752 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 753 * @retval None
Kojto 109:9296ab0bfc11 754 */
Kojto 109:9296ab0bfc11 755 #define __HAL_UART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
Kojto 109:9296ab0bfc11 756
Kojto 109:9296ab0bfc11 757 /** @brief Enable UART.
Kojto 109:9296ab0bfc11 758 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 759 * The Handle Instance can be UARTx where x: 1, 2, 3, 4 or 5 to select the UART peripheral
Kojto 109:9296ab0bfc11 760 * @retval None
Kojto 109:9296ab0bfc11 761 */
Kojto 109:9296ab0bfc11 762 #define __HAL_UART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
Kojto 109:9296ab0bfc11 763
Kojto 109:9296ab0bfc11 764 /** @brief Disable UART.
Kojto 109:9296ab0bfc11 765 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 766 * The Handle Instance can be UARTx where x: 1, 2, 3, 4 or 5 to select the UART peripheral
Kojto 109:9296ab0bfc11 767 * @retval None
Kojto 109:9296ab0bfc11 768 */
Kojto 109:9296ab0bfc11 769 #define __HAL_UART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
Kojto 109:9296ab0bfc11 770
Kojto 109:9296ab0bfc11 771 /** @brief Enable CTS flow control.
Kojto 109:9296ab0bfc11 772 * @note This macro allows to enable CTS hardware flow control for a given UART instance,
Kojto 109:9296ab0bfc11 773 * without need to call HAL_UART_Init() function.
Kojto 109:9296ab0bfc11 774 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
Kojto 109:9296ab0bfc11 775 * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
Kojto 109:9296ab0bfc11 776 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
Kojto 109:9296ab0bfc11 777 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
Kojto 109:9296ab0bfc11 778 * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
Kojto 109:9296ab0bfc11 779 * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
Kojto 109:9296ab0bfc11 780 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 781 * @retval None
Kojto 109:9296ab0bfc11 782 */
Kojto 109:9296ab0bfc11 783 #define __HAL_UART_HWCONTROL_CTS_ENABLE(__HANDLE__) \
Kojto 109:9296ab0bfc11 784 do{ \
Kojto 109:9296ab0bfc11 785 SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
Kojto 109:9296ab0bfc11 786 (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_CTSE; \
Kojto 109:9296ab0bfc11 787 } while(0)
Kojto 109:9296ab0bfc11 788
Kojto 109:9296ab0bfc11 789 /** @brief Disable CTS flow control.
Kojto 109:9296ab0bfc11 790 * @note This macro allows to disable CTS hardware flow control for a given UART instance,
Kojto 109:9296ab0bfc11 791 * without need to call HAL_UART_Init() function.
Kojto 109:9296ab0bfc11 792 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
Kojto 109:9296ab0bfc11 793 * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
Kojto 109:9296ab0bfc11 794 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
Kojto 109:9296ab0bfc11 795 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
Kojto 109:9296ab0bfc11 796 * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
Kojto 109:9296ab0bfc11 797 * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
Kojto 109:9296ab0bfc11 798 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 799 * @retval None
Kojto 109:9296ab0bfc11 800 */
Kojto 109:9296ab0bfc11 801 #define __HAL_UART_HWCONTROL_CTS_DISABLE(__HANDLE__) \
Kojto 109:9296ab0bfc11 802 do{ \
Kojto 109:9296ab0bfc11 803 CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
Kojto 109:9296ab0bfc11 804 (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_CTSE); \
Kojto 109:9296ab0bfc11 805 } while(0)
Kojto 109:9296ab0bfc11 806
Kojto 109:9296ab0bfc11 807 /** @brief Enable RTS flow control.
Kojto 109:9296ab0bfc11 808 * @note This macro allows to enable RTS hardware flow control for a given UART instance,
Kojto 109:9296ab0bfc11 809 * without need to call HAL_UART_Init() function.
Kojto 109:9296ab0bfc11 810 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
Kojto 109:9296ab0bfc11 811 * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
Kojto 109:9296ab0bfc11 812 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
Kojto 109:9296ab0bfc11 813 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
Kojto 109:9296ab0bfc11 814 * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
Kojto 109:9296ab0bfc11 815 * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
Kojto 109:9296ab0bfc11 816 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 817 * @retval None
Kojto 109:9296ab0bfc11 818 */
Kojto 109:9296ab0bfc11 819 #define __HAL_UART_HWCONTROL_RTS_ENABLE(__HANDLE__) \
Kojto 109:9296ab0bfc11 820 do{ \
Kojto 109:9296ab0bfc11 821 SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE); \
Kojto 109:9296ab0bfc11 822 (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_RTSE; \
Kojto 109:9296ab0bfc11 823 } while(0)
Kojto 109:9296ab0bfc11 824
Kojto 109:9296ab0bfc11 825 /** @brief Disable RTS flow control.
Kojto 109:9296ab0bfc11 826 * @note This macro allows to disable RTS hardware flow control for a given UART instance,
Kojto 109:9296ab0bfc11 827 * without need to call HAL_UART_Init() function.
Kojto 109:9296ab0bfc11 828 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
Kojto 109:9296ab0bfc11 829 * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
Kojto 109:9296ab0bfc11 830 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
Kojto 109:9296ab0bfc11 831 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
Kojto 109:9296ab0bfc11 832 * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
Kojto 109:9296ab0bfc11 833 * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
Kojto 109:9296ab0bfc11 834 * @param __HANDLE__: specifies the UART Handle.
Kojto 109:9296ab0bfc11 835 * @retval None
Kojto 109:9296ab0bfc11 836 */
Kojto 109:9296ab0bfc11 837 #define __HAL_UART_HWCONTROL_RTS_DISABLE(__HANDLE__) \
Kojto 109:9296ab0bfc11 838 do{ \
Kojto 109:9296ab0bfc11 839 CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE);\
Kojto 109:9296ab0bfc11 840 (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_RTSE); \
Kojto 109:9296ab0bfc11 841 } while(0)
Kojto 109:9296ab0bfc11 842
Kojto 109:9296ab0bfc11 843 /**
Kojto 109:9296ab0bfc11 844 * @}
Kojto 109:9296ab0bfc11 845 */
Kojto 109:9296ab0bfc11 846
Kojto 109:9296ab0bfc11 847 /* Private macros --------------------------------------------------------*/
Kojto 109:9296ab0bfc11 848 /** @defgroup UART_Private_Macros UART Private Macros
Kojto 109:9296ab0bfc11 849 * @{
Kojto 109:9296ab0bfc11 850 */
Kojto 109:9296ab0bfc11 851
Kojto 109:9296ab0bfc11 852 /** @brief BRR division operation to set BRR register in 8-bit oversampling mode.
Kojto 109:9296ab0bfc11 853 * @param __PCLK__: UART clock.
Kojto 109:9296ab0bfc11 854 * @param __BAUD__: Baud rate set by the user.
Kojto 109:9296ab0bfc11 855 * @retval Division result
Kojto 109:9296ab0bfc11 856 */
Kojto 109:9296ab0bfc11 857 #define UART_DIV_SAMPLING8(__PCLK__, __BAUD__) (((__PCLK__)*2)/((__BAUD__)))
Kojto 109:9296ab0bfc11 858
Kojto 109:9296ab0bfc11 859 /** @brief BRR division operation to set BRR register in 16-bit oversampling mode.
Kojto 109:9296ab0bfc11 860 * @param __PCLK__: UART clock.
Kojto 109:9296ab0bfc11 861 * @param __BAUD__: Baud rate set by the user.
Kojto 109:9296ab0bfc11 862 * @retval Division result
Kojto 109:9296ab0bfc11 863 */
Kojto 109:9296ab0bfc11 864 #define UART_DIV_SAMPLING16(__PCLK__, __BAUD__) (((__PCLK__))/((__BAUD__)))
Kojto 109:9296ab0bfc11 865
Kojto 109:9296ab0bfc11 866 /** @brief Check UART Baud rate
Kojto 109:9296ab0bfc11 867 * @param __BAUDRATE__: Baudrate specified by the user.
Kojto 109:9296ab0bfc11 868 * The maximum Baud Rate is derived from the maximum clock on F0 (i.e. 48 MHz)
Kojto 109:9296ab0bfc11 869 * divided by the smallest oversampling used on the USART (i.e. 8)
Kojto 109:9296ab0bfc11 870 * @retval SET (__BAUDRATE__ is valid) or RESET (__BAUDRATE__ is invalid)
Kojto 109:9296ab0bfc11 871 */
Kojto 109:9296ab0bfc11 872 #define IS_UART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 9000001)
Kojto 109:9296ab0bfc11 873
Kojto 109:9296ab0bfc11 874 /** @brief Check UART assertion time.
Kojto 109:9296ab0bfc11 875 * @param __TIME__: 5-bit value assertion time.
Kojto 109:9296ab0bfc11 876 * @retval Test result (TRUE or FALSE).
Kojto 109:9296ab0bfc11 877 */
Kojto 109:9296ab0bfc11 878 #define IS_UART_ASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1F)
Kojto 109:9296ab0bfc11 879
Kojto 109:9296ab0bfc11 880 /** @brief Check UART deassertion time.
Kojto 109:9296ab0bfc11 881 * @param __TIME__: 5-bit value deassertion time.
Kojto 109:9296ab0bfc11 882 * @retval Test result (TRUE or FALSE).
Kojto 109:9296ab0bfc11 883 */
Kojto 109:9296ab0bfc11 884 #define IS_UART_DEASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1F)
Kojto 109:9296ab0bfc11 885
Kojto 109:9296ab0bfc11 886 /**
Kojto 109:9296ab0bfc11 887 * @brief Ensure that UART frame number of stop bits is valid.
Kojto 109:9296ab0bfc11 888 * @param __STOPBITS__: UART frame number of stop bits.
Kojto 109:9296ab0bfc11 889 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid) UART_STOPBITS_1_5
Kojto 109:9296ab0bfc11 890 */
Kojto 109:9296ab0bfc11 891 #define IS_UART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == UART_STOPBITS_1) || \
Kojto 109:9296ab0bfc11 892 ((__STOPBITS__) == UART_STOPBITS_2) || \
Kojto 109:9296ab0bfc11 893 ((__STOPBITS__) == UART_STOPBITS_1_5))
Kojto 109:9296ab0bfc11 894
Kojto 109:9296ab0bfc11 895 /**
Kojto 109:9296ab0bfc11 896 * @brief Ensure that UART frame parity is valid.
Kojto 109:9296ab0bfc11 897 * @param __PARITY__: UART frame parity.
Kojto 109:9296ab0bfc11 898 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
Kojto 109:9296ab0bfc11 899 */
Kojto 109:9296ab0bfc11 900 #define IS_UART_PARITY(__PARITY__) (((__PARITY__) == UART_PARITY_NONE) || \
Kojto 109:9296ab0bfc11 901 ((__PARITY__) == UART_PARITY_EVEN) || \
Kojto 109:9296ab0bfc11 902 ((__PARITY__) == UART_PARITY_ODD))
Kojto 109:9296ab0bfc11 903
Kojto 109:9296ab0bfc11 904 /**
Kojto 109:9296ab0bfc11 905 * @brief Ensure that UART hardware flow control is valid.
Kojto 109:9296ab0bfc11 906 * @param __CONTROL__: UART hardware flow control.
Kojto 109:9296ab0bfc11 907 * @retval SET (__CONTROL__ is valid) or RESET (__CONTROL__ is invalid)
Kojto 109:9296ab0bfc11 908 */
Kojto 109:9296ab0bfc11 909 #define IS_UART_HARDWARE_FLOW_CONTROL(__CONTROL__)\
Kojto 109:9296ab0bfc11 910 (((__CONTROL__) == UART_HWCONTROL_NONE) || \
Kojto 109:9296ab0bfc11 911 ((__CONTROL__) == UART_HWCONTROL_RTS) || \
Kojto 109:9296ab0bfc11 912 ((__CONTROL__) == UART_HWCONTROL_CTS) || \
Kojto 109:9296ab0bfc11 913 ((__CONTROL__) == UART_HWCONTROL_RTS_CTS))
Kojto 109:9296ab0bfc11 914
Kojto 109:9296ab0bfc11 915 /**
Kojto 109:9296ab0bfc11 916 * @brief Ensure that UART communication mode is valid.
Kojto 109:9296ab0bfc11 917 * @param __MODE__: UART communication mode.
Kojto 109:9296ab0bfc11 918 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
Kojto 109:9296ab0bfc11 919 */
Kojto 109:9296ab0bfc11 920 #define IS_UART_MODE(__MODE__) ((((__MODE__) & (~((uint32_t)(UART_MODE_TX_RX)))) == (uint32_t)0x00) && ((__MODE__) != (uint32_t)0x00))
Kojto 109:9296ab0bfc11 921
Kojto 109:9296ab0bfc11 922 /**
Kojto 109:9296ab0bfc11 923 * @brief Ensure that UART state is valid.
Kojto 109:9296ab0bfc11 924 * @param __STATE__: UART state.
Kojto 109:9296ab0bfc11 925 * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
Kojto 109:9296ab0bfc11 926 */
Kojto 109:9296ab0bfc11 927 #define IS_UART_STATE(__STATE__) (((__STATE__) == UART_STATE_DISABLE) || \
Kojto 109:9296ab0bfc11 928 ((__STATE__) == UART_STATE_ENABLE))
Kojto 109:9296ab0bfc11 929
Kojto 109:9296ab0bfc11 930 /**
Kojto 109:9296ab0bfc11 931 * @brief Ensure that UART oversampling is valid.
Kojto 109:9296ab0bfc11 932 * @param __SAMPLING__: UART oversampling.
Kojto 109:9296ab0bfc11 933 * @retval SET (__SAMPLING__ is valid) or RESET (__SAMPLING__ is invalid)
Kojto 109:9296ab0bfc11 934 */
Kojto 109:9296ab0bfc11 935 #define IS_UART_OVERSAMPLING(__SAMPLING__) (((__SAMPLING__) == UART_OVERSAMPLING_16) || \
Kojto 109:9296ab0bfc11 936 ((__SAMPLING__) == UART_OVERSAMPLING_8))
Kojto 109:9296ab0bfc11 937
Kojto 109:9296ab0bfc11 938 /**
Kojto 109:9296ab0bfc11 939 * @brief Ensure that UART frame sampling is valid.
Kojto 109:9296ab0bfc11 940 * @param __ONEBIT__: UART frame sampling.
Kojto 109:9296ab0bfc11 941 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
Kojto 109:9296ab0bfc11 942 */
Kojto 109:9296ab0bfc11 943 #define IS_UART_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == UART_ONE_BIT_SAMPLE_DISABLE) || \
Kojto 109:9296ab0bfc11 944 ((__ONEBIT__) == UART_ONE_BIT_SAMPLE_ENABLE))
Kojto 109:9296ab0bfc11 945
Kojto 109:9296ab0bfc11 946 /**
Kojto 109:9296ab0bfc11 947 * @brief Ensure that Address Length detection parameter is valid.
Kojto 109:9296ab0bfc11 948 * @param __ADDRESS__: UART Adress length value.
Kojto 109:9296ab0bfc11 949 * @retval SET (__ADDRESS__ is valid) or RESET (__ADDRESS__ is invalid)
Kojto 109:9296ab0bfc11 950 */
Kojto 109:9296ab0bfc11 951 #define IS_UART_ADDRESSLENGTH_DETECT(__ADDRESS__) (((__ADDRESS__) == UART_ADDRESS_DETECT_4B) || \
Kojto 109:9296ab0bfc11 952 ((__ADDRESS__) == UART_ADDRESS_DETECT_7B))
Kojto 109:9296ab0bfc11 953
Kojto 109:9296ab0bfc11 954 /**
Kojto 109:9296ab0bfc11 955 * @brief Ensure that UART receiver timeout setting is valid.
Kojto 109:9296ab0bfc11 956 * @param __TIMEOUT__: UART receiver timeout setting.
Kojto 109:9296ab0bfc11 957 * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid)
Kojto 109:9296ab0bfc11 958 */
Kojto 109:9296ab0bfc11 959 #define IS_UART_RECEIVER_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_DISABLE) || \
Kojto 109:9296ab0bfc11 960 ((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_ENABLE))
Kojto 109:9296ab0bfc11 961
Kojto 109:9296ab0bfc11 962 /**
Kojto 109:9296ab0bfc11 963 * @brief Ensure that UART DMA TX state is valid.
Kojto 109:9296ab0bfc11 964 * @param __DMATX__: UART DMA TX state.
Kojto 109:9296ab0bfc11 965 * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid)
Kojto 109:9296ab0bfc11 966 */
Kojto 109:9296ab0bfc11 967 #define IS_UART_DMA_TX(__DMATX__) (((__DMATX__) == UART_DMA_TX_DISABLE) || \
Kojto 109:9296ab0bfc11 968 ((__DMATX__) == UART_DMA_TX_ENABLE))
Kojto 109:9296ab0bfc11 969
Kojto 109:9296ab0bfc11 970 /**
Kojto 109:9296ab0bfc11 971 * @brief Ensure that UART DMA RX state is valid.
Kojto 109:9296ab0bfc11 972 * @param __DMARX__: UART DMA RX state.
Kojto 109:9296ab0bfc11 973 * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid)
Kojto 109:9296ab0bfc11 974 */
Kojto 109:9296ab0bfc11 975 #define IS_UART_DMA_RX(__DMARX__) (((__DMARX__) == UART_DMA_RX_DISABLE) || \
Kojto 109:9296ab0bfc11 976 ((__DMARX__) == UART_DMA_RX_ENABLE))
Kojto 109:9296ab0bfc11 977
Kojto 109:9296ab0bfc11 978 /**
Kojto 109:9296ab0bfc11 979 * @brief Ensure that UART half-duplex state is valid.
Kojto 109:9296ab0bfc11 980 * @param __HDSEL__: UART half-duplex state.
Kojto 109:9296ab0bfc11 981 * @retval SET (__HDSEL__ is valid) or RESET (__HDSEL__ is invalid)
Kojto 109:9296ab0bfc11 982 */
Kojto 109:9296ab0bfc11 983 #define IS_UART_HALF_DUPLEX(__HDSEL__) (((__HDSEL__) == UART_HALF_DUPLEX_DISABLE) || \
Kojto 109:9296ab0bfc11 984 ((__HDSEL__) == UART_HALF_DUPLEX_ENABLE))
Kojto 109:9296ab0bfc11 985
Kojto 109:9296ab0bfc11 986 /**
Kojto 109:9296ab0bfc11 987 * @brief Ensure that UART wake-up method is valid.
Kojto 109:9296ab0bfc11 988 * @param __WAKEUP__: UART wake-up method .
Kojto 109:9296ab0bfc11 989 * @retval SET (__WAKEUP__ is valid) or RESET (__WAKEUP__ is invalid)
Kojto 109:9296ab0bfc11 990 */
Kojto 109:9296ab0bfc11 991 #define IS_UART_WAKEUPMETHOD(__WAKEUP__) (((__WAKEUP__) == UART_WAKEUPMETHOD_IDLELINE) || \
Kojto 109:9296ab0bfc11 992 ((__WAKEUP__) == UART_WAKEUPMETHOD_ADDRESSMARK))
Kojto 109:9296ab0bfc11 993
Kojto 109:9296ab0bfc11 994 /**
Kojto 109:9296ab0bfc11 995 * @brief Ensure that UART advanced features initialization is valid.
Kojto 109:9296ab0bfc11 996 * @param __INIT__: UART advanced features initialization.
Kojto 109:9296ab0bfc11 997 * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid)
Kojto 109:9296ab0bfc11 998 */
Kojto 109:9296ab0bfc11 999 #define IS_UART_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (UART_ADVFEATURE_NO_INIT | \
Kojto 109:9296ab0bfc11 1000 UART_ADVFEATURE_TXINVERT_INIT | \
Kojto 109:9296ab0bfc11 1001 UART_ADVFEATURE_RXINVERT_INIT | \
Kojto 109:9296ab0bfc11 1002 UART_ADVFEATURE_DATAINVERT_INIT | \
Kojto 109:9296ab0bfc11 1003 UART_ADVFEATURE_SWAP_INIT | \
Kojto 109:9296ab0bfc11 1004 UART_ADVFEATURE_RXOVERRUNDISABLE_INIT | \
Kojto 109:9296ab0bfc11 1005 UART_ADVFEATURE_DMADISABLEONERROR_INIT | \
Kojto 109:9296ab0bfc11 1006 UART_ADVFEATURE_AUTOBAUDRATE_INIT | \
Kojto 109:9296ab0bfc11 1007 UART_ADVFEATURE_MSBFIRST_INIT))
Kojto 109:9296ab0bfc11 1008
Kojto 109:9296ab0bfc11 1009 /**
Kojto 109:9296ab0bfc11 1010 * @brief Ensure that UART frame TX inversion setting is valid.
Kojto 109:9296ab0bfc11 1011 * @param __TXINV__: UART frame TX inversion setting.
Kojto 109:9296ab0bfc11 1012 * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid)
Kojto 109:9296ab0bfc11 1013 */
Kojto 109:9296ab0bfc11 1014 #define IS_UART_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == UART_ADVFEATURE_TXINV_DISABLE) || \
Kojto 109:9296ab0bfc11 1015 ((__TXINV__) == UART_ADVFEATURE_TXINV_ENABLE))
Kojto 109:9296ab0bfc11 1016
Kojto 109:9296ab0bfc11 1017 /**
Kojto 109:9296ab0bfc11 1018 * @brief Ensure that UART frame RX inversion setting is valid.
Kojto 109:9296ab0bfc11 1019 * @param __RXINV__: UART frame RX inversion setting.
Kojto 109:9296ab0bfc11 1020 * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid)
Kojto 109:9296ab0bfc11 1021 */
Kojto 109:9296ab0bfc11 1022 #define IS_UART_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == UART_ADVFEATURE_RXINV_DISABLE) || \
Kojto 109:9296ab0bfc11 1023 ((__RXINV__) == UART_ADVFEATURE_RXINV_ENABLE))
Kojto 109:9296ab0bfc11 1024
Kojto 109:9296ab0bfc11 1025 /**
Kojto 109:9296ab0bfc11 1026 * @brief Ensure that UART frame data inversion setting is valid.
Kojto 109:9296ab0bfc11 1027 * @param __DATAINV__: UART frame data inversion setting.
Kojto 109:9296ab0bfc11 1028 * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid)
Kojto 109:9296ab0bfc11 1029 */
Kojto 109:9296ab0bfc11 1030 #define IS_UART_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == UART_ADVFEATURE_DATAINV_DISABLE) || \
Kojto 109:9296ab0bfc11 1031 ((__DATAINV__) == UART_ADVFEATURE_DATAINV_ENABLE))
Kojto 109:9296ab0bfc11 1032
Kojto 109:9296ab0bfc11 1033 /**
Kojto 109:9296ab0bfc11 1034 * @brief Ensure that UART frame RX/TX pins swap setting is valid.
Kojto 109:9296ab0bfc11 1035 * @param __SWAP__: UART frame RX/TX pins swap setting.
Kojto 109:9296ab0bfc11 1036 * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid)
Kojto 109:9296ab0bfc11 1037 */
Kojto 109:9296ab0bfc11 1038 #define IS_UART_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == UART_ADVFEATURE_SWAP_DISABLE) || \
Kojto 109:9296ab0bfc11 1039 ((__SWAP__) == UART_ADVFEATURE_SWAP_ENABLE))
Kojto 109:9296ab0bfc11 1040
Kojto 109:9296ab0bfc11 1041 /**
Kojto 109:9296ab0bfc11 1042 * @brief Ensure that UART frame overrun setting is valid.
Kojto 109:9296ab0bfc11 1043 * @param __OVERRUN__: UART frame overrun setting.
Kojto 109:9296ab0bfc11 1044 * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid)
Kojto 109:9296ab0bfc11 1045 */
Kojto 109:9296ab0bfc11 1046 #define IS_UART_OVERRUN(__OVERRUN__) (((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_ENABLE) || \
Kojto 109:9296ab0bfc11 1047 ((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_DISABLE))
Kojto 109:9296ab0bfc11 1048
Kojto 109:9296ab0bfc11 1049 /**
Kojto 109:9296ab0bfc11 1050 * @brief Ensure that UART auto Baud rate state is valid.
Kojto 109:9296ab0bfc11 1051 * @param __AUTOBAUDRATE__: UART auto Baud rate state.
Kojto 109:9296ab0bfc11 1052 * @retval SET (__AUTOBAUDRATE__ is valid) or RESET (__AUTOBAUDRATE__ is invalid)
Kojto 109:9296ab0bfc11 1053 */
Kojto 109:9296ab0bfc11 1054 #define IS_UART_ADVFEATURE_AUTOBAUDRATE(__AUTOBAUDRATE__) (((__AUTOBAUDRATE__) == UART_ADVFEATURE_AUTOBAUDRATE_DISABLE) || \
Kojto 109:9296ab0bfc11 1055 ((__AUTOBAUDRATE__) == UART_ADVFEATURE_AUTOBAUDRATE_ENABLE))
Kojto 109:9296ab0bfc11 1056
Kojto 109:9296ab0bfc11 1057 /**
Kojto 109:9296ab0bfc11 1058 * @brief Ensure that UART DMA enabling or disabling on error setting is valid.
Kojto 109:9296ab0bfc11 1059 * @param __DMA__: UART DMA enabling or disabling on error setting.
Kojto 109:9296ab0bfc11 1060 * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid)
Kojto 109:9296ab0bfc11 1061 */
Kojto 109:9296ab0bfc11 1062 #define IS_UART_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == UART_ADVFEATURE_DMA_ENABLEONRXERROR) || \
Kojto 109:9296ab0bfc11 1063 ((__DMA__) == UART_ADVFEATURE_DMA_DISABLEONRXERROR))
Kojto 109:9296ab0bfc11 1064
Kojto 109:9296ab0bfc11 1065 /**
Kojto 109:9296ab0bfc11 1066 * @brief Ensure that UART frame MSB first setting is valid.
Kojto 109:9296ab0bfc11 1067 * @param __MSBFIRST__: UART frame MSB first setting.
Kojto 109:9296ab0bfc11 1068 * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid)
Kojto 109:9296ab0bfc11 1069 */
Kojto 109:9296ab0bfc11 1070 #define IS_UART_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_DISABLE) || \
Kojto 109:9296ab0bfc11 1071 ((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_ENABLE))
Kojto 109:9296ab0bfc11 1072
Kojto 109:9296ab0bfc11 1073 /**
Kojto 109:9296ab0bfc11 1074 * @brief Ensure that UART mute mode state is valid.
Kojto 109:9296ab0bfc11 1075 * @param __MUTE__: UART mute mode state.
Kojto 109:9296ab0bfc11 1076 * @retval SET (__MUTE__ is valid) or RESET (__MUTE__ is invalid)
Kojto 109:9296ab0bfc11 1077 */
Kojto 109:9296ab0bfc11 1078 #define IS_UART_MUTE_MODE(__MUTE__) (((__MUTE__) == UART_ADVFEATURE_MUTEMODE_DISABLE) || \
Kojto 109:9296ab0bfc11 1079 ((__MUTE__) == UART_ADVFEATURE_MUTEMODE_ENABLE))
Kojto 109:9296ab0bfc11 1080
Kojto 109:9296ab0bfc11 1081 /**
Kojto 109:9296ab0bfc11 1082 * @brief Ensure that UART driver enable polarity is valid.
Kojto 109:9296ab0bfc11 1083 * @param __POLARITY__: UART driver enable polarity.
Kojto 109:9296ab0bfc11 1084 * @retval SET (__POLARITY__ is valid) or RESET (__POLARITY__ is invalid)
Kojto 109:9296ab0bfc11 1085 */
Kojto 109:9296ab0bfc11 1086 #define IS_UART_DE_POLARITY(__POLARITY__) (((__POLARITY__) == UART_DE_POLARITY_HIGH) || \
Kojto 109:9296ab0bfc11 1087 ((__POLARITY__) == UART_DE_POLARITY_LOW))
Kojto 109:9296ab0bfc11 1088
Kojto 109:9296ab0bfc11 1089 /**
Kojto 109:9296ab0bfc11 1090 * @}
Kojto 109:9296ab0bfc11 1091 */
Kojto 109:9296ab0bfc11 1092
Kojto 109:9296ab0bfc11 1093 /* Include UART HAL Extension module */
Kojto 109:9296ab0bfc11 1094 #include "stm32f0xx_hal_uart_ex.h"
Kojto 109:9296ab0bfc11 1095
Kojto 109:9296ab0bfc11 1096 /* Exported functions --------------------------------------------------------*/
Kojto 109:9296ab0bfc11 1097 /** @addtogroup UART_Exported_Functions UART Exported Functions
Kojto 109:9296ab0bfc11 1098 * @{
Kojto 109:9296ab0bfc11 1099 */
Kojto 109:9296ab0bfc11 1100
Kojto 109:9296ab0bfc11 1101 /** @addtogroup UART_Exported_Functions_Group1 Initialization and de-initialization functions
Kojto 109:9296ab0bfc11 1102 * @{
Kojto 109:9296ab0bfc11 1103 */
Kojto 109:9296ab0bfc11 1104
Kojto 109:9296ab0bfc11 1105 /* Initialization and de-initialization functions ****************************/
Kojto 109:9296ab0bfc11 1106 HAL_StatusTypeDef HAL_UART_Init(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1107 HAL_StatusTypeDef HAL_HalfDuplex_Init(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1108 HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod);
Kojto 109:9296ab0bfc11 1109 HAL_StatusTypeDef HAL_UART_DeInit (UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1110 void HAL_UART_MspInit(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1111 void HAL_UART_MspDeInit(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1112
Kojto 109:9296ab0bfc11 1113 /**
Kojto 109:9296ab0bfc11 1114 * @}
Kojto 109:9296ab0bfc11 1115 */
Kojto 109:9296ab0bfc11 1116
Kojto 109:9296ab0bfc11 1117 /** @addtogroup UART_Exported_Functions_Group2 IO operation functions
Kojto 109:9296ab0bfc11 1118 * @{
Kojto 109:9296ab0bfc11 1119 */
Kojto 109:9296ab0bfc11 1120
Kojto 109:9296ab0bfc11 1121 /* IO operation functions *****************************************************/
Kojto 109:9296ab0bfc11 1122 HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
Kojto 109:9296ab0bfc11 1123 HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
Kojto 109:9296ab0bfc11 1124 HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
Kojto 109:9296ab0bfc11 1125 HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
Kojto 109:9296ab0bfc11 1126 HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
Kojto 109:9296ab0bfc11 1127 HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
Kojto 109:9296ab0bfc11 1128 HAL_StatusTypeDef HAL_UART_DMAPause(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1129 HAL_StatusTypeDef HAL_UART_DMAResume(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1130 HAL_StatusTypeDef HAL_UART_DMAStop(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1131 void HAL_UART_IRQHandler(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1132 void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1133 void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1134 void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1135 void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1136 void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1137
Kojto 109:9296ab0bfc11 1138 /**
Kojto 109:9296ab0bfc11 1139 * @}
Kojto 109:9296ab0bfc11 1140 */
Kojto 109:9296ab0bfc11 1141
Kojto 109:9296ab0bfc11 1142 /** @addtogroup UART_Exported_Functions_Group3 Peripheral Control functions
Kojto 109:9296ab0bfc11 1143 * @{
Kojto 109:9296ab0bfc11 1144 */
Kojto 109:9296ab0bfc11 1145
Kojto 109:9296ab0bfc11 1146 /* Peripheral Control functions ************************************************/
Kojto 109:9296ab0bfc11 1147 HAL_StatusTypeDef HAL_MultiProcessor_EnableMuteMode(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1148 HAL_StatusTypeDef HAL_MultiProcessor_DisableMuteMode(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1149 void HAL_MultiProcessor_EnterMuteMode(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1150 HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1151 HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1152
Kojto 109:9296ab0bfc11 1153 /**
Kojto 109:9296ab0bfc11 1154 * @}
Kojto 109:9296ab0bfc11 1155 */
Kojto 109:9296ab0bfc11 1156
Kojto 109:9296ab0bfc11 1157 /** @addtogroup UART_Exported_Functions_Group4 Peripheral State and Error functions
Kojto 109:9296ab0bfc11 1158 * @{
Kojto 109:9296ab0bfc11 1159 */
Kojto 109:9296ab0bfc11 1160
Kojto 109:9296ab0bfc11 1161 /* Peripheral State and Errors functions **************************************************/
Kojto 109:9296ab0bfc11 1162 HAL_UART_StateTypeDef HAL_UART_GetState(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1163 uint32_t HAL_UART_GetError(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1164
Kojto 109:9296ab0bfc11 1165 /**
Kojto 109:9296ab0bfc11 1166 * @}
Kojto 109:9296ab0bfc11 1167 */
Kojto 109:9296ab0bfc11 1168
Kojto 109:9296ab0bfc11 1169 /**
Kojto 109:9296ab0bfc11 1170 * @}
Kojto 109:9296ab0bfc11 1171 */
Kojto 109:9296ab0bfc11 1172
Kojto 109:9296ab0bfc11 1173 /* Private functions -----------------------------------------------------------*/
Kojto 109:9296ab0bfc11 1174 /** @addtogroup UART_Private_Functions
Kojto 109:9296ab0bfc11 1175 * @{
Kojto 109:9296ab0bfc11 1176 */
Kojto 109:9296ab0bfc11 1177 void UART_AdvFeatureConfig(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1178 HAL_StatusTypeDef UART_CheckIdleState(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1179 HAL_StatusTypeDef UART_SetConfig(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1180 HAL_StatusTypeDef UART_Transmit_IT(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1181 HAL_StatusTypeDef UART_EndTransmit_IT(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1182 HAL_StatusTypeDef UART_Receive_IT(UART_HandleTypeDef *huart);
Kojto 109:9296ab0bfc11 1183 HAL_StatusTypeDef UART_WaitOnFlagUntilTimeout(UART_HandleTypeDef *huart, uint32_t Flag, FlagStatus Status, uint32_t Timeout);
Kojto 109:9296ab0bfc11 1184 /**
Kojto 109:9296ab0bfc11 1185 * @}
Kojto 109:9296ab0bfc11 1186 */
Kojto 109:9296ab0bfc11 1187
Kojto 109:9296ab0bfc11 1188 /**
Kojto 109:9296ab0bfc11 1189 * @}
Kojto 109:9296ab0bfc11 1190 */
Kojto 109:9296ab0bfc11 1191
Kojto 109:9296ab0bfc11 1192 /**
Kojto 109:9296ab0bfc11 1193 * @}
Kojto 109:9296ab0bfc11 1194 */
Kojto 109:9296ab0bfc11 1195
Kojto 109:9296ab0bfc11 1196 #ifdef __cplusplus
Kojto 109:9296ab0bfc11 1197 }
Kojto 109:9296ab0bfc11 1198 #endif
Kojto 109:9296ab0bfc11 1199
Kojto 109:9296ab0bfc11 1200 #endif /* __STM32F0xx_HAL_UART_H */
Kojto 109:9296ab0bfc11 1201
Kojto 109:9296ab0bfc11 1202 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Kojto 109:9296ab0bfc11 1203