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 * @detected: member of an i2c_driver.clients list or i2c-core's
182 * userspace_devices list
184 * An i2c_client identifies a single device (i.e. chip) connected to an
185 * i2c bus. The behaviour exposed to Linux is defined by the driver
186 * managing the device.
189 unsigned short flags; /* div., see below */
190 unsigned short addr; /* chip address - NOTE: 7bit */
191 /* addresses are stored in the */
193 char name[I2C_NAME_SIZE];
194 struct i2c_adapter *adapter; /* the adapter we sit on */
195 struct i2c_driver *driver; /* and our access routines */
196 struct device dev; /* the device structure */
197 int irq; /* irq issued by device */
198 struct list_head detected;
200 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
202 extern struct i2c_client *i2c_verify_client(struct device *dev);
204 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
206 struct device * const dev = container_of(kobj, struct device, kobj);
207 return to_i2c_client(dev);
210 static inline void *i2c_get_clientdata(const struct i2c_client *dev)
212 return dev_get_drvdata(&dev->dev);
215 static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
217 dev_set_drvdata(&dev->dev, data);
221 * struct i2c_board_info - template for device creation
222 * @type: chip type, to initialize i2c_client.name
223 * @flags: to initialize i2c_client.flags
224 * @addr: stored in i2c_client.addr
225 * @platform_data: stored in i2c_client.dev.platform_data
226 * @archdata: copied into i2c_client.dev.archdata
227 * @irq: stored in i2c_client.irq
229 * I2C doesn't actually support hardware probing, although controllers and
230 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
231 * a device at a given address. Drivers commonly need more information than
232 * that, such as chip type, configuration, associated IRQ, and so on.
234 * i2c_board_info is used to build tables of information listing I2C devices
235 * that are present. This information is used to grow the driver model tree.
236 * For mainboards this is done statically using i2c_register_board_info();
237 * bus numbers identify adapters that aren't yet available. For add-on boards,
238 * i2c_new_device() does this dynamically with the adapter already known.
240 struct i2c_board_info {
241 char type[I2C_NAME_SIZE];
242 unsigned short flags;
245 struct dev_archdata *archdata;
250 * I2C_BOARD_INFO - macro used to list an i2c device and its address
251 * @dev_type: identifies the device type
252 * @dev_addr: the device's address on the bus.
254 * This macro initializes essential fields of a struct i2c_board_info,
255 * declaring what has been provided on a particular board. Optional
256 * fields (such as associated irq, or device-specific platform_data)
257 * are provided using conventional syntax.
259 #define I2C_BOARD_INFO(dev_type, dev_addr) \
260 .type = dev_type, .addr = (dev_addr)
263 /* Add-on boards should register/unregister their devices; e.g. a board
264 * with integrated I2C, a config eeprom, sensors, and a codec that's
265 * used in conjunction with the primary hardware.
267 extern struct i2c_client *
268 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
270 /* If you don't know the exact address of an I2C device, use this variant
271 * instead, which can probe for device presence in a list of possible
274 extern struct i2c_client *
275 i2c_new_probed_device(struct i2c_adapter *adap,
276 struct i2c_board_info *info,
277 unsigned short const *addr_list);
279 /* For devices that use several addresses, use i2c_new_dummy() to make
280 * client handles for the extra addresses.
282 extern struct i2c_client *
283 i2c_new_dummy(struct i2c_adapter *adap, u16 address);
285 extern void i2c_unregister_device(struct i2c_client *);
287 /* Mainboard arch_initcall() code should register all its I2C devices.
288 * This is done at arch_initcall time, before declaring any i2c adapters.
289 * Modules for add-on boards must use other calls.
291 #ifdef CONFIG_I2C_BOARDINFO
293 i2c_register_board_info(int busnum, struct i2c_board_info const *info,
297 i2c_register_board_info(int busnum, struct i2c_board_info const *info,
305 * The following structs are for those who like to implement new bus drivers:
306 * i2c_algorithm is the interface to a class of hardware solutions which can
307 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
308 * to name two of the most common.
310 struct i2c_algorithm {
311 /* If an adapter algorithm can't do I2C-level access, set master_xfer
312 to NULL. If an adapter algorithm can do SMBus access, set
313 smbus_xfer. If set to NULL, the SMBus protocol is simulated
314 using common I2C messages */
315 /* master_xfer should return the number of messages successfully
316 processed, or a negative value on error */
317 int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
319 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
320 unsigned short flags, char read_write,
321 u8 command, int size, union i2c_smbus_data *data);
323 /* To determine what the adapter supports */
324 u32 (*functionality) (struct i2c_adapter *);
328 * i2c_adapter is the structure used to identify a physical i2c bus along
329 * with the access algorithms necessary to access it.
332 struct module *owner;
334 unsigned int class; /* classes to allow probing for */
335 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
338 /* data fields that are valid for all devices */
339 u8 level; /* nesting level for lockdep */
340 struct mutex bus_lock;
342 int timeout; /* in jiffies */
344 struct device dev; /* the adapter device */
348 struct completion dev_released;
350 #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
352 static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
354 return dev_get_drvdata(&dev->dev);
357 static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
359 dev_set_drvdata(&dev->dev, data);
362 /*flags for the client struct: */
363 #define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
364 #define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
365 /* Must equal I2C_M_TEN below */
366 #define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */
368 /* i2c adapter classes (bitmask) */
369 #define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
370 #define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
371 #define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
372 #define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */
373 #define I2C_CLASS_SPD (1<<7) /* SPD EEPROMs and similar */
375 /* i2c_client_address_data is the struct for holding default client
376 * addresses for a driver and for the parameters supplied on the
379 struct i2c_client_address_data {
380 const unsigned short *normal_i2c;
381 const unsigned short *probe;
382 const unsigned short *ignore;
383 const unsigned short * const *forces;
386 /* Internal numbers to terminate lists */
387 #define I2C_CLIENT_END 0xfffeU
389 /* The numbers to use to set I2C bus address */
390 #define ANY_I2C_BUS 0xffff
393 /* ----- functions exported by i2c.o */
397 extern int i2c_add_adapter(struct i2c_adapter *);
398 extern int i2c_del_adapter(struct i2c_adapter *);
399 extern int i2c_add_numbered_adapter(struct i2c_adapter *);
401 extern int i2c_register_driver(struct module *, struct i2c_driver *);
402 extern void i2c_del_driver(struct i2c_driver *);
404 static inline int i2c_add_driver(struct i2c_driver *driver)
406 return i2c_register_driver(THIS_MODULE, driver);
409 extern struct i2c_client *i2c_use_client(struct i2c_client *client);
410 extern void i2c_release_client(struct i2c_client *client);
412 /* call the i2c_client->command() of all attached clients with
413 * the given arguments */
414 extern void i2c_clients_command(struct i2c_adapter *adap,
415 unsigned int cmd, void *arg);
417 extern struct i2c_adapter *i2c_get_adapter(int id);
418 extern void i2c_put_adapter(struct i2c_adapter *adap);
421 /* Return the functionality mask */
422 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
424 return adap->algo->functionality(adap);
427 /* Return 1 if adapter supports everything we need, 0 if not. */
428 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
430 return (func & i2c_get_functionality(adap)) == func;
433 /* Return the adapter number for a specific adapter */
434 static inline int i2c_adapter_id(struct i2c_adapter *adap)
438 #endif /* __KERNEL__ */
441 * struct i2c_msg - an I2C transaction segment beginning with START
442 * @addr: Slave address, either seven or ten bits. When this is a ten
443 * bit address, I2C_M_TEN must be set in @flags and the adapter
444 * must support I2C_FUNC_10BIT_ADDR.
445 * @flags: I2C_M_RD is handled by all adapters. No other flags may be
446 * provided unless the adapter exported the relevant I2C_FUNC_*
447 * flags through i2c_check_functionality().
448 * @len: Number of data bytes in @buf being read from or written to the
449 * I2C slave address. For read transactions where I2C_M_RECV_LEN
450 * is set, the caller guarantees that this buffer can hold up to
451 * 32 bytes in addition to the initial length byte sent by the
452 * slave (plus, if used, the SMBus PEC); and this value will be
453 * incremented by the number of block data bytes received.
454 * @buf: The buffer into which data is read, or from which it's written.
456 * An i2c_msg is the low level representation of one segment of an I2C
457 * transaction. It is visible to drivers in the @i2c_transfer() procedure,
458 * to userspace from i2c-dev, and to I2C adapter drivers through the
459 * @i2c_adapter.@master_xfer() method.
461 * Except when I2C "protocol mangling" is used, all I2C adapters implement
462 * the standard rules for I2C transactions. Each transaction begins with a
463 * START. That is followed by the slave address, and a bit encoding read
464 * versus write. Then follow all the data bytes, possibly including a byte
465 * with SMBus PEC. The transfer terminates with a NAK, or when all those
466 * bytes have been transferred and ACKed. If this is the last message in a
467 * group, it is followed by a STOP. Otherwise it is followed by the next
468 * @i2c_msg transaction segment, beginning with a (repeated) START.
470 * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
471 * passing certain @flags may have changed those standard protocol behaviors.
472 * Those flags are only for use with broken/nonconforming slaves, and with
473 * adapters which are known to support the specific mangling options they
474 * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
477 __u16 addr; /* slave address */
479 #define I2C_M_TEN 0x0010 /* this is a ten bit chip address */
480 #define I2C_M_RD 0x0001 /* read data, from slave to master */
481 #define I2C_M_NOSTART 0x4000 /* if I2C_FUNC_PROTOCOL_MANGLING */
482 #define I2C_M_REV_DIR_ADDR 0x2000 /* if I2C_FUNC_PROTOCOL_MANGLING */
483 #define I2C_M_IGNORE_NAK 0x1000 /* if I2C_FUNC_PROTOCOL_MANGLING */
484 #define I2C_M_NO_RD_ACK 0x0800 /* if I2C_FUNC_PROTOCOL_MANGLING */
485 #define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */
486 __u16 len; /* msg length */
487 __u8 *buf; /* pointer to msg data */
490 /* To determine what functionality is present */
492 #define I2C_FUNC_I2C 0x00000001
493 #define I2C_FUNC_10BIT_ADDR 0x00000002
494 #define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_NOSTART etc. */
495 #define I2C_FUNC_SMBUS_PEC 0x00000008
496 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
497 #define I2C_FUNC_SMBUS_QUICK 0x00010000
498 #define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
499 #define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
500 #define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
501 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
502 #define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
503 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
504 #define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
505 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
506 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
507 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
508 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
510 #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
511 I2C_FUNC_SMBUS_WRITE_BYTE)
512 #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
513 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
514 #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
515 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
516 #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
517 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
518 #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
519 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
521 #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
522 I2C_FUNC_SMBUS_BYTE | \
523 I2C_FUNC_SMBUS_BYTE_DATA | \
524 I2C_FUNC_SMBUS_WORD_DATA | \
525 I2C_FUNC_SMBUS_PROC_CALL | \
526 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
527 I2C_FUNC_SMBUS_I2C_BLOCK | \
531 * Data for SMBus Messages
533 #define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
534 union i2c_smbus_data {
537 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
538 /* and one more for user-space compatibility */
541 /* i2c_smbus_xfer read or write markers */
542 #define I2C_SMBUS_READ 1
543 #define I2C_SMBUS_WRITE 0
545 /* SMBus transaction types (size parameter in the above functions)
546 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
547 #define I2C_SMBUS_QUICK 0
548 #define I2C_SMBUS_BYTE 1
549 #define I2C_SMBUS_BYTE_DATA 2
550 #define I2C_SMBUS_WORD_DATA 3
551 #define I2C_SMBUS_PROC_CALL 4
552 #define I2C_SMBUS_BLOCK_DATA 5
553 #define I2C_SMBUS_I2C_BLOCK_BROKEN 6
554 #define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
555 #define I2C_SMBUS_I2C_BLOCK_DATA 8
560 /* These defines are used for probing i2c client addresses */
561 /* The length of the option lists */
562 #define I2C_CLIENT_MAX_OPTS 48
564 /* Default fill of many variables */
565 #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
566 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
567 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
568 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
569 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
570 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
571 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
572 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
573 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
574 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
575 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
576 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
577 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
578 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
579 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
580 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
582 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
585 #define I2C_CLIENT_MODULE_PARM(var,desc) \
586 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
587 static unsigned int var##_num; \
588 module_param_array(var, short, &var##_num, 0); \
589 MODULE_PARM_DESC(var, desc)
591 #define I2C_CLIENT_MODULE_PARM_FORCE(name) \
592 I2C_CLIENT_MODULE_PARM(force_##name, \
593 "List of adapter,address pairs which are " \
594 "unquestionably assumed to contain a `" \
598 #define I2C_CLIENT_INSMOD_COMMON \
599 I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
601 I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
603 static const struct i2c_client_address_data addr_data = { \
604 .normal_i2c = normal_i2c, \
610 #define I2C_CLIENT_FORCE_TEXT \
611 "List of adapter,address pairs to boldly assume to be present"
613 /* These are the ones you want to use in your own drivers. Pick the one
614 which matches the number of devices the driver differenciates between. */
615 #define I2C_CLIENT_INSMOD \
616 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
617 static const unsigned short * const forces[] = { force, NULL }; \
618 I2C_CLIENT_INSMOD_COMMON
620 #define I2C_CLIENT_INSMOD_1(chip1) \
621 enum chips { any_chip, chip1 }; \
622 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
623 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
624 static const unsigned short * const forces[] = { force, \
625 force_##chip1, NULL }; \
626 I2C_CLIENT_INSMOD_COMMON
628 #define I2C_CLIENT_INSMOD_2(chip1, chip2) \
629 enum chips { any_chip, chip1, chip2 }; \
630 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
631 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
632 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
633 static const unsigned short * const forces[] = { force, \
634 force_##chip1, force_##chip2, NULL }; \
635 I2C_CLIENT_INSMOD_COMMON
637 #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
638 enum chips { any_chip, chip1, chip2, chip3 }; \
639 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
640 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
641 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
642 I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
643 static const unsigned short * const forces[] = { force, \
644 force_##chip1, force_##chip2, force_##chip3, NULL }; \
645 I2C_CLIENT_INSMOD_COMMON
647 #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
648 enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
649 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
650 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
651 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
652 I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
653 I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
654 static const unsigned short * const forces[] = { force, \
655 force_##chip1, force_##chip2, force_##chip3, \
656 force_##chip4, NULL}; \
657 I2C_CLIENT_INSMOD_COMMON
659 #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
660 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
661 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
662 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
663 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
664 I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
665 I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
666 I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
667 static const unsigned short * const forces[] = { force, \
668 force_##chip1, force_##chip2, force_##chip3, \
669 force_##chip4, force_##chip5, NULL }; \
670 I2C_CLIENT_INSMOD_COMMON
672 #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
673 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
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 I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
681 static const unsigned short * const forces[] = { force, \
682 force_##chip1, force_##chip2, force_##chip3, \
683 force_##chip4, force_##chip5, force_##chip6, NULL }; \
684 I2C_CLIENT_INSMOD_COMMON
686 #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
687 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
689 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
690 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
691 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
692 I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
693 I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
694 I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
695 I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
696 I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
697 static const unsigned short * const forces[] = { force, \
698 force_##chip1, force_##chip2, force_##chip3, \
699 force_##chip4, force_##chip5, force_##chip6, \
700 force_##chip7, NULL }; \
701 I2C_CLIENT_INSMOD_COMMON
703 #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
704 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
706 I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
707 I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
708 I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
709 I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
710 I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
711 I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
712 I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
713 I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
714 I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
715 static const unsigned short * const forces[] = { force, \
716 force_##chip1, force_##chip2, force_##chip3, \
717 force_##chip4, force_##chip5, force_##chip6, \
718 force_##chip7, force_##chip8, NULL }; \
719 I2C_CLIENT_INSMOD_COMMON
720 #endif /* __KERNEL__ */
721 #endif /* _LINUX_I2C_H */