xref: /linux-6.15/include/linux/i2c.h (revision 4bedea94)
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
20     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.		     */
21 /* ------------------------------------------------------------------------- */
22 
23 /* With some changes from Ky�sti M�lkki <[email protected]> and
24    Frodo Looijaard <[email protected]> */
25 
26 /* $Id: i2c.h,v 1.68 2003/01/21 08:08:16 kmalkki Exp $ */
27 
28 #ifndef _LINUX_I2C_H
29 #define _LINUX_I2C_H
30 
31 #include <linux/module.h>
32 #include <linux/types.h>
33 #include <linux/i2c-id.h>
34 #include <linux/device.h>	/* for struct device */
35 #include <asm/semaphore.h>
36 
37 /* --- General options ------------------------------------------------	*/
38 
39 struct i2c_msg;
40 struct i2c_algorithm;
41 struct i2c_adapter;
42 struct i2c_client;
43 struct i2c_driver;
44 struct i2c_client_address_data;
45 union i2c_smbus_data;
46 
47 /*
48  * The master routines are the ones normally used to transmit data to devices
49  * on a bus (or read from them). Apart from two basic transfer functions to
50  * transmit one message at a time, a more complex version can be used to
51  * transmit an arbitrary number of messages without interruption.
52  */
53 extern int i2c_master_send(struct i2c_client *,const char* ,int);
54 extern int i2c_master_recv(struct i2c_client *,char* ,int);
55 
56 /* Transfer num messages.
57  */
58 extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
59 
60 /*
61  * Some adapter types (i.e. PCF 8584 based ones) may support slave behaviuor.
62  * This is not tested/implemented yet and will change in the future.
63  */
64 extern int i2c_slave_send(struct i2c_client *,char*,int);
65 extern int i2c_slave_recv(struct i2c_client *,char*,int);
66 
67 
68 
69 /* This is the very generalized SMBus access routine. You probably do not
70    want to use this, though; one of the functions below may be much easier,
71    and probably just as fast.
72    Note that we use i2c_adapter here, because you do not need a specific
73    smbus adapter to call this function. */
74 extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
75                            unsigned short flags,
76                            char read_write, u8 command, int size,
77                            union i2c_smbus_data * data);
78 
79 /* Now follow the 'nice' access routines. These also document the calling
80    conventions of smbus_access. */
81 
82 extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
83 extern s32 i2c_smbus_read_byte(struct i2c_client * client);
84 extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
85 extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
86 extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
87                                      u8 command, u8 value);
88 extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
89 extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
90                                      u8 command, u16 value);
91 /* Returns the number of bytes transferred */
92 extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
93 				      u8 command, u8 length,
94 				      u8 *values);
95 extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
96 					 u8 command, u8 *values);
97 
98 /*
99  * A driver is capable of handling one or more physical devices present on
100  * I2C adapters. This information is used to inform the driver of adapter
101  * events.
102  */
103 
104 struct i2c_driver {
105 	struct module *owner;
106 	char name[32];
107 	int id;
108 	unsigned int class;
109 	unsigned int flags;		/* div., see below		*/
110 
111 	/* Notifies the driver that a new bus has appeared. This routine
112 	 * can be used by the driver to test if the bus meets its conditions
113 	 * & seek for the presence of the chip(s) it supports. If found, it
114 	 * registers the client(s) that are on the bus to the i2c admin. via
115 	 * i2c_attach_client.
116 	 */
117 	int (*attach_adapter)(struct i2c_adapter *);
118 	int (*detach_adapter)(struct i2c_adapter *);
119 
120 	/* tells the driver that a client is about to be deleted & gives it
121 	 * the chance to remove its private data. Also, if the client struct
122 	 * has been dynamically allocated by the driver in the function above,
123 	 * it must be freed here.
124 	 */
125 	int (*detach_client)(struct i2c_client *);
126 
127 	/* a ioctl like command that can be used to perform specific functions
128 	 * with the device.
129 	 */
130 	int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
131 
132 	struct device_driver driver;
133 	struct list_head list;
134 };
135 #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
136 
137 #define I2C_NAME_SIZE	50
138 
139 /*
140  * i2c_client identifies a single device (i.e. chip) that is connected to an
141  * i2c bus. The behaviour is defined by the routines of the driver. This
142  * function is mainly used for lookup & other admin. functions.
143  */
144 struct i2c_client {
145 	unsigned int flags;		/* div., see below		*/
146 	unsigned int addr;		/* chip address - NOTE: 7bit 	*/
147 					/* addresses are stored in the	*/
148 					/* _LOWER_ 7 bits of this char	*/
149 	/* addr: unsigned int to make lm_sensors i2c-isa adapter work
150 	  more cleanly. It does not take any more memory space, due to
151 	  alignment considerations */
152 	struct i2c_adapter *adapter;	/* the adapter we sit on	*/
153 	struct i2c_driver *driver;	/* and our access routines	*/
154 	int usage_count;		/* How many accesses currently  */
155 					/* to the client		*/
156 	struct device dev;		/* the device structure		*/
157 	struct list_head list;
158 	char name[I2C_NAME_SIZE];
159 	struct completion released;
160 };
161 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
162 
163 static inline void *i2c_get_clientdata (struct i2c_client *dev)
164 {
165 	return dev_get_drvdata (&dev->dev);
166 }
167 
168 static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
169 {
170 	dev_set_drvdata (&dev->dev, data);
171 }
172 
173 #define I2C_DEVNAME(str)	.name = str
174 
175 static inline char *i2c_clientname(struct i2c_client *c)
176 {
177 	return &c->name[0];
178 }
179 
180 /*
181  * The following structs are for those who like to implement new bus drivers:
182  * i2c_algorithm is the interface to a class of hardware solutions which can
183  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
184  * to name two of the most common.
185  */
186 struct i2c_algorithm {
187 	char name[32];				/* textual description 	*/
188 	unsigned int id;
189 
190 	/* If an adapter algorithm can't do I2C-level access, set master_xfer
191 	   to NULL. If an adapter algorithm can do SMBus access, set
192 	   smbus_xfer. If set to NULL, the SMBus protocol is simulated
193 	   using common I2C messages */
194 	int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
195 	                   int num);
196 	int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
197 	                   unsigned short flags, char read_write,
198 	                   u8 command, int size, union i2c_smbus_data * data);
199 
200 	/* --- these optional/future use for some adapter types.*/
201 	int (*slave_send)(struct i2c_adapter *,char*,int);
202 	int (*slave_recv)(struct i2c_adapter *,char*,int);
203 
204 	/* --- ioctl like call to set div. parameters. */
205 	int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
206 
207 	/* To determine what the adapter supports */
208 	u32 (*functionality) (struct i2c_adapter *);
209 };
210 
211 /*
212  * i2c_adapter is the structure used to identify a physical i2c bus along
213  * with the access algorithms necessary to access it.
214  */
215 struct i2c_adapter {
216 	struct module *owner;
217 	unsigned int id;/* == is algo->id | hwdep.struct->id, 		*/
218 			/* for registered values see below		*/
219 	unsigned int class;
220 	struct i2c_algorithm *algo;/* the algorithm to access the bus	*/
221 	void *algo_data;
222 
223 	/* --- administration stuff. */
224 	int (*client_register)(struct i2c_client *);
225 	int (*client_unregister)(struct i2c_client *);
226 
227 	/* data fields that are valid for all devices	*/
228 	struct semaphore bus_lock;
229 	struct semaphore clist_lock;
230 
231 	int timeout;
232 	int retries;
233 	struct device dev;		/* the adapter device */
234 	struct class_device class_dev;	/* the class device */
235 
236 #ifdef CONFIG_PROC_FS
237 	/* No need to set this when you initialize the adapter          */
238 	int inode;
239 #endif /* def CONFIG_PROC_FS */
240 
241 	int nr;
242 	struct list_head clients;
243 	struct list_head list;
244 	char name[I2C_NAME_SIZE];
245 	struct completion dev_released;
246 	struct completion class_dev_released;
247 };
248 #define dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
249 #define class_dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, class_dev)
250 
251 static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
252 {
253 	return dev_get_drvdata (&dev->dev);
254 }
255 
256 static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
257 {
258 	dev_set_drvdata (&dev->dev, data);
259 }
260 
261 /*flags for the driver struct: */
262 #define I2C_DF_NOTIFY	0x01		/* notify on bus (de/a)ttaches 	*/
263 #if 0
264 /* this flag is gone -- there is a (optional) driver->detach_adapter
265  * callback now which can be used instead */
266 # define I2C_DF_DUMMY	0x02
267 #endif
268 
269 /*flags for the client struct: */
270 #define I2C_CLIENT_ALLOW_USE		0x01	/* Client allows access */
271 #define I2C_CLIENT_ALLOW_MULTIPLE_USE 	0x02  	/* Allow multiple access-locks */
272 						/* on an i2c_client */
273 #define I2C_CLIENT_PEC  0x04			/* Use Packet Error Checking */
274 #define I2C_CLIENT_TEN	0x10			/* we have a ten bit chip address	*/
275 						/* Must equal I2C_M_TEN below */
276 
277 /* i2c adapter classes (bitmask) */
278 #define I2C_CLASS_HWMON		(1<<0)	/* lm_sensors, ... */
279 #define I2C_CLASS_TV_ANALOG	(1<<1)	/* bttv + friends */
280 #define I2C_CLASS_TV_DIGITAL	(1<<2)	/* dvb cards */
281 #define I2C_CLASS_DDC		(1<<3)	/* i2c-matroxfb ? */
282 #define I2C_CLASS_CAM_ANALOG	(1<<4)	/* camera with analog CCD */
283 #define I2C_CLASS_CAM_DIGITAL	(1<<5)	/* most webcams */
284 #define I2C_CLASS_SOUND		(1<<6)	/* sound devices */
285 #define I2C_CLASS_ALL		(UINT_MAX) /* all of the above */
286 
287 /* i2c_client_address_data is the struct for holding default client
288  * addresses for a driver and for the parameters supplied on the
289  * command line
290  */
291 struct i2c_client_address_data {
292 	unsigned short *normal_i2c;
293 	unsigned short *probe;
294 	unsigned short *ignore;
295 	unsigned short *force;
296 };
297 
298 /* Internal numbers to terminate lists */
299 #define I2C_CLIENT_END		0xfffeU
300 #define I2C_CLIENT_ISA_END	0xfffefffeU
301 
302 /* The numbers to use to set I2C bus address */
303 #define ANY_I2C_BUS		0xffff
304 #define ANY_I2C_ISA_BUS		9191
305 
306 
307 /* ----- functions exported by i2c.o */
308 
309 /* administration...
310  */
311 extern int i2c_add_adapter(struct i2c_adapter *);
312 extern int i2c_del_adapter(struct i2c_adapter *);
313 
314 extern int i2c_add_driver(struct i2c_driver *);
315 extern int i2c_del_driver(struct i2c_driver *);
316 
317 extern int i2c_attach_client(struct i2c_client *);
318 extern int i2c_detach_client(struct i2c_client *);
319 
320 /* New function: This is to get an i2c_client-struct for controlling the
321    client either by using i2c_control-function or having the
322    client-module export functions that can be used with the i2c_client
323    -struct. */
324 extern struct i2c_client *i2c_get_client(int driver_id, int adapter_id,
325 					struct i2c_client *prev);
326 
327 /* Should be used with new function
328    extern struct i2c_client *i2c_get_client(int,int,struct i2c_client *);
329    to make sure that client-struct is valid and that it is okay to access
330    the i2c-client.
331    returns -EACCES if client doesn't allow use (default)
332    returns -EBUSY if client doesn't allow multiple use (default) and
333    usage_count >0 */
334 extern int i2c_use_client(struct i2c_client *);
335 extern int i2c_release_client(struct i2c_client *);
336 
337 /* call the i2c_client->command() of all attached clients with
338  * the given arguments */
339 extern void i2c_clients_command(struct i2c_adapter *adap,
340 				unsigned int cmd, void *arg);
341 
342 /* returns -EBUSY if address has been taken, 0 if not. Note that the only
343    other place at which this is called is within i2c_attach_client; so
344    you can cheat by simply not registering. Not recommended, of course! */
345 extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
346 
347 /* Detect function. It iterates over all possible addresses itself.
348  * It will only call found_proc if some client is connected at the
349  * specific address (unless a 'force' matched);
350  */
351 extern int i2c_probe(struct i2c_adapter *adapter,
352 		struct i2c_client_address_data *address_data,
353 		int (*found_proc) (struct i2c_adapter *, int, int));
354 
355 /* An ioctl like call to set div. parameters of the adapter.
356  */
357 extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
358 
359 /* This call returns a unique low identifier for each registered adapter,
360  * or -1 if the adapter was not registered.
361  */
362 extern int i2c_adapter_id(struct i2c_adapter *adap);
363 extern struct i2c_adapter* i2c_get_adapter(int id);
364 extern void i2c_put_adapter(struct i2c_adapter *adap);
365 
366 
367 /* Return the functionality mask */
368 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
369 {
370 	return adap->algo->functionality(adap);
371 }
372 
373 /* Return 1 if adapter supports everything we need, 0 if not. */
374 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
375 {
376 	return (func & i2c_get_functionality(adap)) == func;
377 }
378 
379 /*
380  * I2C Message - used for pure i2c transaction, also from /dev interface
381  */
382 struct i2c_msg {
383 	__u16 addr;	/* slave address			*/
384  	__u16 flags;
385 #define I2C_M_TEN	0x10	/* we have a ten bit chip address	*/
386 #define I2C_M_RD	0x01
387 #define I2C_M_NOSTART	0x4000
388 #define I2C_M_REV_DIR_ADDR	0x2000
389 #define I2C_M_IGNORE_NAK	0x1000
390 #define I2C_M_NO_RD_ACK		0x0800
391  	__u16 len;		/* msg length				*/
392  	__u8 *buf;		/* pointer to msg data			*/
393 };
394 
395 /* To determine what functionality is present */
396 
397 #define I2C_FUNC_I2C			0x00000001
398 #define I2C_FUNC_10BIT_ADDR		0x00000002
399 #define I2C_FUNC_PROTOCOL_MANGLING	0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
400 #define I2C_FUNC_SMBUS_HWPEC_CALC	0x00000008 /* SMBus 2.0 */
401 #define I2C_FUNC_SMBUS_READ_WORD_DATA_PEC  0x00000800 /* SMBus 2.0 */
402 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA_PEC 0x00001000 /* SMBus 2.0 */
403 #define I2C_FUNC_SMBUS_PROC_CALL_PEC	0x00002000 /* SMBus 2.0 */
404 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL_PEC 0x00004000 /* SMBus 2.0 */
405 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL	0x00008000 /* SMBus 2.0 */
406 #define I2C_FUNC_SMBUS_QUICK		0x00010000
407 #define I2C_FUNC_SMBUS_READ_BYTE	0x00020000
408 #define I2C_FUNC_SMBUS_WRITE_BYTE	0x00040000
409 #define I2C_FUNC_SMBUS_READ_BYTE_DATA	0x00080000
410 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA	0x00100000
411 #define I2C_FUNC_SMBUS_READ_WORD_DATA	0x00200000
412 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA	0x00400000
413 #define I2C_FUNC_SMBUS_PROC_CALL	0x00800000
414 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA	0x01000000
415 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
416 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK	0x04000000 /* I2C-like block xfer  */
417 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK	0x08000000 /* w/ 1-byte reg. addr. */
418 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2	 0x10000000 /* I2C-like block xfer  */
419 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
420 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA_PEC  0x40000000 /* SMBus 2.0 */
421 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC 0x80000000 /* SMBus 2.0 */
422 
423 #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
424                              I2C_FUNC_SMBUS_WRITE_BYTE)
425 #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
426                                   I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
427 #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
428                                   I2C_FUNC_SMBUS_WRITE_WORD_DATA)
429 #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
430                                    I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
431 #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
432                                   I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
433 #define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
434                                     I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
435 #define I2C_FUNC_SMBUS_BLOCK_DATA_PEC (I2C_FUNC_SMBUS_READ_BLOCK_DATA_PEC | \
436                                        I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC)
437 #define I2C_FUNC_SMBUS_WORD_DATA_PEC  (I2C_FUNC_SMBUS_READ_WORD_DATA_PEC | \
438                                        I2C_FUNC_SMBUS_WRITE_WORD_DATA_PEC)
439 
440 #define I2C_FUNC_SMBUS_READ_BYTE_PEC		I2C_FUNC_SMBUS_READ_BYTE_DATA
441 #define I2C_FUNC_SMBUS_WRITE_BYTE_PEC		I2C_FUNC_SMBUS_WRITE_BYTE_DATA
442 #define I2C_FUNC_SMBUS_READ_BYTE_DATA_PEC	I2C_FUNC_SMBUS_READ_WORD_DATA
443 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA_PEC	I2C_FUNC_SMBUS_WRITE_WORD_DATA
444 #define I2C_FUNC_SMBUS_BYTE_PEC			I2C_FUNC_SMBUS_BYTE_DATA
445 #define I2C_FUNC_SMBUS_BYTE_DATA_PEC		I2C_FUNC_SMBUS_WORD_DATA
446 
447 #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
448                              I2C_FUNC_SMBUS_BYTE | \
449                              I2C_FUNC_SMBUS_BYTE_DATA | \
450                              I2C_FUNC_SMBUS_WORD_DATA | \
451                              I2C_FUNC_SMBUS_PROC_CALL | \
452                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
453                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC | \
454                              I2C_FUNC_SMBUS_I2C_BLOCK)
455 
456 /*
457  * Data for SMBus Messages
458  */
459 #define I2C_SMBUS_BLOCK_MAX	32	/* As specified in SMBus standard */
460 #define I2C_SMBUS_I2C_BLOCK_MAX	32	/* Not specified but we use same structure */
461 union i2c_smbus_data {
462 	__u8 byte;
463 	__u16 word;
464 	__u8 block[I2C_SMBUS_BLOCK_MAX + 3]; /* block[0] is used for length */
465                           /* one more for read length in block process call */
466 	                                            /* and one more for PEC */
467 };
468 
469 /* smbus_access read or write markers */
470 #define I2C_SMBUS_READ	1
471 #define I2C_SMBUS_WRITE	0
472 
473 /* SMBus transaction types (size parameter in the above functions)
474    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
475 #define I2C_SMBUS_QUICK		    0
476 #define I2C_SMBUS_BYTE		    1
477 #define I2C_SMBUS_BYTE_DATA	    2
478 #define I2C_SMBUS_WORD_DATA	    3
479 #define I2C_SMBUS_PROC_CALL	    4
480 #define I2C_SMBUS_BLOCK_DATA	    5
481 #define I2C_SMBUS_I2C_BLOCK_DATA    6
482 #define I2C_SMBUS_BLOCK_PROC_CALL   7		/* SMBus 2.0 */
483 #define I2C_SMBUS_BLOCK_DATA_PEC    8		/* SMBus 2.0 */
484 #define I2C_SMBUS_PROC_CALL_PEC     9		/* SMBus 2.0 */
485 #define I2C_SMBUS_BLOCK_PROC_CALL_PEC  10	/* SMBus 2.0 */
486 #define I2C_SMBUS_WORD_DATA_PEC	   11		/* SMBus 2.0 */
487 
488 
489 /* ----- commands for the ioctl like i2c_command call:
490  * note that additional calls are defined in the algorithm and hw
491  *	dependent layers - these can be listed here, or see the
492  *	corresponding header files.
493  */
494 				/* -> bit-adapter specific ioctls	*/
495 #define I2C_RETRIES	0x0701	/* number of times a device address      */
496 				/* should be polled when not            */
497                                 /* acknowledging 			*/
498 #define I2C_TIMEOUT	0x0702	/* set timeout - call with int 		*/
499 
500 
501 /* this is for i2c-dev.c	*/
502 #define I2C_SLAVE	0x0703	/* Change slave address			*/
503 				/* Attn.: Slave address is 7 or 10 bits */
504 #define I2C_SLAVE_FORCE	0x0706	/* Change slave address			*/
505 				/* Attn.: Slave address is 7 or 10 bits */
506 				/* This changes the address, even if it */
507 				/* is already taken!			*/
508 #define I2C_TENBIT	0x0704	/* 0 for 7 bit addrs, != 0 for 10 bit	*/
509 
510 #define I2C_FUNCS	0x0705	/* Get the adapter functionality */
511 #define I2C_RDWR	0x0707	/* Combined R/W transfer (one stop only)*/
512 #define I2C_PEC		0x0708	/* != 0 for SMBus PEC                   */
513 #if 0
514 #define I2C_ACK_TEST	0x0710	/* See if a slave is at a specific address */
515 #endif
516 
517 #define I2C_SMBUS	0x0720	/* SMBus-level access */
518 
519 /* ... algo-bit.c recognizes */
520 #define I2C_UDELAY	0x0705	/* set delay in microsecs between each	*/
521 				/* written byte (except address)	*/
522 #define I2C_MDELAY	0x0706	/* millisec delay between written bytes */
523 
524 /* ----- I2C-DEV: char device interface stuff ------------------------- */
525 
526 #define I2C_MAJOR	89		/* Device major number		*/
527 
528 /* These defines are used for probing i2c client addresses */
529 /* The length of the option lists */
530 #define I2C_CLIENT_MAX_OPTS 48
531 
532 /* Default fill of many variables */
533 #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
534                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
535                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
536                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
537                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
538                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
539                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
540                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
541                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
542                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
543                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
544                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
545                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
546                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
547                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
548                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
549 
550 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
551    module header */
552 
553 #define I2C_CLIENT_MODULE_PARM(var,desc) \
554   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
555   static unsigned int var##_num; \
556   module_param_array(var, short, &var##_num, 0); \
557   MODULE_PARM_DESC(var,desc)
558 
559 /* This is the one you want to use in your own modules */
560 #define I2C_CLIENT_INSMOD \
561   I2C_CLIENT_MODULE_PARM(probe, \
562                       "List of adapter,address pairs to scan additionally"); \
563   I2C_CLIENT_MODULE_PARM(ignore, \
564                       "List of adapter,address pairs not to scan"); \
565   I2C_CLIENT_MODULE_PARM(force, \
566                       "List of adapter,address pairs to boldly assume " \
567                       "to be present"); \
568 	static struct i2c_client_address_data addr_data = {		\
569 			.normal_i2c = 		normal_i2c,		\
570 			.probe =		probe,			\
571 			.ignore =		ignore,			\
572 			.force =		force,			\
573 		}
574 
575 /* Detect whether we are on the isa bus. If this returns true, all i2c
576    access will fail! */
577 #define i2c_is_isa_client(clientptr) \
578         ((clientptr)->adapter->algo->id == I2C_ALGO_ISA)
579 #define i2c_is_isa_adapter(adapptr) \
580         ((adapptr)->algo->id == I2C_ALGO_ISA)
581 
582 #endif /* _LINUX_I2C_H */
583