mbed official / mbed-src

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.

Last commit 20 Feb 2019 by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_uart.h@226:b062af740e40, 2014-06-11 (annotated)

Committer:
mbed_official
Date:
Wed Jun 11 09:45:09 2014 +0100
Revision:
226:b062af740e40
Parent:
106:ced8cbb51063
Child:
369:2e96f1b71984
Synchronized with git revision 42deb9ac55f9bdf9835e9c41dc757117d344ffda



Full URL: https://github.com/mbedmicro/mbed/commit/42deb9ac55f9bdf9835e9c41dc757117d344ffda/



[NUCLEO_F401RE] Remove call to Systick + bug fixes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 87:085cde657901 1 /**
mbed_official 87:085cde657901 2 ******************************************************************************
mbed_official 87:085cde657901 3 * @file stm32f4xx_hal_uart.h
mbed_official 87:085cde657901 4 * @author MCD Application Team
mbed_official 226:b062af740e40 5 * @version V1.1.0RC2
mbed_official 226:b062af740e40 6 * @date 14-May-2014
mbed_official 87:085cde657901 7 * @brief Header file of UART HAL module.
mbed_official 87:085cde657901 8 ******************************************************************************
mbed_official 87:085cde657901 9 * @attention
mbed_official 87:085cde657901 10 *
mbed_official 87:085cde657901 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
mbed_official 87:085cde657901 12 *
mbed_official 87:085cde657901 13 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 87:085cde657901 14 * are permitted provided that the following conditions are met:
mbed_official 87:085cde657901 15 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 87:085cde657901 16 * this list of conditions and the following disclaimer.
mbed_official 87:085cde657901 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 87:085cde657901 18 * this list of conditions and the following disclaimer in the documentation
mbed_official 87:085cde657901 19 * and/or other materials provided with the distribution.
mbed_official 87:085cde657901 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mbed_official 87:085cde657901 21 * may be used to endorse or promote products derived from this software
mbed_official 87:085cde657901 22 * without specific prior written permission.
mbed_official 87:085cde657901 23 *
mbed_official 87:085cde657901 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mbed_official 87:085cde657901 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mbed_official 87:085cde657901 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 87:085cde657901 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mbed_official 87:085cde657901 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 87:085cde657901 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mbed_official 87:085cde657901 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 87:085cde657901 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mbed_official 87:085cde657901 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mbed_official 87:085cde657901 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 87:085cde657901 34 *
mbed_official 87:085cde657901 35 ******************************************************************************
mbed_official 87:085cde657901 36 */
mbed_official 87:085cde657901 37
mbed_official 87:085cde657901 38 /* Define to prevent recursive inclusion -------------------------------------*/
mbed_official 87:085cde657901 39 #ifndef __STM32F4xx_HAL_UART_H
mbed_official 87:085cde657901 40 #define __STM32F4xx_HAL_UART_H
mbed_official 87:085cde657901 41
mbed_official 87:085cde657901 42 #ifdef __cplusplus
mbed_official 87:085cde657901 43 extern "C" {
mbed_official 87:085cde657901 44 #endif
mbed_official 87:085cde657901 45
mbed_official 87:085cde657901 46 /* Includes ------------------------------------------------------------------*/
mbed_official 87:085cde657901 47 #include "stm32f4xx_hal_def.h"
mbed_official 87:085cde657901 48
mbed_official 87:085cde657901 49 /** @addtogroup STM32F4xx_HAL_Driver
mbed_official 87:085cde657901 50 * @{
mbed_official 87:085cde657901 51 */
mbed_official 87:085cde657901 52
mbed_official 87:085cde657901 53 /** @addtogroup UART
mbed_official 87:085cde657901 54 * @{
mbed_official 87:085cde657901 55 */
mbed_official 87:085cde657901 56
mbed_official 87:085cde657901 57 /* Exported types ------------------------------------------------------------*/
mbed_official 87:085cde657901 58
mbed_official 87:085cde657901 59 /**
mbed_official 87:085cde657901 60 * @brief UART Init Structure definition
mbed_official 87:085cde657901 61 */
mbed_official 87:085cde657901 62 typedef struct
mbed_official 87:085cde657901 63 {
mbed_official 87:085cde657901 64 uint32_t BaudRate; /*!< This member configures the UART communication baud rate.
mbed_official 87:085cde657901 65 The baud rate is computed using the following formula:
mbed_official 87:085cde657901 66 - IntegerDivider = ((PCLKx) / (8 * (OVR8+1) * (huart->Init.BaudRate)))
mbed_official 87:085cde657901 67 - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8 * (OVR8+1)) + 0.5
mbed_official 87:085cde657901 68 Where OVR8 is the "oversampling by 8 mode" configuration bit in the CR1 register. */
mbed_official 87:085cde657901 69
mbed_official 87:085cde657901 70 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
mbed_official 87:085cde657901 71 This parameter can be a value of @ref UART_Word_Length */
mbed_official 87:085cde657901 72
mbed_official 87:085cde657901 73 uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
mbed_official 87:085cde657901 74 This parameter can be a value of @ref UART_Stop_Bits */
mbed_official 87:085cde657901 75
mbed_official 87:085cde657901 76 uint32_t Parity; /*!< Specifies the parity mode.
mbed_official 87:085cde657901 77 This parameter can be a value of @ref UART_Parity
mbed_official 87:085cde657901 78 @note When parity is enabled, the computed parity is inserted
mbed_official 87:085cde657901 79 at the MSB position of the transmitted data (9th bit when
mbed_official 87:085cde657901 80 the word length is set to 9 data bits; 8th bit when the
mbed_official 87:085cde657901 81 word length is set to 8 data bits). */
mbed_official 87:085cde657901 82
mbed_official 87:085cde657901 83 uint32_t Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.
mbed_official 87:085cde657901 84 This parameter can be a value of @ref UART_Mode */
mbed_official 87:085cde657901 85
mbed_official 87:085cde657901 86 uint32_t HwFlowCtl; /*!< Specifies wether the hardware flow control mode is enabled
mbed_official 87:085cde657901 87 or disabled.
mbed_official 87:085cde657901 88 This parameter can be a value of @ref UART_Hardware_Flow_Control */
mbed_official 87:085cde657901 89
mbed_official 87:085cde657901 90 uint32_t OverSampling; /*!< Specifies wether the Over sampling 8 is enabled or disabled, to achieve higher speed (up to fPCLK/8).
mbed_official 87:085cde657901 91 This parameter can be a value of @ref UART_Over_Sampling */
mbed_official 87:085cde657901 92 }UART_InitTypeDef;
mbed_official 87:085cde657901 93
mbed_official 87:085cde657901 94 /**
mbed_official 87:085cde657901 95 * @brief HAL UART State structures definition
mbed_official 87:085cde657901 96 */
mbed_official 87:085cde657901 97 typedef enum
mbed_official 87:085cde657901 98 {
mbed_official 87:085cde657901 99 HAL_UART_STATE_RESET = 0x00, /*!< Peripheral is not yet Initialized */
mbed_official 87:085cde657901 100 HAL_UART_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
mbed_official 87:085cde657901 101 HAL_UART_STATE_BUSY = 0x02, /*!< an internal process is ongoing */
mbed_official 87:085cde657901 102 HAL_UART_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
mbed_official 87:085cde657901 103 HAL_UART_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
mbed_official 87:085cde657901 104 HAL_UART_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
mbed_official 87:085cde657901 105 HAL_UART_STATE_TIMEOUT = 0x03, /*!< Timeout state */
mbed_official 87:085cde657901 106 HAL_UART_STATE_ERROR = 0x04 /*!< Error */
mbed_official 87:085cde657901 107 }HAL_UART_StateTypeDef;
mbed_official 87:085cde657901 108
mbed_official 87:085cde657901 109 /**
mbed_official 87:085cde657901 110 * @brief HAL UART Error Code structure definition
mbed_official 87:085cde657901 111 */
mbed_official 87:085cde657901 112 typedef enum
mbed_official 87:085cde657901 113 {
mbed_official 87:085cde657901 114 HAL_UART_ERROR_NONE = 0x00, /*!< No error */
mbed_official 87:085cde657901 115 HAL_UART_ERROR_PE = 0x01, /*!< Parity error */
mbed_official 87:085cde657901 116 HAL_UART_ERROR_NE = 0x02, /*!< Noise error */
mbed_official 87:085cde657901 117 HAL_UART_ERROR_FE = 0x04, /*!< frame error */
mbed_official 87:085cde657901 118 HAL_UART_ERROR_ORE = 0x08, /*!< Overrun error */
mbed_official 87:085cde657901 119 HAL_UART_ERROR_DMA = 0x10 /*!< DMA transfer error */
mbed_official 87:085cde657901 120 }HAL_UART_ErrorTypeDef;
mbed_official 87:085cde657901 121
mbed_official 87:085cde657901 122 /**
mbed_official 87:085cde657901 123 * @brief UART handle Structure definition
mbed_official 87:085cde657901 124 */
mbed_official 87:085cde657901 125 typedef struct
mbed_official 87:085cde657901 126 {
mbed_official 87:085cde657901 127 USART_TypeDef *Instance; /* UART registers base address */
mbed_official 87:085cde657901 128
mbed_official 87:085cde657901 129 UART_InitTypeDef Init; /* UART communication parameters */
mbed_official 87:085cde657901 130
mbed_official 87:085cde657901 131 uint8_t *pTxBuffPtr; /* Pointer to UART Tx transfer Buffer */
mbed_official 87:085cde657901 132
mbed_official 87:085cde657901 133 uint16_t TxXferSize; /* UART Tx Transfer size */
mbed_official 87:085cde657901 134
mbed_official 87:085cde657901 135 uint16_t TxXferCount; /* UART Tx Transfer Counter */
mbed_official 87:085cde657901 136
mbed_official 87:085cde657901 137 uint8_t *pRxBuffPtr; /* Pointer to UART Rx transfer Buffer */
mbed_official 87:085cde657901 138
mbed_official 87:085cde657901 139 uint16_t RxXferSize; /* UART Rx Transfer size */
mbed_official 87:085cde657901 140
mbed_official 87:085cde657901 141 uint16_t RxXferCount; /* UART Rx Transfer Counter */
mbed_official 87:085cde657901 142
mbed_official 87:085cde657901 143 DMA_HandleTypeDef *hdmatx; /* UART Tx DMA Handle parameters */
mbed_official 87:085cde657901 144
mbed_official 87:085cde657901 145 DMA_HandleTypeDef *hdmarx; /* UART Rx DMA Handle parameters */
mbed_official 87:085cde657901 146
mbed_official 87:085cde657901 147 HAL_LockTypeDef Lock; /* Locking object */
mbed_official 87:085cde657901 148
mbed_official 87:085cde657901 149 __IO HAL_UART_StateTypeDef State; /* UART communication state */
mbed_official 87:085cde657901 150
mbed_official 87:085cde657901 151 __IO HAL_UART_ErrorTypeDef ErrorCode; /* UART Error code */
mbed_official 87:085cde657901 152
mbed_official 87:085cde657901 153 }UART_HandleTypeDef;
mbed_official 87:085cde657901 154
mbed_official 87:085cde657901 155 /* Exported constants --------------------------------------------------------*/
mbed_official 87:085cde657901 156 /** @defgroup UART_Exported_Constants
mbed_official 87:085cde657901 157 * @{
mbed_official 87:085cde657901 158 */
mbed_official 87:085cde657901 159
mbed_official 87:085cde657901 160 /** @defgroup UART_Word_Length
mbed_official 87:085cde657901 161 * @{
mbed_official 87:085cde657901 162 */
mbed_official 87:085cde657901 163 #define UART_WORDLENGTH_8B ((uint32_t)0x00000000)
mbed_official 87:085cde657901 164 #define UART_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
mbed_official 87:085cde657901 165 #define IS_UART_WORD_LENGTH(LENGTH) (((LENGTH) == UART_WORDLENGTH_8B) || \
mbed_official 87:085cde657901 166 ((LENGTH) == UART_WORDLENGTH_9B))
mbed_official 87:085cde657901 167 /**
mbed_official 87:085cde657901 168 * @}
mbed_official 87:085cde657901 169 */
mbed_official 87:085cde657901 170
mbed_official 87:085cde657901 171 /** @defgroup UART_Stop_Bits
mbed_official 87:085cde657901 172 * @{
mbed_official 87:085cde657901 173 */
mbed_official 87:085cde657901 174 #define UART_STOPBITS_1 ((uint32_t)0x00000000)
mbed_official 87:085cde657901 175 #define UART_STOPBITS_2 ((uint32_t)USART_CR2_STOP_1)
mbed_official 87:085cde657901 176 #define IS_UART_STOPBITS(STOPBITS) (((STOPBITS) == UART_STOPBITS_1) || \
mbed_official 87:085cde657901 177 ((STOPBITS) == UART_STOPBITS_2))
mbed_official 87:085cde657901 178 /**
mbed_official 87:085cde657901 179 * @}
mbed_official 87:085cde657901 180 */
mbed_official 87:085cde657901 181
mbed_official 87:085cde657901 182 /** @defgroup UART_Parity
mbed_official 87:085cde657901 183 * @{
mbed_official 87:085cde657901 184 */
mbed_official 87:085cde657901 185 #define UART_PARITY_NONE ((uint32_t)0x00000000)
mbed_official 87:085cde657901 186 #define UART_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
mbed_official 87:085cde657901 187 #define UART_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
mbed_official 87:085cde657901 188 #define IS_UART_PARITY(PARITY) (((PARITY) == UART_PARITY_NONE) || \
mbed_official 87:085cde657901 189 ((PARITY) == UART_PARITY_EVEN) || \
mbed_official 87:085cde657901 190 ((PARITY) == UART_PARITY_ODD))
mbed_official 87:085cde657901 191 /**
mbed_official 87:085cde657901 192 * @}
mbed_official 87:085cde657901 193 */
mbed_official 87:085cde657901 194
mbed_official 87:085cde657901 195 /** @defgroup UART_Hardware_Flow_Control
mbed_official 87:085cde657901 196 * @{
mbed_official 87:085cde657901 197 */
mbed_official 87:085cde657901 198 #define UART_HWCONTROL_NONE ((uint32_t)0x00000000)
mbed_official 87:085cde657901 199 #define UART_HWCONTROL_RTS ((uint32_t)USART_CR3_RTSE)
mbed_official 87:085cde657901 200 #define UART_HWCONTROL_CTS ((uint32_t)USART_CR3_CTSE)
mbed_official 87:085cde657901 201 #define UART_HWCONTROL_RTS_CTS ((uint32_t)(USART_CR3_RTSE | USART_CR3_CTSE))
mbed_official 87:085cde657901 202 #define IS_UART_HARDWARE_FLOW_CONTROL(CONTROL)\
mbed_official 87:085cde657901 203 (((CONTROL) == UART_HWCONTROL_NONE) || \
mbed_official 87:085cde657901 204 ((CONTROL) == UART_HWCONTROL_RTS) || \
mbed_official 87:085cde657901 205 ((CONTROL) == UART_HWCONTROL_CTS) || \
mbed_official 87:085cde657901 206 ((CONTROL) == UART_HWCONTROL_RTS_CTS))
mbed_official 87:085cde657901 207 /**
mbed_official 87:085cde657901 208 * @}
mbed_official 87:085cde657901 209 */
mbed_official 87:085cde657901 210
mbed_official 87:085cde657901 211 /** @defgroup UART_Mode
mbed_official 87:085cde657901 212 * @{
mbed_official 87:085cde657901 213 */
mbed_official 87:085cde657901 214 #define UART_MODE_RX ((uint32_t)USART_CR1_RE)
mbed_official 87:085cde657901 215 #define UART_MODE_TX ((uint32_t)USART_CR1_TE)
mbed_official 87:085cde657901 216 #define UART_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
mbed_official 87:085cde657901 217 #define IS_UART_MODE(MODE) ((((MODE) & (uint32_t)0x0000FFF3) == 0x00) && ((MODE) != (uint32_t)0x000000))
mbed_official 87:085cde657901 218 /**
mbed_official 87:085cde657901 219 * @}
mbed_official 87:085cde657901 220 */
mbed_official 87:085cde657901 221
mbed_official 87:085cde657901 222 /** @defgroup UART_State
mbed_official 87:085cde657901 223 * @{
mbed_official 87:085cde657901 224 */
mbed_official 87:085cde657901 225 #define UART_STATE_DISABLE ((uint32_t)0x00000000)
mbed_official 87:085cde657901 226 #define UART_STATE_ENABLE ((uint32_t)USART_CR1_UE)
mbed_official 87:085cde657901 227 #define IS_UART_STATE(STATE) (((STATE) == UART_STATE_DISABLE) || \
mbed_official 87:085cde657901 228 ((STATE) == UART_STATE_ENABLE))
mbed_official 87:085cde657901 229 /**
mbed_official 87:085cde657901 230 * @}
mbed_official 87:085cde657901 231 */
mbed_official 87:085cde657901 232
mbed_official 87:085cde657901 233 /** @defgroup UART_Over_Sampling
mbed_official 87:085cde657901 234 * @{
mbed_official 87:085cde657901 235 */
mbed_official 87:085cde657901 236 #define UART_OVERSAMPLING_16 ((uint32_t)0x00000000)
mbed_official 87:085cde657901 237 #define UART_OVERSAMPLING_8 ((uint32_t)USART_CR1_OVER8)
mbed_official 87:085cde657901 238 #define IS_UART_OVERSAMPLING(SAMPLING) (((SAMPLING) == UART_OVERSAMPLING_16) || \
mbed_official 87:085cde657901 239 ((SAMPLING) == UART_OVERSAMPLING_8))
mbed_official 87:085cde657901 240 /**
mbed_official 87:085cde657901 241 * @}
mbed_official 87:085cde657901 242 */
mbed_official 87:085cde657901 243
mbed_official 87:085cde657901 244 /** @defgroup UART_LIN_Break_Detection_Length
mbed_official 87:085cde657901 245 * @{
mbed_official 87:085cde657901 246 */
mbed_official 87:085cde657901 247 #define UART_LINBREAKDETECTLENGTH_10B ((uint32_t)0x00000000)
mbed_official 87:085cde657901 248 #define UART_LINBREAKDETECTLENGTH_11B ((uint32_t)0x00000020)
mbed_official 87:085cde657901 249 #define IS_UART_LIN_BREAK_DETECT_LENGTH(LENGTH) (((LENGTH) == UART_LINBREAKDETECTLENGTH_10B) || \
mbed_official 87:085cde657901 250 ((LENGTH) == UART_LINBREAKDETECTLENGTH_11B))
mbed_official 87:085cde657901 251 /**
mbed_official 87:085cde657901 252 * @}
mbed_official 87:085cde657901 253 */
mbed_official 87:085cde657901 254
mbed_official 87:085cde657901 255 /** @defgroup UART_WakeUp_functions
mbed_official 87:085cde657901 256 * @{
mbed_official 87:085cde657901 257 */
mbed_official 87:085cde657901 258 #define UART_WAKEUPMETHODE_IDLELINE ((uint32_t)0x00000000)
mbed_official 87:085cde657901 259 #define UART_WAKEUPMETHODE_ADDRESSMARK ((uint32_t)0x00000800)
mbed_official 87:085cde657901 260 #define IS_UART_WAKEUPMETHODE(WAKEUP) (((WAKEUP) == UART_WAKEUPMETHODE_IDLELINE) || \
mbed_official 87:085cde657901 261 ((WAKEUP) == UART_WAKEUPMETHODE_ADDRESSMARK))
mbed_official 87:085cde657901 262 /**
mbed_official 87:085cde657901 263 * @}
mbed_official 87:085cde657901 264 */
mbed_official 87:085cde657901 265
mbed_official 87:085cde657901 266 /** @defgroup UART_Flags
mbed_official 87:085cde657901 267 * Elements values convention: 0xXXXX
mbed_official 87:085cde657901 268 * - 0xXXXX : Flag mask in the SR register
mbed_official 87:085cde657901 269 * @{
mbed_official 87:085cde657901 270 */
mbed_official 87:085cde657901 271 #define UART_FLAG_CTS ((uint32_t)0x00000200)
mbed_official 87:085cde657901 272 #define UART_FLAG_LBD ((uint32_t)0x00000100)
mbed_official 87:085cde657901 273 #define UART_FLAG_TXE ((uint32_t)0x00000080)
mbed_official 87:085cde657901 274 #define UART_FLAG_TC ((uint32_t)0x00000040)
mbed_official 87:085cde657901 275 #define UART_FLAG_RXNE ((uint32_t)0x00000020)
mbed_official 87:085cde657901 276 #define UART_FLAG_IDLE ((uint32_t)0x00000010)
mbed_official 87:085cde657901 277 #define UART_FLAG_ORE ((uint32_t)0x00000008)
mbed_official 87:085cde657901 278 #define UART_FLAG_NE ((uint32_t)0x00000004)
mbed_official 87:085cde657901 279 #define UART_FLAG_FE ((uint32_t)0x00000002)
mbed_official 87:085cde657901 280 #define UART_FLAG_PE ((uint32_t)0x00000001)
mbed_official 87:085cde657901 281 /**
mbed_official 87:085cde657901 282 * @}
mbed_official 87:085cde657901 283 */
mbed_official 87:085cde657901 284
mbed_official 87:085cde657901 285 /** @defgroup UART_Interrupt_definition
mbed_official 87:085cde657901 286 * Elements values convention: 0xY000XXXX
mbed_official 87:085cde657901 287 * - XXXX : Interrupt mask in the XX register
mbed_official 87:085cde657901 288 * - Y : Interrupt source register (2bits)
mbed_official 87:085cde657901 289 * - 01: CR1 register
mbed_official 87:085cde657901 290 * - 10: CR2 register
mbed_official 87:085cde657901 291 * - 11: CR3 register
mbed_official 87:085cde657901 292 *
mbed_official 87:085cde657901 293 * @{
mbed_official 87:085cde657901 294 */
mbed_official 87:085cde657901 295 #define UART_IT_PE ((uint32_t)0x10000100)
mbed_official 87:085cde657901 296 #define UART_IT_TXE ((uint32_t)0x10000080)
mbed_official 87:085cde657901 297 #define UART_IT_TC ((uint32_t)0x10000040)
mbed_official 87:085cde657901 298 #define UART_IT_RXNE ((uint32_t)0x10000020)
mbed_official 87:085cde657901 299 #define UART_IT_IDLE ((uint32_t)0x10000010)
mbed_official 87:085cde657901 300
mbed_official 87:085cde657901 301 #define UART_IT_LBD ((uint32_t)0x20000040)
mbed_official 87:085cde657901 302 #define UART_IT_CTS ((uint32_t)0x30000400)
mbed_official 226:b062af740e40 303
mbed_official 87:085cde657901 304 #define UART_IT_ERR ((uint32_t)0x30000001)
mbed_official 87:085cde657901 305
mbed_official 87:085cde657901 306 /**
mbed_official 87:085cde657901 307 * @}
mbed_official 87:085cde657901 308 */
mbed_official 226:b062af740e40 309
mbed_official 87:085cde657901 310 /**
mbed_official 87:085cde657901 311 * @}
mbed_official 87:085cde657901 312 */
mbed_official 87:085cde657901 313
mbed_official 87:085cde657901 314 /* Exported macro ------------------------------------------------------------*/
mbed_official 226:b062af740e40 315
mbed_official 226:b062af740e40 316 /** @brief Reset UART handle state
mbed_official 226:b062af740e40 317 * @param __HANDLE__: specifies the UART Handle.
mbed_official 226:b062af740e40 318 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
mbed_official 226:b062af740e40 319 * UART peripheral.
mbed_official 226:b062af740e40 320 * @retval None
mbed_official 226:b062af740e40 321 */
mbed_official 226:b062af740e40 322 #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_UART_STATE_RESET)
mbed_official 226:b062af740e40 323
mbed_official 226:b062af740e40 324 /** @brief Flushs the UART DR register
mbed_official 226:b062af740e40 325 * @param __HANDLE__: specifies the UART Handle.
mbed_official 226:b062af740e40 326 */
mbed_official 226:b062af740e40 327 #define __HAL_UART_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
mbed_official 226:b062af740e40 328
mbed_official 87:085cde657901 329 /** @brief Checks whether the specified UART flag is set or not.
mbed_official 87:085cde657901 330 * @param __HANDLE__: specifies the UART Handle.
mbed_official 87:085cde657901 331 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
mbed_official 87:085cde657901 332 * UART peripheral.
mbed_official 87:085cde657901 333 * @param __FLAG__: specifies the flag to check.
mbed_official 87:085cde657901 334 * This parameter can be one of the following values:
mbed_official 87:085cde657901 335 * @arg UART_FLAG_CTS: CTS Change flag (not available for UART4 and UART5)
mbed_official 87:085cde657901 336 * @arg UART_FLAG_LBD: LIN Break detection flag
mbed_official 87:085cde657901 337 * @arg UART_FLAG_TXE: Transmit data register empty flag
mbed_official 87:085cde657901 338 * @arg UART_FLAG_TC: Transmission Complete flag
mbed_official 87:085cde657901 339 * @arg UART_FLAG_RXNE: Receive data register not empty flag
mbed_official 87:085cde657901 340 * @arg UART_FLAG_IDLE: Idle Line detection flag
mbed_official 87:085cde657901 341 * @arg UART_FLAG_ORE: OverRun Error flag
mbed_official 87:085cde657901 342 * @arg UART_FLAG_NE: Noise Error flag
mbed_official 87:085cde657901 343 * @arg UART_FLAG_FE: Framing Error flag
mbed_official 87:085cde657901 344 * @arg UART_FLAG_PE: Parity Error flag
mbed_official 87:085cde657901 345 * @retval The new state of __FLAG__ (TRUE or FALSE).
mbed_official 87:085cde657901 346 */
mbed_official 87:085cde657901 347
mbed_official 87:085cde657901 348 #define __HAL_UART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
mbed_official 87:085cde657901 349
mbed_official 87:085cde657901 350 /** @brief Clears the specified UART pending flag.
mbed_official 87:085cde657901 351 * @param __HANDLE__: specifies the UART Handle.
mbed_official 87:085cde657901 352 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
mbed_official 87:085cde657901 353 * UART peripheral.
mbed_official 87:085cde657901 354 * @param __FLAG__: specifies the flag to check.
mbed_official 87:085cde657901 355 * This parameter can be any combination of the following values:
mbed_official 87:085cde657901 356 * @arg UART_FLAG_CTS: CTS Change flag (not available for UART4 and UART5).
mbed_official 87:085cde657901 357 * @arg UART_FLAG_LBD: LIN Break detection flag.
mbed_official 87:085cde657901 358 * @arg UART_FLAG_TC: Transmission Complete flag.
mbed_official 87:085cde657901 359 * @arg UART_FLAG_RXNE: Receive data register not empty flag.
mbed_official 87:085cde657901 360 *
mbed_official 87:085cde657901 361 * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (OverRun
mbed_official 87:085cde657901 362 * error) and IDLE (Idle line detected) flags are cleared by software
mbed_official 87:085cde657901 363 * sequence: a read operation to USART_SR register followed by a read
mbed_official 87:085cde657901 364 * operation to USART_DR register.
mbed_official 87:085cde657901 365 * @note RXNE flag can be also cleared by a read to the USART_DR register.
mbed_official 87:085cde657901 366 * @note TC flag can be also cleared by software sequence: a read operation to
mbed_official 87:085cde657901 367 * USART_SR register followed by a write operation to USART_DR register.
mbed_official 87:085cde657901 368 * @note TXE flag is cleared only by a write to the USART_DR register.
mbed_official 87:085cde657901 369 *
mbed_official 87:085cde657901 370 * @retval None
mbed_official 87:085cde657901 371 */
mbed_official 87:085cde657901 372 #define __HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR &= ~(__FLAG__))
mbed_official 87:085cde657901 373
mbed_official 87:085cde657901 374 /** @brief Enables or disables the specified UART interrupt.
mbed_official 87:085cde657901 375 * @param __HANDLE__: specifies the UART Handle.
mbed_official 87:085cde657901 376 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
mbed_official 87:085cde657901 377 * UART peripheral.
mbed_official 87:085cde657901 378 * @param __INTERRUPT__: specifies the UART interrupt source to check.
mbed_official 87:085cde657901 379 * This parameter can be one of the following values:
mbed_official 87:085cde657901 380 * @arg UART_IT_CTS: CTS change interrupt
mbed_official 87:085cde657901 381 * @arg UART_IT_LBD: LIN Break detection interrupt
mbed_official 87:085cde657901 382 * @arg UART_IT_TXE: Transmit Data Register empty interrupt
mbed_official 87:085cde657901 383 * @arg UART_IT_TC: Transmission complete interrupt
mbed_official 87:085cde657901 384 * @arg UART_IT_RXNE: Receive Data register not empty interrupt
mbed_official 87:085cde657901 385 * @arg UART_IT_IDLE: Idle line detection interrupt
mbed_official 87:085cde657901 386 * @arg UART_IT_PE: Parity Error interrupt
mbed_official 87:085cde657901 387 * @arg UART_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
mbed_official 87:085cde657901 388 * @param NewState: new state of the specified UART interrupt.
mbed_official 87:085cde657901 389 * This parameter can be: ENABLE or DISABLE.
mbed_official 87:085cde657901 390 * @retval None
mbed_official 87:085cde657901 391 */
mbed_official 87:085cde657901 392 #define UART_IT_MASK ((uint32_t)0x0000FFFF)
mbed_official 87:085cde657901 393 #define __HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & UART_IT_MASK)): \
mbed_official 87:085cde657901 394 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & UART_IT_MASK)): \
mbed_official 87:085cde657901 395 ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & UART_IT_MASK)))
mbed_official 87:085cde657901 396 #define __HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & UART_IT_MASK)): \
mbed_official 87:085cde657901 397 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & UART_IT_MASK)): \
mbed_official 87:085cde657901 398 ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & UART_IT_MASK)))
mbed_official 87:085cde657901 399
mbed_official 87:085cde657901 400 /** @brief Checks whether the specified UART interrupt has occurred or not.
mbed_official 87:085cde657901 401 * @param __HANDLE__: specifies the UART Handle.
mbed_official 87:085cde657901 402 * This parameter can be UARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
mbed_official 87:085cde657901 403 * UART peripheral.
mbed_official 87:085cde657901 404 * @param __IT__: specifies the UART interrupt source to check.
mbed_official 87:085cde657901 405 * This parameter can be one of the following values:
mbed_official 87:085cde657901 406 * @arg UART_IT_CTS: CTS change interrupt (not available for UART4 and UART5)
mbed_official 87:085cde657901 407 * @arg UART_IT_LBD: LIN Break detection interrupt
mbed_official 87:085cde657901 408 * @arg UART_IT_TXE: Transmit Data Register empty interrupt
mbed_official 87:085cde657901 409 * @arg UART_IT_TC: Transmission complete interrupt
mbed_official 87:085cde657901 410 * @arg UART_IT_RXNE: Receive Data register not empty interrupt
mbed_official 87:085cde657901 411 * @arg UART_IT_IDLE: Idle line detection interrupt
mbed_official 87:085cde657901 412 * @arg USART_IT_ERR: Error interrupt
mbed_official 87:085cde657901 413 * @retval The new state of __IT__ (TRUE or FALSE).
mbed_official 87:085cde657901 414 */
mbed_official 87:085cde657901 415 #define __HAL_UART_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28) == 1)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28) == 2)? \
mbed_official 87:085cde657901 416 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & UART_IT_MASK))
mbed_official 87:085cde657901 417
mbed_official 87:085cde657901 418 /** @brief macros to enables or disables the UART's one bit sampling method
mbed_official 87:085cde657901 419 * @param __HANDLE__: specifies the UART Handle.
mbed_official 87:085cde657901 420 * @retval None
mbed_official 87:085cde657901 421 */
mbed_official 87:085cde657901 422 #define __HAL_UART_ONEBIT_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
mbed_official 87:085cde657901 423 #define __HAL_UART_ONEBIT_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
mbed_official 87:085cde657901 424
mbed_official 87:085cde657901 425 #define __HAL_UART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
mbed_official 87:085cde657901 426 #define __HAL_UART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
mbed_official 87:085cde657901 427
mbed_official 87:085cde657901 428 #define __DIV_SAMPLING16(_PCLK_, _BAUD_) (((_PCLK_)*25)/(4*(_BAUD_)))
mbed_official 87:085cde657901 429 #define __DIVMANT_SAMPLING16(_PCLK_, _BAUD_) (__DIV_SAMPLING16((_PCLK_), (_BAUD_))/100)
mbed_official 87:085cde657901 430 #define __DIVFRAQ_SAMPLING16(_PCLK_, _BAUD_) (((__DIV_SAMPLING16((_PCLK_), (_BAUD_)) - (__DIVMANT_SAMPLING16((_PCLK_), (_BAUD_)) * 100)) * 16 + 50) / 100)
mbed_official 87:085cde657901 431 #define __UART_BRR_SAMPLING16(_PCLK_, _BAUD_) ((__DIVMANT_SAMPLING16((_PCLK_), (_BAUD_)) << 4)|(__DIVFRAQ_SAMPLING16((_PCLK_), (_BAUD_)) & 0x0F))
mbed_official 87:085cde657901 432
mbed_official 87:085cde657901 433 #define __DIV_SAMPLING8(_PCLK_, _BAUD_) (((_PCLK_)*25)/(2*(_BAUD_)))
mbed_official 87:085cde657901 434 #define __DIVMANT_SAMPLING8(_PCLK_, _BAUD_) (__DIV_SAMPLING8((_PCLK_), (_BAUD_))/100)
mbed_official 87:085cde657901 435 #define __DIVFRAQ_SAMPLING8(_PCLK_, _BAUD_) (((__DIV_SAMPLING8((_PCLK_), (_BAUD_)) - (__DIVMANT_SAMPLING8((_PCLK_), (_BAUD_)) * 100)) * 16 + 50) / 100)
mbed_official 87:085cde657901 436 #define __UART_BRR_SAMPLING8(_PCLK_, _BAUD_) ((__DIVMANT_SAMPLING8((_PCLK_), (_BAUD_)) << 4)|(__DIVFRAQ_SAMPLING8((_PCLK_), (_BAUD_)) & 0x0F))
mbed_official 87:085cde657901 437
mbed_official 87:085cde657901 438 #define IS_UART_BAUDRATE(BAUDRATE) ((BAUDRATE) < 10500001)
mbed_official 87:085cde657901 439 #define IS_UART_ADDRESS(ADDRESS) ((ADDRESS) <= 0xF)
mbed_official 87:085cde657901 440
mbed_official 87:085cde657901 441 /* Exported functions --------------------------------------------------------*/
mbed_official 87:085cde657901 442 /* Initialization/de-initialization functions **********************************/
mbed_official 87:085cde657901 443 HAL_StatusTypeDef HAL_UART_Init(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 444 HAL_StatusTypeDef HAL_HalfDuplex_Init(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 445 HAL_StatusTypeDef HAL_LIN_Init(UART_HandleTypeDef *huart, uint32_t BreakDetectLength);
mbed_official 87:085cde657901 446 HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethode);
mbed_official 87:085cde657901 447 HAL_StatusTypeDef HAL_UART_DeInit (UART_HandleTypeDef *huart);
mbed_official 106:ced8cbb51063 448 void HAL_UART_MspInit(UART_HandleTypeDef *huart);
mbed_official 106:ced8cbb51063 449 void HAL_UART_MspDeInit(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 450
mbed_official 87:085cde657901 451 /* IO operation functions *******************************************************/
mbed_official 87:085cde657901 452 HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
mbed_official 87:085cde657901 453 HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
mbed_official 87:085cde657901 454 HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 455 HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 456 HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 457 HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 458 HAL_StatusTypeDef HAL_UART_DMAPause(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 459 HAL_StatusTypeDef HAL_UART_DMAResume(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 460 HAL_StatusTypeDef HAL_UART_DMAStop(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 461 void HAL_UART_IRQHandler(UART_HandleTypeDef *huart);
mbed_official 106:ced8cbb51063 462 void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart);
mbed_official 106:ced8cbb51063 463 void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart);
mbed_official 106:ced8cbb51063 464 void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart);
mbed_official 106:ced8cbb51063 465 void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart);
mbed_official 106:ced8cbb51063 466 void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 467
mbed_official 87:085cde657901 468 /* Peripheral Control functions ************************************************/
mbed_official 87:085cde657901 469 HAL_StatusTypeDef HAL_LIN_SendBreak(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 470 HAL_StatusTypeDef HAL_MultiProcessor_EnterMuteMode(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 471 HAL_StatusTypeDef HAL_MultiProcessor_ExitMuteMode(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 472 HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 473 HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 474
mbed_official 87:085cde657901 475 /* Peripheral State functions **************************************************/
mbed_official 87:085cde657901 476 HAL_UART_StateTypeDef HAL_UART_GetState(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 477 uint32_t HAL_UART_GetError(UART_HandleTypeDef *huart);
mbed_official 87:085cde657901 478
mbed_official 87:085cde657901 479 /**
mbed_official 87:085cde657901 480 * @}
mbed_official 87:085cde657901 481 */
mbed_official 87:085cde657901 482
mbed_official 87:085cde657901 483 /**
mbed_official 87:085cde657901 484 * @}
mbed_official 87:085cde657901 485 */
mbed_official 87:085cde657901 486
mbed_official 87:085cde657901 487 #ifdef __cplusplus
mbed_official 87:085cde657901 488 }
mbed_official 87:085cde657901 489 #endif
mbed_official 87:085cde657901 490
mbed_official 87:085cde657901 491 #endif /* __STM32F4xx_HAL_UART_H */
mbed_official 87:085cde657901 492
mbed_official 87:085cde657901 493 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/