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

Committer:
Kojto
Date:
Wed Nov 25 13:21:40 2015 +0000
Revision:
110:165afa46840b
Release 110  of the mbed library

Changes:
- new platforms - STM32F410R, DISCO_F429ZI, DISCO_F469NI
- Nucleo L476 - gcc and uvision template
- k22,k64f targets - ADC channels A addition
- EFM32 - bugfixes in sleep, serial and spi
- Delta DFCM NNN40 - pinnames update

Who changed what in which revision?

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