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:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
110:165afa46840b
.

Who changed what in which revision?

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