i2c: Update stray references to smbus_access
[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 i2c_smbus_xfer. */
73
74 extern s32 i2c_smbus_read_byte(struct i2c_client * client);
75 extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
76 extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
77 extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
78                                      u8 command, u8 value);
79 extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
80 extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
81                                      u8 command, u16 value);
82 /* Returns the number of read bytes */
83 extern s32 i2c_smbus_read_block_data(struct i2c_client *client,
84                                      u8 command, u8 *values);
85 extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
86                                       u8 command, u8 length,
87                                       const u8 *values);
88 /* Returns the number of read bytes */
89 extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
90                                          u8 command, u8 length, u8 *values);
91 extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,
92                                           u8 command, u8 length,
93                                           const u8 *values);
94
95 /*
96  * A driver is capable of handling one or more physical devices present on
97  * I2C adapters. This information is used to inform the driver of adapter
98  * events.
99  *
100  * The driver.owner field should be set to the module owner of this driver.
101  * The driver.name field should be set to the name of this driver.
102  */
103
104 struct i2c_driver {
105         int id;
106         unsigned int class;
107
108         /* Notifies the driver that a new bus has appeared. This routine
109          * can be used by the driver to test if the bus meets its conditions
110          * & seek for the presence of the chip(s) it supports. If found, it
111          * registers the client(s) that are on the bus to the i2c admin. via
112          * i2c_attach_client.  (LEGACY I2C DRIVERS ONLY)
113          */
114         int (*attach_adapter)(struct i2c_adapter *);
115         int (*detach_adapter)(struct i2c_adapter *);
116
117         /* tells the driver that a client is about to be deleted & gives it
118          * the chance to remove its private data. Also, if the client struct
119          * has been dynamically allocated by the driver in the function above,
120          * it must be freed here.  (LEGACY I2C DRIVERS ONLY)
121          */
122         int (*detach_client)(struct i2c_client *);
123
124         /* Standard driver model interfaces, for "new style" i2c drivers.
125          * With the driver model, device enumeration is NEVER done by drivers;
126          * it's done by infrastructure.  (NEW STYLE DRIVERS ONLY)
127          */
128         int (*probe)(struct i2c_client *, const struct i2c_device_id *);
129         int (*remove)(struct i2c_client *);
130
131         /* driver model interfaces that don't relate to enumeration  */
132         void (*shutdown)(struct i2c_client *);
133         int (*suspend)(struct i2c_client *, pm_message_t mesg);
134         int (*resume)(struct i2c_client *);
135
136         /* a ioctl like command that can be used to perform specific functions
137          * with the device.
138          */
139         int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
140
141         struct device_driver driver;
142         const struct i2c_device_id *id_table;
143 };
144 #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
145
146 /**
147  * struct i2c_client - represent an I2C slave device
148  * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
149  *      I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
150  * @addr: Address used on the I2C bus connected to the parent adapter.
151  * @name: Indicates the type of the device, usually a chip name that's
152  *      generic enough to hide second-sourcing and compatible revisions.
153  * @adapter: manages the bus segment hosting this I2C device
154  * @driver: device's driver, hence pointer to access routines
155  * @dev: Driver model device node for the slave.
156  * @irq: indicates the IRQ generated by this device (if any)
157  * @list: list of active/busy clients (DEPRECATED)
158  * @released: used to synchronize client releases & detaches and references
159  *
160  * An i2c_client identifies a single device (i.e. chip) connected to an
161  * i2c bus. The behaviour exposed to Linux is defined by the driver
162  * managing the device.
163  */
164 struct i2c_client {
165         unsigned short flags;           /* div., see below              */
166         unsigned short addr;            /* chip address - NOTE: 7bit    */
167                                         /* addresses are stored in the  */
168                                         /* _LOWER_ 7 bits               */
169         char name[I2C_NAME_SIZE];
170         struct i2c_adapter *adapter;    /* the adapter we sit on        */
171         struct i2c_driver *driver;      /* and our access routines      */
172         struct device dev;              /* the device structure         */
173         int irq;                        /* irq issued by device         */
174         struct list_head list;          /* DEPRECATED */
175         struct completion released;
176 };
177 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
178
179 extern struct i2c_client *i2c_verify_client(struct device *dev);
180
181 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
182 {
183         struct device * const dev = container_of(kobj, struct device, kobj);
184         return to_i2c_client(dev);
185 }
186
187 static inline void *i2c_get_clientdata (struct i2c_client *dev)
188 {
189         return dev_get_drvdata (&dev->dev);
190 }
191
192 static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
193 {
194         dev_set_drvdata (&dev->dev, data);
195 }
196
197 /**
198  * struct i2c_board_info - template for device creation
199  * @type: chip type, to initialize i2c_client.name
200  * @flags: to initialize i2c_client.flags
201  * @addr: stored in i2c_client.addr
202  * @platform_data: stored in i2c_client.dev.platform_data
203  * @irq: stored in i2c_client.irq
204  *
205  * I2C doesn't actually support hardware probing, although controllers and
206  * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
207  * a device at a given address.  Drivers commonly need more information than
208  * that, such as chip type, configuration, associated IRQ, and so on.
209  *
210  * i2c_board_info is used to build tables of information listing I2C devices
211  * that are present.  This information is used to grow the driver model tree
212  * for "new style" I2C drivers.  For mainboards this is done statically using
213  * i2c_register_board_info(); bus numbers identify adapters that aren't
214  * yet available.  For add-on boards, i2c_new_device() does this dynamically
215  * with the adapter already known.
216  */
217 struct i2c_board_info {
218         char            type[I2C_NAME_SIZE];
219         unsigned short  flags;
220         unsigned short  addr;
221         void            *platform_data;
222         int             irq;
223 };
224
225 /**
226  * I2C_BOARD_INFO - macro used to list an i2c device and its address
227  * @dev_type: identifies the device type
228  * @dev_addr: the device's address on the bus.
229  *
230  * This macro initializes essential fields of a struct i2c_board_info,
231  * declaring what has been provided on a particular board.  Optional
232  * fields (such as associated irq, or device-specific platform_data)
233  * are provided using conventional syntax.
234  */
235 #define I2C_BOARD_INFO(dev_type,dev_addr) \
236         .type = (dev_type), .addr = (dev_addr)
237
238
239 /* Add-on boards should register/unregister their devices; e.g. a board
240  * with integrated I2C, a config eeprom, sensors, and a codec that's
241  * used in conjunction with the primary hardware.
242  */
243 extern struct i2c_client *
244 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
245
246 /* If you don't know the exact address of an I2C device, use this variant
247  * instead, which can probe for device presence in a list of possible
248  * addresses.
249  */
250 extern struct i2c_client *
251 i2c_new_probed_device(struct i2c_adapter *adap,
252                       struct i2c_board_info *info,
253                       unsigned short const *addr_list);
254
255 /* For devices that use several addresses, use i2c_new_dummy() to make
256  * client handles for the extra addresses.
257  */
258 extern struct i2c_client *
259 i2c_new_dummy(struct i2c_adapter *adap, u16 address);
260
261 extern void i2c_unregister_device(struct i2c_client *);
262
263 /* Mainboard arch_initcall() code should register all its I2C devices.
264  * This is done at arch_initcall time, before declaring any i2c adapters.
265  * Modules for add-on boards must use other calls.
266  */
267 #ifdef CONFIG_I2C_BOARDINFO
268 extern int
269 i2c_register_board_info(int busnum, struct i2c_board_info const *info, unsigned n);
270 #else
271 static inline int
272 i2c_register_board_info(int busnum, struct i2c_board_info const *info, unsigned n)
273 {
274         return 0;
275 }
276 #endif
277
278 /*
279  * The following structs are for those who like to implement new bus drivers:
280  * i2c_algorithm is the interface to a class of hardware solutions which can
281  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
282  * to name two of the most common.
283  */
284 struct i2c_algorithm {
285         /* If an adapter algorithm can't do I2C-level access, set master_xfer
286            to NULL. If an adapter algorithm can do SMBus access, set
287            smbus_xfer. If set to NULL, the SMBus protocol is simulated
288            using common I2C messages */
289         /* master_xfer should return the number of messages successfully
290            processed, or a negative value on error */
291         int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
292                            int num);
293         int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
294                            unsigned short flags, char read_write,
295                            u8 command, int size, union i2c_smbus_data * data);
296
297         /* To determine what the adapter supports */
298         u32 (*functionality) (struct i2c_adapter *);
299 };
300
301 /*
302  * i2c_adapter is the structure used to identify a physical i2c bus along
303  * with the access algorithms necessary to access it.
304  */
305 struct i2c_adapter {
306         struct module *owner;
307         unsigned int id;
308         unsigned int class;
309         const struct i2c_algorithm *algo; /* the algorithm to access the bus */
310         void *algo_data;
311
312         /* --- administration stuff. */
313         int (*client_register)(struct i2c_client *);
314         int (*client_unregister)(struct i2c_client *);
315
316         /* data fields that are valid for all devices   */
317         u8 level;                       /* nesting level for lockdep */
318         struct mutex bus_lock;
319         struct mutex clist_lock;
320
321         int timeout;
322         int retries;
323         struct device dev;              /* the adapter device */
324
325         int nr;
326         struct list_head clients;       /* DEPRECATED */
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         const unsigned short *normal_i2c;
364         const unsigned short *probe;
365         const unsigned short *ignore;
366         const unsigned short * const *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 extern struct i2c_client *i2c_use_client(struct i2c_client *client);
396 extern void i2c_release_client(struct i2c_client *client);
397
398 /* call the i2c_client->command() of all attached clients with
399  * the given arguments */
400 extern void i2c_clients_command(struct i2c_adapter *adap,
401                                 unsigned int cmd, void *arg);
402
403 /* Detect function. It iterates over all possible addresses itself.
404  * It will only call found_proc if some client is connected at the
405  * specific address (unless a 'force' matched);
406  */
407 extern int i2c_probe(struct i2c_adapter *adapter,
408                 const struct i2c_client_address_data *address_data,
409                 int (*found_proc) (struct i2c_adapter *, int, int));
410
411 extern struct i2c_adapter* i2c_get_adapter(int id);
412 extern void i2c_put_adapter(struct i2c_adapter *adap);
413
414
415 /* Return the functionality mask */
416 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
417 {
418         return adap->algo->functionality(adap);
419 }
420
421 /* Return 1 if adapter supports everything we need, 0 if not. */
422 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
423 {
424         return (func & i2c_get_functionality(adap)) == func;
425 }
426
427 /* Return id number for a specific adapter */
428 static inline int i2c_adapter_id(struct i2c_adapter *adap)
429 {
430         return adap->nr;
431 }
432 #endif /* __KERNEL__ */
433
434 /**
435  * struct i2c_msg - an I2C transaction segment beginning with START
436  * @addr: Slave address, either seven or ten bits.  When this is a ten
437  *      bit address, I2C_M_TEN must be set in @flags and the adapter
438  *      must support I2C_FUNC_10BIT_ADDR.
439  * @flags: I2C_M_RD is handled by all adapters.  No other flags may be
440  *      provided unless the adapter exported the relevant I2C_FUNC_*
441  *      flags through i2c_check_functionality().
442  * @len: Number of data bytes in @buf being read from or written to the
443  *      I2C slave address.  For read transactions where I2C_M_RECV_LEN
444  *      is set, the caller guarantees that this buffer can hold up to
445  *      32 bytes in addition to the initial length byte sent by the
446  *      slave (plus, if used, the SMBus PEC); and this value will be
447  *      incremented by the number of block data bytes received.
448  * @buf: The buffer into which data is read, or from which it's written.
449  *
450  * An i2c_msg is the low level representation of one segment of an I2C
451  * transaction.  It is visible to drivers in the @i2c_transfer() procedure,
452  * to userspace from i2c-dev, and to I2C adapter drivers through the
453  * @i2c_adapter.@master_xfer() method.
454  *
455  * Except when I2C "protocol mangling" is used, all I2C adapters implement
456  * the standard rules for I2C transactions.  Each transaction begins with a
457  * START.  That is followed by the slave address, and a bit encoding read
458  * versus write.  Then follow all the data bytes, possibly including a byte
459  * with SMBus PEC.  The transfer terminates with a NAK, or when all those
460  * bytes have been transferred and ACKed.  If this is the last message in a
461  * group, it is followed by a STOP.  Otherwise it is followed by the next
462  * @i2c_msg transaction segment, beginning with a (repeated) START.
463  *
464  * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
465  * passing certain @flags may have changed those standard protocol behaviors.
466  * Those flags are only for use with broken/nonconforming slaves, and with
467  * adapters which are known to support the specific mangling options they
468  * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
469  */
470 struct i2c_msg {
471         __u16 addr;     /* slave address                        */
472         __u16 flags;
473 #define I2C_M_TEN               0x0010  /* this is a ten bit chip address */
474 #define I2C_M_RD                0x0001  /* read data, from slave to master */
475 #define I2C_M_NOSTART           0x4000  /* if I2C_FUNC_PROTOCOL_MANGLING */
476 #define I2C_M_REV_DIR_ADDR      0x2000  /* if I2C_FUNC_PROTOCOL_MANGLING */
477 #define I2C_M_IGNORE_NAK        0x1000  /* if I2C_FUNC_PROTOCOL_MANGLING */
478 #define I2C_M_NO_RD_ACK         0x0800  /* if I2C_FUNC_PROTOCOL_MANGLING */
479 #define I2C_M_RECV_LEN          0x0400  /* length will be first received byte */
480         __u16 len;              /* msg length                           */
481         __u8 *buf;              /* pointer to msg data                  */
482 };
483
484 /* To determine what functionality is present */
485
486 #define I2C_FUNC_I2C                    0x00000001
487 #define I2C_FUNC_10BIT_ADDR             0x00000002
488 #define I2C_FUNC_PROTOCOL_MANGLING      0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
489 #define I2C_FUNC_SMBUS_PEC              0x00000008
490 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL  0x00008000 /* SMBus 2.0 */
491 #define I2C_FUNC_SMBUS_QUICK            0x00010000
492 #define I2C_FUNC_SMBUS_READ_BYTE        0x00020000
493 #define I2C_FUNC_SMBUS_WRITE_BYTE       0x00040000
494 #define I2C_FUNC_SMBUS_READ_BYTE_DATA   0x00080000
495 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA  0x00100000
496 #define I2C_FUNC_SMBUS_READ_WORD_DATA   0x00200000
497 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA  0x00400000
498 #define I2C_FUNC_SMBUS_PROC_CALL        0x00800000
499 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA  0x01000000
500 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
501 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK   0x04000000 /* I2C-like block xfer  */
502 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK  0x08000000 /* w/ 1-byte reg. addr. */
503 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2  0x10000000 /* I2C-like block xfer  */
504 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
505
506 #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
507                              I2C_FUNC_SMBUS_WRITE_BYTE)
508 #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
509                                   I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
510 #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
511                                   I2C_FUNC_SMBUS_WRITE_WORD_DATA)
512 #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
513                                    I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
514 #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
515                                   I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
516 #define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
517                                     I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
518
519 #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
520                              I2C_FUNC_SMBUS_BYTE | \
521                              I2C_FUNC_SMBUS_BYTE_DATA | \
522                              I2C_FUNC_SMBUS_WORD_DATA | \
523                              I2C_FUNC_SMBUS_PROC_CALL | \
524                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
525                              I2C_FUNC_SMBUS_I2C_BLOCK | \
526                              I2C_FUNC_SMBUS_PEC)
527
528 /*
529  * Data for SMBus Messages
530  */
531 #define I2C_SMBUS_BLOCK_MAX     32      /* As specified in SMBus standard */
532 union i2c_smbus_data {
533         __u8 byte;
534         __u16 word;
535         __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
536                                /* and one more for user-space compatibility */
537 };
538
539 /* i2c_smbus_xfer read or write markers */
540 #define I2C_SMBUS_READ  1
541 #define I2C_SMBUS_WRITE 0
542
543 /* SMBus transaction types (size parameter in the above functions)
544    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
545 #define I2C_SMBUS_QUICK             0
546 #define I2C_SMBUS_BYTE              1
547 #define I2C_SMBUS_BYTE_DATA         2
548 #define I2C_SMBUS_WORD_DATA         3
549 #define I2C_SMBUS_PROC_CALL         4
550 #define I2C_SMBUS_BLOCK_DATA        5
551 #define I2C_SMBUS_I2C_BLOCK_BROKEN  6
552 #define I2C_SMBUS_BLOCK_PROC_CALL   7           /* SMBus 2.0 */
553 #define I2C_SMBUS_I2C_BLOCK_DATA    8
554
555
556 #ifdef __KERNEL__
557
558 /* These defines are used for probing i2c client addresses */
559 /* The length of the option lists */
560 #define I2C_CLIENT_MAX_OPTS 48
561
562 /* Default fill of many variables */
563 #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
564                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
565                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
566                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
567                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
568                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
569                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
570                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
571                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
572                           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
580 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
581    module header */
582
583 #define I2C_CLIENT_MODULE_PARM(var,desc) \
584   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
585   static unsigned int var##_num; \
586   module_param_array(var, short, &var##_num, 0); \
587   MODULE_PARM_DESC(var,desc)
588
589 #define I2C_CLIENT_MODULE_PARM_FORCE(name)                              \
590 I2C_CLIENT_MODULE_PARM(force_##name,                                    \
591                        "List of adapter,address pairs which are "       \
592                        "unquestionably assumed to contain a `"          \
593                        # name "' chip")
594
595
596 #define I2C_CLIENT_INSMOD_COMMON                                        \
597 I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan "  \
598                        "additionally");                                 \
599 I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to "  \
600                        "scan");                                         \
601 static const struct i2c_client_address_data addr_data = {               \
602         .normal_i2c     = normal_i2c,                                   \
603         .probe          = probe,                                        \
604         .ignore         = ignore,                                       \
605         .forces         = forces,                                       \
606 }
607
608 #define I2C_CLIENT_FORCE_TEXT \
609         "List of adapter,address pairs to boldly assume to be present"
610
611 /* These are the ones you want to use in your own drivers. Pick the one
612    which matches the number of devices the driver differenciates between. */
613 #define I2C_CLIENT_INSMOD                                               \
614 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
615 static const unsigned short * const forces[] = { force, NULL };         \
616 I2C_CLIENT_INSMOD_COMMON
617
618 #define I2C_CLIENT_INSMOD_1(chip1)                                      \
619 enum chips { any_chip, chip1 };                                         \
620 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
621 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
622 static const unsigned short * const forces[] =  { force,                \
623         force_##chip1, NULL };                                          \
624 I2C_CLIENT_INSMOD_COMMON
625
626 #define I2C_CLIENT_INSMOD_2(chip1, chip2)                               \
627 enum chips { any_chip, chip1, chip2 };                                  \
628 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
629 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
630 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
631 static const unsigned short * const forces[] =  { force,                \
632         force_##chip1, force_##chip2, NULL };                           \
633 I2C_CLIENT_INSMOD_COMMON
634
635 #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3)                        \
636 enum chips { any_chip, chip1, chip2, chip3 };                           \
637 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
638 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
639 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
640 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
641 static const unsigned short * const forces[] =  { force,                \
642         force_##chip1, force_##chip2, force_##chip3, NULL };            \
643 I2C_CLIENT_INSMOD_COMMON
644
645 #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4)                 \
646 enum chips { any_chip, chip1, chip2, chip3, chip4 };                    \
647 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
648 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
649 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
650 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
651 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
652 static const unsigned short * const forces[] =  { force,                \
653         force_##chip1, force_##chip2, force_##chip3,                    \
654         force_##chip4, NULL};                                           \
655 I2C_CLIENT_INSMOD_COMMON
656
657 #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5)          \
658 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 };             \
659 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
660 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
661 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
662 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
663 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
664 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
665 static const unsigned short * const forces[] = { force,                 \
666         force_##chip1, force_##chip2, force_##chip3,                    \
667         force_##chip4, force_##chip5, NULL };                           \
668 I2C_CLIENT_INSMOD_COMMON
669
670 #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6)   \
671 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 };      \
672 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
673 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
674 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
675 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
676 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
677 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
678 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
679 static const unsigned short * const forces[] = { force,                 \
680         force_##chip1, force_##chip2, force_##chip3,                    \
681         force_##chip4, force_##chip5, force_##chip6, NULL };            \
682 I2C_CLIENT_INSMOD_COMMON
683
684 #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
685 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
686              chip7 };                                                   \
687 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
688 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
689 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
690 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
691 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
692 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
693 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
694 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
695 static const unsigned short * const forces[] = { force,                 \
696         force_##chip1, force_##chip2, force_##chip3,                    \
697         force_##chip4, force_##chip5, force_##chip6,                    \
698         force_##chip7, NULL };                                          \
699 I2C_CLIENT_INSMOD_COMMON
700
701 #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
702 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
703              chip7, chip8 };                                            \
704 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
705 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
706 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
707 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
708 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
709 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
710 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
711 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
712 I2C_CLIENT_MODULE_PARM_FORCE(chip8);                                    \
713 static const unsigned short * const forces[] = { force,                 \
714         force_##chip1, force_##chip2, force_##chip3,                    \
715         force_##chip4, force_##chip5, force_##chip6,                    \
716         force_##chip7, force_##chip8, NULL };                           \
717 I2C_CLIENT_INSMOD_COMMON
718 #endif /* __KERNEL__ */
719 #endif /* _LINUX_I2C_H */