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