i2c: Drop redundant i2c_driver.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 };
144 #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
145
146 #define I2C_NAME_SIZE   20
147
148 /**
149  * struct i2c_client - represent an I2C slave device
150  * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
151  *      I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
152  * @addr: Address used on the I2C bus connected to the parent adapter.
153  * @name: Indicates the type of the device, usually a chip name that's
154  *      generic enough to hide second-sourcing and compatible revisions.
155  * @adapter: manages the bus segment hosting this I2C device
156  * @driver: device's driver, hence pointer to access routines
157  * @dev: Driver model device node for the slave.
158  * @irq: indicates the IRQ generated by this device (if any)
159  * @driver_name: Identifies new-style driver used with this device; also
160  *      used as the module name for hotplug/coldplug modprobe support.
161  * @list: list of active/busy clients
162  * @released: used to synchronize client releases & detaches and references
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         struct device dev;              /* the device structure         */
177         int irq;                        /* irq issued by device (or -1) */
178         char driver_name[KOBJ_NAME_LEN];
179         struct list_head list;
180         struct completion released;
181 };
182 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
183
184 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
185 {
186         struct device * const dev = container_of(kobj, struct device, kobj);
187         return to_i2c_client(dev);
188 }
189
190 static inline void *i2c_get_clientdata (struct i2c_client *dev)
191 {
192         return dev_get_drvdata (&dev->dev);
193 }
194
195 static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
196 {
197         dev_set_drvdata (&dev->dev, data);
198 }
199
200 /**
201  * struct i2c_board_info - template for device creation
202  * @driver_name: identifies the driver to be bound to the device
203  * @type: optional chip type information, to initialize i2c_client.name
204  * @flags: to initialize i2c_client.flags
205  * @addr: stored in i2c_client.addr
206  * @platform_data: stored in i2c_client.dev.platform_data
207  * @irq: stored in i2c_client.irq
208  *
209  * I2C doesn't actually support hardware probing, although controllers and
210  * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
211  * a device at a given address.  Drivers commonly need more information than
212  * that, such as chip type, configuration, associated IRQ, and so on.
213  *
214  * i2c_board_info is used to build tables of information listing I2C devices
215  * that are present.  This information is used to grow the driver model tree
216  * for "new style" I2C drivers.  For mainboards this is done statically using
217  * i2c_register_board_info(); bus numbers identify adapters that aren't
218  * yet available.  For add-on boards, i2c_new_device() does this dynamically
219  * with the adapter already known.
220  */
221 struct i2c_board_info {
222         char            driver_name[KOBJ_NAME_LEN];
223         char            type[I2C_NAME_SIZE];
224         unsigned short  flags;
225         unsigned short  addr;
226         void            *platform_data;
227         int             irq;
228 };
229
230 /**
231  * I2C_BOARD_INFO - macro used to list an i2c device and its driver
232  * @driver: identifies the driver to use with the device
233  * @dev_addr: the device's address on the bus.
234  *
235  * This macro initializes essential fields of a struct i2c_board_info,
236  * declaring what has been provided on a particular board.  Optional
237  * fields (such as the chip type, its associated irq, or device-specific
238  * platform_data) are provided using conventional syntax.
239  */
240 #define I2C_BOARD_INFO(driver,dev_addr) \
241         .driver_name = (driver), .addr = (dev_addr)
242
243
244 /* Add-on boards should register/unregister their devices; e.g. a board
245  * with integrated I2C, a config eeprom, sensors, and a codec that's
246  * used in conjunction with the primary hardware.
247  */
248 extern struct i2c_client *
249 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
250
251 /* If you don't know the exact address of an I2C device, use this variant
252  * instead, which can probe for device presence in a list of possible
253  * addresses.
254  */
255 extern struct i2c_client *
256 i2c_new_probed_device(struct i2c_adapter *adap,
257                       struct i2c_board_info *info,
258                       unsigned short const *addr_list);
259
260 extern void i2c_unregister_device(struct i2c_client *);
261
262 /* Mainboard arch_initcall() code should register all its I2C devices.
263  * This is done at arch_initcall time, before declaring any i2c adapters.
264  * Modules for add-on boards must use other calls.
265  */
266 extern int
267 i2c_register_board_info(int busnum, struct i2c_board_info const *info, unsigned n);
268
269
270 /*
271  * The following structs are for those who like to implement new bus drivers:
272  * i2c_algorithm is the interface to a class of hardware solutions which can
273  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
274  * to name two of the most common.
275  */
276 struct i2c_algorithm {
277         /* If an adapter algorithm can't do I2C-level access, set master_xfer
278            to NULL. If an adapter algorithm can do SMBus access, set
279            smbus_xfer. If set to NULL, the SMBus protocol is simulated
280            using common I2C messages */
281         /* master_xfer should return the number of messages successfully
282            processed, or a negative value on error */
283         int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
284                            int num);
285         int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
286                            unsigned short flags, char read_write,
287                            u8 command, int size, union i2c_smbus_data * data);
288
289         /* To determine what the adapter supports */
290         u32 (*functionality) (struct i2c_adapter *);
291 };
292
293 /*
294  * i2c_adapter is the structure used to identify a physical i2c bus along
295  * with the access algorithms necessary to access it.
296  */
297 struct i2c_adapter {
298         struct module *owner;
299         unsigned int id;
300         unsigned int class;
301         const struct i2c_algorithm *algo; /* the algorithm to access the bus */
302         void *algo_data;
303
304         /* --- administration stuff. */
305         int (*client_register)(struct i2c_client *);
306         int (*client_unregister)(struct i2c_client *);
307
308         /* data fields that are valid for all devices   */
309         u8 level;                       /* nesting level for lockdep */
310         struct mutex bus_lock;
311         struct mutex clist_lock;
312
313         int timeout;
314         int retries;
315         struct device dev;              /* the adapter device */
316
317         int nr;
318         struct list_head clients;
319         char name[48];
320         struct completion dev_released;
321 };
322 #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
323
324 static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
325 {
326         return dev_get_drvdata (&dev->dev);
327 }
328
329 static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
330 {
331         dev_set_drvdata (&dev->dev, data);
332 }
333
334 /*flags for the client struct: */
335 #define I2C_CLIENT_PEC  0x04            /* Use Packet Error Checking */
336 #define I2C_CLIENT_TEN  0x10            /* we have a ten bit chip address */
337                                         /* Must equal I2C_M_TEN below */
338 #define I2C_CLIENT_WAKE 0x80            /* for board_info; true iff can wake */
339
340 /* i2c adapter classes (bitmask) */
341 #define I2C_CLASS_HWMON         (1<<0)  /* lm_sensors, ... */
342 #define I2C_CLASS_TV_ANALOG     (1<<1)  /* bttv + friends */
343 #define I2C_CLASS_TV_DIGITAL    (1<<2)  /* dvb cards */
344 #define I2C_CLASS_DDC           (1<<3)  /* i2c-matroxfb ? */
345 #define I2C_CLASS_CAM_ANALOG    (1<<4)  /* camera with analog CCD */
346 #define I2C_CLASS_CAM_DIGITAL   (1<<5)  /* most webcams */
347 #define I2C_CLASS_SOUND         (1<<6)  /* sound devices */
348 #define I2C_CLASS_ALL           (UINT_MAX) /* all of the above */
349
350 /* i2c_client_address_data is the struct for holding default client
351  * addresses for a driver and for the parameters supplied on the
352  * command line
353  */
354 struct i2c_client_address_data {
355         const unsigned short *normal_i2c;
356         const unsigned short *probe;
357         const unsigned short *ignore;
358         const unsigned short * const *forces;
359 };
360
361 /* Internal numbers to terminate lists */
362 #define I2C_CLIENT_END          0xfffeU
363
364 /* The numbers to use to set I2C bus address */
365 #define ANY_I2C_BUS             0xffff
366
367
368 /* ----- functions exported by i2c.o */
369
370 /* administration...
371  */
372 extern int i2c_add_adapter(struct i2c_adapter *);
373 extern int i2c_del_adapter(struct i2c_adapter *);
374 extern int i2c_add_numbered_adapter(struct i2c_adapter *);
375
376 extern int i2c_register_driver(struct module *, struct i2c_driver *);
377 extern void i2c_del_driver(struct i2c_driver *);
378
379 static inline int i2c_add_driver(struct i2c_driver *driver)
380 {
381         return i2c_register_driver(THIS_MODULE, driver);
382 }
383
384 extern int i2c_attach_client(struct i2c_client *);
385 extern int i2c_detach_client(struct i2c_client *);
386
387 extern struct i2c_client *i2c_use_client(struct i2c_client *client);
388 extern void i2c_release_client(struct i2c_client *client);
389
390 /* call the i2c_client->command() of all attached clients with
391  * the given arguments */
392 extern void i2c_clients_command(struct i2c_adapter *adap,
393                                 unsigned int cmd, void *arg);
394
395 /* Detect function. It iterates over all possible addresses itself.
396  * It will only call found_proc if some client is connected at the
397  * specific address (unless a 'force' matched);
398  */
399 extern int i2c_probe(struct i2c_adapter *adapter,
400                 const struct i2c_client_address_data *address_data,
401                 int (*found_proc) (struct i2c_adapter *, int, int));
402
403 extern struct i2c_adapter* i2c_get_adapter(int id);
404 extern void i2c_put_adapter(struct i2c_adapter *adap);
405
406
407 /* Return the functionality mask */
408 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
409 {
410         return adap->algo->functionality(adap);
411 }
412
413 /* Return 1 if adapter supports everything we need, 0 if not. */
414 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
415 {
416         return (func & i2c_get_functionality(adap)) == func;
417 }
418
419 /* Return id number for a specific adapter */
420 static inline int i2c_adapter_id(struct i2c_adapter *adap)
421 {
422         return adap->nr;
423 }
424 #endif /* __KERNEL__ */
425
426 /**
427  * struct i2c_msg - an I2C transaction segment beginning with START
428  * @addr: Slave address, either seven or ten bits.  When this is a ten
429  *      bit address, I2C_M_TEN must be set in @flags and the adapter
430  *      must support I2C_FUNC_10BIT_ADDR.
431  * @flags: I2C_M_RD is handled by all adapters.  No other flags may be
432  *      provided unless the adapter exported the relevant I2C_FUNC_*
433  *      flags through i2c_check_functionality().
434  * @len: Number of data bytes in @buf being read from or written to the
435  *      I2C slave address.  For read transactions where I2C_M_RECV_LEN
436  *      is set, the caller guarantees that this buffer can hold up to
437  *      32 bytes in addition to the initial length byte sent by the
438  *      slave (plus, if used, the SMBus PEC); and this value will be
439  *      incremented by the number of block data bytes received.
440  * @buf: The buffer into which data is read, or from which it's written.
441  *
442  * An i2c_msg is the low level representation of one segment of an I2C
443  * transaction.  It is visible to drivers in the @i2c_transfer() procedure,
444  * to userspace from i2c-dev, and to I2C adapter drivers through the
445  * @i2c_adapter.@master_xfer() method.
446  *
447  * Except when I2C "protocol mangling" is used, all I2C adapters implement
448  * the standard rules for I2C transactions.  Each transaction begins with a
449  * START.  That is followed by the slave address, and a bit encoding read
450  * versus write.  Then follow all the data bytes, possibly including a byte
451  * with SMBus PEC.  The transfer terminates with a NAK, or when all those
452  * bytes have been transferred and ACKed.  If this is the last message in a
453  * group, it is followed by a STOP.  Otherwise it is followed by the next
454  * @i2c_msg transaction segment, beginning with a (repeated) START.
455  *
456  * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
457  * passing certain @flags may have changed those standard protocol behaviors.
458  * Those flags are only for use with broken/nonconforming slaves, and with
459  * adapters which are known to support the specific mangling options they
460  * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
461  */
462 struct i2c_msg {
463         __u16 addr;     /* slave address                        */
464         __u16 flags;
465 #define I2C_M_TEN               0x0010  /* this is a ten bit chip address */
466 #define I2C_M_RD                0x0001  /* read data, from slave to master */
467 #define I2C_M_NOSTART           0x4000  /* if I2C_FUNC_PROTOCOL_MANGLING */
468 #define I2C_M_REV_DIR_ADDR      0x2000  /* if I2C_FUNC_PROTOCOL_MANGLING */
469 #define I2C_M_IGNORE_NAK        0x1000  /* if I2C_FUNC_PROTOCOL_MANGLING */
470 #define I2C_M_NO_RD_ACK         0x0800  /* if I2C_FUNC_PROTOCOL_MANGLING */
471 #define I2C_M_RECV_LEN          0x0400  /* length will be first received byte */
472         __u16 len;              /* msg length                           */
473         __u8 *buf;              /* pointer to msg data                  */
474 };
475
476 /* To determine what functionality is present */
477
478 #define I2C_FUNC_I2C                    0x00000001
479 #define I2C_FUNC_10BIT_ADDR             0x00000002
480 #define I2C_FUNC_PROTOCOL_MANGLING      0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
481 #define I2C_FUNC_SMBUS_PEC              0x00000008
482 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL  0x00008000 /* SMBus 2.0 */
483 #define I2C_FUNC_SMBUS_QUICK            0x00010000
484 #define I2C_FUNC_SMBUS_READ_BYTE        0x00020000
485 #define I2C_FUNC_SMBUS_WRITE_BYTE       0x00040000
486 #define I2C_FUNC_SMBUS_READ_BYTE_DATA   0x00080000
487 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA  0x00100000
488 #define I2C_FUNC_SMBUS_READ_WORD_DATA   0x00200000
489 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA  0x00400000
490 #define I2C_FUNC_SMBUS_PROC_CALL        0x00800000
491 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA  0x01000000
492 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
493 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK   0x04000000 /* I2C-like block xfer  */
494 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK  0x08000000 /* w/ 1-byte reg. addr. */
495 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2  0x10000000 /* I2C-like block xfer  */
496 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
497
498 #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
499                              I2C_FUNC_SMBUS_WRITE_BYTE)
500 #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
501                                   I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
502 #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
503                                   I2C_FUNC_SMBUS_WRITE_WORD_DATA)
504 #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
505                                    I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
506 #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
507                                   I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
508 #define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
509                                     I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
510
511 #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
512                              I2C_FUNC_SMBUS_BYTE | \
513                              I2C_FUNC_SMBUS_BYTE_DATA | \
514                              I2C_FUNC_SMBUS_WORD_DATA | \
515                              I2C_FUNC_SMBUS_PROC_CALL | \
516                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
517                              I2C_FUNC_SMBUS_I2C_BLOCK | \
518                              I2C_FUNC_SMBUS_PEC)
519
520 /*
521  * Data for SMBus Messages
522  */
523 #define I2C_SMBUS_BLOCK_MAX     32      /* As specified in SMBus standard */
524 union i2c_smbus_data {
525         __u8 byte;
526         __u16 word;
527         __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
528                                /* and one more for user-space compatibility */
529 };
530
531 /* smbus_access read or write markers */
532 #define I2C_SMBUS_READ  1
533 #define I2C_SMBUS_WRITE 0
534
535 /* SMBus transaction types (size parameter in the above functions)
536    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
537 #define I2C_SMBUS_QUICK             0
538 #define I2C_SMBUS_BYTE              1
539 #define I2C_SMBUS_BYTE_DATA         2
540 #define I2C_SMBUS_WORD_DATA         3
541 #define I2C_SMBUS_PROC_CALL         4
542 #define I2C_SMBUS_BLOCK_DATA        5
543 #define I2C_SMBUS_I2C_BLOCK_BROKEN  6
544 #define I2C_SMBUS_BLOCK_PROC_CALL   7           /* SMBus 2.0 */
545 #define I2C_SMBUS_I2C_BLOCK_DATA    8
546
547
548 #ifdef __KERNEL__
549
550 /* These defines are used for probing i2c client addresses */
551 /* The length of the option lists */
552 #define I2C_CLIENT_MAX_OPTS 48
553
554 /* Default fill of many variables */
555 #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
556                           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
572 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
573    module header */
574
575 #define I2C_CLIENT_MODULE_PARM(var,desc) \
576   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
577   static unsigned int var##_num; \
578   module_param_array(var, short, &var##_num, 0); \
579   MODULE_PARM_DESC(var,desc)
580
581 #define I2C_CLIENT_MODULE_PARM_FORCE(name)                              \
582 I2C_CLIENT_MODULE_PARM(force_##name,                                    \
583                        "List of adapter,address pairs which are "       \
584                        "unquestionably assumed to contain a `"          \
585                        # name "' chip")
586
587
588 #define I2C_CLIENT_INSMOD_COMMON                                        \
589 I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan "  \
590                        "additionally");                                 \
591 I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to "  \
592                        "scan");                                         \
593 const static struct i2c_client_address_data addr_data = {               \
594         .normal_i2c     = normal_i2c,                                   \
595         .probe          = probe,                                        \
596         .ignore         = ignore,                                       \
597         .forces         = forces,                                       \
598 }
599
600 #define I2C_CLIENT_FORCE_TEXT \
601         "List of adapter,address pairs to boldly assume to be present"
602
603 /* These are the ones you want to use in your own drivers. Pick the one
604    which matches the number of devices the driver differenciates between. */
605 #define I2C_CLIENT_INSMOD                                               \
606 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
607 static const unsigned short * const forces[] = { force, NULL };         \
608 I2C_CLIENT_INSMOD_COMMON
609
610 #define I2C_CLIENT_INSMOD_1(chip1)                                      \
611 enum chips { any_chip, chip1 };                                         \
612 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
613 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
614 static const unsigned short * const forces[] =  { force,                \
615         force_##chip1, NULL };                                          \
616 I2C_CLIENT_INSMOD_COMMON
617
618 #define I2C_CLIENT_INSMOD_2(chip1, chip2)                               \
619 enum chips { any_chip, chip1, chip2 };                                  \
620 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
621 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
622 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
623 static const unsigned short * const forces[] =  { force,                \
624         force_##chip1, force_##chip2, NULL };                           \
625 I2C_CLIENT_INSMOD_COMMON
626
627 #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3)                        \
628 enum chips { any_chip, chip1, chip2, chip3 };                           \
629 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
630 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
631 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
632 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
633 static const unsigned short * const forces[] =  { force,                \
634         force_##chip1, force_##chip2, force_##chip3, NULL };            \
635 I2C_CLIENT_INSMOD_COMMON
636
637 #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4)                 \
638 enum chips { any_chip, chip1, chip2, chip3, chip4 };                    \
639 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
640 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
641 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
642 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
643 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
644 static const unsigned short * const forces[] =  { force,                \
645         force_##chip1, force_##chip2, force_##chip3,                    \
646         force_##chip4, NULL};                                           \
647 I2C_CLIENT_INSMOD_COMMON
648
649 #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5)          \
650 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 };             \
651 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
652 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
653 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
654 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
655 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
656 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
657 static const unsigned short * const forces[] = { force,                 \
658         force_##chip1, force_##chip2, force_##chip3,                    \
659         force_##chip4, force_##chip5, NULL };                           \
660 I2C_CLIENT_INSMOD_COMMON
661
662 #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6)   \
663 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 };      \
664 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
665 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
666 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
667 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
668 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
669 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
670 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
671 static const unsigned short * const forces[] = { force,                 \
672         force_##chip1, force_##chip2, force_##chip3,                    \
673         force_##chip4, force_##chip5, force_##chip6, NULL };            \
674 I2C_CLIENT_INSMOD_COMMON
675
676 #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
677 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
678              chip7 };                                                   \
679 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
680 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
681 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
682 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
683 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
684 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
685 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
686 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
687 static const unsigned short * const forces[] = { force,                 \
688         force_##chip1, force_##chip2, force_##chip3,                    \
689         force_##chip4, force_##chip5, force_##chip6,                    \
690         force_##chip7, NULL };                                          \
691 I2C_CLIENT_INSMOD_COMMON
692
693 #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
694 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
695              chip7, chip8 };                                            \
696 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
697 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
698 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
699 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
700 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
701 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
702 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
703 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
704 I2C_CLIENT_MODULE_PARM_FORCE(chip8);                                    \
705 static const unsigned short * const forces[] = { force,                 \
706         force_##chip1, force_##chip2, force_##chip3,                    \
707         force_##chip4, force_##chip5, force_##chip6,                    \
708         force_##chip7, force_##chip8, NULL };                           \
709 I2C_CLIENT_INSMOD_COMMON
710 #endif /* __KERNEL__ */
711 #endif /* _LINUX_I2C_H */