mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Committer:
mbed_official
Date:
Thu Jul 02 16:30:08 2015 +0100
Revision:
581:39197bcd20f2
Parent:
532:fe11edbda85c
Child:
613:bc40b8d2aec4
Synchronized with git revision ae2d3cdffe70184eb8736d94f76c45c93f4b7724

Full URL: https://github.com/mbedmicro/mbed/commit/ae2d3cdffe70184eb8736d94f76c45c93f4b7724/

Make it possible to build the core mbed library with yotta

Who changed what in which revision?

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