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