2 ******************************************************************************
3 * @file stm32f4xx_usart.h
4 * @author MCD Application Team
7 * @brief This file contains all the functions prototypes for the USART
9 ******************************************************************************
12 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
13 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
14 * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
15 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
16 * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
17 * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
19 * <h2><center>© COPYRIGHT 2011 STMicroelectronics</center></h2>
20 ******************************************************************************
23 /* Define to prevent recursive inclusion -------------------------------------*/
24 #ifndef __STM32F4xx_USART_H
25 #define __STM32F4xx_USART_H
31 /* Includes ------------------------------------------------------------------*/
32 #include "stm32f4xx.h"
34 /** @addtogroup STM32F4xx_StdPeriph_Driver
42 /* Exported types ------------------------------------------------------------*/
45 * @brief USART Init Structure definition
50 uint32_t USART_BaudRate; /*!< This member configures the USART communication baud rate.
51 The baud rate is computed using the following formula:
52 - IntegerDivider = ((PCLKx) / (8 * (OVR8+1) * (USART_InitStruct->USART_BaudRate)))
53 - FractionalDivider = ((IntegerDivider - ((u32) IntegerDivider)) * 8 * (OVR8+1)) + 0.5
54 Where OVR8 is the "oversampling by 8 mode" configuration bit in the CR1 register. */
56 uint16_t USART_WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
57 This parameter can be a value of @ref USART_Word_Length */
59 uint16_t USART_StopBits; /*!< Specifies the number of stop bits transmitted.
60 This parameter can be a value of @ref USART_Stop_Bits */
62 uint16_t USART_Parity; /*!< Specifies the parity mode.
63 This parameter can be a value of @ref USART_Parity
64 @note When parity is enabled, the computed parity is inserted
65 at the MSB position of the transmitted data (9th bit when
66 the word length is set to 9 data bits; 8th bit when the
67 word length is set to 8 data bits). */
69 uint16_t USART_Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.
70 This parameter can be a value of @ref USART_Mode */
72 uint16_t USART_HardwareFlowControl; /*!< Specifies wether the hardware flow control mode is enabled
74 This parameter can be a value of @ref USART_Hardware_Flow_Control */
78 * @brief USART Clock Init Structure definition
84 uint16_t USART_Clock; /*!< Specifies whether the USART clock is enabled or disabled.
85 This parameter can be a value of @ref USART_Clock */
87 uint16_t USART_CPOL; /*!< Specifies the steady state of the serial clock.
88 This parameter can be a value of @ref USART_Clock_Polarity */
90 uint16_t USART_CPHA; /*!< Specifies the clock transition on which the bit capture is made.
91 This parameter can be a value of @ref USART_Clock_Phase */
93 uint16_t USART_LastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted
94 data bit (MSB) has to be output on the SCLK pin in synchronous mode.
95 This parameter can be a value of @ref USART_Last_Bit */
96 } USART_ClockInitTypeDef;
98 /* Exported constants --------------------------------------------------------*/
100 /** @defgroup USART_Exported_Constants
104 #define IS_USART_ALL_PERIPH(PERIPH) (((PERIPH) == USART1) || \
105 ((PERIPH) == USART2) || \
106 ((PERIPH) == USART3) || \
107 ((PERIPH) == UART4) || \
108 ((PERIPH) == UART5) || \
109 ((PERIPH) == USART6))
111 #define IS_USART_1236_PERIPH(PERIPH) (((PERIPH) == USART1) || \
112 ((PERIPH) == USART2) || \
113 ((PERIPH) == USART3) || \
114 ((PERIPH) == USART6))
116 /** @defgroup USART_Word_Length
120 #define USART_WordLength_8b ((uint16_t)0x0000)
121 #define USART_WordLength_9b ((uint16_t)0x1000)
123 #define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WordLength_8b) || \
124 ((LENGTH) == USART_WordLength_9b))
129 /** @defgroup USART_Stop_Bits
133 #define USART_StopBits_1 ((uint16_t)0x0000)
134 #define USART_StopBits_0_5 ((uint16_t)0x1000)
135 #define USART_StopBits_2 ((uint16_t)0x2000)
136 #define USART_StopBits_1_5 ((uint16_t)0x3000)
137 #define IS_USART_STOPBITS(STOPBITS) (((STOPBITS) == USART_StopBits_1) || \
138 ((STOPBITS) == USART_StopBits_0_5) || \
139 ((STOPBITS) == USART_StopBits_2) || \
140 ((STOPBITS) == USART_StopBits_1_5))
145 /** @defgroup USART_Parity
149 #define USART_Parity_No ((uint16_t)0x0000)
150 #define USART_Parity_Even ((uint16_t)0x0400)
151 #define USART_Parity_Odd ((uint16_t)0x0600)
152 #define IS_USART_PARITY(PARITY) (((PARITY) == USART_Parity_No) || \
153 ((PARITY) == USART_Parity_Even) || \
154 ((PARITY) == USART_Parity_Odd))
159 /** @defgroup USART_Mode
163 #define USART_Mode_Rx ((uint16_t)0x0004)
164 #define USART_Mode_Tx ((uint16_t)0x0008)
165 #define IS_USART_MODE(MODE) ((((MODE) & (uint16_t)0xFFF3) == 0x00) && ((MODE) != (uint16_t)0x00))
170 /** @defgroup USART_Hardware_Flow_Control
173 #define USART_HardwareFlowControl_None ((uint16_t)0x0000)
174 #define USART_HardwareFlowControl_RTS ((uint16_t)0x0100)
175 #define USART_HardwareFlowControl_CTS ((uint16_t)0x0200)
176 #define USART_HardwareFlowControl_RTS_CTS ((uint16_t)0x0300)
177 #define IS_USART_HARDWARE_FLOW_CONTROL(CONTROL)\
178 (((CONTROL) == USART_HardwareFlowControl_None) || \
179 ((CONTROL) == USART_HardwareFlowControl_RTS) || \
180 ((CONTROL) == USART_HardwareFlowControl_CTS) || \
181 ((CONTROL) == USART_HardwareFlowControl_RTS_CTS))
186 /** @defgroup USART_Clock
189 #define USART_Clock_Disable ((uint16_t)0x0000)
190 #define USART_Clock_Enable ((uint16_t)0x0800)
191 #define IS_USART_CLOCK(CLOCK) (((CLOCK) == USART_Clock_Disable) || \
192 ((CLOCK) == USART_Clock_Enable))
197 /** @defgroup USART_Clock_Polarity
201 #define USART_CPOL_Low ((uint16_t)0x0000)
202 #define USART_CPOL_High ((uint16_t)0x0400)
203 #define IS_USART_CPOL(CPOL) (((CPOL) == USART_CPOL_Low) || ((CPOL) == USART_CPOL_High))
209 /** @defgroup USART_Clock_Phase
213 #define USART_CPHA_1Edge ((uint16_t)0x0000)
214 #define USART_CPHA_2Edge ((uint16_t)0x0200)
215 #define IS_USART_CPHA(CPHA) (((CPHA) == USART_CPHA_1Edge) || ((CPHA) == USART_CPHA_2Edge))
221 /** @defgroup USART_Last_Bit
225 #define USART_LastBit_Disable ((uint16_t)0x0000)
226 #define USART_LastBit_Enable ((uint16_t)0x0100)
227 #define IS_USART_LASTBIT(LASTBIT) (((LASTBIT) == USART_LastBit_Disable) || \
228 ((LASTBIT) == USART_LastBit_Enable))
233 /** @defgroup USART_Interrupt_definition
237 #define USART_IT_PE ((uint16_t)0x0028)
238 #define USART_IT_TXE ((uint16_t)0x0727)
239 #define USART_IT_TC ((uint16_t)0x0626)
240 #define USART_IT_RXNE ((uint16_t)0x0525)
241 #define USART_IT_IDLE ((uint16_t)0x0424)
242 #define USART_IT_LBD ((uint16_t)0x0846)
243 #define USART_IT_CTS ((uint16_t)0x096A)
244 #define USART_IT_ERR ((uint16_t)0x0060)
245 #define USART_IT_ORE ((uint16_t)0x0360)
246 #define USART_IT_NE ((uint16_t)0x0260)
247 #define USART_IT_FE ((uint16_t)0x0160)
248 #define IS_USART_CONFIG_IT(IT) (((IT) == USART_IT_PE) || ((IT) == USART_IT_TXE) || \
249 ((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || \
250 ((IT) == USART_IT_IDLE) || ((IT) == USART_IT_LBD) || \
251 ((IT) == USART_IT_CTS) || ((IT) == USART_IT_ERR))
252 #define IS_USART_GET_IT(IT) (((IT) == USART_IT_PE) || ((IT) == USART_IT_TXE) || \
253 ((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || \
254 ((IT) == USART_IT_IDLE) || ((IT) == USART_IT_LBD) || \
255 ((IT) == USART_IT_CTS) || ((IT) == USART_IT_ORE) || \
256 ((IT) == USART_IT_NE) || ((IT) == USART_IT_FE))
257 #define IS_USART_CLEAR_IT(IT) (((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || \
258 ((IT) == USART_IT_LBD) || ((IT) == USART_IT_CTS))
263 /** @defgroup USART_DMA_Requests
267 #define USART_DMAReq_Tx ((uint16_t)0x0080)
268 #define USART_DMAReq_Rx ((uint16_t)0x0040)
269 #define IS_USART_DMAREQ(DMAREQ) ((((DMAREQ) & (uint16_t)0xFF3F) == 0x00) && ((DMAREQ) != (uint16_t)0x00))
275 /** @defgroup USART_WakeUp_methods
279 #define USART_WakeUp_IdleLine ((uint16_t)0x0000)
280 #define USART_WakeUp_AddressMark ((uint16_t)0x0800)
281 #define IS_USART_WAKEUP(WAKEUP) (((WAKEUP) == USART_WakeUp_IdleLine) || \
282 ((WAKEUP) == USART_WakeUp_AddressMark))
287 /** @defgroup USART_LIN_Break_Detection_Length
291 #define USART_LINBreakDetectLength_10b ((uint16_t)0x0000)
292 #define USART_LINBreakDetectLength_11b ((uint16_t)0x0020)
293 #define IS_USART_LIN_BREAK_DETECT_LENGTH(LENGTH) \
294 (((LENGTH) == USART_LINBreakDetectLength_10b) || \
295 ((LENGTH) == USART_LINBreakDetectLength_11b))
300 /** @defgroup USART_IrDA_Low_Power
304 #define USART_IrDAMode_LowPower ((uint16_t)0x0004)
305 #define USART_IrDAMode_Normal ((uint16_t)0x0000)
306 #define IS_USART_IRDA_MODE(MODE) (((MODE) == USART_IrDAMode_LowPower) || \
307 ((MODE) == USART_IrDAMode_Normal))
312 /** @defgroup USART_Flags
316 #define USART_FLAG_CTS ((uint16_t)0x0200)
317 #define USART_FLAG_LBD ((uint16_t)0x0100)
318 #define USART_FLAG_TXE ((uint16_t)0x0080)
319 #define USART_FLAG_TC ((uint16_t)0x0040)
320 #define USART_FLAG_RXNE ((uint16_t)0x0020)
321 #define USART_FLAG_IDLE ((uint16_t)0x0010)
322 #define USART_FLAG_ORE ((uint16_t)0x0008)
323 #define USART_FLAG_NE ((uint16_t)0x0004)
324 #define USART_FLAG_FE ((uint16_t)0x0002)
325 #define USART_FLAG_PE ((uint16_t)0x0001)
326 #define IS_USART_FLAG(FLAG) (((FLAG) == USART_FLAG_PE) || ((FLAG) == USART_FLAG_TXE) || \
327 ((FLAG) == USART_FLAG_TC) || ((FLAG) == USART_FLAG_RXNE) || \
328 ((FLAG) == USART_FLAG_IDLE) || ((FLAG) == USART_FLAG_LBD) || \
329 ((FLAG) == USART_FLAG_CTS) || ((FLAG) == USART_FLAG_ORE) || \
330 ((FLAG) == USART_FLAG_NE) || ((FLAG) == USART_FLAG_FE))
332 #define IS_USART_CLEAR_FLAG(FLAG) ((((FLAG) & (uint16_t)0xFC9F) == 0x00) && ((FLAG) != (uint16_t)0x00))
334 #define IS_USART_BAUDRATE(BAUDRATE) (((BAUDRATE) > 0) && ((BAUDRATE) < 7500001))
335 #define IS_USART_ADDRESS(ADDRESS) ((ADDRESS) <= 0xF)
336 #define IS_USART_DATA(DATA) ((DATA) <= 0x1FF)
346 /* Exported macro ------------------------------------------------------------*/
347 /* Exported functions --------------------------------------------------------*/
349 /* Function used to set the USART configuration to the default reset state ***/
350 void USART_DeInit(USART_TypeDef* USARTx);
352 /* Initialization and Configuration functions *********************************/
353 void USART_Init(USART_TypeDef* USARTx, USART_InitTypeDef* USART_InitStruct);
354 void USART_StructInit(USART_InitTypeDef* USART_InitStruct);
355 void USART_ClockInit(USART_TypeDef* USARTx, USART_ClockInitTypeDef* USART_ClockInitStruct);
356 void USART_ClockStructInit(USART_ClockInitTypeDef* USART_ClockInitStruct);
357 void USART_Cmd(USART_TypeDef* USARTx, FunctionalState NewState);
358 void USART_SetPrescaler(USART_TypeDef* USARTx, uint8_t USART_Prescaler);
359 void USART_OverSampling8Cmd(USART_TypeDef* USARTx, FunctionalState NewState);
360 void USART_OneBitMethodCmd(USART_TypeDef* USARTx, FunctionalState NewState);
362 /* Data transfers functions ***************************************************/
363 void USART_SendData(USART_TypeDef* USARTx, uint16_t Data);
364 uint16_t USART_ReceiveData(USART_TypeDef* USARTx);
366 /* Multi-Processor Communication functions ************************************/
367 void USART_SetAddress(USART_TypeDef* USARTx, uint8_t USART_Address);
368 void USART_WakeUpConfig(USART_TypeDef* USARTx, uint16_t USART_WakeUp);
369 void USART_ReceiverWakeUpCmd(USART_TypeDef* USARTx, FunctionalState NewState);
371 /* LIN mode functions *********************************************************/
372 void USART_LINBreakDetectLengthConfig(USART_TypeDef* USARTx, uint16_t USART_LINBreakDetectLength);
373 void USART_LINCmd(USART_TypeDef* USARTx, FunctionalState NewState);
374 void USART_SendBreak(USART_TypeDef* USARTx);
376 /* Half-duplex mode function **************************************************/
377 void USART_HalfDuplexCmd(USART_TypeDef* USARTx, FunctionalState NewState);
379 /* Smartcard mode functions ***************************************************/
380 void USART_SmartCardCmd(USART_TypeDef* USARTx, FunctionalState NewState);
381 void USART_SmartCardNACKCmd(USART_TypeDef* USARTx, FunctionalState NewState);
382 void USART_SetGuardTime(USART_TypeDef* USARTx, uint8_t USART_GuardTime);
384 /* IrDA mode functions ********************************************************/
385 void USART_IrDAConfig(USART_TypeDef* USARTx, uint16_t USART_IrDAMode);
386 void USART_IrDACmd(USART_TypeDef* USARTx, FunctionalState NewState);
388 /* DMA transfers management functions *****************************************/
389 void USART_DMACmd(USART_TypeDef* USARTx, uint16_t USART_DMAReq, FunctionalState NewState);
391 /* Interrupts and flags management functions **********************************/
392 void USART_ITConfig(USART_TypeDef* USARTx, uint16_t USART_IT, FunctionalState NewState);
393 FlagStatus USART_GetFlagStatus(USART_TypeDef* USARTx, uint16_t USART_FLAG);
394 void USART_ClearFlag(USART_TypeDef* USARTx, uint16_t USART_FLAG);
395 ITStatus USART_GetITStatus(USART_TypeDef* USARTx, uint16_t USART_IT);
396 void USART_ClearITPendingBit(USART_TypeDef* USARTx, uint16_t USART_IT);
402 #endif /* __STM32F4xx_USART_H */
412 /******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/