Subversion Repositories Kolibri OS

Rev

Rev 3243 | Rev 5056 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1408 serge 1
/* ------------------------------------------------------------------------- */
2
/*									     */
3
/* i2c.h - definitions for the i2c-bus interface			     */
4
/*									     */
5
/* ------------------------------------------------------------------------- */
6
/*   Copyright (C) 1995-2000 Simon G. Vogl
7
 
8
    This program is free software; you can redistribute it and/or modify
9
    it under the terms of the GNU General Public License as published by
10
    the Free Software Foundation; either version 2 of the License, or
11
    (at your option) any later version.
12
 
13
    This program is distributed in the hope that it will be useful,
14
    but WITHOUT ANY WARRANTY; without even the implied warranty of
15
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
    GNU General Public License for more details.
17
 
18
    You should have received a copy of the GNU General Public License
19
    along with this program; if not, write to the Free Software
3031 serge 20
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
21
    MA 02110-1301 USA.							     */
1408 serge 22
/* ------------------------------------------------------------------------- */
23
 
24
/* With some changes from Kyösti Mälkki  and
25
   Frodo Looijaard  */
26
#ifndef _LINUX_I2C_H
27
#define _LINUX_I2C_H
28
 
1964 serge 29
#include 
30
#ifdef __KERNEL__
1430 serge 31
#include 
32
#include 
1964 serge 33
#include 
1408 serge 34
 
3031 serge 35
extern struct bus_type i2c_bus_type;
36
extern struct device_type i2c_adapter_type;
1408 serge 37
 
1964 serge 38
/* --- General options ------------------------------------------------	*/
1408 serge 39
 
40
struct i2c_msg;
41
struct i2c_algorithm;
42
struct i2c_adapter;
43
struct i2c_client;
1964 serge 44
struct i2c_driver;
1408 serge 45
union i2c_smbus_data;
1964 serge 46
struct i2c_board_info;
1408 serge 47
 
48
 
49
/* Transfer num messages.
50
 */
51
extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
52
			int num);
53
 
54
/**
1430 serge 55
 * struct i2c_driver - represent an I2C device driver
56
 * @class: What kind of i2c device we instantiate (for detect)
1970 serge 57
 * @attach_adapter: Callback for bus addition (deprecated)
1430 serge 58
 * @probe: Callback for device binding
59
 * @remove: Callback for device unbinding
60
 * @shutdown: Callback for device shutdown
61
 * @suspend: Callback for device suspend
62
 * @resume: Callback for device resume
1964 serge 63
 * @alert: Alert callback, for example for the SMBus alert protocol
1430 serge 64
 * @command: Callback for bus-wide signaling (optional)
65
 * @driver: Device driver model driver
66
 * @id_table: List of I2C devices supported by this driver
67
 * @detect: Callback for device detection
68
 * @address_list: The I2C addresses to probe (for detect)
69
 * @clients: List of detected clients we created (for i2c-core use only)
70
 *
71
 * The driver.owner field should be set to the module owner of this driver.
72
 * The driver.name field should be set to the name of this driver.
73
 *
3031 serge 74
 * For automatic device detection, both @detect and @address_list must
1430 serge 75
 * be defined. @class should also be set, otherwise only devices forced
76
 * with module parameters will be created. The detect function must
77
 * fill at least the name field of the i2c_board_info structure it is
78
 * handed upon successful detection, and possibly also the flags field.
79
 *
80
 * If @detect is missing, the driver will still work fine for enumerated
81
 * devices. Detected devices simply won't be supported. This is expected
82
 * for the many I2C/SMBus devices which can't be detected reliably, and
83
 * the ones which can always be enumerated in practice.
84
 *
85
 * The i2c_client structure which is handed to the @detect callback is
86
 * not a real i2c_client. It is initialized just enough so that you can
87
 * call i2c_smbus_read_byte_data and friends on it. Don't do anything
88
 * else with it. In particular, calling dev_dbg and friends on it is
89
 * not allowed.
90
 */
91
struct i2c_driver {
92
	unsigned int class;
93
 
4065 Serge 94
	/* Notifies the driver that a new bus has appeared. You should avoid
95
	 * using this, it will be removed in a near future.
1430 serge 96
	 */
1970 serge 97
	int (*attach_adapter)(struct i2c_adapter *) __deprecated;
1430 serge 98
 
99
	/* Standard driver model interfaces */
100
	int (*probe)(struct i2c_client *, const struct i2c_device_id *);
101
	int (*remove)(struct i2c_client *);
102
 
103
	/* driver model interfaces that don't relate to enumeration  */
104
	void (*shutdown)(struct i2c_client *);
105
//	int (*suspend)(struct i2c_client *, pm_message_t mesg);
106
	int (*resume)(struct i2c_client *);
107
 
108
	/* Alert callback, for example for the SMBus alert protocol.
109
	 * The format and meaning of the data value depends on the protocol.
110
	 * For the SMBus alert protocol, there is a single bit of data passed
111
	 * as the alert response's low bit ("event flag").
112
	 */
113
	void (*alert)(struct i2c_client *, unsigned int data);
114
 
115
	/* a ioctl like command that can be used to perform specific functions
116
	 * with the device.
117
	 */
118
	int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
119
 
120
//	struct device_driver driver;
121
	const struct i2c_device_id *id_table;
122
 
123
	/* Device detection callback for automatic device creation */
124
//	int (*detect)(struct i2c_client *, struct i2c_board_info *);
125
	const unsigned short *address_list;
126
	struct list_head clients;
127
};
128
#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
129
 
130
/**
1408 serge 131
 * struct i2c_client - represent an I2C slave device
132
 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
133
 *	I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
134
 * @addr: Address used on the I2C bus connected to the parent adapter.
135
 * @name: Indicates the type of the device, usually a chip name that's
136
 *	generic enough to hide second-sourcing and compatible revisions.
137
 * @adapter: manages the bus segment hosting this I2C device
138
 * @driver: device's driver, hence pointer to access routines
139
 * @dev: Driver model device node for the slave.
140
 * @irq: indicates the IRQ generated by this device (if any)
141
 * @detected: member of an i2c_driver.clients list or i2c-core's
142
 *	userspace_devices list
143
 *
144
 * An i2c_client identifies a single device (i.e. chip) connected to an
145
 * i2c bus. The behaviour exposed to Linux is defined by the driver
146
 * managing the device.
147
 */
148
struct i2c_client {
149
	unsigned short flags;		/* div., see below		*/
150
	unsigned short addr;		/* chip address - NOTE: 7bit	*/
151
					/* addresses are stored in the	*/
152
					/* _LOWER_ 7 bits		*/
153
	char name[I2C_NAME_SIZE];
154
	struct i2c_adapter *adapter;	/* the adapter we sit on	*/
1430 serge 155
    struct i2c_driver *driver;      /* and our access routines      */
1964 serge 156
	struct device dev;		/* the device structure		*/
157
	int irq;			/* irq issued by device		*/
1408 serge 158
	struct list_head detected;
159
};
160
#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
161
 
1430 serge 162
extern struct i2c_client *i2c_verify_client(struct device *dev);
1408 serge 163
 
1964 serge 164
/**
165
 * struct i2c_board_info - template for device creation
166
 * @type: chip type, to initialize i2c_client.name
167
 * @flags: to initialize i2c_client.flags
168
 * @addr: stored in i2c_client.addr
169
 * @platform_data: stored in i2c_client.dev.platform_data
170
 * @archdata: copied into i2c_client.dev.archdata
171
 * @of_node: pointer to OpenFirmware device node
3243 Serge 172
 * @acpi_node: ACPI device node
1964 serge 173
 * @irq: stored in i2c_client.irq
174
 *
175
 * I2C doesn't actually support hardware probing, although controllers and
176
 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
177
 * a device at a given address.  Drivers commonly need more information than
178
 * that, such as chip type, configuration, associated IRQ, and so on.
179
 *
180
 * i2c_board_info is used to build tables of information listing I2C devices
181
 * that are present.  This information is used to grow the driver model tree.
182
 * For mainboards this is done statically using i2c_register_board_info();
183
 * bus numbers identify adapters that aren't yet available.  For add-on boards,
184
 * i2c_new_device() does this dynamically with the adapter already known.
185
 */
186
struct i2c_board_info {
187
	char		type[I2C_NAME_SIZE];
188
	unsigned short	flags;
189
	unsigned short	addr;
190
	void		*platform_data;
191
	struct dev_archdata	*archdata;
192
	int		irq;
193
};
194
 
195
/**
196
 * I2C_BOARD_INFO - macro used to list an i2c device and its address
197
 * @dev_type: identifies the device type
198
 * @dev_addr: the device's address on the bus.
199
 *
200
 * This macro initializes essential fields of a struct i2c_board_info,
201
 * declaring what has been provided on a particular board.  Optional
202
 * fields (such as associated irq, or device-specific platform_data)
203
 * are provided using conventional syntax.
204
 */
205
#define I2C_BOARD_INFO(dev_type, dev_addr) \
206
	.type = dev_type, .addr = (dev_addr)
1408 serge 207
/*
208
 * The following structs are for those who like to implement new bus drivers:
209
 * i2c_algorithm is the interface to a class of hardware solutions which can
210
 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
211
 * to name two of the most common.
212
 */
213
struct i2c_algorithm {
214
	/* If an adapter algorithm can't do I2C-level access, set master_xfer
215
	   to NULL. If an adapter algorithm can do SMBus access, set
216
	   smbus_xfer. If set to NULL, the SMBus protocol is simulated
217
	   using common I2C messages */
218
	/* master_xfer should return the number of messages successfully
219
	   processed, or a negative value on error */
220
	int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
221
			   int num);
222
	int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
223
			   unsigned short flags, char read_write,
224
			   u8 command, int size, union i2c_smbus_data *data);
225
 
226
	/* To determine what the adapter supports */
227
	u32 (*functionality) (struct i2c_adapter *);
228
};
229
 
230
/*
231
 * i2c_adapter is the structure used to identify a physical i2c bus along
232
 * with the access algorithms necessary to access it.
233
 */
234
struct i2c_adapter {
1964 serge 235
	struct module *owner;
1408 serge 236
	unsigned int class;		  /* classes to allow probing for */
237
	const struct i2c_algorithm *algo; /* the algorithm to access the bus */
238
	void *algo_data;
239
 
240
        /* data fields that are valid for all devices   */
1430 serge 241
//	struct rt_mutex bus_lock;
1408 serge 242
 
243
	int timeout;			/* in jiffies */
244
    int retries;
1430 serge 245
    struct device dev;      /* the adapter device */
1408 serge 246
 
247
    int nr;
248
    char name[48];
249
};
250
#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
251
 
1970 serge 252
static inline void *i2c_get_adapdata(struct i2c_adapter *dev)
1430 serge 253
{
254
	return dev_get_drvdata(&dev->dev);
255
}
1408 serge 256
 
1430 serge 257
static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
258
{
259
	dev_set_drvdata(&dev->dev, data);
260
}
261
 
1964 serge 262
/* Adapter locking functions, exported for shared pin cases */
263
void i2c_lock_adapter(struct i2c_adapter *);
264
void i2c_unlock_adapter(struct i2c_adapter *);
265
 
1408 serge 266
/*flags for the client struct: */
267
#define I2C_CLIENT_PEC	0x04		/* Use Packet Error Checking */
268
#define I2C_CLIENT_TEN	0x10		/* we have a ten bit chip address */
269
					/* Must equal I2C_M_TEN below */
270
#define I2C_CLIENT_WAKE	0x80		/* for board_info; true iff can wake */
3031 serge 271
#define I2C_CLIENT_SCCB	0x9000		/* Use Omnivision SCCB protocol */
272
					/* Must match I2C_M_STOP|IGNORE_NAK */
1408 serge 273
 
274
/* i2c adapter classes (bitmask) */
275
#define I2C_CLASS_HWMON		(1<<0)	/* lm_sensors, ... */
276
#define I2C_CLASS_DDC		(1<<3)	/* DDC bus on graphics adapters */
1964 serge 277
#define I2C_CLASS_SPD		(1<<7)	/* Memory modules */
1408 serge 278
 
279
/* Internal numbers to terminate lists */
280
#define I2C_CLIENT_END		0xfffeU
281
 
282
/* Construct an I2C_CLIENT_END-terminated array of i2c addresses */
283
#define I2C_ADDRS(addr, addrs...) \
284
	((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END })
285
 
286
 
1964 serge 287
#endif /* __KERNEL__ */
2967 Serge 288
 
1408 serge 289
/**
290
 * struct i2c_msg - an I2C transaction segment beginning with START
291
 * @addr: Slave address, either seven or ten bits.  When this is a ten
292
 *	bit address, I2C_M_TEN must be set in @flags and the adapter
293
 *	must support I2C_FUNC_10BIT_ADDR.
294
 * @flags: I2C_M_RD is handled by all adapters.  No other flags may be
295
 *	provided unless the adapter exported the relevant I2C_FUNC_*
296
 *	flags through i2c_check_functionality().
297
 * @len: Number of data bytes in @buf being read from or written to the
298
 *	I2C slave address.  For read transactions where I2C_M_RECV_LEN
299
 *	is set, the caller guarantees that this buffer can hold up to
300
 *	32 bytes in addition to the initial length byte sent by the
301
 *	slave (plus, if used, the SMBus PEC); and this value will be
302
 *	incremented by the number of block data bytes received.
303
 * @buf: The buffer into which data is read, or from which it's written.
304
 *
305
 * An i2c_msg is the low level representation of one segment of an I2C
306
 * transaction.  It is visible to drivers in the @i2c_transfer() procedure,
307
 * to userspace from i2c-dev, and to I2C adapter drivers through the
308
 * @i2c_adapter.@master_xfer() method.
309
 *
310
 * Except when I2C "protocol mangling" is used, all I2C adapters implement
311
 * the standard rules for I2C transactions.  Each transaction begins with a
312
 * START.  That is followed by the slave address, and a bit encoding read
313
 * versus write.  Then follow all the data bytes, possibly including a byte
314
 * with SMBus PEC.  The transfer terminates with a NAK, or when all those
315
 * bytes have been transferred and ACKed.  If this is the last message in a
316
 * group, it is followed by a STOP.  Otherwise it is followed by the next
317
 * @i2c_msg transaction segment, beginning with a (repeated) START.
318
 *
319
 * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
320
 * passing certain @flags may have changed those standard protocol behaviors.
321
 * Those flags are only for use with broken/nonconforming slaves, and with
322
 * adapters which are known to support the specific mangling options they
323
 * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
324
 */
325
struct i2c_msg {
1964 serge 326
	__u16 addr;	/* slave address			*/
327
	__u16 flags;
1408 serge 328
#define I2C_M_TEN               0x0010  /* this is a ten bit chip address */
329
#define I2C_M_RD                0x0001  /* read data, from slave to master */
330
#define I2C_M_NOSTART           0x4000  /* if I2C_FUNC_PROTOCOL_MANGLING */
331
#define I2C_M_REV_DIR_ADDR      0x2000  /* if I2C_FUNC_PROTOCOL_MANGLING */
332
#define I2C_M_IGNORE_NAK        0x1000  /* if I2C_FUNC_PROTOCOL_MANGLING */
333
#define I2C_M_NO_RD_ACK         0x0800  /* if I2C_FUNC_PROTOCOL_MANGLING */
334
#define I2C_M_RECV_LEN          0x0400  /* length will be first received byte */
1964 serge 335
	__u16 len;		/* msg length				*/
336
	__u8 *buf;		/* pointer to msg data			*/
1408 serge 337
};
338
 
339
/* To determine what functionality is present */
340
 
341
#define I2C_FUNC_I2C			0x00000001
342
#define I2C_FUNC_10BIT_ADDR		0x00000002
343
#define I2C_FUNC_PROTOCOL_MANGLING	0x00000004 /* I2C_M_NOSTART etc. */
344
#define I2C_FUNC_SMBUS_PEC		0x00000008
345
#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL	0x00008000 /* SMBus 2.0 */
346
#define I2C_FUNC_SMBUS_QUICK		0x00010000
347
#define I2C_FUNC_SMBUS_READ_BYTE	0x00020000
348
#define I2C_FUNC_SMBUS_WRITE_BYTE	0x00040000
349
#define I2C_FUNC_SMBUS_READ_BYTE_DATA	0x00080000
350
#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA	0x00100000
351
#define I2C_FUNC_SMBUS_READ_WORD_DATA	0x00200000
352
#define I2C_FUNC_SMBUS_WRITE_WORD_DATA	0x00400000
353
#define I2C_FUNC_SMBUS_PROC_CALL	0x00800000
354
#define I2C_FUNC_SMBUS_READ_BLOCK_DATA	0x01000000
355
#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
356
#define I2C_FUNC_SMBUS_READ_I2C_BLOCK	0x04000000 /* I2C-like block xfer  */
357
#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK	0x08000000 /* w/ 1-byte reg. addr. */
358
 
359
#define I2C_FUNC_SMBUS_BYTE		(I2C_FUNC_SMBUS_READ_BYTE | \
360
					 I2C_FUNC_SMBUS_WRITE_BYTE)
361
#define I2C_FUNC_SMBUS_BYTE_DATA	(I2C_FUNC_SMBUS_READ_BYTE_DATA | \
362
					 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
363
#define I2C_FUNC_SMBUS_WORD_DATA	(I2C_FUNC_SMBUS_READ_WORD_DATA | \
364
					 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
365
#define I2C_FUNC_SMBUS_BLOCK_DATA	(I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
366
					 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
367
#define I2C_FUNC_SMBUS_I2C_BLOCK	(I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
368
					 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
369
 
370
#define I2C_FUNC_SMBUS_EMUL		(I2C_FUNC_SMBUS_QUICK | \
371
					 I2C_FUNC_SMBUS_BYTE | \
372
					 I2C_FUNC_SMBUS_BYTE_DATA | \
373
					 I2C_FUNC_SMBUS_WORD_DATA | \
374
					 I2C_FUNC_SMBUS_PROC_CALL | \
375
					 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
376
					 I2C_FUNC_SMBUS_I2C_BLOCK | \
377
					 I2C_FUNC_SMBUS_PEC)
378
 
379
/*
380
 * Data for SMBus Messages
381
 */
382
#define I2C_SMBUS_BLOCK_MAX	32	/* As specified in SMBus standard */
383
union i2c_smbus_data {
384
	__u8 byte;
385
	__u16 word;
386
	__u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
387
			       /* and one more for user-space compatibility */
388
};
389
 
390
/* i2c_smbus_xfer read or write markers */
391
#define I2C_SMBUS_READ	1
392
#define I2C_SMBUS_WRITE	0
393
 
394
/* SMBus transaction types (size parameter in the above functions)
395
   Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
396
#define I2C_SMBUS_QUICK		    0
397
#define I2C_SMBUS_BYTE		    1
398
#define I2C_SMBUS_BYTE_DATA	    2
399
#define I2C_SMBUS_WORD_DATA	    3
400
#define I2C_SMBUS_PROC_CALL	    4
401
#define I2C_SMBUS_BLOCK_DATA	    5
402
#define I2C_SMBUS_I2C_BLOCK_BROKEN  6
403
#define I2C_SMBUS_BLOCK_PROC_CALL   7		/* SMBus 2.0 */
404
#define I2C_SMBUS_I2C_BLOCK_DATA    8
405
 
3192 Serge 406
#define i2c_add_adapter(x)      0
407
#define i2c_del_adapter(x)
408
 
1408 serge 409
#endif /* _LINUX_I2C_H */