1 /* ------------------------------------------------------------------------- */
3 /* i2c.h - definitions for the i2c-bus interface */
5 /* ------------------------------------------------------------------------- */
6 /* Copyright (C) 1995-2000 Simon G. Vogl
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.
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.
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 /* ------------------------------------------------------------------------- */
23 /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
24 Frodo Looijaard <frodol@dds.nl> */
29 #include <linux/types.h>
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>
38 extern struct bus_type i2c_bus_type;
40 /* --- General options ------------------------------------------------ */
48 struct i2c_board_info;
51 * The master routines are the ones normally used to transmit data to devices
52 * on a bus (or read from them). Apart from two basic transfer functions to
53 * transmit one message at a time, a more complex version can be used to
54 * transmit an arbitrary number of messages without interruption.
56 extern int i2c_master_send(struct i2c_client *client, const char *buf,
58 extern int i2c_master_recv(struct i2c_client *client, char *buf, int count);
60 /* Transfer num messages.
62 extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
65 /* This is the very generalized SMBus access routine. You probably do not
66 want to use this, though; one of the functions below may be much easier,
67 and probably just as fast.
68 Note that we use i2c_adapter here, because you do not need a specific
69 smbus adapter to call this function. */
70 extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
71 unsigned short flags, char read_write, u8 command,
72 int size, union i2c_smbus_data *data);
74 /* Now follow the 'nice' access routines. These also document the calling
75 conventions of i2c_smbus_xfer. */
77 extern s32 i2c_smbus_read_byte(struct i2c_client *client);
78 extern s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value);
79 extern s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command);
80 extern s32 i2c_smbus_write_byte_data(struct i2c_client *client,
81 u8 command, u8 value);
82 extern s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command);
83 extern s32 i2c_smbus_write_word_data(struct i2c_client *client,
84 u8 command, u16 value);
85 /* Returns the number of read bytes */
86 extern s32 i2c_smbus_read_block_data(struct i2c_client *client,
87 u8 command, u8 *values);
88 extern s32 i2c_smbus_write_block_data(struct i2c_client *client,
89 u8 command, u8 length, const u8 *values);
90 /* Returns the number of read bytes */
91 extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client,
92 u8 command, u8 length, u8 *values);
93 extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client,
94 u8 command, u8 length,
98 * struct i2c_driver - represent an I2C device driver
99 * @id: Unique driver ID (optional)
100 * @class: What kind of i2c device we instantiate (for detect)
101 * @attach_adapter: Callback for bus addition (for legacy drivers)
102 * @detach_adapter: Callback for bus removal (for legacy drivers)
103 * @probe: Callback for device binding
104 * @remove: Callback for device unbinding
105 * @shutdown: Callback for device shutdown
106 * @suspend: Callback for device suspend
107 * @resume: Callback for device resume
108 * @command: Callback for bus-wide signaling (optional)
109 * @driver: Device driver model driver
110 * @id_table: List of I2C devices supported by this driver
111 * @detect: Callback for device detection
112 * @address_data: The I2C addresses to probe, ignore or force (for detect)
113 * @clients: List of detected clients we created (for i2c-core use only)
115 * The driver.owner field should be set to the module owner of this driver.
116 * The driver.name field should be set to the name of this driver.
118 * For automatic device detection, both @detect and @address_data must
119 * be defined. @class should also be set, otherwise only devices forced
120 * with module parameters will be created. The detect function must
121 * fill at least the name field of the i2c_board_info structure it is
122 * handed upon successful detection, and possibly also the flags field.
124 * If @detect is missing, the driver will still work fine for enumerated
125 * devices. Detected devices simply won't be supported. This is expected
126 * for the many I2C/SMBus devices which can't be detected reliably, and
127 * the ones which can always be enumerated in practice.
129 * The i2c_client structure which is handed to the @detect callback is
130 * not a real i2c_client. It is initialized just enough so that you can
131 * call i2c_smbus_read_byte_data and friends on it. Don't do anything
132 * else with it. In particular, calling dev_dbg and friends on it is
139 /* Notifies the driver that a new bus has appeared or is about to be
140 * removed. You should avoid using this if you can, it will probably
141 * be removed in a near future.
143 int (*attach_adapter)(struct i2c_adapter *);
144 int (*detach_adapter)(struct i2c_adapter *);
146 /* Standard driver model interfaces */
147 int (*probe)(struct i2c_client *, const struct i2c_device_id *);
148 int (*remove)(struct i2c_client *);
150 /* driver model interfaces that don't relate to enumeration */
151 void (*shutdown)(struct i2c_client *);
152 int (*suspend)(struct i2c_client *, pm_message_t mesg);
153 int (*resume)(struct i2c_client *);
155 /* a ioctl like command that can be used to perform specific functions
158 int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
160 struct device_driver driver;
161 const struct i2c_device_id *id_table;
163 /* Device detection callback for automatic device creation */
164 int (*detect)(struct i2c_client *, int kind, struct i2c_board_info *);
165 const struct i2c_client_address_data *address_data;
166 struct list_head clients;
168 #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
171 * struct i2c_client - represent an I2C slave device
172 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
173 * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
174 * @addr: Address used on the I2C bus connected to the parent adapter.
175 * @name: Indicates the type of the device, usually a chip name that's
176 * generic enough to hide second-sourcing and compatible revisions.
177 * @adapter: manages the bus segment hosting this I2C device
178 * @driver: device's driver, hence pointer to access routines
179 * @dev: Driver model device node for the slave.
180 * @irq: indicates the IRQ generated by this device (if any)
181 * @list: list of active/busy clients (DEPRECATED)
182 * @detected: member of an i2c_driver.clients list
183 * @released: used to synchronize client releases & detaches and references
185 * An i2c_client identifies a single device (i.e. chip) connected to an
186 * i2c bus. The behaviour exposed to Linux is defined by the driver
187 * managing the device.
190 unsigned short flags; /* div., see below */
191 unsigned short addr; /* chip address - NOTE: 7bit */
192 /* addresses are stored in the */
194 char name[I2C_NAME_SIZE];
195 struct i2c_adapter *adapter; /* the adapter we sit on */
196 struct i2c_driver *driver; /* and our access routines */
197 struct device dev; /* the device structure */
198 int irq; /* irq issued by device */
199 struct list_head list; /* DEPRECATED */
200 struct list_head detected;
201 struct completion released;
203 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
205 extern struct i2c_client *i2c_verify_client(struct device *dev);
207 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
209 struct device * const dev = container_of(kobj, struct device, kobj);
210 return to_i2c_client(dev);
213 static inline void *i2c_get_clientdata(const struct i2c_client *dev)
215 return dev_get_drvdata(&dev->dev);
218 static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
220 dev_set_drvdata(&dev->dev, data);
224 * struct i2c_board_info - template for device creation
225 * @type: chip type, to initialize i2c_client.name
226 * @flags: to initialize i2c_client.flags
227 * @addr: stored in i2c_client.addr
228 * @platform_data: stored in i2c_client.dev.platform_data
229 * @archdata: copied into i2c_client.dev.archdata
230 * @irq: stored in i2c_client.irq
232 * I2C doesn't actually support hardware probing, although controllers and
233 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
234 * a device at a given address. Drivers commonly need more information than
235 * that, such as chip type, configuration, associated IRQ, and so on.
237 * i2c_board_info is used to build tables of information listing I2C devices
238 * that are present. This information is used to grow the driver model tree.
239 * For mainboards this is done statically using i2c_register_board_info();
240 * bus numbers identify adapters that aren't yet available. For add-on boards,
241 * i2c_new_device() does this dynamically with the adapter already known.
243 struct i2c_board_info {
244 char type[I2C_NAME_SIZE];
245 unsigned short flags;
248 struct dev_archdata *archdata;
253 * I2C_BOARD_INFO - macro used to list an i2c device and its address
254 * @dev_type: identifies the device type
255 * @dev_addr: the device's address on the bus.
257 * This macro initializes essential fields of a struct i2c_board_info,
258 * declaring what has been provided on a particular board. Optional
259 * fields (such as associated irq, or device-specific platform_data)
260 * are provided using conventional syntax.
262 #define I2C_BOARD_INFO(dev_type, dev_addr) \
263 .type = dev_type, .addr = (dev_addr)
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.
270 extern struct i2c_client *
271 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
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
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);
282 /* For devices that use several addresses, use i2c_new_dummy() to make
283 * client handles for the extra addresses.
285 extern struct i2c_client *
286 i2c_new_dummy(struct i2c_adapter *adap, u16 address);
288 extern void i2c_unregister_device(struct i2c_client *);
290 /* Mainboard arch_initcall() code should register all its I2C devices.
291 * This is done at arch_initcall time, before declaring any i2c adapters.
292 * Modules for add-on boards must use other calls.
294 #ifdef CONFIG_I2C_BOARDINFO
296 i2c_register_board_info(int busnum, struct i2c_board_info const *info,
300 i2c_register_board_info(int busnum, struct i2c_board_info const *info,
308 * The following structs are for those who like to implement new bus drivers:
309 * i2c_algorithm is the interface to a class of hardware solutions which can
310 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
311 * to name two of the most common.
313 struct i2c_algorithm {
314 /* If an adapter algorithm can't do I2C-level access, set master_xfer
315 to NULL. If an adapter algorithm can do SMBus access, set
316 smbus_xfer. If set to NULL, the SMBus protocol is simulated
317 using common I2C messages */
318 /* master_xfer should return the number of messages successfully
319 processed, or a negative value on error */
320 int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
322 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
323 unsigned short flags, char read_write,
324 u8 command, int size, union i2c_smbus_data *data);
326 /* To determine what the adapter supports */
327 u32 (*functionality) (struct i2c_adapter *);
331 * i2c_adapter is the structure used to identify a physical i2c bus along
332 * with the access algorithms necessary to access it.
335 struct module *owner;
337 unsigned int class; /* classes to allow probing for */
338 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
341 /* data fields that are valid for all devices */
342 u8 level; /* nesting level for lockdep */
343 struct mutex bus_lock;
344 struct mutex clist_lock;
346 int timeout; /* in jiffies */
348 struct device dev; /* the adapter device */
351 struct list_head clients; /* DEPRECATED */
353 struct completion dev_released;
355 #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
357 static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
359 return dev_get_drvdata(&dev->dev);
362 static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
364 dev_set_drvdata(&dev->dev, data);
367 /*flags for the client struct: */
368 #define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
369 #define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
370 /* Must equal I2C_M_TEN below */
371 #define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */
373 /* i2c adapter classes (bitmask) */
374 #define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
375 #define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
376 #define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
377 #define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */
378 #define I2C_CLASS_SPD (1<<7) /* SPD EEPROMs and similar */
380 /* i2c_client_address_data is the struct for holding default client
381 * addresses for a driver and for the parameters supplied on the
384 struct i2c_client_address_data {
385 const unsigned short *normal_i2c;
386 const unsigned short *probe;
387 const unsigned short *ignore;
388 const unsigned short * const *forces;
391 /* Internal numbers to terminate lists */
392 #define I2C_CLIENT_END 0xfffeU
394 /* The numbers to use to set I2C bus address */
395 #define ANY_I2C_BUS 0xffff
398 /* ----- functions exported by i2c.o */
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 *);
406 extern int i2c_register_driver(struct module *, struct i2c_driver *);
407 extern void i2c_del_driver(struct i2c_driver *);
409 static inline int i2c_add_driver(struct i2c_driver *driver)
411 return i2c_register_driver(THIS_MODULE, driver);
414 extern struct i2c_client *i2c_use_client(struct i2c_client *client);
415 extern void i2c_release_client(struct i2c_client *client);
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);
422 /* Detect function. It iterates over all possible addresses itself.
423 * It will only call found_proc if some client is connected at the
424 * specific address (unless a 'force' matched);
426 extern int i2c_probe(struct i2c_adapter *adapter,
427 const struct i2c_client_address_data *address_data,
428 int (*found_proc) (struct i2c_adapter *, int, int));
430 extern struct i2c_adapter *i2c_get_adapter(int id);
431 extern void i2c_put_adapter(struct i2c_adapter *adap);
434 /* Return the functionality mask */
435 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
437 return adap->algo->functionality(adap);
440 /* Return 1 if adapter supports everything we need, 0 if not. */
441 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
443 return (func & i2c_get_functionality(adap)) == func;
446 /* Return the adapter number for a specific adapter */
447 static inline int i2c_adapter_id(struct i2c_adapter *adap)
451 #endif /* __KERNEL__ */
454 * struct i2c_msg - an I2C transaction segment beginning with START
455 * @addr: Slave address, either seven or ten bits. When this is a ten
456 * bit address, I2C_M_TEN must be set in @flags and the adapter
457 * must support I2C_FUNC_10BIT_ADDR.
458 * @flags: I2C_M_RD is handled by all adapters. No other flags may be
459 * provided unless the adapter exported the relevant I2C_FUNC_*
460 * flags through i2c_check_functionality().
461 * @len: Number of data bytes in @buf being read from or written to the
462 * I2C slave address. For read transactions where I2C_M_RECV_LEN
463 * is set, the caller guarantees that this buffer can hold up to
464 * 32 bytes in addition to the initial length byte sent by the
465 * slave (plus, if used, the SMBus PEC); and this value will be
466 * incremented by the number of block data bytes received.
467 * @buf: The buffer into which data is read, or from which it's written.
469 * An i2c_msg is the low level representation of one segment of an I2C
470 * transaction. It is visible to drivers in the @i2c_transfer() procedure,
471 * to userspace from i2c-dev, and to I2C adapter drivers through the
472 * @i2c_adapter.@master_xfer() method.
474 * Except when I2C "protocol mangling" is used, all I2C adapters implement
475 * the standard rules for I2C transactions. Each transaction begins with a
476 * START. That is followed by the slave address, and a bit encoding read
477 * versus write. Then follow all the data bytes, possibly including a byte
478 * with SMBus PEC. The transfer terminates with a NAK, or when all those
479 * bytes have been transferred and ACKed. If this is the last message in a
480 * group, it is followed by a STOP. Otherwise it is followed by the next
481 * @i2c_msg transaction segment, beginning with a (repeated) START.
483 * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
484 * passing certain @flags may have changed those standard protocol behaviors.
485 * Those flags are only for use with broken/nonconforming slaves, and with
486 * adapters which are known to support the specific mangling options they
487 * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
490 __u16 addr; /* slave address */
492 #define I2C_M_TEN 0x0010 /* this is a ten bit chip address */
493 #define I2C_M_RD 0x0001 /* read data, from slave to master */
494 #define I2C_M_NOSTART 0x4000 /* if I2C_FUNC_PROTOCOL_MANGLING */
495 #define I2C_M_REV_DIR_ADDR 0x2000 /* if I2C_FUNC_PROTOCOL_MANGLING */
496 #define I2C_M_IGNORE_NAK 0x1000 /* if I2C_FUNC_PROTOCOL_MANGLING */
497 #define I2C_M_NO_RD_ACK 0x0800 /* if I2C_FUNC_PROTOCOL_MANGLING */
498 #define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */
499 __u16 len; /* msg length */
500 __u8 *buf; /* pointer to msg data */
503 /* To determine what functionality is present */
505 #define I2C_FUNC_I2C 0x00000001
506 #define I2C_FUNC_10BIT_ADDR 0x00000002
507 #define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_NOSTART etc. */
508 #define I2C_FUNC_SMBUS_PEC 0x00000008
509 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
510 #define I2C_FUNC_SMBUS_QUICK 0x00010000
511 #define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
512 #define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
513 #define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
514 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
515 #define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
516 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
517 #define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
518 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
519 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
520 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
521 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
523 #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
524 I2C_FUNC_SMBUS_WRITE_BYTE)
525 #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
526 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
527 #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
528 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
529 #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
530 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
531 #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
532 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
534 #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
535 I2C_FUNC_SMBUS_BYTE | \
536 I2C_FUNC_SMBUS_BYTE_DATA | \
537 I2C_FUNC_SMBUS_WORD_DATA | \
538 I2C_FUNC_SMBUS_PROC_CALL | \
539 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
540 I2C_FUNC_SMBUS_I2C_BLOCK | \
544 * Data for SMBus Messages
546 #define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
547 union i2c_smbus_data {
550 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
551 /* and one more for user-space compatibility */
554 /* i2c_smbus_xfer read or write markers */
555 #define I2C_SMBUS_READ 1
556 #define I2C_SMBUS_WRITE 0
558 /* SMBus transaction types (size parameter in the above functions)
559 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
560 #define I2C_SMBUS_QUICK 0
561 #define I2C_SMBUS_BYTE 1
562 #define I2C_SMBUS_BYTE_DATA 2
563 #define I2C_SMBUS_WORD_DATA 3
564 #define I2C_SMBUS_PROC_CALL 4
565 #define I2C_SMBUS_BLOCK_DATA 5
566 #define I2C_SMBUS_I2C_BLOCK_BROKEN 6
567 #define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
568 #define I2C_SMBUS_I2C_BLOCK_DATA 8
573 /* These defines are used for probing i2c client addresses */
574 /* The length of the option lists */
575 #define I2C_CLIENT_MAX_OPTS 48
577 /* Default fill of many variables */
578 #define I2C_CLIENT_DEFAULTS {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 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
588 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
589 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
590 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
591 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
592 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
593 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
595 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
598 #define I2C_CLIENT_MODULE_PARM(var,desc) \
599 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
600 static unsigned int var##_num; \
601 module_param_array(var, short, &var##_num, 0); \
602 MODULE_PARM_DESC(var, desc)
604 #define I2C_CLIENT_MODULE_PARM_FORCE(name) \
605 I2C_CLIENT_MODULE_PARM(force_##name, \
606 "List of adapter,address pairs which are " \
607 "unquestionably assumed to contain a `" \
611 #define I2C_CLIENT_INSMOD_COMMON \
612 I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
614 I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
616 static const struct i2c_client_address_data addr_data = { \
617 .normal_i2c = normal_i2c, \
623 #define I2C_CLIENT_FORCE_TEXT \
624 "List of adapter,address pairs to boldly assume to be present"
626 /* These are the ones you want to use in your own drivers. Pick the one
627 which matches the number of devices the driver differenciates between. */
628 #define I2C_CLIENT_INSMOD \
629 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
630 static const unsigned short * const forces[] = { force, NULL }; \
631 I2C_CLIENT_INSMOD_COMMON
633 #define I2C_CLIENT_INSMOD_1(chip1) \
634 enum chips { any_chip, chip1 }; \
635 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
636 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
637 static const unsigned short * const forces[] = { force, \
638 force_##chip1, NULL }; \
639 I2C_CLIENT_INSMOD_COMMON
641 #define I2C_CLIENT_INSMOD_2(chip1, chip2) \
642 enum chips { any_chip, chip1, chip2 }; \
643 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
644 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
645 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
646 static const unsigned short * const forces[] = { force, \
647 force_##chip1, force_##chip2, NULL }; \
648 I2C_CLIENT_INSMOD_COMMON
650 #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
651 enum chips { any_chip, chip1, chip2, chip3 }; \
652 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
653 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
654 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
655 I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
656 static const unsigned short * const forces[] = { force, \
657 force_##chip1, force_##chip2, force_##chip3, NULL }; \
658 I2C_CLIENT_INSMOD_COMMON
660 #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
661 enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
662 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
663 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
664 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
665 I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
666 I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
667 static const unsigned short * const forces[] = { force, \
668 force_##chip1, force_##chip2, force_##chip3, \
669 force_##chip4, NULL}; \
670 I2C_CLIENT_INSMOD_COMMON
672 #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
673 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
674 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
675 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
676 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
677 I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
678 I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
679 I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
680 static const unsigned short * const forces[] = { force, \
681 force_##chip1, force_##chip2, force_##chip3, \
682 force_##chip4, force_##chip5, NULL }; \
683 I2C_CLIENT_INSMOD_COMMON
685 #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
686 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
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 static const unsigned short * const forces[] = { force, \
695 force_##chip1, force_##chip2, force_##chip3, \
696 force_##chip4, force_##chip5, force_##chip6, NULL }; \
697 I2C_CLIENT_INSMOD_COMMON
699 #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
700 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
702 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
703 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
704 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
705 I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
706 I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
707 I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
708 I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
709 I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
710 static const unsigned short * const forces[] = { force, \
711 force_##chip1, force_##chip2, force_##chip3, \
712 force_##chip4, force_##chip5, force_##chip6, \
713 force_##chip7, NULL }; \
714 I2C_CLIENT_INSMOD_COMMON
716 #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
717 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
719 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
720 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
721 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
722 I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
723 I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
724 I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
725 I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
726 I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
727 I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
728 static const unsigned short * const forces[] = { force, \
729 force_##chip1, force_##chip2, force_##chip3, \
730 force_##chip4, force_##chip5, force_##chip6, \
731 force_##chip7, force_##chip8, NULL }; \
732 I2C_CLIENT_INSMOD_COMMON
733 #endif /* __KERNEL__ */
734 #endif /* _LINUX_I2C_H */