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