Elijah Orr / mbed-renbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_B96B_F446VE/stm32f4xx_hal_uart.h@112:6f327212ef96, 2016-01-13 (annotated)

Committer:
Kojto
Date:
Wed Jan 13 09:48:29 2016 +0000
Revision:
112:6f327212ef96
Release 112 of the mbed library



Changes:

- new platforms - STM32 B96B F446, MOTE_L152RC

- nrf51 - fix serial init bug (character sent)

- stm all devices - fix RTC clocking in the init

- stm f0 - SystemInit clock fix, for SetVector()

- RawSerial - fix for microlib (vsnprintf with size 0)

Who changed what in which revision?

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