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