i2c: Drop redundant i2c_adapter.list
[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 /* --- General options ------------------------------------------------ */
39
40 struct i2c_msg;
41 struct i2c_algorithm;
42 struct i2c_adapter;
43 struct i2c_client;
44 struct i2c_driver;
45 union i2c_smbus_data;
46
47 /*
48  * The master routines are the ones normally used to transmit data to devices
49  * on a bus (or read from them). Apart from two basic transfer functions to
50  * transmit one message at a time, a more complex version can be used to
51  * transmit an arbitrary number of messages without interruption.
52  */
53 extern int i2c_master_send(struct i2c_client *,const char* ,int);
54 extern int i2c_master_recv(struct i2c_client *,char* ,int);
55
56 /* Transfer num messages.
57  */
58 extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
59
60
61 /* This is the very generalized SMBus access routine. You probably do not
62    want to use this, though; one of the functions below may be much easier,
63    and probably just as fast.
64    Note that we use i2c_adapter here, because you do not need a specific
65    smbus adapter to call this function. */
66 extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
67                            unsigned short flags,
68                            char read_write, u8 command, int size,
69                            union i2c_smbus_data * data);
70
71 /* Now follow the 'nice' access routines. These also document the calling
72    conventions of smbus_access. */
73
74 extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
75 extern s32 i2c_smbus_read_byte(struct i2c_client * client);
76 extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
77 extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
78 extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
79                                      u8 command, u8 value);
80 extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
81 extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
82                                      u8 command, u16 value);
83 /* Returns the number of read bytes */
84 extern s32 i2c_smbus_read_block_data(struct i2c_client *client,
85                                      u8 command, u8 *values);
86 extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
87                                       u8 command, u8 length,
88                                       const u8 *values);
89 /* Returns the number of read bytes */
90 extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
91                                          u8 command, u8 length, u8 *values);
92 extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,
93                                           u8 command, u8 length,
94                                           const u8 *values);
95
96 /*
97  * A driver is capable of handling one or more physical devices present on
98  * I2C adapters. This information is used to inform the driver of adapter
99  * events.
100  *
101  * The driver.owner field should be set to the module owner of this driver.
102  * The driver.name field should be set to the name of this driver.
103  */
104
105 struct i2c_driver {
106         int id;
107         unsigned int class;
108
109         /* Notifies the driver that a new bus has appeared. This routine
110          * can be used by the driver to test if the bus meets its conditions
111          * & seek for the presence of the chip(s) it supports. If found, it
112          * registers the client(s) that are on the bus to the i2c admin. via
113          * i2c_attach_client.  (LEGACY I2C DRIVERS ONLY)
114          */
115         int (*attach_adapter)(struct i2c_adapter *);
116         int (*detach_adapter)(struct i2c_adapter *);
117
118         /* tells the driver that a client is about to be deleted & gives it
119          * the chance to remove its private data. Also, if the client struct
120          * has been dynamically allocated by the driver in the function above,
121          * it must be freed here.  (LEGACY I2C DRIVERS ONLY)
122          */
123         int (*detach_client)(struct i2c_client *);
124
125         /* Standard driver model interfaces, for "new style" i2c drivers.
126          * With the driver model, device enumeration is NEVER done by drivers;
127          * it's done by infrastructure.  (NEW STYLE DRIVERS ONLY)
128          */
129         int (*probe)(struct i2c_client *);
130         int (*remove)(struct i2c_client *);
131
132         /* driver model interfaces that don't relate to enumeration  */
133         void (*shutdown)(struct i2c_client *);
134         int (*suspend)(struct i2c_client *, pm_message_t mesg);
135         int (*resume)(struct i2c_client *);
136
137         /* a ioctl like command that can be used to perform specific functions
138          * with the device.
139          */
140         int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
141
142         struct device_driver driver;
143         struct list_head list;
144 };
145 #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
146
147 #define I2C_NAME_SIZE   20
148
149 /**
150  * struct i2c_client - represent an I2C slave device
151  * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
152  *      I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
153  * @addr: Address used on the I2C bus connected to the parent adapter.
154  * @name: Indicates the type of the device, usually a chip name that's
155  *      generic enough to hide second-sourcing and compatible revisions.
156  * @adapter: manages the bus segment hosting this I2C device
157  * @driver: device's driver, hence pointer to access routines
158  * @dev: Driver model device node for the slave.
159  * @irq: indicates the IRQ generated by this device (if any)
160  * @driver_name: Identifies new-style driver used with this device; also
161  *      used as the module name for hotplug/coldplug modprobe support.
162  * @list: list of active/busy clients
163  * @released: used to synchronize client releases & detaches and references
164  *
165  * An i2c_client identifies a single device (i.e. chip) connected to an
166  * i2c bus. The behaviour exposed to Linux is defined by the driver
167  * managing the device.
168  */
169 struct i2c_client {
170         unsigned short flags;           /* div., see below              */
171         unsigned short addr;            /* chip address - NOTE: 7bit    */
172                                         /* addresses are stored in the  */
173                                         /* _LOWER_ 7 bits               */
174         char name[I2C_NAME_SIZE];
175         struct i2c_adapter *adapter;    /* the adapter we sit on        */
176         struct i2c_driver *driver;      /* and our access routines      */
177         struct device dev;              /* the device structure         */
178         int irq;                        /* irq issued by device (or -1) */
179         char driver_name[KOBJ_NAME_LEN];
180         struct list_head list;
181         struct completion released;
182 };
183 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
184
185 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
186 {
187         struct device * const dev = container_of(kobj, struct device, kobj);
188         return to_i2c_client(dev);
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         /* To determine what the adapter supports */
291         u32 (*functionality) (struct i2c_adapter *);
292 };
293
294 /*
295  * i2c_adapter is the structure used to identify a physical i2c bus along
296  * with the access algorithms necessary to access it.
297  */
298 struct i2c_adapter {
299         struct module *owner;
300         unsigned int id;
301         unsigned int class;
302         const struct i2c_algorithm *algo; /* the algorithm to access the bus */
303         void *algo_data;
304
305         /* --- administration stuff. */
306         int (*client_register)(struct i2c_client *);
307         int (*client_unregister)(struct i2c_client *);
308
309         /* data fields that are valid for all devices   */
310         u8 level;                       /* nesting level for lockdep */
311         struct mutex bus_lock;
312         struct mutex clist_lock;
313
314         int timeout;
315         int retries;
316         struct device dev;              /* the adapter device */
317
318         int nr;
319         struct list_head clients;
320         char name[48];
321         struct completion dev_released;
322 };
323 #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
324
325 static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
326 {
327         return dev_get_drvdata (&dev->dev);
328 }
329
330 static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
331 {
332         dev_set_drvdata (&dev->dev, data);
333 }
334
335 /*flags for the client struct: */
336 #define I2C_CLIENT_PEC  0x04            /* Use Packet Error Checking */
337 #define I2C_CLIENT_TEN  0x10            /* we have a ten bit chip address */
338                                         /* Must equal I2C_M_TEN below */
339 #define I2C_CLIENT_WAKE 0x80            /* for board_info; true iff can wake */
340
341 /* i2c adapter classes (bitmask) */
342 #define I2C_CLASS_HWMON         (1<<0)  /* lm_sensors, ... */
343 #define I2C_CLASS_TV_ANALOG     (1<<1)  /* bttv + friends */
344 #define I2C_CLASS_TV_DIGITAL    (1<<2)  /* dvb cards */
345 #define I2C_CLASS_DDC           (1<<3)  /* i2c-matroxfb ? */
346 #define I2C_CLASS_CAM_ANALOG    (1<<4)  /* camera with analog CCD */
347 #define I2C_CLASS_CAM_DIGITAL   (1<<5)  /* most webcams */
348 #define I2C_CLASS_SOUND         (1<<6)  /* sound devices */
349 #define I2C_CLASS_ALL           (UINT_MAX) /* all of the above */
350
351 /* i2c_client_address_data is the struct for holding default client
352  * addresses for a driver and for the parameters supplied on the
353  * command line
354  */
355 struct i2c_client_address_data {
356         const unsigned short *normal_i2c;
357         const unsigned short *probe;
358         const unsigned short *ignore;
359         const unsigned short * const *forces;
360 };
361
362 /* Internal numbers to terminate lists */
363 #define I2C_CLIENT_END          0xfffeU
364
365 /* The numbers to use to set I2C bus address */
366 #define ANY_I2C_BUS             0xffff
367
368
369 /* ----- functions exported by i2c.o */
370
371 /* administration...
372  */
373 extern int i2c_add_adapter(struct i2c_adapter *);
374 extern int i2c_del_adapter(struct i2c_adapter *);
375 extern int i2c_add_numbered_adapter(struct i2c_adapter *);
376
377 extern int i2c_register_driver(struct module *, struct i2c_driver *);
378 extern void i2c_del_driver(struct i2c_driver *);
379
380 static inline int i2c_add_driver(struct i2c_driver *driver)
381 {
382         return i2c_register_driver(THIS_MODULE, driver);
383 }
384
385 extern int i2c_attach_client(struct i2c_client *);
386 extern int i2c_detach_client(struct i2c_client *);
387
388 extern struct i2c_client *i2c_use_client(struct i2c_client *client);
389 extern void i2c_release_client(struct i2c_client *client);
390
391 /* call the i2c_client->command() of all attached clients with
392  * the given arguments */
393 extern void i2c_clients_command(struct i2c_adapter *adap,
394                                 unsigned int cmd, void *arg);
395
396 /* Detect function. It iterates over all possible addresses itself.
397  * It will only call found_proc if some client is connected at the
398  * specific address (unless a 'force' matched);
399  */
400 extern int i2c_probe(struct i2c_adapter *adapter,
401                 const struct i2c_client_address_data *address_data,
402                 int (*found_proc) (struct i2c_adapter *, int, int));
403
404 extern struct i2c_adapter* i2c_get_adapter(int id);
405 extern void i2c_put_adapter(struct i2c_adapter *adap);
406
407
408 /* Return the functionality mask */
409 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
410 {
411         return adap->algo->functionality(adap);
412 }
413
414 /* Return 1 if adapter supports everything we need, 0 if not. */
415 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
416 {
417         return (func & i2c_get_functionality(adap)) == func;
418 }
419
420 /* Return id number for a specific adapter */
421 static inline int i2c_adapter_id(struct i2c_adapter *adap)
422 {
423         return adap->nr;
424 }
425 #endif /* __KERNEL__ */
426
427 /**
428  * struct i2c_msg - an I2C transaction segment beginning with START
429  * @addr: Slave address, either seven or ten bits.  When this is a ten
430  *      bit address, I2C_M_TEN must be set in @flags and the adapter
431  *      must support I2C_FUNC_10BIT_ADDR.
432  * @flags: I2C_M_RD is handled by all adapters.  No other flags may be
433  *      provided unless the adapter exported the relevant I2C_FUNC_*
434  *      flags through i2c_check_functionality().
435  * @len: Number of data bytes in @buf being read from or written to the
436  *      I2C slave address.  For read transactions where I2C_M_RECV_LEN
437  *      is set, the caller guarantees that this buffer can hold up to
438  *      32 bytes in addition to the initial length byte sent by the
439  *      slave (plus, if used, the SMBus PEC); and this value will be
440  *      incremented by the number of block data bytes received.
441  * @buf: The buffer into which data is read, or from which it's written.
442  *
443  * An i2c_msg is the low level representation of one segment of an I2C
444  * transaction.  It is visible to drivers in the @i2c_transfer() procedure,
445  * to userspace from i2c-dev, and to I2C adapter drivers through the
446  * @i2c_adapter.@master_xfer() method.
447  *
448  * Except when I2C "protocol mangling" is used, all I2C adapters implement
449  * the standard rules for I2C transactions.  Each transaction begins with a
450  * START.  That is followed by the slave address, and a bit encoding read
451  * versus write.  Then follow all the data bytes, possibly including a byte
452  * with SMBus PEC.  The transfer terminates with a NAK, or when all those
453  * bytes have been transferred and ACKed.  If this is the last message in a
454  * group, it is followed by a STOP.  Otherwise it is followed by the next
455  * @i2c_msg transaction segment, beginning with a (repeated) START.
456  *
457  * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
458  * passing certain @flags may have changed those standard protocol behaviors.
459  * Those flags are only for use with broken/nonconforming slaves, and with
460  * adapters which are known to support the specific mangling options they
461  * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
462  */
463 struct i2c_msg {
464         __u16 addr;     /* slave address                        */
465         __u16 flags;
466 #define I2C_M_TEN               0x0010  /* this is a ten bit chip address */
467 #define I2C_M_RD                0x0001  /* read data, from slave to master */
468 #define I2C_M_NOSTART           0x4000  /* if I2C_FUNC_PROTOCOL_MANGLING */
469 #define I2C_M_REV_DIR_ADDR      0x2000  /* if I2C_FUNC_PROTOCOL_MANGLING */
470 #define I2C_M_IGNORE_NAK        0x1000  /* if I2C_FUNC_PROTOCOL_MANGLING */
471 #define I2C_M_NO_RD_ACK         0x0800  /* if I2C_FUNC_PROTOCOL_MANGLING */
472 #define I2C_M_RECV_LEN          0x0400  /* length will be first received byte */
473         __u16 len;              /* msg length                           */
474         __u8 *buf;              /* pointer to msg data                  */
475 };
476
477 /* To determine what functionality is present */
478
479 #define I2C_FUNC_I2C                    0x00000001
480 #define I2C_FUNC_10BIT_ADDR             0x00000002
481 #define I2C_FUNC_PROTOCOL_MANGLING      0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
482 #define I2C_FUNC_SMBUS_PEC              0x00000008
483 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL  0x00008000 /* SMBus 2.0 */
484 #define I2C_FUNC_SMBUS_QUICK            0x00010000
485 #define I2C_FUNC_SMBUS_READ_BYTE        0x00020000
486 #define I2C_FUNC_SMBUS_WRITE_BYTE       0x00040000
487 #define I2C_FUNC_SMBUS_READ_BYTE_DATA   0x00080000
488 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA  0x00100000
489 #define I2C_FUNC_SMBUS_READ_WORD_DATA   0x00200000
490 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA  0x00400000
491 #define I2C_FUNC_SMBUS_PROC_CALL        0x00800000
492 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA  0x01000000
493 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
494 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK   0x04000000 /* I2C-like block xfer  */
495 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK  0x08000000 /* w/ 1-byte reg. addr. */
496 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2  0x10000000 /* I2C-like block xfer  */
497 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
498
499 #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
500                              I2C_FUNC_SMBUS_WRITE_BYTE)
501 #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
502                                   I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
503 #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
504                                   I2C_FUNC_SMBUS_WRITE_WORD_DATA)
505 #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
506                                    I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
507 #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
508                                   I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
509 #define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
510                                     I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
511
512 #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
513                              I2C_FUNC_SMBUS_BYTE | \
514                              I2C_FUNC_SMBUS_BYTE_DATA | \
515                              I2C_FUNC_SMBUS_WORD_DATA | \
516                              I2C_FUNC_SMBUS_PROC_CALL | \
517                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
518                              I2C_FUNC_SMBUS_I2C_BLOCK | \
519                              I2C_FUNC_SMBUS_PEC)
520
521 /*
522  * Data for SMBus Messages
523  */
524 #define I2C_SMBUS_BLOCK_MAX     32      /* As specified in SMBus standard */
525 union i2c_smbus_data {
526         __u8 byte;
527         __u16 word;
528         __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
529                                /* and one more for user-space compatibility */
530 };
531
532 /* smbus_access read or write markers */
533 #define I2C_SMBUS_READ  1
534 #define I2C_SMBUS_WRITE 0
535
536 /* SMBus transaction types (size parameter in the above functions)
537    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
538 #define I2C_SMBUS_QUICK             0
539 #define I2C_SMBUS_BYTE              1
540 #define I2C_SMBUS_BYTE_DATA         2
541 #define I2C_SMBUS_WORD_DATA         3
542 #define I2C_SMBUS_PROC_CALL         4
543 #define I2C_SMBUS_BLOCK_DATA        5
544 #define I2C_SMBUS_I2C_BLOCK_BROKEN  6
545 #define I2C_SMBUS_BLOCK_PROC_CALL   7           /* SMBus 2.0 */
546 #define I2C_SMBUS_I2C_BLOCK_DATA    8
547
548
549 #ifdef __KERNEL__
550
551 /* These defines are used for probing i2c client addresses */
552 /* The length of the option lists */
553 #define I2C_CLIENT_MAX_OPTS 48
554
555 /* Default fill of many variables */
556 #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
557                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
558                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
559                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
560                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
561                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
562                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
563                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
564                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
565                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
566                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
567                           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
573 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
574    module header */
575
576 #define I2C_CLIENT_MODULE_PARM(var,desc) \
577   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
578   static unsigned int var##_num; \
579   module_param_array(var, short, &var##_num, 0); \
580   MODULE_PARM_DESC(var,desc)
581
582 #define I2C_CLIENT_MODULE_PARM_FORCE(name)                              \
583 I2C_CLIENT_MODULE_PARM(force_##name,                                    \
584                        "List of adapter,address pairs which are "       \
585                        "unquestionably assumed to contain a `"          \
586                        # name "' chip")
587
588
589 #define I2C_CLIENT_INSMOD_COMMON                                        \
590 I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan "  \
591                        "additionally");                                 \
592 I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to "  \
593                        "scan");                                         \
594 const static struct i2c_client_address_data addr_data = {               \
595         .normal_i2c     = normal_i2c,                                   \
596         .probe          = probe,                                        \
597         .ignore         = ignore,                                       \
598         .forces         = forces,                                       \
599 }
600
601 #define I2C_CLIENT_FORCE_TEXT \
602         "List of adapter,address pairs to boldly assume to be present"
603
604 /* These are the ones you want to use in your own drivers. Pick the one
605    which matches the number of devices the driver differenciates between. */
606 #define I2C_CLIENT_INSMOD                                               \
607 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
608 static const unsigned short * const forces[] = { force, NULL };         \
609 I2C_CLIENT_INSMOD_COMMON
610
611 #define I2C_CLIENT_INSMOD_1(chip1)                                      \
612 enum chips { any_chip, chip1 };                                         \
613 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
614 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
615 static const unsigned short * const forces[] =  { force,                \
616         force_##chip1, NULL };                                          \
617 I2C_CLIENT_INSMOD_COMMON
618
619 #define I2C_CLIENT_INSMOD_2(chip1, chip2)                               \
620 enum chips { any_chip, chip1, chip2 };                                  \
621 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
622 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
623 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
624 static const unsigned short * const forces[] =  { force,                \
625         force_##chip1, force_##chip2, NULL };                           \
626 I2C_CLIENT_INSMOD_COMMON
627
628 #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3)                        \
629 enum chips { any_chip, chip1, chip2, chip3 };                           \
630 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
631 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
632 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
633 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
634 static const unsigned short * const forces[] =  { force,                \
635         force_##chip1, force_##chip2, force_##chip3, NULL };            \
636 I2C_CLIENT_INSMOD_COMMON
637
638 #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4)                 \
639 enum chips { any_chip, chip1, chip2, chip3, chip4 };                    \
640 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
641 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
642 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
643 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
644 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
645 static const unsigned short * const forces[] =  { force,                \
646         force_##chip1, force_##chip2, force_##chip3,                    \
647         force_##chip4, NULL};                                           \
648 I2C_CLIENT_INSMOD_COMMON
649
650 #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5)          \
651 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 };             \
652 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
653 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
654 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
655 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
656 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
657 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
658 static const unsigned short * const forces[] = { force,                 \
659         force_##chip1, force_##chip2, force_##chip3,                    \
660         force_##chip4, force_##chip5, NULL };                           \
661 I2C_CLIENT_INSMOD_COMMON
662
663 #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6)   \
664 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 };      \
665 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
666 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
667 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
668 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
669 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
670 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
671 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
672 static const unsigned short * const forces[] = { force,                 \
673         force_##chip1, force_##chip2, force_##chip3,                    \
674         force_##chip4, force_##chip5, force_##chip6, NULL };            \
675 I2C_CLIENT_INSMOD_COMMON
676
677 #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
678 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
679              chip7 };                                                   \
680 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
681 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
682 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
683 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
684 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
685 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
686 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
687 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
688 static const unsigned short * const forces[] = { force,                 \
689         force_##chip1, force_##chip2, force_##chip3,                    \
690         force_##chip4, force_##chip5, force_##chip6,                    \
691         force_##chip7, NULL };                                          \
692 I2C_CLIENT_INSMOD_COMMON
693
694 #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
695 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
696              chip7, chip8 };                                            \
697 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
698 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
699 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
700 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
701 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
702 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
703 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
704 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
705 I2C_CLIENT_MODULE_PARM_FORCE(chip8);                                    \
706 static const unsigned short * const forces[] = { force,                 \
707         force_##chip1, force_##chip2, force_##chip3,                    \
708         force_##chip4, force_##chip5, force_##chip6,                    \
709         force_##chip7, force_##chip8, NULL };                           \
710 I2C_CLIENT_INSMOD_COMMON
711 #endif /* __KERNEL__ */
712 #endif /* _LINUX_I2C_H */