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_i2c.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_i2c.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
*                      I2C 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_I2C_H    
19
#define __STM32F10x_I2C_H
20
 
21
/* Includes ------------------------------------------------------------------*/
22
#include "stm32f10x_map.h"
23
 
24
/* Exported types ------------------------------------------------------------*/
25
/* I2C Init structure definition */
26
typedef struct
27
{
28
  u16 I2C_Mode;
29
  u16 I2C_DutyCycle;
30
  u16 I2C_OwnAddress1;
31
  u16 I2C_Ack;
32
  u16 I2C_AcknowledgedAddress;
33
  u32 I2C_ClockSpeed;
34
}I2C_InitTypeDef;
35
 
36
/* Exported constants --------------------------------------------------------*/
37
#define IS_I2C_ALL_PERIPH(PERIPH) (((*(u32*)&(PERIPH)) == I2C1_BASE) || \
38
                                   ((*(u32*)&(PERIPH)) == I2C2_BASE))
39
 
40
/* I2C modes */
41
#define I2C_Mode_I2C                    ((u16)0x0000)
42
#define I2C_Mode_SMBusDevice            ((u16)0x0002)
43
#define I2C_Mode_SMBusHost              ((u16)0x000A)
44
 
45
#define IS_I2C_MODE(MODE) (((MODE) == I2C_Mode_I2C) || \
46
                           ((MODE) == I2C_Mode_SMBusDevice) || \
47
                           ((MODE) == I2C_Mode_SMBusHost))
48
/* I2C duty cycle in fast mode */
49
#define I2C_DutyCycle_16_9              ((u16)0x4000)
50
#define I2C_DutyCycle_2                 ((u16)0xBFFF)
51
 
52
#define IS_I2C_DUTY_CYCLE(CYCLE) (((CYCLE) == I2C_DutyCycle_16_9) || \
53
                                  ((CYCLE) == I2C_DutyCycle_2))
54
 
55
/* I2C cknowledgementy */
56
#define I2C_Ack_Enable                  ((u16)0x0400)
57
#define I2C_Ack_Disable                 ((u16)0x0000)
58
 
59
#define IS_I2C_ACK_STATE(STATE) (((STATE) == I2C_Ack_Enable) || \
60
                                 ((STATE) == I2C_Ack_Disable))
61
 
62
/* I2C transfer direction */
63
#define  I2C_Direction_Transmitter      ((u8)0x00)
64
#define  I2C_Direction_Receiver         ((u8)0x01)
65
 
66
#define IS_I2C_DIRECTION(DIRECTION) (((DIRECTION) == I2C_Direction_Transmitter) || \
67
                                     ((DIRECTION) == I2C_Direction_Receiver))
68
 
69
/* I2C acknowledged address defines */
70
#define I2C_AcknowledgedAddress_7bit    ((u16)0x4000)
71
#define I2C_AcknowledgedAddress_10bit   ((u16)0xC000)
72
 
73
#define IS_I2C_ACKNOWLEDGE_ADDRESS(ADDRESS) (((ADDRESS) == I2C_AcknowledgedAddress_7bit) || \
74
                                             ((ADDRESS) == I2C_AcknowledgedAddress_10bit))
75
 
76
/* I2C registers */
77
#define I2C_Register_CR1                ((u8)0x00)
78
#define I2C_Register_CR2                ((u8)0x04)
79
#define I2C_Register_OAR1               ((u8)0x08)
80
#define I2C_Register_OAR2               ((u8)0x0C)
81
#define I2C_Register_DR                 ((u8)0x10)
82
#define I2C_Register_SR1                ((u8)0x14)
83
#define I2C_Register_SR2                ((u8)0x18)
84
#define I2C_Register_CCR                ((u8)0x1C)
85
#define I2C_Register_TRISE              ((u8)0x20)
86
 
87
#define IS_I2C_REGISTER(REGISTER) (((REGISTER) == I2C_Register_CR1) || \
88
                                   ((REGISTER) == I2C_Register_CR2) || \
89
                                   ((REGISTER) == I2C_Register_OAR1) || \
90
                                   ((REGISTER) == I2C_Register_OAR2) || \
91
                                   ((REGISTER) == I2C_Register_DR) || \
92
                                   ((REGISTER) == I2C_Register_SR1) || \
93
                                   ((REGISTER) == I2C_Register_SR2) || \
94
                                   ((REGISTER) == I2C_Register_CCR) || \
95
                                   ((REGISTER) == I2C_Register_TRISE))
96
 
97
/* I2C SMBus alert pin level */
98
#define I2C_SMBusAlert_Low              ((u16)0x2000)
99
#define I2C_SMBusAlert_High             ((u16)0xDFFF)
100
 
101
#define IS_I2C_SMBUS_ALERT(ALERT) (((ALERT) == I2C_SMBusAlert_Low) || \
102
                                   ((ALERT) == I2C_SMBusAlert_High))
103
 
104
/* I2C PEC position */
105
#define I2C_PECPosition_Next            ((u16)0x0800)
106
#define I2C_PECPosition_Current         ((u16)0xF7FF)
107
 
108
#define IS_I2C_PEC_POSITION(POSITION) (((POSITION) == I2C_PECPosition_Next) || \
109
                                       ((POSITION) == I2C_PECPosition_Current))
110
 
111
/* I2C interrupts definition */
112
#define I2C_IT_BUF                      ((u16)0x0400)
113
#define I2C_IT_EVT                      ((u16)0x0200)
114
#define I2C_IT_ERR                      ((u16)0x0100)
115
 
116
#define IS_I2C_CONFIG_IT(IT) ((((IT) & (u16)0xF8FF) == 0x00) && ((IT) != 0x00))
117
 
118
/* I2C interrupts definition */
119
#define I2C_IT_SMBALERT                 ((u32)0x10008000)
120
#define I2C_IT_TIMEOUT                  ((u32)0x10004000)
121
#define I2C_IT_PECERR                   ((u32)0x10001000)
122
#define I2C_IT_OVR                      ((u32)0x10000800)
123
#define I2C_IT_AF                       ((u32)0x10000400)
124
#define I2C_IT_ARLO                     ((u32)0x10000200)
125
#define I2C_IT_BERR                     ((u32)0x10000100)
126
#define I2C_IT_TXE                      ((u32)0x00000080)
127
#define I2C_IT_RXNE                     ((u32)0x00000040)
128
#define I2C_IT_STOPF                    ((u32)0x60000010)
129
#define I2C_IT_ADD10                    ((u32)0x20000008)
130
#define I2C_IT_BTF                      ((u32)0x60000004)
131
#define I2C_IT_ADDR                     ((u32)0xA0000002)
132
#define I2C_IT_SB                       ((u32)0x20000001)
133
 
134
#define IS_I2C_CLEAR_IT(IT) (((IT) == I2C_IT_SMBALERT) || ((IT) == I2C_IT_TIMEOUT) || \
135
                             ((IT) == I2C_IT_PECERR) || ((IT) == I2C_IT_OVR) || \
136
                             ((IT) == I2C_IT_AF) || ((IT) == I2C_IT_ARLO) || \
137
                             ((IT) == I2C_IT_BERR) || ((IT) == I2C_IT_STOPF) || \
138
                             ((IT) == I2C_IT_ADD10) || ((IT) == I2C_IT_BTF) || \
139
                             ((IT) == I2C_IT_ADDR) || ((IT) == I2C_IT_SB))
140
 
141
#define IS_I2C_GET_IT(IT) (((IT) == I2C_IT_SMBALERT) || ((IT) == I2C_IT_TIMEOUT) || \
142
                           ((IT) == I2C_IT_PECERR) || ((IT) == I2C_IT_OVR) || \
143
                           ((IT) == I2C_IT_AF) || ((IT) == I2C_IT_ARLO) || \
144
                           ((IT) == I2C_IT_BERR) || ((IT) == I2C_IT_TXE) || \
145
                           ((IT) == I2C_IT_RXNE) || ((IT) == I2C_IT_STOPF) || \
146
                           ((IT) == I2C_IT_ADD10) || ((IT) == I2C_IT_BTF) || \
147
                           ((IT) == I2C_IT_ADDR) || ((IT) == I2C_IT_SB))
148
 
149
/* I2C flags definition */
150
#define I2C_FLAG_DUALF                  ((u32)0x00800000)
151
#define I2C_FLAG_SMBHOST                ((u32)0x00400000)
152
#define I2C_FLAG_SMBDEFAULT             ((u32)0x00200000)
153
#define I2C_FLAG_GENCALL                ((u32)0x00100000)
154
#define I2C_FLAG_TRA                    ((u32)0x00040000)
155
#define I2C_FLAG_BUSY                   ((u32)0x00020000)
156
#define I2C_FLAG_MSL                    ((u32)0x00010000)
157
#define I2C_FLAG_SMBALERT               ((u32)0x10008000)
158
#define I2C_FLAG_TIMEOUT                ((u32)0x10004000)
159
#define I2C_FLAG_PECERR                 ((u32)0x10001000)
160
#define I2C_FLAG_OVR                    ((u32)0x10000800)
161
#define I2C_FLAG_AF                     ((u32)0x10000400)
162
#define I2C_FLAG_ARLO                   ((u32)0x10000200)
163
#define I2C_FLAG_BERR                   ((u32)0x10000100)
164
#define I2C_FLAG_TXE                    ((u32)0x00000080)
165
#define I2C_FLAG_RXNE                   ((u32)0x00000040)
166
#define I2C_FLAG_STOPF                  ((u32)0x60000010)
167
#define I2C_FLAG_ADD10                  ((u32)0x20000008)
168
#define I2C_FLAG_BTF                    ((u32)0x60000004)
169
#define I2C_FLAG_ADDR                   ((u32)0xA0000002)
170
#define I2C_FLAG_SB                     ((u32)0x20000001)
171
 
172
#define IS_I2C_CLEAR_FLAG(FLAG) (((FLAG) == I2C_FLAG_SMBALERT) || ((FLAG) == I2C_FLAG_TIMEOUT) || \
173
                                 ((FLAG) == I2C_FLAG_PECERR) || ((FLAG) == I2C_FLAG_OVR) || \
174
                                 ((FLAG) == I2C_FLAG_AF) || ((FLAG) == I2C_FLAG_ARLO) || \
175
                                 ((FLAG) == I2C_FLAG_BERR) || ((FLAG) == I2C_FLAG_STOPF) || \
176
                                 ((FLAG) == I2C_FLAG_ADD10) || ((FLAG) == I2C_FLAG_BTF) || \
177
                                 ((FLAG) == I2C_FLAG_ADDR) || ((FLAG) == I2C_FLAG_SB))
178
 
179
#define IS_I2C_GET_FLAG(FLAG) (((FLAG) == I2C_FLAG_DUALF) || ((FLAG) == I2C_FLAG_SMBHOST) || \
180
                               ((FLAG) == I2C_FLAG_SMBDEFAULT) || ((FLAG) == I2C_FLAG_GENCALL) || \
181
                               ((FLAG) == I2C_FLAG_TRA) || ((FLAG) == I2C_FLAG_BUSY) || \
182
                               ((FLAG) == I2C_FLAG_MSL) || ((FLAG) == I2C_FLAG_SMBALERT) || \
183
                               ((FLAG) == I2C_FLAG_TIMEOUT) || ((FLAG) == I2C_FLAG_PECERR) || \
184
                               ((FLAG) == I2C_FLAG_OVR) || ((FLAG) == I2C_FLAG_AF) || \
185
                               ((FLAG) == I2C_FLAG_ARLO) || ((FLAG) == I2C_FLAG_BERR) || \
186
                               ((FLAG) == I2C_FLAG_TXE) || ((FLAG) == I2C_FLAG_RXNE) || \
187
                               ((FLAG) == I2C_FLAG_STOPF) || ((FLAG) == I2C_FLAG_ADD10) || \
188
                               ((FLAG) == I2C_FLAG_BTF) || ((FLAG) == I2C_FLAG_ADDR) || \
189
                               ((FLAG) == I2C_FLAG_SB))
190
 
191
/* I2C Events */
192
/* EV1 */
193
#define  I2C_EVENT_SLAVE_TRANSMITTER_ADDRESS_MATCHED       ((u32)0x00060082) /* TRA, BUSY, TXE and ADDR flags */
194
#define  I2C_EVENT_SLAVE_RECEIVER_ADDRESS_MATCHED          ((u32)0x00020002) /* BUSY and ADDR flags */
195
#define  I2C_EVENT_SLAVE_TRANSMITTER_SECONDADDRESS_MATCHED ((u32)0x00860080)  /* DUALF, TRA, BUSY and TXE flags */
196
#define  I2C_EVENT_SLAVE_RECEIVER_SECONDADDRESS_MATCHED    ((u32)0x00820000)  /* DUALF and BUSY flags */
197
#define  I2C_EVENT_SLAVE_GENERALCALLADDRESS_MATCHED        ((u32)0x00120000)  /* GENCALL and BUSY flags */
198
 
199
/* EV2 */
200
#define  I2C_EVENT_SLAVE_BYTE_RECEIVED                     ((u32)0x00020040)  /* BUSY and RXNE flags */
201
 
202
/* EV3 */
203
#define  I2C_EVENT_SLAVE_BYTE_TRANSMITTED                  ((u32)0x00060084)  /* TRA, BUSY, TXE and BTF flags */
204
 
205
/* EV4 */
206
#define  I2C_EVENT_SLAVE_STOP_DETECTED                     ((u32)0x00000010)  /* STOPF flag */
207
 
208
/* EV5 */
209
#define  I2C_EVENT_MASTER_MODE_SELECT                      ((u32)0x00030001)  /* BUSY, MSL and SB flag */
210
 
211
/* EV6 */
212
#define  I2C_EVENT_MASTER_TRANSMITTER_MODE_SELECTED        ((u32)0x00070082)  /* BUSY, MSL, ADDR, TXE and TRA flags */
213
#define  I2C_EVENT_MASTER_RECEIVER_MODE_SELECTED           ((u32)0x00030002)  /* BUSY, MSL and ADDR flags */
214
 
215
/* EV7 */
216
#define  I2C_EVENT_MASTER_BYTE_RECEIVED                    ((u32)0x00030040)  /* BUSY, MSL and RXNE flags */
217
 
218
/* EV8 */
219
#define  I2C_EVENT_MASTER_BYTE_TRANSMITTED                 ((u32)0x00070084)  /* TRA, BUSY, MSL, TXE and BTF flags */
220
 
221
/* EV9 */
222
#define  I2C_EVENT_MASTER_MODE_ADDRESS10                   ((u32)0x00030008)  /* BUSY, MSL and ADD10 flags */
223
 
224
/* EV3_2 */
225
#define  I2C_EVENT_SLAVE_ACK_FAILURE                       ((u32)0x00000400)  /* AF flag */
226
 
227
#define IS_I2C_EVENT(EVENT) (((EVENT) == I2C_EVENT_SLAVE_TRANSMITTER_ADDRESS_MATCHED) || \
228
                             ((EVENT) == I2C_EVENT_SLAVE_RECEIVER_ADDRESS_MATCHED) || \
229
                             ((EVENT) == I2C_EVENT_SLAVE_TRANSMITTER_SECONDADDRESS_MATCHED) || \
230
                             ((EVENT) == I2C_EVENT_SLAVE_RECEIVER_SECONDADDRESS_MATCHED) || \
231
                             ((EVENT) == I2C_EVENT_SLAVE_GENERALCALLADDRESS_MATCHED) || \
232
                             ((EVENT) == I2C_EVENT_SLAVE_BYTE_RECEIVED) || \
233
                             ((EVENT) == (I2C_EVENT_SLAVE_BYTE_RECEIVED | I2C_FLAG_DUALF)) || \
234
                             ((EVENT) == (I2C_EVENT_SLAVE_BYTE_RECEIVED | I2C_FLAG_GENCALL)) || \
235
                             ((EVENT) == I2C_EVENT_SLAVE_BYTE_TRANSMITTED) || \
236
                             ((EVENT) == (I2C_EVENT_SLAVE_BYTE_TRANSMITTED | I2C_FLAG_DUALF)) || \
237
                             ((EVENT) == (I2C_EVENT_SLAVE_BYTE_TRANSMITTED | I2C_FLAG_GENCALL)) || \
238
                             ((EVENT) == I2C_EVENT_SLAVE_STOP_DETECTED) || \
239
                             ((EVENT) == I2C_EVENT_MASTER_MODE_SELECT) || \
240
                             ((EVENT) == I2C_EVENT_MASTER_TRANSMITTER_MODE_SELECTED) || \
241
                             ((EVENT) == I2C_EVENT_MASTER_RECEIVER_MODE_SELECTED) || \
242
                             ((EVENT) == I2C_EVENT_MASTER_BYTE_RECEIVED) || \
243
                             ((EVENT) == I2C_EVENT_MASTER_BYTE_TRANSMITTED) || \
244
                             ((EVENT) == I2C_EVENT_MASTER_MODE_ADDRESS10) || \
245
                             ((EVENT) == I2C_EVENT_SLAVE_ACK_FAILURE))
246
 
247
/* I2C own address1 -----------------------------------------------------------*/
248
#define IS_I2C_OWN_ADDRESS1(ADDRESS1) ((ADDRESS1) <= 0x3FF)
249
/* I2C clock speed ------------------------------------------------------------*/
250
#define IS_I2C_CLOCK_SPEED(SPEED) (((SPEED) >= 0x1) && ((SPEED) <= 400000))
251
 
252
/* Exported macro ------------------------------------------------------------*/
253
/* Exported functions ------------------------------------------------------- */
254
void I2C_DeInit(I2C_TypeDef* I2Cx);
255
void I2C_Init(I2C_TypeDef* I2Cx, I2C_InitTypeDef* I2C_InitStruct);
256
void I2C_StructInit(I2C_InitTypeDef* I2C_InitStruct);
257
void I2C_Cmd(I2C_TypeDef* I2Cx, FunctionalState NewState);
258
void I2C_DMACmd(I2C_TypeDef* I2Cx, FunctionalState NewState);
259
void I2C_DMALastTransferCmd(I2C_TypeDef* I2Cx, FunctionalState NewState);
260
void I2C_GenerateSTART(I2C_TypeDef* I2Cx, FunctionalState NewState);
261
void I2C_GenerateSTOP(I2C_TypeDef* I2Cx, FunctionalState NewState);
262
void I2C_AcknowledgeConfig(I2C_TypeDef* I2Cx, FunctionalState NewState);
263
void I2C_OwnAddress2Config(I2C_TypeDef* I2Cx, u8 Address);
264
void I2C_DualAddressCmd(I2C_TypeDef* I2Cx, FunctionalState NewState);
265
void I2C_GeneralCallCmd(I2C_TypeDef* I2Cx, FunctionalState NewState);
266
void I2C_ITConfig(I2C_TypeDef* I2Cx, u16 I2C_IT, FunctionalState NewState);
267
void I2C_SendData(I2C_TypeDef* I2Cx, u8 Data);
268
u8 I2C_ReceiveData(I2C_TypeDef* I2Cx);
269
void I2C_Send7bitAddress(I2C_TypeDef* I2Cx, u8 Address, u8 I2C_Direction);
270
u16 I2C_ReadRegister(I2C_TypeDef* I2Cx, u8 I2C_Register);
271
void I2C_SoftwareResetCmd(I2C_TypeDef* I2Cx, FunctionalState NewState);
272
void I2C_SMBusAlertConfig(I2C_TypeDef* I2Cx, u16 I2C_SMBusAlert);
273
void I2C_TransmitPEC(I2C_TypeDef* I2Cx, FunctionalState NewState);
274
void I2C_PECPositionConfig(I2C_TypeDef* I2Cx, u16 I2C_PECPosition);
275
void I2C_CalculatePEC(I2C_TypeDef* I2Cx, FunctionalState NewState);
276
u8 I2C_GetPEC(I2C_TypeDef* I2Cx);
277
void I2C_ARPCmd(I2C_TypeDef* I2Cx, FunctionalState NewState);
278
void I2C_StretchClockCmd(I2C_TypeDef* I2Cx, FunctionalState NewState);
279
void I2C_FastModeDutyCycleConfig(I2C_TypeDef* I2Cx, u16 I2C_DutyCycle);
280
u32 I2C_GetLastEvent(I2C_TypeDef* I2Cx);
281
ErrorStatus I2C_CheckEvent(I2C_TypeDef* I2Cx, u32 I2C_EVENT);
282
FlagStatus I2C_GetFlagStatus(I2C_TypeDef* I2Cx, u32 I2C_FLAG);
283
void I2C_ClearFlag(I2C_TypeDef* I2Cx, u32 I2C_FLAG);
284
ITStatus I2C_GetITStatus(I2C_TypeDef* I2Cx, u32 I2C_IT);
285
void I2C_ClearITPendingBit(I2C_TypeDef* I2Cx, u32 I2C_IT);
286
 
287
#endif /*__STM32F10x_I2C_H */
288
 
289
/******************* (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.