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