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