i2c: Don't advertise i2c functions when not available
[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 extern struct bus_type i2c_bus_type;
39
40 /* --- General options ------------------------------------------------ */
41
42 struct i2c_msg;
43 struct i2c_algorithm;
44 struct i2c_adapter;
45 struct i2c_client;
46 struct i2c_driver;
47 union i2c_smbus_data;
48 struct i2c_board_info;
49
50 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
51 /*
52  * The master routines are the ones normally used to transmit data to devices
53  * on a bus (or read from them). Apart from two basic transfer functions to
54  * transmit one message at a time, a more complex version can be used to
55  * transmit an arbitrary number of messages without interruption.
56  */
57 extern int i2c_master_send(struct i2c_client *client, const char *buf,
58                            int count);
59 extern int i2c_master_recv(struct i2c_client *client, char *buf, int count);
60
61 /* Transfer num messages.
62  */
63 extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
64                         int num);
65
66 /* This is the very generalized SMBus access routine. You probably do not
67    want to use this, though; one of the functions below may be much easier,
68    and probably just as fast.
69    Note that we use i2c_adapter here, because you do not need a specific
70    smbus adapter to call this function. */
71 extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
72                           unsigned short flags, char read_write, u8 command,
73                           int size, union i2c_smbus_data *data);
74
75 /* Now follow the 'nice' access routines. These also document the calling
76    conventions of i2c_smbus_xfer. */
77
78 extern s32 i2c_smbus_read_byte(struct i2c_client *client);
79 extern s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value);
80 extern s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command);
81 extern s32 i2c_smbus_write_byte_data(struct i2c_client *client,
82                                      u8 command, u8 value);
83 extern s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command);
84 extern s32 i2c_smbus_write_word_data(struct i2c_client *client,
85                                      u8 command, u16 value);
86 /* Returns the number of read bytes */
87 extern s32 i2c_smbus_read_block_data(struct i2c_client *client,
88                                      u8 command, u8 *values);
89 extern s32 i2c_smbus_write_block_data(struct i2c_client *client,
90                                       u8 command, u8 length, const u8 *values);
91 /* Returns the number of read bytes */
92 extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client,
93                                          u8 command, u8 length, u8 *values);
94 extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client,
95                                           u8 command, u8 length,
96                                           const u8 *values);
97 #endif /* I2C */
98
99 /**
100  * struct i2c_driver - represent an I2C device driver
101  * @id: Unique driver ID (optional)
102  * @class: What kind of i2c device we instantiate (for detect)
103  * @attach_adapter: Callback for bus addition (for legacy drivers)
104  * @detach_adapter: Callback for bus removal (for legacy drivers)
105  * @probe: Callback for device binding
106  * @remove: Callback for device unbinding
107  * @shutdown: Callback for device shutdown
108  * @suspend: Callback for device suspend
109  * @resume: Callback for device resume
110  * @command: Callback for bus-wide signaling (optional)
111  * @driver: Device driver model driver
112  * @id_table: List of I2C devices supported by this driver
113  * @detect: Callback for device detection
114  * @address_data: The I2C addresses to probe, ignore or force (for detect)
115  * @clients: List of detected clients we created (for i2c-core use only)
116  *
117  * The driver.owner field should be set to the module owner of this driver.
118  * The driver.name field should be set to the name of this driver.
119  *
120  * For automatic device detection, both @detect and @address_data must
121  * be defined. @class should also be set, otherwise only devices forced
122  * with module parameters will be created. The detect function must
123  * fill at least the name field of the i2c_board_info structure it is
124  * handed upon successful detection, and possibly also the flags field.
125  *
126  * If @detect is missing, the driver will still work fine for enumerated
127  * devices. Detected devices simply won't be supported. This is expected
128  * for the many I2C/SMBus devices which can't be detected reliably, and
129  * the ones which can always be enumerated in practice.
130  *
131  * The i2c_client structure which is handed to the @detect callback is
132  * not a real i2c_client. It is initialized just enough so that you can
133  * call i2c_smbus_read_byte_data and friends on it. Don't do anything
134  * else with it. In particular, calling dev_dbg and friends on it is
135  * not allowed.
136  */
137 struct i2c_driver {
138         int id;
139         unsigned int class;
140
141         /* Notifies the driver that a new bus has appeared or is about to be
142          * removed. You should avoid using this if you can, it will probably
143          * be removed in a near future.
144          */
145         int (*attach_adapter)(struct i2c_adapter *);
146         int (*detach_adapter)(struct i2c_adapter *);
147
148         /* Standard driver model interfaces */
149         int (*probe)(struct i2c_client *, const struct i2c_device_id *);
150         int (*remove)(struct i2c_client *);
151
152         /* driver model interfaces that don't relate to enumeration  */
153         void (*shutdown)(struct i2c_client *);
154         int (*suspend)(struct i2c_client *, pm_message_t mesg);
155         int (*resume)(struct i2c_client *);
156
157         /* a ioctl like command that can be used to perform specific functions
158          * with the device.
159          */
160         int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
161
162         struct device_driver driver;
163         const struct i2c_device_id *id_table;
164
165         /* Device detection callback for automatic device creation */
166         int (*detect)(struct i2c_client *, int kind, struct i2c_board_info *);
167         const struct i2c_client_address_data *address_data;
168         struct list_head clients;
169 };
170 #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
171
172 /**
173  * struct i2c_client - represent an I2C slave device
174  * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
175  *      I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
176  * @addr: Address used on the I2C bus connected to the parent adapter.
177  * @name: Indicates the type of the device, usually a chip name that's
178  *      generic enough to hide second-sourcing and compatible revisions.
179  * @adapter: manages the bus segment hosting this I2C device
180  * @driver: device's driver, hence pointer to access routines
181  * @dev: Driver model device node for the slave.
182  * @irq: indicates the IRQ generated by this device (if any)
183  * @detected: member of an i2c_driver.clients list or i2c-core's
184  *      userspace_devices list
185  *
186  * An i2c_client identifies a single device (i.e. chip) connected to an
187  * i2c bus. The behaviour exposed to Linux is defined by the driver
188  * managing the device.
189  */
190 struct i2c_client {
191         unsigned short flags;           /* div., see below              */
192         unsigned short addr;            /* chip address - NOTE: 7bit    */
193                                         /* addresses are stored in the  */
194                                         /* _LOWER_ 7 bits               */
195         char name[I2C_NAME_SIZE];
196         struct i2c_adapter *adapter;    /* the adapter we sit on        */
197         struct i2c_driver *driver;      /* and our access routines      */
198         struct device dev;              /* the device structure         */
199         int irq;                        /* irq issued by device         */
200         struct list_head detected;
201 };
202 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
203
204 extern struct i2c_client *i2c_verify_client(struct device *dev);
205
206 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
207 {
208         struct device * const dev = container_of(kobj, struct device, kobj);
209         return to_i2c_client(dev);
210 }
211
212 static inline void *i2c_get_clientdata(const struct i2c_client *dev)
213 {
214         return dev_get_drvdata(&dev->dev);
215 }
216
217 static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
218 {
219         dev_set_drvdata(&dev->dev, data);
220 }
221
222 /**
223  * struct i2c_board_info - template for device creation
224  * @type: chip type, to initialize i2c_client.name
225  * @flags: to initialize i2c_client.flags
226  * @addr: stored in i2c_client.addr
227  * @platform_data: stored in i2c_client.dev.platform_data
228  * @archdata: copied into i2c_client.dev.archdata
229  * @irq: stored in i2c_client.irq
230  *
231  * I2C doesn't actually support hardware probing, although controllers and
232  * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
233  * a device at a given address.  Drivers commonly need more information than
234  * that, such as chip type, configuration, associated IRQ, and so on.
235  *
236  * i2c_board_info is used to build tables of information listing I2C devices
237  * that are present.  This information is used to grow the driver model tree.
238  * For mainboards this is done statically using i2c_register_board_info();
239  * bus numbers identify adapters that aren't yet available.  For add-on boards,
240  * i2c_new_device() does this dynamically with the adapter already known.
241  */
242 struct i2c_board_info {
243         char            type[I2C_NAME_SIZE];
244         unsigned short  flags;
245         unsigned short  addr;
246         void            *platform_data;
247         struct dev_archdata     *archdata;
248         int             irq;
249 };
250
251 /**
252  * I2C_BOARD_INFO - macro used to list an i2c device and its address
253  * @dev_type: identifies the device type
254  * @dev_addr: the device's address on the bus.
255  *
256  * This macro initializes essential fields of a struct i2c_board_info,
257  * declaring what has been provided on a particular board.  Optional
258  * fields (such as associated irq, or device-specific platform_data)
259  * are provided using conventional syntax.
260  */
261 #define I2C_BOARD_INFO(dev_type, dev_addr) \
262         .type = dev_type, .addr = (dev_addr)
263
264
265 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
266 /* Add-on boards should register/unregister their devices; e.g. a board
267  * with integrated I2C, a config eeprom, sensors, and a codec that's
268  * used in conjunction with the primary hardware.
269  */
270 extern struct i2c_client *
271 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
272
273 /* If you don't know the exact address of an I2C device, use this variant
274  * instead, which can probe for device presence in a list of possible
275  * addresses.
276  */
277 extern struct i2c_client *
278 i2c_new_probed_device(struct i2c_adapter *adap,
279                       struct i2c_board_info *info,
280                       unsigned short const *addr_list);
281
282 /* For devices that use several addresses, use i2c_new_dummy() to make
283  * client handles for the extra addresses.
284  */
285 extern struct i2c_client *
286 i2c_new_dummy(struct i2c_adapter *adap, u16 address);
287
288 extern void i2c_unregister_device(struct i2c_client *);
289 #endif /* I2C */
290
291 /* Mainboard arch_initcall() code should register all its I2C devices.
292  * This is done at arch_initcall time, before declaring any i2c adapters.
293  * Modules for add-on boards must use other calls.
294  */
295 #ifdef CONFIG_I2C_BOARDINFO
296 extern int
297 i2c_register_board_info(int busnum, struct i2c_board_info const *info,
298                         unsigned n);
299 #else
300 static inline int
301 i2c_register_board_info(int busnum, struct i2c_board_info const *info,
302                         unsigned n)
303 {
304         return 0;
305 }
306 #endif /* I2C_BOARDINFO */
307
308 /*
309  * The following structs are for those who like to implement new bus drivers:
310  * i2c_algorithm is the interface to a class of hardware solutions which can
311  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
312  * to name two of the most common.
313  */
314 struct i2c_algorithm {
315         /* If an adapter algorithm can't do I2C-level access, set master_xfer
316            to NULL. If an adapter algorithm can do SMBus access, set
317            smbus_xfer. If set to NULL, the SMBus protocol is simulated
318            using common I2C messages */
319         /* master_xfer should return the number of messages successfully
320            processed, or a negative value on error */
321         int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
322                            int num);
323         int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
324                            unsigned short flags, char read_write,
325                            u8 command, int size, union i2c_smbus_data *data);
326
327         /* To determine what the adapter supports */
328         u32 (*functionality) (struct i2c_adapter *);
329 };
330
331 /*
332  * i2c_adapter is the structure used to identify a physical i2c bus along
333  * with the access algorithms necessary to access it.
334  */
335 struct i2c_adapter {
336         struct module *owner;
337         unsigned int id;
338         unsigned int class;               /* classes to allow probing for */
339         const struct i2c_algorithm *algo; /* the algorithm to access the bus */
340         void *algo_data;
341
342         /* data fields that are valid for all devices   */
343         u8 level;                       /* nesting level for lockdep */
344         struct mutex bus_lock;
345
346         int timeout;                    /* in jiffies */
347         int retries;
348         struct device dev;              /* the adapter device */
349
350         int nr;
351         char name[48];
352         struct completion dev_released;
353 };
354 #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
355
356 static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
357 {
358         return dev_get_drvdata(&dev->dev);
359 }
360
361 static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
362 {
363         dev_set_drvdata(&dev->dev, data);
364 }
365
366 /*flags for the client struct: */
367 #define I2C_CLIENT_PEC  0x04            /* Use Packet Error Checking */
368 #define I2C_CLIENT_TEN  0x10            /* we have a ten bit chip address */
369                                         /* Must equal I2C_M_TEN below */
370 #define I2C_CLIENT_WAKE 0x80            /* for board_info; true iff can wake */
371
372 /* i2c adapter classes (bitmask) */
373 #define I2C_CLASS_HWMON         (1<<0)  /* lm_sensors, ... */
374 #define I2C_CLASS_TV_ANALOG     (1<<1)  /* bttv + friends */
375 #define I2C_CLASS_TV_DIGITAL    (1<<2)  /* dvb cards */
376 #define I2C_CLASS_DDC           (1<<3)  /* DDC bus on graphics adapters */
377 #define I2C_CLASS_SPD           (1<<7)  /* SPD EEPROMs and similar */
378
379 /* i2c_client_address_data is the struct for holding default client
380  * addresses for a driver and for the parameters supplied on the
381  * command line
382  */
383 struct i2c_client_address_data {
384         const unsigned short *normal_i2c;
385         const unsigned short *probe;
386         const unsigned short *ignore;
387         const unsigned short * const *forces;
388 };
389
390 /* Internal numbers to terminate lists */
391 #define I2C_CLIENT_END          0xfffeU
392
393 /* The numbers to use to set I2C bus address */
394 #define ANY_I2C_BUS             0xffff
395
396
397 /* ----- functions exported by i2c.o */
398
399 /* administration...
400  */
401 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
402 extern int i2c_add_adapter(struct i2c_adapter *);
403 extern int i2c_del_adapter(struct i2c_adapter *);
404 extern int i2c_add_numbered_adapter(struct i2c_adapter *);
405
406 extern int i2c_register_driver(struct module *, struct i2c_driver *);
407 extern void i2c_del_driver(struct i2c_driver *);
408
409 static inline int i2c_add_driver(struct i2c_driver *driver)
410 {
411         return i2c_register_driver(THIS_MODULE, driver);
412 }
413
414 extern struct i2c_client *i2c_use_client(struct i2c_client *client);
415 extern void i2c_release_client(struct i2c_client *client);
416
417 /* call the i2c_client->command() of all attached clients with
418  * the given arguments */
419 extern void i2c_clients_command(struct i2c_adapter *adap,
420                                 unsigned int cmd, void *arg);
421
422 extern struct i2c_adapter *i2c_get_adapter(int id);
423 extern void i2c_put_adapter(struct i2c_adapter *adap);
424
425
426 /* Return the functionality mask */
427 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
428 {
429         return adap->algo->functionality(adap);
430 }
431
432 /* Return 1 if adapter supports everything we need, 0 if not. */
433 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
434 {
435         return (func & i2c_get_functionality(adap)) == func;
436 }
437
438 /* Return the adapter number for a specific adapter */
439 static inline int i2c_adapter_id(struct i2c_adapter *adap)
440 {
441         return adap->nr;
442 }
443 #endif /* I2C */
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_NOSTART etc. */
501 #define I2C_FUNC_SMBUS_PEC              0x00000008
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
516 #define I2C_FUNC_SMBUS_BYTE             (I2C_FUNC_SMBUS_READ_BYTE | \
517                                          I2C_FUNC_SMBUS_WRITE_BYTE)
518 #define I2C_FUNC_SMBUS_BYTE_DATA        (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
519                                          I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
520 #define I2C_FUNC_SMBUS_WORD_DATA        (I2C_FUNC_SMBUS_READ_WORD_DATA | \
521                                          I2C_FUNC_SMBUS_WRITE_WORD_DATA)
522 #define I2C_FUNC_SMBUS_BLOCK_DATA       (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
523                                          I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
524 #define I2C_FUNC_SMBUS_I2C_BLOCK        (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
525                                          I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
526
527 #define I2C_FUNC_SMBUS_EMUL             (I2C_FUNC_SMBUS_QUICK | \
528                                          I2C_FUNC_SMBUS_BYTE | \
529                                          I2C_FUNC_SMBUS_BYTE_DATA | \
530                                          I2C_FUNC_SMBUS_WORD_DATA | \
531                                          I2C_FUNC_SMBUS_PROC_CALL | \
532                                          I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
533                                          I2C_FUNC_SMBUS_I2C_BLOCK | \
534                                          I2C_FUNC_SMBUS_PEC)
535
536 /*
537  * Data for SMBus Messages
538  */
539 #define I2C_SMBUS_BLOCK_MAX     32      /* As specified in SMBus standard */
540 union i2c_smbus_data {
541         __u8 byte;
542         __u16 word;
543         __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
544                                /* and one more for user-space compatibility */
545 };
546
547 /* i2c_smbus_xfer read or write markers */
548 #define I2C_SMBUS_READ  1
549 #define I2C_SMBUS_WRITE 0
550
551 /* SMBus transaction types (size parameter in the above functions)
552    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
553 #define I2C_SMBUS_QUICK             0
554 #define I2C_SMBUS_BYTE              1
555 #define I2C_SMBUS_BYTE_DATA         2
556 #define I2C_SMBUS_WORD_DATA         3
557 #define I2C_SMBUS_PROC_CALL         4
558 #define I2C_SMBUS_BLOCK_DATA        5
559 #define I2C_SMBUS_I2C_BLOCK_BROKEN  6
560 #define I2C_SMBUS_BLOCK_PROC_CALL   7           /* SMBus 2.0 */
561 #define I2C_SMBUS_I2C_BLOCK_DATA    8
562
563
564 #ifdef __KERNEL__
565
566 /* These defines are used for probing i2c client addresses */
567 /* The length of the option lists */
568 #define I2C_CLIENT_MAX_OPTS 48
569
570 /* Default fill of many variables */
571 #define I2C_CLIENT_DEFAULTS {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                              I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
581                              I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
582                              I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
583                              I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
584                              I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
585                              I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
586                              I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
587
588 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
589    module header */
590
591 #define I2C_CLIENT_MODULE_PARM(var,desc) \
592   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
593   static unsigned int var##_num; \
594   module_param_array(var, short, &var##_num, 0); \
595   MODULE_PARM_DESC(var, desc)
596
597 #define I2C_CLIENT_MODULE_PARM_FORCE(name)                              \
598 I2C_CLIENT_MODULE_PARM(force_##name,                                    \
599                        "List of adapter,address pairs which are "       \
600                        "unquestionably assumed to contain a `"          \
601                        # name "' chip")
602
603
604 #define I2C_CLIENT_INSMOD_COMMON                                        \
605 I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan "  \
606                        "additionally");                                 \
607 I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to "  \
608                        "scan");                                         \
609 static const struct i2c_client_address_data addr_data = {               \
610         .normal_i2c     = normal_i2c,                                   \
611         .probe          = probe,                                        \
612         .ignore         = ignore,                                       \
613         .forces         = forces,                                       \
614 }
615
616 #define I2C_CLIENT_FORCE_TEXT \
617         "List of adapter,address pairs to boldly assume to be present"
618
619 /* These are the ones you want to use in your own drivers. Pick the one
620    which matches the number of devices the driver differenciates between. */
621 #define I2C_CLIENT_INSMOD                                               \
622 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
623 static const unsigned short * const forces[] = { force, NULL };         \
624 I2C_CLIENT_INSMOD_COMMON
625
626 #define I2C_CLIENT_INSMOD_1(chip1)                                      \
627 enum chips { any_chip, chip1 };                                         \
628 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
629 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
630 static const unsigned short * const forces[] =  { force,                \
631         force_##chip1, NULL };                                          \
632 I2C_CLIENT_INSMOD_COMMON
633
634 #define I2C_CLIENT_INSMOD_2(chip1, chip2)                               \
635 enum chips { any_chip, chip1, chip2 };                                  \
636 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
637 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
638 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
639 static const unsigned short * const forces[] =  { force,                \
640         force_##chip1, force_##chip2, NULL };                           \
641 I2C_CLIENT_INSMOD_COMMON
642
643 #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3)                        \
644 enum chips { any_chip, chip1, chip2, chip3 };                           \
645 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
646 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
647 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
648 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
649 static const unsigned short * const forces[] =  { force,                \
650         force_##chip1, force_##chip2, force_##chip3, NULL };            \
651 I2C_CLIENT_INSMOD_COMMON
652
653 #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4)                 \
654 enum chips { any_chip, chip1, chip2, chip3, chip4 };                    \
655 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
656 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
657 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
658 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
659 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
660 static const unsigned short * const forces[] =  { force,                \
661         force_##chip1, force_##chip2, force_##chip3,                    \
662         force_##chip4, NULL};                                           \
663 I2C_CLIENT_INSMOD_COMMON
664
665 #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5)          \
666 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 };             \
667 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
668 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
669 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
670 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
671 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
672 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
673 static const unsigned short * const forces[] = { force,                 \
674         force_##chip1, force_##chip2, force_##chip3,                    \
675         force_##chip4, force_##chip5, NULL };                           \
676 I2C_CLIENT_INSMOD_COMMON
677
678 #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6)   \
679 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 };      \
680 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
681 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
682 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
683 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
684 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
685 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
686 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
687 static const unsigned short * const forces[] = { force,                 \
688         force_##chip1, force_##chip2, force_##chip3,                    \
689         force_##chip4, force_##chip5, force_##chip6, NULL };            \
690 I2C_CLIENT_INSMOD_COMMON
691
692 #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
693 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
694              chip7 };                                                   \
695 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
696 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
697 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
698 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
699 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
700 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
701 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
702 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
703 static const unsigned short * const forces[] = { force,                 \
704         force_##chip1, force_##chip2, force_##chip3,                    \
705         force_##chip4, force_##chip5, force_##chip6,                    \
706         force_##chip7, NULL };                                          \
707 I2C_CLIENT_INSMOD_COMMON
708
709 #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
710 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
711              chip7, chip8 };                                            \
712 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT);                   \
713 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
714 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
715 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
716 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
717 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
718 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
719 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
720 I2C_CLIENT_MODULE_PARM_FORCE(chip8);                                    \
721 static const unsigned short * const forces[] = { force,                 \
722         force_##chip1, force_##chip2, force_##chip3,                    \
723         force_##chip4, force_##chip5, force_##chip6,                    \
724         force_##chip7, force_##chip8, NULL };                           \
725 I2C_CLIENT_INSMOD_COMMON
726 #endif /* __KERNEL__ */
727 #endif /* _LINUX_I2C_H */