STM32F4 Standard Peripheral bibliotheek  1.0
ST Microelectronics bibliotheek documentatie voor de STM32F4 Standard Peripheral Library
 All Data Structures Files Functions Variables Enumerations Enumerator Groups
stm32f4xx_usart.h
Go to the documentation of this file.
1 
29 /* Define to prevent recursive inclusion -------------------------------------*/
30 #ifndef __STM32F4xx_USART_H
31 #define __STM32F4xx_USART_H
32 
33 #ifdef __cplusplus
34  extern "C" {
35 #endif
36 
37 /* Includes ------------------------------------------------------------------*/
38 #include "stm32f4xx.h"
39 
48 /* Exported types ------------------------------------------------------------*/
49 
54 typedef struct
55 {
56  uint32_t USART_BaudRate;
62  uint16_t USART_WordLength;
65  uint16_t USART_StopBits;
68  uint16_t USART_Parity;
75  uint16_t USART_Mode;
78  uint16_t USART_HardwareFlowControl;
81 } USART_InitTypeDef;
82 
87 typedef struct
88 {
89 
90  uint16_t USART_Clock;
93  uint16_t USART_CPOL;
96  uint16_t USART_CPHA;
99  uint16_t USART_LastBit;
102 } USART_ClockInitTypeDef;
103 
104 /* Exported constants --------------------------------------------------------*/
105 
110 #define IS_USART_ALL_PERIPH(PERIPH) (((PERIPH) == USART1) || \
111  ((PERIPH) == USART2) || \
112  ((PERIPH) == USART3) || \
113  ((PERIPH) == UART4) || \
114  ((PERIPH) == UART5) || \
115  ((PERIPH) == USART6))
116 
117 #define IS_USART_1236_PERIPH(PERIPH) (((PERIPH) == USART1) || \
118  ((PERIPH) == USART2) || \
119  ((PERIPH) == USART3) || \
120  ((PERIPH) == USART6))
121 
126 #define USART_WordLength_8b ((uint16_t)0x0000)
127 #define USART_WordLength_9b ((uint16_t)0x1000)
128 
129 #define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WordLength_8b) || \
130  ((LENGTH) == USART_WordLength_9b))
131 
139 #define USART_StopBits_1 ((uint16_t)0x0000)
140 #define USART_StopBits_0_5 ((uint16_t)0x1000)
141 #define USART_StopBits_2 ((uint16_t)0x2000)
142 #define USART_StopBits_1_5 ((uint16_t)0x3000)
143 #define IS_USART_STOPBITS(STOPBITS) (((STOPBITS) == USART_StopBits_1) || \
144  ((STOPBITS) == USART_StopBits_0_5) || \
145  ((STOPBITS) == USART_StopBits_2) || \
146  ((STOPBITS) == USART_StopBits_1_5))
147 
155 #define USART_Parity_No ((uint16_t)0x0000)
156 #define USART_Parity_Even ((uint16_t)0x0400)
157 #define USART_Parity_Odd ((uint16_t)0x0600)
158 #define IS_USART_PARITY(PARITY) (((PARITY) == USART_Parity_No) || \
159  ((PARITY) == USART_Parity_Even) || \
160  ((PARITY) == USART_Parity_Odd))
161 
169 #define USART_Mode_Rx ((uint16_t)0x0004)
170 #define USART_Mode_Tx ((uint16_t)0x0008)
171 #define IS_USART_MODE(MODE) ((((MODE) & (uint16_t)0xFFF3) == 0x00) && ((MODE) != (uint16_t)0x00))
172 
179 #define USART_HardwareFlowControl_None ((uint16_t)0x0000)
180 #define USART_HardwareFlowControl_RTS ((uint16_t)0x0100)
181 #define USART_HardwareFlowControl_CTS ((uint16_t)0x0200)
182 #define USART_HardwareFlowControl_RTS_CTS ((uint16_t)0x0300)
183 #define IS_USART_HARDWARE_FLOW_CONTROL(CONTROL)\
184  (((CONTROL) == USART_HardwareFlowControl_None) || \
185  ((CONTROL) == USART_HardwareFlowControl_RTS) || \
186  ((CONTROL) == USART_HardwareFlowControl_CTS) || \
187  ((CONTROL) == USART_HardwareFlowControl_RTS_CTS))
188 
195 #define USART_Clock_Disable ((uint16_t)0x0000)
196 #define USART_Clock_Enable ((uint16_t)0x0800)
197 #define IS_USART_CLOCK(CLOCK) (((CLOCK) == USART_Clock_Disable) || \
198  ((CLOCK) == USART_Clock_Enable))
199 
207 #define USART_CPOL_Low ((uint16_t)0x0000)
208 #define USART_CPOL_High ((uint16_t)0x0400)
209 #define IS_USART_CPOL(CPOL) (((CPOL) == USART_CPOL_Low) || ((CPOL) == USART_CPOL_High))
210 
219 #define USART_CPHA_1Edge ((uint16_t)0x0000)
220 #define USART_CPHA_2Edge ((uint16_t)0x0200)
221 #define IS_USART_CPHA(CPHA) (((CPHA) == USART_CPHA_1Edge) || ((CPHA) == USART_CPHA_2Edge))
222 
231 #define USART_LastBit_Disable ((uint16_t)0x0000)
232 #define USART_LastBit_Enable ((uint16_t)0x0100)
233 #define IS_USART_LASTBIT(LASTBIT) (((LASTBIT) == USART_LastBit_Disable) || \
234  ((LASTBIT) == USART_LastBit_Enable))
235 
243 #define USART_IT_PE ((uint16_t)0x0028)
244 #define USART_IT_TXE ((uint16_t)0x0727)
245 #define USART_IT_TC ((uint16_t)0x0626)
246 #define USART_IT_RXNE ((uint16_t)0x0525)
247 #define USART_IT_ORE_RX ((uint16_t)0x0325) /* In case interrupt is generated if the RXNEIE bit is set */
248 #define USART_IT_IDLE ((uint16_t)0x0424)
249 #define USART_IT_LBD ((uint16_t)0x0846)
250 #define USART_IT_CTS ((uint16_t)0x096A)
251 #define USART_IT_ERR ((uint16_t)0x0060)
252 #define USART_IT_ORE_ER ((uint16_t)0x0360) /* In case interrupt is generated if the EIE bit is set */
253 #define USART_IT_NE ((uint16_t)0x0260)
254 #define USART_IT_FE ((uint16_t)0x0160)
255 
259 #define USART_IT_ORE USART_IT_ORE_ER
260 
264 #define IS_USART_CONFIG_IT(IT) (((IT) == USART_IT_PE) || ((IT) == USART_IT_TXE) || \
265  ((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || \
266  ((IT) == USART_IT_IDLE) || ((IT) == USART_IT_LBD) || \
267  ((IT) == USART_IT_CTS) || ((IT) == USART_IT_ERR))
268 #define IS_USART_GET_IT(IT) (((IT) == USART_IT_PE) || ((IT) == USART_IT_TXE) || \
269  ((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || \
270  ((IT) == USART_IT_IDLE) || ((IT) == USART_IT_LBD) || \
271  ((IT) == USART_IT_CTS) || ((IT) == USART_IT_ORE) || \
272  ((IT) == USART_IT_ORE_RX) || ((IT) == USART_IT_ORE_ER) || \
273  ((IT) == USART_IT_NE) || ((IT) == USART_IT_FE))
274 #define IS_USART_CLEAR_IT(IT) (((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || \
275  ((IT) == USART_IT_LBD) || ((IT) == USART_IT_CTS))
276 
284 #define USART_DMAReq_Tx ((uint16_t)0x0080)
285 #define USART_DMAReq_Rx ((uint16_t)0x0040)
286 #define IS_USART_DMAREQ(DMAREQ) ((((DMAREQ) & (uint16_t)0xFF3F) == 0x00) && ((DMAREQ) != (uint16_t)0x00))
287 
296 #define USART_WakeUp_IdleLine ((uint16_t)0x0000)
297 #define USART_WakeUp_AddressMark ((uint16_t)0x0800)
298 #define IS_USART_WAKEUP(WAKEUP) (((WAKEUP) == USART_WakeUp_IdleLine) || \
299  ((WAKEUP) == USART_WakeUp_AddressMark))
300 
308 #define USART_LINBreakDetectLength_10b ((uint16_t)0x0000)
309 #define USART_LINBreakDetectLength_11b ((uint16_t)0x0020)
310 #define IS_USART_LIN_BREAK_DETECT_LENGTH(LENGTH) \
311  (((LENGTH) == USART_LINBreakDetectLength_10b) || \
312  ((LENGTH) == USART_LINBreakDetectLength_11b))
313 
321 #define USART_IrDAMode_LowPower ((uint16_t)0x0004)
322 #define USART_IrDAMode_Normal ((uint16_t)0x0000)
323 #define IS_USART_IRDA_MODE(MODE) (((MODE) == USART_IrDAMode_LowPower) || \
324  ((MODE) == USART_IrDAMode_Normal))
325 
333 #define USART_FLAG_CTS ((uint16_t)0x0200)
334 #define USART_FLAG_LBD ((uint16_t)0x0100)
335 #define USART_FLAG_TXE ((uint16_t)0x0080)
336 #define USART_FLAG_TC ((uint16_t)0x0040)
337 #define USART_FLAG_RXNE ((uint16_t)0x0020)
338 #define USART_FLAG_IDLE ((uint16_t)0x0010)
339 #define USART_FLAG_ORE ((uint16_t)0x0008)
340 #define USART_FLAG_NE ((uint16_t)0x0004)
341 #define USART_FLAG_FE ((uint16_t)0x0002)
342 #define USART_FLAG_PE ((uint16_t)0x0001)
343 #define IS_USART_FLAG(FLAG) (((FLAG) == USART_FLAG_PE) || ((FLAG) == USART_FLAG_TXE) || \
344  ((FLAG) == USART_FLAG_TC) || ((FLAG) == USART_FLAG_RXNE) || \
345  ((FLAG) == USART_FLAG_IDLE) || ((FLAG) == USART_FLAG_LBD) || \
346  ((FLAG) == USART_FLAG_CTS) || ((FLAG) == USART_FLAG_ORE) || \
347  ((FLAG) == USART_FLAG_NE) || ((FLAG) == USART_FLAG_FE))
348 
349 #define IS_USART_CLEAR_FLAG(FLAG) ((((FLAG) & (uint16_t)0xFC9F) == 0x00) && ((FLAG) != (uint16_t)0x00))
350 
351 #define IS_USART_BAUDRATE(BAUDRATE) (((BAUDRATE) > 0) && ((BAUDRATE) < 7500001))
352 #define IS_USART_ADDRESS(ADDRESS) ((ADDRESS) <= 0xF)
353 #define IS_USART_DATA(DATA) ((DATA) <= 0x1FF)
354 
363 /* Exported macro ------------------------------------------------------------*/
364 /* Exported functions --------------------------------------------------------*/
365 
366 /* Function used to set the USART configuration to the default reset state ***/
367 void USART_DeInit(USART_TypeDef* USARTx);
368 
369 /* Initialization and Configuration functions *********************************/
370 void USART_Init(USART_TypeDef* USARTx, USART_InitTypeDef* USART_InitStruct);
371 void USART_StructInit(USART_InitTypeDef* USART_InitStruct);
372 void USART_ClockInit(USART_TypeDef* USARTx, USART_ClockInitTypeDef* USART_ClockInitStruct);
373 void USART_ClockStructInit(USART_ClockInitTypeDef* USART_ClockInitStruct);
374 void USART_Cmd(USART_TypeDef* USARTx, FunctionalState NewState);
375 void USART_SetPrescaler(USART_TypeDef* USARTx, uint8_t USART_Prescaler);
376 void USART_OverSampling8Cmd(USART_TypeDef* USARTx, FunctionalState NewState);
377 void USART_OneBitMethodCmd(USART_TypeDef* USARTx, FunctionalState NewState);
378 
379 /* Data transfers functions ***************************************************/
380 void USART_SendData(USART_TypeDef* USARTx, uint16_t Data);
381 uint16_t USART_ReceiveData(USART_TypeDef* USARTx);
382 
383 /* Multi-Processor Communication functions ************************************/
384 void USART_SetAddress(USART_TypeDef* USARTx, uint8_t USART_Address);
385 void USART_WakeUpConfig(USART_TypeDef* USARTx, uint16_t USART_WakeUp);
386 void USART_ReceiverWakeUpCmd(USART_TypeDef* USARTx, FunctionalState NewState);
387 
388 /* LIN mode functions *********************************************************/
389 void USART_LINBreakDetectLengthConfig(USART_TypeDef* USARTx, uint16_t USART_LINBreakDetectLength);
390 void USART_LINCmd(USART_TypeDef* USARTx, FunctionalState NewState);
391 void USART_SendBreak(USART_TypeDef* USARTx);
392 
393 /* Half-duplex mode function **************************************************/
394 void USART_HalfDuplexCmd(USART_TypeDef* USARTx, FunctionalState NewState);
395 
396 /* Smartcard mode functions ***************************************************/
397 void USART_SmartCardCmd(USART_TypeDef* USARTx, FunctionalState NewState);
398 void USART_SmartCardNACKCmd(USART_TypeDef* USARTx, FunctionalState NewState);
399 void USART_SetGuardTime(USART_TypeDef* USARTx, uint8_t USART_GuardTime);
400 
401 /* IrDA mode functions ********************************************************/
402 void USART_IrDAConfig(USART_TypeDef* USARTx, uint16_t USART_IrDAMode);
403 void USART_IrDACmd(USART_TypeDef* USARTx, FunctionalState NewState);
404 
405 /* DMA transfers management functions *****************************************/
406 void USART_DMACmd(USART_TypeDef* USARTx, uint16_t USART_DMAReq, FunctionalState NewState);
407 
408 /* Interrupts and flags management functions **********************************/
409 void USART_ITConfig(USART_TypeDef* USARTx, uint16_t USART_IT, FunctionalState NewState);
410 FlagStatus USART_GetFlagStatus(USART_TypeDef* USARTx, uint16_t USART_FLAG);
411 void USART_ClearFlag(USART_TypeDef* USARTx, uint16_t USART_FLAG);
412 ITStatus USART_GetITStatus(USART_TypeDef* USARTx, uint16_t USART_IT);
413 void USART_ClearITPendingBit(USART_TypeDef* USARTx, uint16_t USART_IT);
414 
415 #ifdef __cplusplus
416 }
417 #endif
418 
419 #endif /* __STM32F4xx_USART_H */
420 
429 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/