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