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