OpenCores
URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [rtos/] [freertos-6.1.1/] [Demo/] [CORTEX_STM32F103_GCC_Rowley/] [ST Library/] [inc/] [stm32f10x_usart.h] - Blame information for rev 582

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 582 jeremybenn
/******************** (C) COPYRIGHT 2008 STMicroelectronics ********************
2
* File Name          : stm32f10x_usart.h
3
* Author             : MCD Application Team
4
* Version            : V2.0.1
5
* Date               : 06/13/2008
6
* Description        : This file contains all the functions prototypes for the
7
*                      USART firmware library.
8
********************************************************************************
9
* THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
10
* WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
11
* AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT,
12
* INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE
13
* CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING
14
* INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
15
*******************************************************************************/
16
 
17
/* Define to prevent recursive inclusion -------------------------------------*/
18
#ifndef __STM32F10x_USART_H
19
#define __STM32F10x_USART_H
20
 
21
/* Includes ------------------------------------------------------------------*/
22
#include "stm32f10x_map.h"
23
 
24
/* Exported types ------------------------------------------------------------*/
25
/* USART Init Structure definition */
26
typedef struct
27
{
28
  u32 USART_BaudRate;
29
  u16 USART_WordLength;
30
  u16 USART_StopBits;
31
  u16 USART_Parity;
32
  u16 USART_Mode;
33
  u16 USART_HardwareFlowControl;
34
} USART_InitTypeDef;
35
 
36
/* USART Clock Init Structure definition */
37
typedef struct
38
{
39
  u16 USART_Clock;
40
  u16 USART_CPOL;
41
  u16 USART_CPHA;
42
  u16 USART_LastBit;
43
} USART_ClockInitTypeDef;
44
 
45
/* Exported constants --------------------------------------------------------*/
46
#define IS_USART_ALL_PERIPH(PERIPH) (((*(u32*)&(PERIPH)) == USART1_BASE) || \
47
                                     ((*(u32*)&(PERIPH)) == USART2_BASE) || \
48
                                     ((*(u32*)&(PERIPH)) == USART3_BASE) || \
49
                                     ((*(u32*)&(PERIPH)) == UART4_BASE) || \
50
                                     ((*(u32*)&(PERIPH)) == UART5_BASE))
51
 
52
#define IS_USART_123_PERIPH(PERIPH) (((*(u32*)&(PERIPH)) == USART1_BASE) || \
53
                                     ((*(u32*)&(PERIPH)) == USART2_BASE) || \
54
                                     ((*(u32*)&(PERIPH)) == USART3_BASE))
55
 
56
#define IS_USART_1234_PERIPH(PERIPH) (((*(u32*)&(PERIPH)) == USART1_BASE) || \
57
                                      ((*(u32*)&(PERIPH)) == USART2_BASE) || \
58
                                      ((*(u32*)&(PERIPH)) == USART3_BASE) || \
59
                                      ((*(u32*)&(PERIPH)) == UART4_BASE))
60
 
61
/* USART Word Length ---------------------------------------------------------*/
62
#define USART_WordLength_8b                  ((u16)0x0000)
63
#define USART_WordLength_9b                  ((u16)0x1000)
64
 
65
#define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WordLength_8b) || \
66
                                      ((LENGTH) == USART_WordLength_9b))
67
 
68
/* USART Stop Bits -----------------------------------------------------------*/
69
#define USART_StopBits_1                     ((u16)0x0000)
70
#define USART_StopBits_0_5                   ((u16)0x1000)
71
#define USART_StopBits_2                     ((u16)0x2000)
72
#define USART_StopBits_1_5                   ((u16)0x3000)
73
 
74
#define IS_USART_STOPBITS(STOPBITS) (((STOPBITS) == USART_StopBits_1) || \
75
                                     ((STOPBITS) == USART_StopBits_0_5) || \
76
                                     ((STOPBITS) == USART_StopBits_2) || \
77
                                     ((STOPBITS) == USART_StopBits_1_5))
78
/* USART Parity --------------------------------------------------------------*/
79
#define USART_Parity_No                      ((u16)0x0000)
80
#define USART_Parity_Even                    ((u16)0x0400)
81
#define USART_Parity_Odd                     ((u16)0x0600) 
82
 
83
#define IS_USART_PARITY(PARITY) (((PARITY) == USART_Parity_No) || \
84
                                 ((PARITY) == USART_Parity_Even) || \
85
                                 ((PARITY) == USART_Parity_Odd))
86
 
87
/* USART Mode ----------------------------------------------------------------*/
88
#define USART_Mode_Rx                        ((u16)0x0004)
89
#define USART_Mode_Tx                        ((u16)0x0008)
90
 
91
#define IS_USART_MODE(MODE) ((((MODE) & (u16)0xFFF3) == 0x00) && ((MODE) != (u16)0x00))
92
 
93
/* USART Hardware Flow Control -----------------------------------------------*/
94
#define USART_HardwareFlowControl_None       ((u16)0x0000)
95
#define USART_HardwareFlowControl_RTS        ((u16)0x0100)
96
#define USART_HardwareFlowControl_CTS        ((u16)0x0200)
97
#define USART_HardwareFlowControl_RTS_CTS    ((u16)0x0300)
98
 
99
#define IS_USART_HARDWARE_FLOW_CONTROL(CONTROL)\
100
                              (((CONTROL) == USART_HardwareFlowControl_None) || \
101
                               ((CONTROL) == USART_HardwareFlowControl_RTS) || \
102
                               ((CONTROL) == USART_HardwareFlowControl_CTS) || \
103
                               ((CONTROL) == USART_HardwareFlowControl_RTS_CTS))
104
 
105
#define IS_USART_PERIPH_HFC(PERIPH, HFC) ((((*(u32*)&(PERIPH)) != UART4_BASE) && \
106
                                          ((*(u32*)&(PERIPH)) != UART5_BASE)) \
107
                                          || ((HFC) == USART_HardwareFlowControl_None))
108
 
109
/* USART Clock ---------------------------------------------------------------*/
110
#define USART_Clock_Disable                  ((u16)0x0000)
111
#define USART_Clock_Enable                   ((u16)0x0800)
112
 
113
#define IS_USART_CLOCK(CLOCK) (((CLOCK) == USART_Clock_Disable) || \
114
                               ((CLOCK) == USART_Clock_Enable))
115
 
116
/* USART Clock Polarity ------------------------------------------------------*/
117
#define USART_CPOL_Low                       ((u16)0x0000)
118
#define USART_CPOL_High                      ((u16)0x0400)
119
 
120
#define IS_USART_CPOL(CPOL) (((CPOL) == USART_CPOL_Low) || ((CPOL) == USART_CPOL_High))
121
 
122
/* USART Clock Phase ---------------------------------------------------------*/
123
#define USART_CPHA_1Edge                     ((u16)0x0000)
124
#define USART_CPHA_2Edge                     ((u16)0x0200)
125
#define IS_USART_CPHA(CPHA) (((CPHA) == USART_CPHA_1Edge) || ((CPHA) == USART_CPHA_2Edge))
126
 
127
/* USART Last Bit ------------------------------------------------------------*/
128
#define USART_LastBit_Disable                ((u16)0x0000)
129
#define USART_LastBit_Enable                 ((u16)0x0100)
130
 
131
#define IS_USART_LASTBIT(LASTBIT) (((LASTBIT) == USART_LastBit_Disable) || \
132
                                   ((LASTBIT) == USART_LastBit_Enable))
133
 
134
/* USART Interrupt definition ------------------------------------------------*/
135
#define USART_IT_PE                          ((u16)0x0028)
136
#define USART_IT_TXE                         ((u16)0x0727)
137
#define USART_IT_TC                          ((u16)0x0626)
138
#define USART_IT_RXNE                        ((u16)0x0525)
139
#define USART_IT_IDLE                        ((u16)0x0424)
140
#define USART_IT_LBD                         ((u16)0x0846)
141
#define USART_IT_CTS                         ((u16)0x096A)
142
#define USART_IT_ERR                         ((u16)0x0060)
143
#define USART_IT_ORE                         ((u16)0x0360)
144
#define USART_IT_NE                          ((u16)0x0260)
145
#define USART_IT_FE                          ((u16)0x0160)
146
 
147
#define IS_USART_CONFIG_IT(IT) (((IT) == USART_IT_PE) || ((IT) == USART_IT_TXE) || \
148
                               ((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || \
149
                               ((IT) == USART_IT_IDLE) || ((IT) == USART_IT_LBD) || \
150
                               ((IT) == USART_IT_CTS) || ((IT) == USART_IT_ERR))
151
 
152
#define IS_USART_IT(IT) (((IT) == USART_IT_PE) || ((IT) == USART_IT_TXE) || \
153
                         ((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || \
154
                         ((IT) == USART_IT_IDLE) || ((IT) == USART_IT_LBD) || \
155
                         ((IT) == USART_IT_CTS) || ((IT) == USART_IT_ORE) || \
156
                         ((IT) == USART_IT_NE) || ((IT) == USART_IT_FE))
157
 
158
#define IS_USART_CLEAR_IT(IT) (((IT) == USART_IT_PE) || ((IT) == USART_IT_TC) || \
159
                               ((IT) == USART_IT_RXNE) || ((IT) == USART_IT_IDLE) || \
160
                               ((IT) == USART_IT_LBD) || ((IT) == USART_IT_CTS) ||  \
161
                               ((IT) == USART_IT_ORE) || ((IT) == USART_IT_NE) || \
162
                               ((IT) == USART_IT_FE))
163
 
164
#define IS_USART_PERIPH_IT(PERIPH, USART_IT) ((((*(u32*)&(PERIPH)) != UART4_BASE) && \
165
                                              ((*(u32*)&(PERIPH)) != UART5_BASE)) \
166
                                              || ((USART_IT) != USART_IT_CTS))
167
 
168
/* USART DMA Requests --------------------------------------------------------*/
169
#define USART_DMAReq_Tx                      ((u16)0x0080)
170
#define USART_DMAReq_Rx                      ((u16)0x0040)
171
 
172
#define IS_USART_DMAREQ(DMAREQ) ((((DMAREQ) & (u16)0xFF3F) == 0x00) && ((DMAREQ) != (u16)0x00))
173
 
174
/* USART WakeUp methods ------------------------------------------------------*/
175
#define USART_WakeUp_IdleLine                ((u16)0x0000)
176
#define USART_WakeUp_AddressMark             ((u16)0x0800)
177
 
178
#define IS_USART_WAKEUP(WAKEUP) (((WAKEUP) == USART_WakeUp_IdleLine) || \
179
                                 ((WAKEUP) == USART_WakeUp_AddressMark))
180
 
181
/* USART LIN Break Detection Length ------------------------------------------*/
182
#define USART_LINBreakDetectLength_10b      ((u16)0x0000)
183
#define USART_LINBreakDetectLength_11b      ((u16)0x0020)
184
 
185
#define IS_USART_LIN_BREAK_DETECT_LENGTH(LENGTH) \
186
                               (((LENGTH) == USART_LINBreakDetectLength_10b) || \
187
                                ((LENGTH) == USART_LINBreakDetectLength_11b))
188
 
189
/* USART IrDA Low Power ------------------------------------------------------*/
190
#define USART_IrDAMode_LowPower              ((u16)0x0004)
191
#define USART_IrDAMode_Normal                ((u16)0x0000)
192
 
193
#define IS_USART_IRDA_MODE(MODE) (((MODE) == USART_IrDAMode_LowPower) || \
194
                                  ((MODE) == USART_IrDAMode_Normal))
195
 
196
/* USART Flags ---------------------------------------------------------------*/
197
#define USART_FLAG_CTS                       ((u16)0x0200)
198
#define USART_FLAG_LBD                       ((u16)0x0100)
199
#define USART_FLAG_TXE                       ((u16)0x0080)
200
#define USART_FLAG_TC                        ((u16)0x0040)
201
#define USART_FLAG_RXNE                      ((u16)0x0020)
202
#define USART_FLAG_IDLE                      ((u16)0x0010)
203
#define USART_FLAG_ORE                       ((u16)0x0008)
204
#define USART_FLAG_NE                        ((u16)0x0004)
205
#define USART_FLAG_FE                        ((u16)0x0002)
206
#define USART_FLAG_PE                        ((u16)0x0001)
207
 
208
#define IS_USART_FLAG(FLAG) (((FLAG) == USART_FLAG_PE) || ((FLAG) == USART_FLAG_TXE) || \
209
                             ((FLAG) == USART_FLAG_TC) || ((FLAG) == USART_FLAG_RXNE) || \
210
                             ((FLAG) == USART_FLAG_IDLE) || ((FLAG) == USART_FLAG_LBD) || \
211
                             ((FLAG) == USART_FLAG_CTS) || ((FLAG) == USART_FLAG_ORE) || \
212
                             ((FLAG) == USART_FLAG_NE) || ((FLAG) == USART_FLAG_FE))
213
 
214
#define IS_USART_CLEAR_FLAG(FLAG) ((((FLAG) & (u16)0xFC80) == 0x00) && ((FLAG) != (u16)0x00))
215
 
216
#define IS_USART_PERIPH_FLAG(PERIPH, USART_FLAG) ((((*(u32*)&(PERIPH)) != UART4_BASE) &&\
217
                                                  ((*(u32*)&(PERIPH)) != UART5_BASE)) \
218
                                                  || ((USART_FLAG) != USART_FLAG_CTS))
219
 
220
#define IS_USART_BAUDRATE(BAUDRATE) (((BAUDRATE) > 0) && ((BAUDRATE) < 0x0044AA21))
221
#define IS_USART_ADDRESS(ADDRESS) ((ADDRESS) <= 0xF)
222
#define IS_USART_DATA(DATA) ((DATA) <= 0x1FF)
223
 
224
/* Exported macro ------------------------------------------------------------*/
225
/* Exported functions ------------------------------------------------------- */
226
void USART_DeInit(USART_TypeDef* USARTx);
227
void USART_Init(USART_TypeDef* USARTx, USART_InitTypeDef* USART_InitStruct);
228
void USART_StructInit(USART_InitTypeDef* USART_InitStruct);
229
void USART_ClockInit(USART_TypeDef* USARTx, USART_ClockInitTypeDef* USART_ClockInitStruct);
230
void USART_ClockStructInit(USART_ClockInitTypeDef* USART_ClockInitStruct);
231
void USART_Cmd(USART_TypeDef* USARTx, FunctionalState NewState);
232
void USART_ITConfig(USART_TypeDef* USARTx, u16 USART_IT, FunctionalState NewState);
233
void USART_DMACmd(USART_TypeDef* USARTx, u16 USART_DMAReq, FunctionalState NewState);
234
void USART_SetAddress(USART_TypeDef* USARTx, u8 USART_Address);
235
void USART_WakeUpConfig(USART_TypeDef* USARTx, u16 USART_WakeUp);
236
void USART_ReceiverWakeUpCmd(USART_TypeDef* USARTx, FunctionalState NewState);
237
void USART_LINBreakDetectLengthConfig(USART_TypeDef* USARTx, u16 USART_LINBreakDetectLength);
238
void USART_LINCmd(USART_TypeDef* USARTx, FunctionalState NewState);
239
void USART_SendData(USART_TypeDef* USARTx, u16 Data);
240
u16 USART_ReceiveData(USART_TypeDef* USARTx);
241
void USART_SendBreak(USART_TypeDef* USARTx);
242
void USART_SetGuardTime(USART_TypeDef* USARTx, u8 USART_GuardTime);
243
void USART_SetPrescaler(USART_TypeDef* USARTx, u8 USART_Prescaler);
244
void USART_SmartCardCmd(USART_TypeDef* USARTx, FunctionalState NewState);
245
void USART_SmartCardNACKCmd(USART_TypeDef* USARTx, FunctionalState NewState);
246
void USART_HalfDuplexCmd(USART_TypeDef* USARTx, FunctionalState NewState);
247
void USART_IrDAConfig(USART_TypeDef* USARTx, u16 USART_IrDAMode);
248
void USART_IrDACmd(USART_TypeDef* USARTx, FunctionalState NewState);
249
FlagStatus USART_GetFlagStatus(USART_TypeDef* USARTx, u16 USART_FLAG);
250
void USART_ClearFlag(USART_TypeDef* USARTx, u16 USART_FLAG);
251
ITStatus USART_GetITStatus(USART_TypeDef* USARTx, u16 USART_IT);
252
void USART_ClearITPendingBit(USART_TypeDef* USARTx, u16 USART_IT);
253
 
254
#endif /* __STM32F10x_USART_H */
255
 
256
/******************* (C) COPYRIGHT 2008 STMicroelectronics *****END OF FILE****/

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.