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