stm32f10x_usart.h File Reference

This file contains all the functions prototypes for the USART firmware library. More...

#include "stm32f10x.h"

Go to the source code of this file.

Data Structures
struct	USART_InitTypeDef
	USART Init Structure definition. More...
struct	USART_ClockInitTypeDef
	USART Clock Init Structure definition. More...

Macros
#define	IS_USART_ALL_PERIPH(PERIPH)
#define	IS_USART_123_PERIPH(PERIPH)
#define	IS_USART_1234_PERIPH(PERIPH)
#define	USART_WordLength_8b   ((uint16_t)0x0000)
#define	USART_WordLength_9b   ((uint16_t)0x1000)
#define	IS_USART_WORD_LENGTH(LENGTH)
#define	USART_StopBits_1   ((uint16_t)0x0000)
#define	USART_StopBits_0_5   ((uint16_t)0x1000)
#define	USART_StopBits_2   ((uint16_t)0x2000)
#define	USART_StopBits_1_5   ((uint16_t)0x3000)
#define	IS_USART_STOPBITS(STOPBITS)
#define	USART_Parity_No   ((uint16_t)0x0000)
#define	USART_Parity_Even   ((uint16_t)0x0400)
#define	USART_Parity_Odd   ((uint16_t)0x0600)
#define	IS_USART_PARITY(PARITY)
#define	USART_Mode_Rx   ((uint16_t)0x0004)
#define	USART_Mode_Tx   ((uint16_t)0x0008)
#define	IS_USART_MODE(MODE)   ((((MODE) & (uint16_t)0xFFF3) == 0x00) && ((MODE) != (uint16_t)0x00))
#define	USART_HardwareFlowControl_None   ((uint16_t)0x0000)
#define	USART_HardwareFlowControl_RTS   ((uint16_t)0x0100)
#define	USART_HardwareFlowControl_CTS   ((uint16_t)0x0200)
#define	USART_HardwareFlowControl_RTS_CTS   ((uint16_t)0x0300)
#define	IS_USART_HARDWARE_FLOW_CONTROL(CONTROL)
#define	USART_Clock_Disable   ((uint16_t)0x0000)
#define	USART_Clock_Enable   ((uint16_t)0x0800)
#define	IS_USART_CLOCK(CLOCK)
#define	USART_CPOL_Low   ((uint16_t)0x0000)
#define	USART_CPOL_High   ((uint16_t)0x0400)
#define	IS_USART_CPOL(CPOL)   (((CPOL) == USART_CPOL_Low) || ((CPOL) == USART_CPOL_High))
#define	USART_CPHA_1Edge   ((uint16_t)0x0000)
#define	USART_CPHA_2Edge   ((uint16_t)0x0200)
#define	IS_USART_CPHA(CPHA)   (((CPHA) == USART_CPHA_1Edge) || ((CPHA) == USART_CPHA_2Edge))
#define	USART_LastBit_Disable   ((uint16_t)0x0000)
#define	USART_LastBit_Enable   ((uint16_t)0x0100)
#define	IS_USART_LASTBIT(LASTBIT)
#define	USART_IT_PE   ((uint16_t)0x0028)
#define	USART_IT_TXE   ((uint16_t)0x0727)
#define	USART_IT_TC   ((uint16_t)0x0626)
#define	USART_IT_RXNE   ((uint16_t)0x0525)
#define	USART_IT_IDLE   ((uint16_t)0x0424)
#define	USART_IT_LBD   ((uint16_t)0x0846)
#define	USART_IT_CTS   ((uint16_t)0x096A)
#define	USART_IT_ERR   ((uint16_t)0x0060)
#define	USART_IT_ORE   ((uint16_t)0x0360)
#define	USART_IT_NE   ((uint16_t)0x0260)
#define	USART_IT_FE   ((uint16_t)0x0160)
#define	IS_USART_CONFIG_IT(IT)
#define	IS_USART_GET_IT(IT)
#define	IS_USART_CLEAR_IT(IT)
#define	USART_DMAReq_Tx   ((uint16_t)0x0080)
#define	USART_DMAReq_Rx   ((uint16_t)0x0040)
#define	IS_USART_DMAREQ(DMAREQ)   ((((DMAREQ) & (uint16_t)0xFF3F) == 0x00) && ((DMAREQ) != (uint16_t)0x00))
#define	USART_WakeUp_IdleLine   ((uint16_t)0x0000)
#define	USART_WakeUp_AddressMark   ((uint16_t)0x0800)
#define	IS_USART_WAKEUP(WAKEUP)
#define	USART_LINBreakDetectLength_10b   ((uint16_t)0x0000)
#define	USART_LINBreakDetectLength_11b   ((uint16_t)0x0020)
#define	IS_USART_LIN_BREAK_DETECT_LENGTH(LENGTH)
#define	USART_IrDAMode_LowPower   ((uint16_t)0x0004)
#define	USART_IrDAMode_Normal   ((uint16_t)0x0000)
#define	IS_USART_IRDA_MODE(MODE)
#define	USART_FLAG_CTS   ((uint16_t)0x0200)
#define	USART_FLAG_LBD   ((uint16_t)0x0100)
#define	USART_FLAG_TXE   ((uint16_t)0x0080)
#define	USART_FLAG_TC   ((uint16_t)0x0040)
#define	USART_FLAG_RXNE   ((uint16_t)0x0020)
#define	USART_FLAG_IDLE   ((uint16_t)0x0010)
#define	USART_FLAG_ORE   ((uint16_t)0x0008)
#define	USART_FLAG_NE   ((uint16_t)0x0004)
#define	USART_FLAG_FE   ((uint16_t)0x0002)
#define	USART_FLAG_PE   ((uint16_t)0x0001)
#define	IS_USART_FLAG(FLAG)
#define	IS_USART_CLEAR_FLAG(FLAG)   ((((FLAG) & (uint16_t)0xFC9F) == 0x00) && ((FLAG) != (uint16_t)0x00))
#define	IS_USART_PERIPH_FLAG(PERIPH, USART_FLAG)
#define	IS_USART_BAUDRATE(BAUDRATE)   (((BAUDRATE) > 0) && ((BAUDRATE) < 0x0044AA21))
#define	IS_USART_ADDRESS(ADDRESS)   ((ADDRESS) <= 0xF)
#define	IS_USART_DATA(DATA)   ((DATA) <= 0x1FF)

Functions
void	USART_DeInit (USART_TypeDef *USARTx)
	Deinitializes the USARTx peripheral registers to their default reset values. More...
void	USART_Init (USART_TypeDef *USARTx, USART_InitTypeDef *USART_InitStruct)
	Initializes the USARTx peripheral according to the specified parameters in the USART_InitStruct . More...
void	USART_StructInit (USART_InitTypeDef *USART_InitStruct)
	Fills each USART_InitStruct member with its default value. More...
void	USART_ClockInit (USART_TypeDef *USARTx, USART_ClockInitTypeDef *USART_ClockInitStruct)
	Initializes the USARTx peripheral Clock according to the specified parameters in the USART_ClockInitStruct . More...
void	USART_ClockStructInit (USART_ClockInitTypeDef *USART_ClockInitStruct)
	Fills each USART_ClockInitStruct member with its default value. More...
void	USART_Cmd (USART_TypeDef *USARTx, FunctionalState NewState)
	Enables or disables the specified USART peripheral. More...
void	USART_ITConfig (USART_TypeDef *USARTx, uint16_t USART_IT, FunctionalState NewState)
	Enables or disables the specified USART interrupts. More...
void	USART_DMACmd (USART_TypeDef *USARTx, uint16_t USART_DMAReq, FunctionalState NewState)
	Enables or disables the USART’s DMA interface. More...
void	USART_SetAddress (USART_TypeDef *USARTx, uint8_t USART_Address)
	Sets the address of the USART node. More...
void	USART_WakeUpConfig (USART_TypeDef *USARTx, uint16_t USART_WakeUp)
	Selects the USART WakeUp method. More...
void	USART_ReceiverWakeUpCmd (USART_TypeDef *USARTx, FunctionalState NewState)
	Determines if the USART is in mute mode or not. More...
void	USART_LINBreakDetectLengthConfig (USART_TypeDef *USARTx, uint16_t USART_LINBreakDetectLength)
	Sets the USART LIN Break detection length. More...
void	USART_LINCmd (USART_TypeDef *USARTx, FunctionalState NewState)
	Enables or disables the USART’s LIN mode. More...
void	USART_SendData (USART_TypeDef *USARTx, uint16_t Data)
	Transmits single data through the USARTx peripheral. More...
uint16_t	USART_ReceiveData (USART_TypeDef *USARTx)
	Returns the most recent received data by the USARTx peripheral. More...
void	USART_SendBreak (USART_TypeDef *USARTx)
	Transmits break characters. More...
void	USART_SetGuardTime (USART_TypeDef *USARTx, uint8_t USART_GuardTime)
	Sets the specified USART guard time. More...
void	USART_SetPrescaler (USART_TypeDef *USARTx, uint8_t USART_Prescaler)
	Sets the system clock prescaler. More...
void	USART_SmartCardCmd (USART_TypeDef *USARTx, FunctionalState NewState)
	Enables or disables the USART’s Smart Card mode. More...
void	USART_SmartCardNACKCmd (USART_TypeDef *USARTx, FunctionalState NewState)
	Enables or disables NACK transmission. More...
void	USART_HalfDuplexCmd (USART_TypeDef *USARTx, FunctionalState NewState)
	Enables or disables the USART’s Half Duplex communication. More...
void	USART_OverSampling8Cmd (USART_TypeDef *USARTx, FunctionalState NewState)
	Enables or disables the USART's 8x oversampling mode. More...
void	USART_OneBitMethodCmd (USART_TypeDef *USARTx, FunctionalState NewState)
	Enables or disables the USART's one bit sampling methode. More...
void	USART_IrDAConfig (USART_TypeDef *USARTx, uint16_t USART_IrDAMode)
	Configures the USART’s IrDA interface. More...
void	USART_IrDACmd (USART_TypeDef *USARTx, FunctionalState NewState)
	Enables or disables the USART’s IrDA interface. More...
FlagStatus	USART_GetFlagStatus (USART_TypeDef *USARTx, uint16_t USART_FLAG)
	Checks whether the specified USART flag is set or not. More...
void	USART_ClearFlag (USART_TypeDef *USARTx, uint16_t USART_FLAG)
	Clears the USARTx's pending flags. More...
ITStatus	USART_GetITStatus (USART_TypeDef *USARTx, uint16_t USART_IT)
	Checks whether the specified USART interrupt has occurred or not. More...
void	USART_ClearITPendingBit (USART_TypeDef *USARTx, uint16_t USART_IT)
	Clears the USARTx’s interrupt pending bits. More...
void	USART_putchar (USART_TypeDef *USARTx, uint16_t Data)
uint8_t	USART_getchar (USART_TypeDef *USARTx)

Detailed Description

This file contains all the functions prototypes for the USART firmware library.

Author

MCD Application Team

Version

V3.3.0

Date

04/16/2010

THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.

© COPYRIGHT 2010 STMicroelectronics