mbed(SerialHalfDuplex入り)

Fork of mbed by mbed official

Committer:
yusuke_kyo
Date:
Wed Apr 08 08:04:18 2015 +0000
Revision:
98:01a414ca7d6d
Parent:
93:e188a91d3eaa
remove SerialHalfDuplex.h

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 93:e188a91d3eaa 1 /**
Kojto 93:e188a91d3eaa 2 ******************************************************************************
Kojto 93:e188a91d3eaa 3 * @file stm32f4xx_hal_usart.h
Kojto 93:e188a91d3eaa 4 * @author MCD Application Team
Kojto 93:e188a91d3eaa 5 * @version V1.1.0
Kojto 93:e188a91d3eaa 6 * @date 19-June-2014
Kojto 93:e188a91d3eaa 7 * @brief Header file of USART HAL module.
Kojto 93:e188a91d3eaa 8 ******************************************************************************
Kojto 93:e188a91d3eaa 9 * @attention
Kojto 93:e188a91d3eaa 10 *
Kojto 93:e188a91d3eaa 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
Kojto 93:e188a91d3eaa 12 *
Kojto 93:e188a91d3eaa 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 93:e188a91d3eaa 14 * are permitted provided that the following conditions are met:
Kojto 93:e188a91d3eaa 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 93:e188a91d3eaa 16 * this list of conditions and the following disclaimer.
Kojto 93:e188a91d3eaa 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 93:e188a91d3eaa 18 * this list of conditions and the following disclaimer in the documentation
Kojto 93:e188a91d3eaa 19 * and/or other materials provided with the distribution.
Kojto 93:e188a91d3eaa 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 93:e188a91d3eaa 21 * may be used to endorse or promote products derived from this software
Kojto 93:e188a91d3eaa 22 * without specific prior written permission.
Kojto 93:e188a91d3eaa 23 *
Kojto 93:e188a91d3eaa 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 93:e188a91d3eaa 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 93:e188a91d3eaa 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 93:e188a91d3eaa 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 93:e188a91d3eaa 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 93:e188a91d3eaa 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 93:e188a91d3eaa 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 93:e188a91d3eaa 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 93:e188a91d3eaa 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 93:e188a91d3eaa 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 93:e188a91d3eaa 34 *
Kojto 93:e188a91d3eaa 35 ******************************************************************************
Kojto 93:e188a91d3eaa 36 */
Kojto 93:e188a91d3eaa 37
Kojto 93:e188a91d3eaa 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 93:e188a91d3eaa 39 #ifndef __STM32F4xx_HAL_USART_H
Kojto 93:e188a91d3eaa 40 #define __STM32F4xx_HAL_USART_H
Kojto 93:e188a91d3eaa 41
Kojto 93:e188a91d3eaa 42 #ifdef __cplusplus
Kojto 93:e188a91d3eaa 43 extern "C" {
Kojto 93:e188a91d3eaa 44 #endif
Kojto 93:e188a91d3eaa 45
Kojto 93:e188a91d3eaa 46 /* Includes ------------------------------------------------------------------*/
Kojto 93:e188a91d3eaa 47 #include "stm32f4xx_hal_def.h"
Kojto 93:e188a91d3eaa 48
Kojto 93:e188a91d3eaa 49 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 93:e188a91d3eaa 50 * @{
Kojto 93:e188a91d3eaa 51 */
Kojto 93:e188a91d3eaa 52
Kojto 93:e188a91d3eaa 53 /** @addtogroup USART
Kojto 93:e188a91d3eaa 54 * @{
Kojto 93:e188a91d3eaa 55 */
Kojto 93:e188a91d3eaa 56
Kojto 93:e188a91d3eaa 57 /* Exported types ------------------------------------------------------------*/
Kojto 93:e188a91d3eaa 58 /**
Kojto 93:e188a91d3eaa 59 * @brief USART Init Structure definition
Kojto 93:e188a91d3eaa 60 */
Kojto 93:e188a91d3eaa 61 typedef struct
Kojto 93:e188a91d3eaa 62 {
Kojto 93:e188a91d3eaa 63 uint32_t BaudRate; /*!< This member configures the Usart communication baud rate.
Kojto 93:e188a91d3eaa 64 The baud rate is computed using the following formula:
Kojto 93:e188a91d3eaa 65 - IntegerDivider = ((PCLKx) / (8 * (husart->Init.BaudRate)))
Kojto 93:e188a91d3eaa 66 - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8) + 0.5 */
Kojto 93:e188a91d3eaa 67
Kojto 93:e188a91d3eaa 68 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
Kojto 93:e188a91d3eaa 69 This parameter can be a value of @ref USART_Word_Length */
Kojto 93:e188a91d3eaa 70
Kojto 93:e188a91d3eaa 71 uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
Kojto 93:e188a91d3eaa 72 This parameter can be a value of @ref USART_Stop_Bits */
Kojto 93:e188a91d3eaa 73
Kojto 93:e188a91d3eaa 74 uint32_t Parity; /*!< Specifies the parity mode.
Kojto 93:e188a91d3eaa 75 This parameter can be a value of @ref USART_Parity
Kojto 93:e188a91d3eaa 76 @note When parity is enabled, the computed parity is inserted
Kojto 93:e188a91d3eaa 77 at the MSB position of the transmitted data (9th bit when
Kojto 93:e188a91d3eaa 78 the word length is set to 9 data bits; 8th bit when the
Kojto 93:e188a91d3eaa 79 word length is set to 8 data bits). */
Kojto 93:e188a91d3eaa 80
Kojto 93:e188a91d3eaa 81 uint32_t Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.
Kojto 93:e188a91d3eaa 82 This parameter can be a value of @ref USART_Mode */
Kojto 93:e188a91d3eaa 83
Kojto 93:e188a91d3eaa 84 uint32_t CLKPolarity; /*!< Specifies the steady state of the serial clock.
Kojto 93:e188a91d3eaa 85 This parameter can be a value of @ref USART_Clock_Polarity */
Kojto 93:e188a91d3eaa 86
Kojto 93:e188a91d3eaa 87 uint32_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made.
Kojto 93:e188a91d3eaa 88 This parameter can be a value of @ref USART_Clock_Phase */
Kojto 93:e188a91d3eaa 89
Kojto 93:e188a91d3eaa 90 uint32_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted
Kojto 93:e188a91d3eaa 91 data bit (MSB) has to be output on the SCLK pin in synchronous mode.
Kojto 93:e188a91d3eaa 92 This parameter can be a value of @ref USART_Last_Bit */
Kojto 93:e188a91d3eaa 93 }USART_InitTypeDef;
Kojto 93:e188a91d3eaa 94
Kojto 93:e188a91d3eaa 95 /**
Kojto 93:e188a91d3eaa 96 * @brief HAL State structures definition
Kojto 93:e188a91d3eaa 97 */
Kojto 93:e188a91d3eaa 98 typedef enum
Kojto 93:e188a91d3eaa 99 {
Kojto 93:e188a91d3eaa 100 HAL_USART_STATE_RESET = 0x00, /*!< Peripheral is not yet Initialized */
Kojto 93:e188a91d3eaa 101 HAL_USART_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
Kojto 93:e188a91d3eaa 102 HAL_USART_STATE_BUSY = 0x02, /*!< an internal process is ongoing */
Kojto 93:e188a91d3eaa 103 HAL_USART_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
Kojto 93:e188a91d3eaa 104 HAL_USART_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
Kojto 93:e188a91d3eaa 105 HAL_USART_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission Reception process is ongoing */
Kojto 93:e188a91d3eaa 106 HAL_USART_STATE_TIMEOUT = 0x03, /*!< Timeout state */
Kojto 93:e188a91d3eaa 107 HAL_USART_STATE_ERROR = 0x04 /*!< Error */
Kojto 93:e188a91d3eaa 108 }HAL_USART_StateTypeDef;
Kojto 93:e188a91d3eaa 109
Kojto 93:e188a91d3eaa 110 /**
Kojto 93:e188a91d3eaa 111 * @brief HAL USART Error Code structure definition
Kojto 93:e188a91d3eaa 112 */
Kojto 93:e188a91d3eaa 113 typedef enum
Kojto 93:e188a91d3eaa 114 {
Kojto 93:e188a91d3eaa 115 HAL_USART_ERROR_NONE = 0x00, /*!< No error */
Kojto 93:e188a91d3eaa 116 HAL_USART_ERROR_PE = 0x01, /*!< Parity error */
Kojto 93:e188a91d3eaa 117 HAL_USART_ERROR_NE = 0x02, /*!< Noise error */
Kojto 93:e188a91d3eaa 118 HAL_USART_ERROR_FE = 0x04, /*!< frame error */
Kojto 93:e188a91d3eaa 119 HAL_USART_ERROR_ORE = 0x08, /*!< Overrun error */
Kojto 93:e188a91d3eaa 120 HAL_USART_ERROR_DMA = 0x10 /*!< DMA transfer error */
Kojto 93:e188a91d3eaa 121 }HAL_USART_ErrorTypeDef;
Kojto 93:e188a91d3eaa 122
Kojto 93:e188a91d3eaa 123 /**
Kojto 93:e188a91d3eaa 124 * @brief USART handle Structure definition
Kojto 93:e188a91d3eaa 125 */
Kojto 93:e188a91d3eaa 126 typedef struct
Kojto 93:e188a91d3eaa 127 {
Kojto 93:e188a91d3eaa 128 USART_TypeDef *Instance; /* USART registers base address */
Kojto 93:e188a91d3eaa 129
Kojto 93:e188a91d3eaa 130 USART_InitTypeDef Init; /* Usart communication parameters */
Kojto 93:e188a91d3eaa 131
Kojto 93:e188a91d3eaa 132 uint8_t *pTxBuffPtr; /* Pointer to Usart Tx transfer Buffer */
Kojto 93:e188a91d3eaa 133
Kojto 93:e188a91d3eaa 134 uint16_t TxXferSize; /* Usart Tx Transfer size */
Kojto 93:e188a91d3eaa 135
Kojto 93:e188a91d3eaa 136 __IO uint16_t TxXferCount; /* Usart Tx Transfer Counter */
Kojto 93:e188a91d3eaa 137
Kojto 93:e188a91d3eaa 138 uint8_t *pRxBuffPtr; /* Pointer to Usart Rx transfer Buffer */
Kojto 93:e188a91d3eaa 139
Kojto 93:e188a91d3eaa 140 uint16_t RxXferSize; /* Usart Rx Transfer size */
Kojto 93:e188a91d3eaa 141
Kojto 93:e188a91d3eaa 142 __IO uint16_t RxXferCount; /* Usart Rx Transfer Counter */
Kojto 93:e188a91d3eaa 143
Kojto 93:e188a91d3eaa 144 DMA_HandleTypeDef *hdmatx; /* Usart Tx DMA Handle parameters */
Kojto 93:e188a91d3eaa 145
Kojto 93:e188a91d3eaa 146 DMA_HandleTypeDef *hdmarx; /* Usart Rx DMA Handle parameters */
Kojto 93:e188a91d3eaa 147
Kojto 93:e188a91d3eaa 148 HAL_LockTypeDef Lock; /* Locking object */
Kojto 93:e188a91d3eaa 149
Kojto 93:e188a91d3eaa 150 __IO HAL_USART_StateTypeDef State; /* Usart communication state */
Kojto 93:e188a91d3eaa 151
Kojto 93:e188a91d3eaa 152 __IO HAL_USART_ErrorTypeDef ErrorCode; /* USART Error code */
Kojto 93:e188a91d3eaa 153
Kojto 93:e188a91d3eaa 154 }USART_HandleTypeDef;
Kojto 93:e188a91d3eaa 155
Kojto 93:e188a91d3eaa 156
Kojto 93:e188a91d3eaa 157 /* Exported constants --------------------------------------------------------*/
Kojto 93:e188a91d3eaa 158 /** @defgroup USART_Exported_Constants
Kojto 93:e188a91d3eaa 159 * @{
Kojto 93:e188a91d3eaa 160 */
Kojto 93:e188a91d3eaa 161
Kojto 93:e188a91d3eaa 162 /** @defgroup USART_Word_Length
Kojto 93:e188a91d3eaa 163 * @{
Kojto 93:e188a91d3eaa 164 */
Kojto 93:e188a91d3eaa 165 #define USART_WORDLENGTH_8B ((uint32_t)0x00000000)
Kojto 93:e188a91d3eaa 166 #define USART_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
Kojto 93:e188a91d3eaa 167 #define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WORDLENGTH_8B) || \
Kojto 93:e188a91d3eaa 168 ((LENGTH) == USART_WORDLENGTH_9B))
Kojto 93:e188a91d3eaa 169 /**
Kojto 93:e188a91d3eaa 170 * @}
Kojto 93:e188a91d3eaa 171 */
Kojto 93:e188a91d3eaa 172
Kojto 93:e188a91d3eaa 173 /** @defgroup USART_Stop_Bits
Kojto 93:e188a91d3eaa 174 * @{
Kojto 93:e188a91d3eaa 175 */
Kojto 93:e188a91d3eaa 176 #define USART_STOPBITS_1 ((uint32_t)0x00000000)
Kojto 93:e188a91d3eaa 177 #define USART_STOPBITS_0_5 ((uint32_t)USART_CR2_STOP_0)
Kojto 93:e188a91d3eaa 178 #define USART_STOPBITS_2 ((uint32_t)USART_CR2_STOP_1)
Kojto 93:e188a91d3eaa 179 #define USART_STOPBITS_1_5 ((uint32_t)(USART_CR2_STOP_0 | USART_CR2_STOP_1))
Kojto 93:e188a91d3eaa 180 #define IS_USART_STOPBITS(STOPBITS) (((STOPBITS) == USART_STOPBITS_1) || \
Kojto 93:e188a91d3eaa 181 ((STOPBITS) == USART_STOPBITS_0_5) || \
Kojto 93:e188a91d3eaa 182 ((STOPBITS) == USART_STOPBITS_1_5) || \
Kojto 93:e188a91d3eaa 183 ((STOPBITS) == USART_STOPBITS_2))
Kojto 93:e188a91d3eaa 184 /**
Kojto 93:e188a91d3eaa 185 * @}
Kojto 93:e188a91d3eaa 186 */
Kojto 93:e188a91d3eaa 187
Kojto 93:e188a91d3eaa 188 /** @defgroup USART_Parity
Kojto 93:e188a91d3eaa 189 * @{
Kojto 93:e188a91d3eaa 190 */
Kojto 93:e188a91d3eaa 191 #define USART_PARITY_NONE ((uint32_t)0x00000000)
Kojto 93:e188a91d3eaa 192 #define USART_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
Kojto 93:e188a91d3eaa 193 #define USART_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
Kojto 93:e188a91d3eaa 194 #define IS_USART_PARITY(PARITY) (((PARITY) == USART_PARITY_NONE) || \
Kojto 93:e188a91d3eaa 195 ((PARITY) == USART_PARITY_EVEN) || \
Kojto 93:e188a91d3eaa 196 ((PARITY) == USART_PARITY_ODD))
Kojto 93:e188a91d3eaa 197 /**
Kojto 93:e188a91d3eaa 198 * @}
Kojto 93:e188a91d3eaa 199 */
Kojto 93:e188a91d3eaa 200
Kojto 93:e188a91d3eaa 201 /** @defgroup USART_Mode
Kojto 93:e188a91d3eaa 202 * @{
Kojto 93:e188a91d3eaa 203 */
Kojto 93:e188a91d3eaa 204 #define USART_MODE_RX ((uint32_t)USART_CR1_RE)
Kojto 93:e188a91d3eaa 205 #define USART_MODE_TX ((uint32_t)USART_CR1_TE)
Kojto 93:e188a91d3eaa 206 #define USART_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
Kojto 93:e188a91d3eaa 207 #define IS_USART_MODE(MODE) ((((MODE) & (uint32_t)0xFFF3) == 0x00) && ((MODE) != (uint32_t)0x00))
Kojto 93:e188a91d3eaa 208 /**
Kojto 93:e188a91d3eaa 209 * @}
Kojto 93:e188a91d3eaa 210 */
Kojto 93:e188a91d3eaa 211
Kojto 93:e188a91d3eaa 212 /** @defgroup USART_Clock
Kojto 93:e188a91d3eaa 213 * @{
Kojto 93:e188a91d3eaa 214 */
Kojto 93:e188a91d3eaa 215 #define USART_CLOCK_DISABLED ((uint32_t)0x00000000)
Kojto 93:e188a91d3eaa 216 #define USART_CLOCK_ENABLED ((uint32_t)USART_CR2_CLKEN)
Kojto 93:e188a91d3eaa 217 #define IS_USART_CLOCK(CLOCK) (((CLOCK) == USART_CLOCK_DISABLED) || \
Kojto 93:e188a91d3eaa 218 ((CLOCK) == USART_CLOCK_ENABLED))
Kojto 93:e188a91d3eaa 219 /**
Kojto 93:e188a91d3eaa 220 * @}
Kojto 93:e188a91d3eaa 221 */
Kojto 93:e188a91d3eaa 222
Kojto 93:e188a91d3eaa 223 /** @defgroup USART_Clock_Polarity
Kojto 93:e188a91d3eaa 224 * @{
Kojto 93:e188a91d3eaa 225 */
Kojto 93:e188a91d3eaa 226 #define USART_POLARITY_LOW ((uint32_t)0x00000000)
Kojto 93:e188a91d3eaa 227 #define USART_POLARITY_HIGH ((uint32_t)USART_CR2_CPOL)
Kojto 93:e188a91d3eaa 228 #define IS_USART_POLARITY(CPOL) (((CPOL) == USART_POLARITY_LOW) || ((CPOL) == USART_POLARITY_HIGH))
Kojto 93:e188a91d3eaa 229 /**
Kojto 93:e188a91d3eaa 230 * @}
Kojto 93:e188a91d3eaa 231 */
Kojto 93:e188a91d3eaa 232
Kojto 93:e188a91d3eaa 233 /** @defgroup USART_Clock_Phase
Kojto 93:e188a91d3eaa 234 * @{
Kojto 93:e188a91d3eaa 235 */
Kojto 93:e188a91d3eaa 236 #define USART_PHASE_1EDGE ((uint32_t)0x00000000)
Kojto 93:e188a91d3eaa 237 #define USART_PHASE_2EDGE ((uint32_t)USART_CR2_CPHA)
Kojto 93:e188a91d3eaa 238 #define IS_USART_PHASE(CPHA) (((CPHA) == USART_PHASE_1EDGE) || ((CPHA) == USART_PHASE_2EDGE))
Kojto 93:e188a91d3eaa 239 /**
Kojto 93:e188a91d3eaa 240 * @}
Kojto 93:e188a91d3eaa 241 */
Kojto 93:e188a91d3eaa 242
Kojto 93:e188a91d3eaa 243 /** @defgroup USART_Last_Bit
Kojto 93:e188a91d3eaa 244 * @{
Kojto 93:e188a91d3eaa 245 */
Kojto 93:e188a91d3eaa 246 #define USART_LASTBIT_DISABLE ((uint32_t)0x00000000)
Kojto 93:e188a91d3eaa 247 #define USART_LASTBIT_ENABLE ((uint32_t)USART_CR2_LBCL)
Kojto 93:e188a91d3eaa 248 #define IS_USART_LASTBIT(LASTBIT) (((LASTBIT) == USART_LASTBIT_DISABLE) || \
Kojto 93:e188a91d3eaa 249 ((LASTBIT) == USART_LASTBIT_ENABLE))
Kojto 93:e188a91d3eaa 250 /**
Kojto 93:e188a91d3eaa 251 * @}
Kojto 93:e188a91d3eaa 252 */
Kojto 93:e188a91d3eaa 253
Kojto 93:e188a91d3eaa 254 /** @defgroup USART_NACK_State
Kojto 93:e188a91d3eaa 255 * @{
Kojto 93:e188a91d3eaa 256 */
Kojto 93:e188a91d3eaa 257 #define USARTNACK_ENABLED ((uint32_t)USART_CR3_NACK)
Kojto 93:e188a91d3eaa 258 #define USARTNACK_DISABLED ((uint32_t)0x00000000)
Kojto 93:e188a91d3eaa 259 #define IS_USART_NACK_STATE(NACK) (((NACK) == USARTNACK_ENABLED) || \
Kojto 93:e188a91d3eaa 260 ((NACK) == USARTNACK_DISABLED))
Kojto 93:e188a91d3eaa 261 /**
Kojto 93:e188a91d3eaa 262 * @}
Kojto 93:e188a91d3eaa 263 */
Kojto 93:e188a91d3eaa 264
Kojto 93:e188a91d3eaa 265 /** @defgroup USART_Flags
Kojto 93:e188a91d3eaa 266 * Elements values convention: 0xXXXX
Kojto 93:e188a91d3eaa 267 * - 0xXXXX : Flag mask in the SR register
Kojto 93:e188a91d3eaa 268 * @{
Kojto 93:e188a91d3eaa 269 */
Kojto 93:e188a91d3eaa 270
Kojto 93:e188a91d3eaa 271 #define USART_FLAG_TXE ((uint32_t)0x00000080)
Kojto 93:e188a91d3eaa 272 #define USART_FLAG_TC ((uint32_t)0x00000040)
Kojto 93:e188a91d3eaa 273 #define USART_FLAG_RXNE ((uint32_t)0x00000020)
Kojto 93:e188a91d3eaa 274 #define USART_FLAG_IDLE ((uint32_t)0x00000010)
Kojto 93:e188a91d3eaa 275 #define USART_FLAG_ORE ((uint32_t)0x00000008)
Kojto 93:e188a91d3eaa 276 #define USART_FLAG_NE ((uint32_t)0x00000004)
Kojto 93:e188a91d3eaa 277 #define USART_FLAG_FE ((uint32_t)0x00000002)
Kojto 93:e188a91d3eaa 278 #define USART_FLAG_PE ((uint32_t)0x00000001)
Kojto 93:e188a91d3eaa 279 /**
Kojto 93:e188a91d3eaa 280 * @}
Kojto 93:e188a91d3eaa 281 */
Kojto 93:e188a91d3eaa 282
Kojto 93:e188a91d3eaa 283 /** @defgroup USART_Interrupt_definition
Kojto 93:e188a91d3eaa 284 * Elements values convention: 0xY000XXXX
Kojto 93:e188a91d3eaa 285 * - XXXX : Interrupt mask in the XX register
Kojto 93:e188a91d3eaa 286 * - Y : Interrupt source register (2bits)
Kojto 93:e188a91d3eaa 287 * - 01: CR1 register
Kojto 93:e188a91d3eaa 288 * - 10: CR2 register
Kojto 93:e188a91d3eaa 289 * - 11: CR3 register
Kojto 93:e188a91d3eaa 290 *
Kojto 93:e188a91d3eaa 291 * @{
Kojto 93:e188a91d3eaa 292 */
Kojto 93:e188a91d3eaa 293 #define USART_IT_PE ((uint32_t)0x10000100)
Kojto 93:e188a91d3eaa 294 #define USART_IT_TXE ((uint32_t)0x10000080)
Kojto 93:e188a91d3eaa 295 #define USART_IT_TC ((uint32_t)0x10000040)
Kojto 93:e188a91d3eaa 296 #define USART_IT_RXNE ((uint32_t)0x10000020)
Kojto 93:e188a91d3eaa 297 #define USART_IT_IDLE ((uint32_t)0x10000010)
Kojto 93:e188a91d3eaa 298
Kojto 93:e188a91d3eaa 299 #define USART_IT_LBD ((uint32_t)0x20000040)
Kojto 93:e188a91d3eaa 300 #define USART_IT_CTS ((uint32_t)0x30000400)
Kojto 93:e188a91d3eaa 301
Kojto 93:e188a91d3eaa 302 #define USART_IT_ERR ((uint32_t)0x30000001)
Kojto 93:e188a91d3eaa 303
Kojto 93:e188a91d3eaa 304
Kojto 93:e188a91d3eaa 305 /**
Kojto 93:e188a91d3eaa 306 * @}
Kojto 93:e188a91d3eaa 307 */
Kojto 93:e188a91d3eaa 308
Kojto 93:e188a91d3eaa 309 /**
Kojto 93:e188a91d3eaa 310 * @}
Kojto 93:e188a91d3eaa 311 */
Kojto 93:e188a91d3eaa 312
Kojto 93:e188a91d3eaa 313 /* Exported macro ------------------------------------------------------------*/
Kojto 93:e188a91d3eaa 314 /** @brief Reset USART handle state
Kojto 93:e188a91d3eaa 315 * @param __HANDLE__: specifies the USART Handle.
Kojto 93:e188a91d3eaa 316 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Kojto 93:e188a91d3eaa 317 * @retval None
Kojto 93:e188a91d3eaa 318 */
Kojto 93:e188a91d3eaa 319 #define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_USART_STATE_RESET)
Kojto 93:e188a91d3eaa 320
Kojto 93:e188a91d3eaa 321 /** @brief Checks whether the specified Smartcard flag is set or not.
Kojto 93:e188a91d3eaa 322 * @param __HANDLE__: specifies the USART Handle.
Kojto 93:e188a91d3eaa 323 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Kojto 93:e188a91d3eaa 324 * @param __FLAG__: specifies the flag to check.
Kojto 93:e188a91d3eaa 325 * This parameter can be one of the following values:
Kojto 93:e188a91d3eaa 326 * @arg USART_FLAG_TXE: Transmit data register empty flag
Kojto 93:e188a91d3eaa 327 * @arg USART_FLAG_TC: Transmission Complete flag
Kojto 93:e188a91d3eaa 328 * @arg USART_FLAG_RXNE: Receive data register not empty flag
Kojto 93:e188a91d3eaa 329 * @arg USART_FLAG_IDLE: Idle Line detection flag
Kojto 93:e188a91d3eaa 330 * @arg USART_FLAG_ORE: OverRun Error flag
Kojto 93:e188a91d3eaa 331 * @arg USART_FLAG_NE: Noise Error flag
Kojto 93:e188a91d3eaa 332 * @arg USART_FLAG_FE: Framing Error flag
Kojto 93:e188a91d3eaa 333 * @arg USART_FLAG_PE: Parity Error flag
Kojto 93:e188a91d3eaa 334 * @retval The new state of __FLAG__ (TRUE or FALSE).
Kojto 93:e188a91d3eaa 335 */
Kojto 93:e188a91d3eaa 336
Kojto 93:e188a91d3eaa 337 #define __HAL_USART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
Kojto 93:e188a91d3eaa 338
Kojto 93:e188a91d3eaa 339 /** @brief Clears the specified Smartcard pending flags.
Kojto 93:e188a91d3eaa 340 * @param __HANDLE__: specifies the USART Handle.
Kojto 93:e188a91d3eaa 341 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Kojto 93:e188a91d3eaa 342 * @param __FLAG__: specifies the flag to check.
Kojto 93:e188a91d3eaa 343 * This parameter can be any combination of the following values:
Kojto 93:e188a91d3eaa 344 * @arg USART_FLAG_TC: Transmission Complete flag.
Kojto 93:e188a91d3eaa 345 * @arg USART_FLAG_RXNE: Receive data register not empty flag.
Kojto 93:e188a91d3eaa 346 *
Kojto 93:e188a91d3eaa 347 * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (OverRun
Kojto 93:e188a91d3eaa 348 * error) and IDLE (Idle line detected) flags are cleared by software
Kojto 93:e188a91d3eaa 349 * sequence: a read operation to USART_SR register followed by a read
Kojto 93:e188a91d3eaa 350 * operation to USART_DR register.
Kojto 93:e188a91d3eaa 351 * @note RXNE flag can be also cleared by a read to the USART_DR register.
Kojto 93:e188a91d3eaa 352 * @note TC flag can be also cleared by software sequence: a read operation to
Kojto 93:e188a91d3eaa 353 * USART_SR register followed by a write operation to USART_DR register.
Kojto 93:e188a91d3eaa 354 * @note TXE flag is cleared only by a write to the USART_DR register.
Kojto 93:e188a91d3eaa 355 *
Kojto 93:e188a91d3eaa 356 * @retval None
Kojto 93:e188a91d3eaa 357 */
Kojto 93:e188a91d3eaa 358 #define __HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
Kojto 93:e188a91d3eaa 359
Kojto 93:e188a91d3eaa 360 /** @brief Clear the USART PE pending flag.
Kojto 93:e188a91d3eaa 361 * @param __HANDLE__: specifies the USART Handle.
Kojto 93:e188a91d3eaa 362 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Kojto 93:e188a91d3eaa 363 * @retval None
Kojto 93:e188a91d3eaa 364 */
Kojto 93:e188a91d3eaa 365 #define __HAL_USART_CLEAR_PEFLAG(__HANDLE__) do{(__HANDLE__)->Instance->SR;\
Kojto 93:e188a91d3eaa 366 (__HANDLE__)->Instance->DR;}while(0)
Kojto 93:e188a91d3eaa 367 /** @brief Clear the USART FE pending flag.
Kojto 93:e188a91d3eaa 368 * @param __HANDLE__: specifies the USART Handle.
Kojto 93:e188a91d3eaa 369 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Kojto 93:e188a91d3eaa 370 * @retval None
Kojto 93:e188a91d3eaa 371 */
Kojto 93:e188a91d3eaa 372 #define __HAL_USART_CLEAR_FEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
Kojto 93:e188a91d3eaa 373
Kojto 93:e188a91d3eaa 374 /** @brief Clear the USART NE pending flag.
Kojto 93:e188a91d3eaa 375 * @param __HANDLE__: specifies the USART Handle.
Kojto 93:e188a91d3eaa 376 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Kojto 93:e188a91d3eaa 377 * @retval None
Kojto 93:e188a91d3eaa 378 */
Kojto 93:e188a91d3eaa 379 #define __HAL_USART_CLEAR_NEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
Kojto 93:e188a91d3eaa 380
Kojto 93:e188a91d3eaa 381 /** @brief Clear the UART ORE pending flag.
Kojto 93:e188a91d3eaa 382 * @param __HANDLE__: specifies the USART Handle.
Kojto 93:e188a91d3eaa 383 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Kojto 93:e188a91d3eaa 384 * @retval None
Kojto 93:e188a91d3eaa 385 */
Kojto 93:e188a91d3eaa 386 #define __HAL_USART_CLEAR_OREFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
Kojto 93:e188a91d3eaa 387
Kojto 93:e188a91d3eaa 388 /** @brief Clear the USART IDLE pending flag.
Kojto 93:e188a91d3eaa 389 * @param __HANDLE__: specifies the USART Handle.
Kojto 93:e188a91d3eaa 390 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Kojto 93:e188a91d3eaa 391 * @retval None
Kojto 93:e188a91d3eaa 392 */
Kojto 93:e188a91d3eaa 393 #define __HAL_USART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_USART_CLEAR_PEFLAG(__HANDLE__)
Kojto 93:e188a91d3eaa 394
Kojto 93:e188a91d3eaa 395 /** @brief Enables or disables the specified Usart interrupts.
Kojto 93:e188a91d3eaa 396 * @param __HANDLE__: specifies the USART Handle.
Kojto 93:e188a91d3eaa 397 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Kojto 93:e188a91d3eaa 398 * @param __INTERRUPT__: specifies the USART interrupt source to check.
Kojto 93:e188a91d3eaa 399 * This parameter can be one of the following values:
Kojto 93:e188a91d3eaa 400 * @arg USART_IT_TXE: Transmit Data Register empty interrupt
Kojto 93:e188a91d3eaa 401 * @arg USART_IT_TC: Transmission complete interrupt
Kojto 93:e188a91d3eaa 402 * @arg USART_IT_RXNE: Receive Data register not empty interrupt
Kojto 93:e188a91d3eaa 403 * @arg USART_IT_IDLE: Idle line detection interrupt
Kojto 93:e188a91d3eaa 404 * @arg USART_IT_PE: Parity Error interrupt
Kojto 93:e188a91d3eaa 405 * @arg USART_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
Kojto 93:e188a91d3eaa 406 * @param NewState: new state of the specified Usart interrupt.
Kojto 93:e188a91d3eaa 407 * This parameter can be: ENABLE or DISABLE.
Kojto 93:e188a91d3eaa 408 * @retval None
Kojto 93:e188a91d3eaa 409 */
Kojto 93:e188a91d3eaa 410 #define USART_IT_MASK ((uint32_t)0x0000FFFF)
Kojto 93:e188a91d3eaa 411 #define __USART_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & USART_IT_MASK)): \
Kojto 93:e188a91d3eaa 412 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & USART_IT_MASK)): \
Kojto 93:e188a91d3eaa 413 ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & USART_IT_MASK)))
Kojto 93:e188a91d3eaa 414 #define __USART_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
Kojto 93:e188a91d3eaa 415 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & USART_IT_MASK)): \
Kojto 93:e188a91d3eaa 416 ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & USART_IT_MASK)))
Kojto 93:e188a91d3eaa 417
Kojto 93:e188a91d3eaa 418
Kojto 93:e188a91d3eaa 419 /** @brief Checks whether the specified Usart interrupt has occurred or not.
Kojto 93:e188a91d3eaa 420 * @param __HANDLE__: specifies the USART Handle.
Kojto 93:e188a91d3eaa 421 * This parameter can be USARTx where x: 1, 2, 3 or 6 to select the USART peripheral.
Kojto 93:e188a91d3eaa 422 * @param __IT__: specifies the USART interrupt source to check.
Kojto 93:e188a91d3eaa 423 * This parameter can be one of the following values:
Kojto 93:e188a91d3eaa 424 * @arg USART_IT_TXE: Transmit Data Register empty interrupt
Kojto 93:e188a91d3eaa 425 * @arg USART_IT_TC: Transmission complete interrupt
Kojto 93:e188a91d3eaa 426 * @arg USART_IT_RXNE: Receive Data register not empty interrupt
Kojto 93:e188a91d3eaa 427 * @arg USART_IT_IDLE: Idle line detection interrupt
Kojto 93:e188a91d3eaa 428 * @arg USART_IT_ERR: Error interrupt
Kojto 93:e188a91d3eaa 429 * @arg USART_IT_PE: Parity Error interrupt
Kojto 93:e188a91d3eaa 430 * @retval The new state of __IT__ (TRUE or FALSE).
Kojto 93:e188a91d3eaa 431 */
Kojto 93:e188a91d3eaa 432 #define __HAL_USART_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28) == 1)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28) == 2)? \
Kojto 93:e188a91d3eaa 433 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & USART_IT_MASK))
Kojto 93:e188a91d3eaa 434
Kojto 93:e188a91d3eaa 435 #define __USART_ENABLE(__HANDLE__) ( (__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
Kojto 93:e188a91d3eaa 436 #define __USART_DISABLE(__HANDLE__) ( (__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
Kojto 93:e188a91d3eaa 437
Kojto 93:e188a91d3eaa 438 #define __DIV(_PCLK_, _BAUD_) (((_PCLK_)*25)/(4*(_BAUD_)))
Kojto 93:e188a91d3eaa 439 #define __DIVMANT(_PCLK_, _BAUD_) (__DIV((_PCLK_), (_BAUD_))/100)
Kojto 93:e188a91d3eaa 440 #define __DIVFRAQ(_PCLK_, _BAUD_) (((__DIV((_PCLK_), (_BAUD_)) - (__DIVMANT((_PCLK_), (_BAUD_)) * 100)) * 16 + 50) / 100)
Kojto 93:e188a91d3eaa 441 #define __USART_BRR(_PCLK_, _BAUD_) ((__DIVMANT((_PCLK_), (_BAUD_)) << 4)|(__DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0F))
Kojto 93:e188a91d3eaa 442
Kojto 93:e188a91d3eaa 443 #define IS_USART_BAUDRATE(BAUDRATE) ((BAUDRATE) < 10500001)
Kojto 93:e188a91d3eaa 444
Kojto 93:e188a91d3eaa 445 /* Exported functions --------------------------------------------------------*/
Kojto 93:e188a91d3eaa 446 /* Initialization/de-initialization functions **********************************/
Kojto 93:e188a91d3eaa 447 HAL_StatusTypeDef HAL_USART_Init(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 448 HAL_StatusTypeDef HAL_USART_DeInit(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 449 void HAL_USART_MspInit(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 450 void HAL_USART_MspDeInit(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 451 /* IO operation functions *******************************************************/
Kojto 93:e188a91d3eaa 452 HAL_StatusTypeDef HAL_USART_Transmit(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size, uint32_t Timeout);
Kojto 93:e188a91d3eaa 453 HAL_StatusTypeDef HAL_USART_Receive(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
Kojto 93:e188a91d3eaa 454 HAL_StatusTypeDef HAL_USART_TransmitReceive(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
Kojto 93:e188a91d3eaa 455 HAL_StatusTypeDef HAL_USART_Transmit_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
Kojto 93:e188a91d3eaa 456 HAL_StatusTypeDef HAL_USART_Receive_IT(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
Kojto 93:e188a91d3eaa 457 HAL_StatusTypeDef HAL_USART_TransmitReceive_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
Kojto 93:e188a91d3eaa 458 HAL_StatusTypeDef HAL_USART_Transmit_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
Kojto 93:e188a91d3eaa 459 HAL_StatusTypeDef HAL_USART_Receive_DMA(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
Kojto 93:e188a91d3eaa 460 HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
Kojto 93:e188a91d3eaa 461 HAL_StatusTypeDef HAL_USART_DMAPause(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 462 HAL_StatusTypeDef HAL_USART_DMAResume(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 463 HAL_StatusTypeDef HAL_USART_DMAStop(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 464 void HAL_USART_IRQHandler(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 465 void HAL_USART_TxCpltCallback(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 466 void HAL_USART_TxHalfCpltCallback(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 467 void HAL_USART_RxCpltCallback(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 468 void HAL_USART_RxHalfCpltCallback(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 469 void HAL_USART_TxRxCpltCallback(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 470 void HAL_USART_ErrorCallback(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 471
Kojto 93:e188a91d3eaa 472 /* Peripheral State functions **************************************************/
Kojto 93:e188a91d3eaa 473 HAL_USART_StateTypeDef HAL_USART_GetState(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 474 uint32_t HAL_USART_GetError(USART_HandleTypeDef *husart);
Kojto 93:e188a91d3eaa 475
Kojto 93:e188a91d3eaa 476 /**
Kojto 93:e188a91d3eaa 477 * @}
Kojto 93:e188a91d3eaa 478 */
Kojto 93:e188a91d3eaa 479
Kojto 93:e188a91d3eaa 480 /**
Kojto 93:e188a91d3eaa 481 * @}
Kojto 93:e188a91d3eaa 482 */
Kojto 93:e188a91d3eaa 483
Kojto 93:e188a91d3eaa 484 #ifdef __cplusplus
Kojto 93:e188a91d3eaa 485 }
Kojto 93:e188a91d3eaa 486 #endif
Kojto 93:e188a91d3eaa 487
Kojto 93:e188a91d3eaa 488 #endif /* __STM32F4xx_HAL_USART_H */
Kojto 93:e188a91d3eaa 489
Kojto 93:e188a91d3eaa 490 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/