en 129 / mbed-dev

fix LPC812 PWM

Dependents:   IR_LED_Send

Fork of mbed-dev by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32F4/stm32f4xx_hal_uart.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Child:
19:112740acecfa
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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