Vladimir Vana / mbed

pro vyuku PSS v Jecne

TARGET_NUCLEO_F103RB/stm32f1xx_hal_uart.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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