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