]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/i2c.h
i2c: i2c stack can probe()
[net-next-2.6.git] / include / linux / i2c.h
CommitLineData
1da177e4 1/* ------------------------------------------------------------------------- */
438d6c2c 2/* */
1da177e4 3/* i2c.h - definitions for the i2c-bus interface */
438d6c2c 4/* */
1da177e4
LT
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
a1b9298e 23/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
1da177e4
LT
24 Frodo Looijaard <frodol@dds.nl> */
25
1da177e4
LT
26#ifndef _LINUX_I2C_H
27#define _LINUX_I2C_H
28
1da177e4 29#include <linux/types.h>
438d6c2c 30#ifdef __KERNEL__
a1b9298e 31#include <linux/module.h>
1da177e4 32#include <linux/i2c-id.h>
a9d1b24d 33#include <linux/mod_devicetable.h>
1da177e4 34#include <linux/device.h> /* for struct device */
4e57b681 35#include <linux/sched.h> /* for completion */
5c085d36 36#include <linux/mutex.h>
1da177e4 37
efde723f
JD
38/* --- For i2c-isa ---------------------------------------------------- */
39
40extern void i2c_adapter_dev_release(struct device *dev);
efde723f
JD
41extern struct class i2c_adapter_class;
42extern struct bus_type i2c_bus_type;
43
1da177e4
LT
44/* --- General options ------------------------------------------------ */
45
46struct i2c_msg;
47struct i2c_algorithm;
48struct i2c_adapter;
49struct i2c_client;
50struct i2c_driver;
1da177e4
LT
51union i2c_smbus_data;
52
53/*
54 * The master routines are the ones normally used to transmit data to devices
438d6c2c
DB
55 * on a bus (or read from them). Apart from two basic transfer functions to
56 * transmit one message at a time, a more complex version can be used to
1da177e4
LT
57 * transmit an arbitrary number of messages without interruption.
58 */
59extern int i2c_master_send(struct i2c_client *,const char* ,int);
60extern int i2c_master_recv(struct i2c_client *,char* ,int);
61
62/* Transfer num messages.
63 */
64extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
65
1da177e4
LT
66
67/* This is the very generalized SMBus access routine. You probably do not
68 want to use this, though; one of the functions below may be much easier,
438d6c2c 69 and probably just as fast.
1da177e4
LT
70 Note that we use i2c_adapter here, because you do not need a specific
71 smbus adapter to call this function. */
438d6c2c 72extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
1da177e4
LT
73 unsigned short flags,
74 char read_write, u8 command, int size,
75 union i2c_smbus_data * data);
76
77/* Now follow the 'nice' access routines. These also document the calling
78 conventions of smbus_access. */
79
80extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
81extern s32 i2c_smbus_read_byte(struct i2c_client * client);
82extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
83extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
84extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
85 u8 command, u8 value);
86extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
87extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
88 u8 command, u16 value);
1da177e4
LT
89extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
90 u8 command, u8 length,
46f5ed75 91 const u8 *values);
31ec5bc5 92/* Returns the number of read bytes */
1da177e4
LT
93extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
94 u8 command, u8 *values);
21bbd691
JD
95extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,
96 u8 command, u8 length,
46f5ed75 97 const u8 *values);
1da177e4
LT
98
99/*
100 * A driver is capable of handling one or more physical devices present on
101 * I2C adapters. This information is used to inform the driver of adapter
102 * events.
35d8b2e6
LR
103 *
104 * The driver.owner field should be set to the module owner of this driver.
105 * The driver.name field should be set to the name of this driver.
1da177e4
LT
106 */
107
108struct i2c_driver {
1da177e4
LT
109 int id;
110 unsigned int class;
1da177e4
LT
111
112 /* Notifies the driver that a new bus has appeared. This routine
113 * can be used by the driver to test if the bus meets its conditions
438d6c2c 114 * & seek for the presence of the chip(s) it supports. If found, it
1da177e4 115 * registers the client(s) that are on the bus to the i2c admin. via
7b4fbc50 116 * i2c_attach_client. (LEGACY I2C DRIVERS ONLY)
1da177e4
LT
117 */
118 int (*attach_adapter)(struct i2c_adapter *);
119 int (*detach_adapter)(struct i2c_adapter *);
120
438d6c2c 121 /* tells the driver that a client is about to be deleted & gives it
1da177e4
LT
122 * the chance to remove its private data. Also, if the client struct
123 * has been dynamically allocated by the driver in the function above,
7b4fbc50 124 * it must be freed here. (LEGACY I2C DRIVERS ONLY)
1da177e4
LT
125 */
126 int (*detach_client)(struct i2c_client *);
f37dd80a 127
7b4fbc50
DB
128 /* Standard driver model interfaces, for "new style" i2c drivers.
129 * With the driver model, device enumeration is NEVER done by drivers;
130 * it's done by infrastructure. (NEW STYLE DRIVERS ONLY)
131 */
132 int (*probe)(struct i2c_client *);
133
f37dd80a
DB
134 /* driver model interfaces that don't relate to enumeration */
135 void (*shutdown)(struct i2c_client *);
136 int (*suspend)(struct i2c_client *, pm_message_t mesg);
137 int (*resume)(struct i2c_client *);
138
1da177e4
LT
139 /* a ioctl like command that can be used to perform specific functions
140 * with the device.
141 */
142 int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
143
144 struct device_driver driver;
145 struct list_head list;
146};
147#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
148
2096b956
DB
149#define I2C_NAME_SIZE 20
150
151/**
152 * struct i2c_client - represent an I2C slave device
153 * @addr: Address used on the I2C bus connected to the parent adapter.
154 * @name: Indicates the type of the device, usually a chip name that's
155 * generic enough to hide second-sourcing and compatible revisions.
156 * @dev: Driver model device node for the slave.
7b4fbc50
DB
157 * @driver_name: Identifies new-style driver used with this device; also
158 * used as the module name for hotplug/coldplug modprobe support.
2096b956
DB
159 *
160 * An i2c_client identifies a single device (i.e. chip) connected to an
161 * i2c bus. The behaviour is defined by the routines of the driver.
1da177e4
LT
162 */
163struct i2c_client {
2096b956 164 unsigned short flags; /* div., see below */
438d6c2c 165 unsigned short addr; /* chip address - NOTE: 7bit */
1da177e4 166 /* addresses are stored in the */
5071860a 167 /* _LOWER_ 7 bits */
2096b956 168 char name[I2C_NAME_SIZE];
1da177e4
LT
169 struct i2c_adapter *adapter; /* the adapter we sit on */
170 struct i2c_driver *driver; /* and our access routines */
171 int usage_count; /* How many accesses currently */
172 /* to the client */
173 struct device dev; /* the device structure */
7b4fbc50 174 char driver_name[KOBJ_NAME_LEN];
1da177e4 175 struct list_head list;
1da177e4
LT
176 struct completion released;
177};
178#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
179
a61fc683
BG
180static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
181{
182 return to_i2c_client(container_of(kobj, struct device, kobj));
183}
184
1da177e4
LT
185static inline void *i2c_get_clientdata (struct i2c_client *dev)
186{
187 return dev_get_drvdata (&dev->dev);
188}
189
190static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
191{
192 dev_set_drvdata (&dev->dev, data);
193}
194
1da177e4
LT
195/*
196 * The following structs are for those who like to implement new bus drivers:
197 * i2c_algorithm is the interface to a class of hardware solutions which can
198 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
199 * to name two of the most common.
200 */
201struct i2c_algorithm {
1da177e4 202 /* If an adapter algorithm can't do I2C-level access, set master_xfer
438d6c2c 203 to NULL. If an adapter algorithm can do SMBus access, set
1da177e4
LT
204 smbus_xfer. If set to NULL, the SMBus protocol is simulated
205 using common I2C messages */
8ced8eee
JD
206 /* master_xfer should return the number of messages successfully
207 processed, or a negative value on error */
438d6c2c 208 int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
1da177e4 209 int num);
438d6c2c 210 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
1da177e4
LT
211 unsigned short flags, char read_write,
212 u8 command, int size, union i2c_smbus_data * data);
213
1da177e4
LT
214 /* --- ioctl like call to set div. parameters. */
215 int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
216
217 /* To determine what the adapter supports */
218 u32 (*functionality) (struct i2c_adapter *);
219};
220
221/*
222 * i2c_adapter is the structure used to identify a physical i2c bus along
223 * with the access algorithms necessary to access it.
224 */
225struct i2c_adapter {
226 struct module *owner;
020789e9 227 unsigned int id;
1da177e4 228 unsigned int class;
af71ff69 229 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
1da177e4
LT
230 void *algo_data;
231
232 /* --- administration stuff. */
233 int (*client_register)(struct i2c_client *);
234 int (*client_unregister)(struct i2c_client *);
235
236 /* data fields that are valid for all devices */
6ea23039 237 u8 level; /* nesting level for lockdep */
5c085d36
IM
238 struct mutex bus_lock;
239 struct mutex clist_lock;
1da177e4
LT
240
241 int timeout;
242 int retries;
243 struct device dev; /* the adapter device */
1da177e4 244
1da177e4
LT
245 int nr;
246 struct list_head clients;
247 struct list_head list;
2096b956 248 char name[48];
1da177e4 249 struct completion dev_released;
1da177e4 250};
ef2c8321 251#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
1da177e4
LT
252
253static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
254{
255 return dev_get_drvdata (&dev->dev);
256}
257
258static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
259{
260 dev_set_drvdata (&dev->dev, data);
261}
262
1da177e4 263/*flags for the client struct: */
1da177e4
LT
264#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
265#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
266 /* Must equal I2C_M_TEN below */
267
268/* i2c adapter classes (bitmask) */
269#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
270#define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
271#define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
272#define I2C_CLASS_DDC (1<<3) /* i2c-matroxfb ? */
273#define I2C_CLASS_CAM_ANALOG (1<<4) /* camera with analog CCD */
274#define I2C_CLASS_CAM_DIGITAL (1<<5) /* most webcams */
275#define I2C_CLASS_SOUND (1<<6) /* sound devices */
276#define I2C_CLASS_ALL (UINT_MAX) /* all of the above */
277
278/* i2c_client_address_data is the struct for holding default client
279 * addresses for a driver and for the parameters supplied on the
280 * command line
281 */
282struct i2c_client_address_data {
283 unsigned short *normal_i2c;
1da177e4 284 unsigned short *probe;
1da177e4 285 unsigned short *ignore;
9fc6adfa 286 unsigned short **forces;
1da177e4
LT
287};
288
289/* Internal numbers to terminate lists */
290#define I2C_CLIENT_END 0xfffeU
1da177e4
LT
291
292/* The numbers to use to set I2C bus address */
293#define ANY_I2C_BUS 0xffff
294#define ANY_I2C_ISA_BUS 9191
295
296
297/* ----- functions exported by i2c.o */
298
299/* administration...
300 */
301extern int i2c_add_adapter(struct i2c_adapter *);
302extern int i2c_del_adapter(struct i2c_adapter *);
303
de59cf9e 304extern int i2c_register_driver(struct module *, struct i2c_driver *);
1da177e4
LT
305extern int i2c_del_driver(struct i2c_driver *);
306
de59cf9e
GKH
307static inline int i2c_add_driver(struct i2c_driver *driver)
308{
309 return i2c_register_driver(THIS_MODULE, driver);
310}
311
1da177e4
LT
312extern int i2c_attach_client(struct i2c_client *);
313extern int i2c_detach_client(struct i2c_client *);
314
482c788d
JD
315/* Should be used to make sure that client-struct is valid and that it
316 is okay to access the i2c-client.
cf02df77 317 returns -ENODEV if client has gone in the meantime */
1da177e4
LT
318extern int i2c_use_client(struct i2c_client *);
319extern int i2c_release_client(struct i2c_client *);
320
321/* call the i2c_client->command() of all attached clients with
322 * the given arguments */
323extern void i2c_clients_command(struct i2c_adapter *adap,
324 unsigned int cmd, void *arg);
325
326/* returns -EBUSY if address has been taken, 0 if not. Note that the only
327 other place at which this is called is within i2c_attach_client; so
328 you can cheat by simply not registering. Not recommended, of course! */
329extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
330
331/* Detect function. It iterates over all possible addresses itself.
332 * It will only call found_proc if some client is connected at the
333 * specific address (unless a 'force' matched);
334 */
438d6c2c 335extern int i2c_probe(struct i2c_adapter *adapter,
1da177e4
LT
336 struct i2c_client_address_data *address_data,
337 int (*found_proc) (struct i2c_adapter *, int, int));
338
339/* An ioctl like call to set div. parameters of the adapter.
340 */
341extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
342
1da177e4
LT
343extern struct i2c_adapter* i2c_get_adapter(int id);
344extern void i2c_put_adapter(struct i2c_adapter *adap);
345
346
347/* Return the functionality mask */
348static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
349{
350 return adap->algo->functionality(adap);
351}
352
353/* Return 1 if adapter supports everything we need, 0 if not. */
354static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
355{
356 return (func & i2c_get_functionality(adap)) == func;
357}
358
cdcb1921
JD
359/* Return id number for a specific adapter */
360static inline int i2c_adapter_id(struct i2c_adapter *adap)
361{
362 return adap->nr;
363}
a1b9298e 364#endif /* __KERNEL__ */
cdcb1921 365
1da177e4
LT
366/*
367 * I2C Message - used for pure i2c transaction, also from /dev interface
368 */
369struct i2c_msg {
370 __u16 addr; /* slave address */
438d6c2c 371 __u16 flags;
1da177e4
LT
372#define I2C_M_TEN 0x10 /* we have a ten bit chip address */
373#define I2C_M_RD 0x01
374#define I2C_M_NOSTART 0x4000
375#define I2C_M_REV_DIR_ADDR 0x2000
376#define I2C_M_IGNORE_NAK 0x1000
377#define I2C_M_NO_RD_ACK 0x0800
209d27c3 378#define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */
438d6c2c
DB
379 __u16 len; /* msg length */
380 __u8 *buf; /* pointer to msg data */
1da177e4
LT
381};
382
383/* To determine what functionality is present */
384
385#define I2C_FUNC_I2C 0x00000001
386#define I2C_FUNC_10BIT_ADDR 0x00000002
387#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
388#define I2C_FUNC_SMBUS_HWPEC_CALC 0x00000008 /* SMBus 2.0 */
1da177e4 389#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
438d6c2c
DB
390#define I2C_FUNC_SMBUS_QUICK 0x00010000
391#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
392#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
393#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
394#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
395#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
396#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
397#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
398#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
399#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
1da177e4
LT
400#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
401#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
402#define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 0x10000000 /* I2C-like block xfer */
403#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
1da177e4
LT
404
405#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
406 I2C_FUNC_SMBUS_WRITE_BYTE)
407#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
408 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
409#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
410 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
411#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
412 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
413#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
414 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
415#define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
416 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
1da177e4
LT
417
418#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
419 I2C_FUNC_SMBUS_BYTE | \
420 I2C_FUNC_SMBUS_BYTE_DATA | \
421 I2C_FUNC_SMBUS_WORD_DATA | \
422 I2C_FUNC_SMBUS_PROC_CALL | \
423 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
1da177e4
LT
424 I2C_FUNC_SMBUS_I2C_BLOCK)
425
438d6c2c
DB
426/*
427 * Data for SMBus Messages
1da177e4 428 */
438d6c2c 429#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
1da177e4
LT
430union i2c_smbus_data {
431 __u8 byte;
432 __u16 word;
332bf92b 433 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
421ef47b 434 /* and one more for user-space compatibility */
1da177e4
LT
435};
436
437/* smbus_access read or write markers */
438#define I2C_SMBUS_READ 1
439#define I2C_SMBUS_WRITE 0
440
438d6c2c 441/* SMBus transaction types (size parameter in the above functions)
1da177e4
LT
442 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
443#define I2C_SMBUS_QUICK 0
444#define I2C_SMBUS_BYTE 1
438d6c2c 445#define I2C_SMBUS_BYTE_DATA 2
1da177e4
LT
446#define I2C_SMBUS_WORD_DATA 3
447#define I2C_SMBUS_PROC_CALL 4
448#define I2C_SMBUS_BLOCK_DATA 5
449#define I2C_SMBUS_I2C_BLOCK_DATA 6
450#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
1da177e4
LT
451
452
453/* ----- commands for the ioctl like i2c_command call:
438d6c2c
DB
454 * note that additional calls are defined in the algorithm and hw
455 * dependent layers - these can be listed here, or see the
1da177e4
LT
456 * corresponding header files.
457 */
458 /* -> bit-adapter specific ioctls */
459#define I2C_RETRIES 0x0701 /* number of times a device address */
460 /* should be polled when not */
438d6c2c
DB
461 /* acknowledging */
462#define I2C_TIMEOUT 0x0702 /* set timeout - call with int */
1da177e4
LT
463
464
465/* this is for i2c-dev.c */
466#define I2C_SLAVE 0x0703 /* Change slave address */
467 /* Attn.: Slave address is 7 or 10 bits */
468#define I2C_SLAVE_FORCE 0x0706 /* Change slave address */
469 /* Attn.: Slave address is 7 or 10 bits */
470 /* This changes the address, even if it */
471 /* is already taken! */
472#define I2C_TENBIT 0x0704 /* 0 for 7 bit addrs, != 0 for 10 bit */
473
474#define I2C_FUNCS 0x0705 /* Get the adapter functionality */
475#define I2C_RDWR 0x0707 /* Combined R/W transfer (one stop only)*/
476#define I2C_PEC 0x0708 /* != 0 for SMBus PEC */
1da177e4
LT
477
478#define I2C_SMBUS 0x0720 /* SMBus-level access */
479
1da177e4 480/* ----- I2C-DEV: char device interface stuff ------------------------- */
a1b9298e 481#ifdef __KERNEL__
1da177e4
LT
482
483#define I2C_MAJOR 89 /* Device major number */
484
485/* These defines are used for probing i2c client addresses */
486/* The length of the option lists */
487#define I2C_CLIENT_MAX_OPTS 48
488
489/* Default fill of many variables */
490#define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
491 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
492 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
493 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
494 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
495 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
496 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
497 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
498 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
499 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
500 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
501 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
502 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
503 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
504 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
505 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
506
507/* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
508 module header */
509
510#define I2C_CLIENT_MODULE_PARM(var,desc) \
511 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
512 static unsigned int var##_num; \
513 module_param_array(var, short, &var##_num, 0); \
514 MODULE_PARM_DESC(var,desc)
515
f4b50261
JD
516#define I2C_CLIENT_MODULE_PARM_FORCE(name) \
517I2C_CLIENT_MODULE_PARM(force_##name, \
518 "List of adapter,address pairs which are " \
519 "unquestionably assumed to contain a `" \
520 # name "' chip")
521
522
523#define I2C_CLIENT_INSMOD_COMMON \
524I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
525 "additionally"); \
526I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
527 "scan"); \
528static struct i2c_client_address_data addr_data = { \
529 .normal_i2c = normal_i2c, \
530 .probe = probe, \
531 .ignore = ignore, \
532 .forces = forces, \
533}
534
535/* These are the ones you want to use in your own drivers. Pick the one
536 which matches the number of devices the driver differenciates between. */
1da177e4 537#define I2C_CLIENT_INSMOD \
1da177e4
LT
538 I2C_CLIENT_MODULE_PARM(force, \
539 "List of adapter,address pairs to boldly assume " \
540 "to be present"); \
f4b50261 541 static unsigned short *forces[] = { \
9fc6adfa
JD
542 force, \
543 NULL \
544 }; \
f4b50261
JD
545I2C_CLIENT_INSMOD_COMMON
546
547#define I2C_CLIENT_INSMOD_1(chip1) \
548enum chips { any_chip, chip1 }; \
549I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
550 "boldly assume to be present"); \
551I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
552static unsigned short *forces[] = { force, force_##chip1, NULL }; \
553I2C_CLIENT_INSMOD_COMMON
554
555#define I2C_CLIENT_INSMOD_2(chip1, chip2) \
556enum chips { any_chip, chip1, chip2 }; \
557I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
558 "boldly assume to be present"); \
559I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
560I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
561static unsigned short *forces[] = { force, force_##chip1, \
562 force_##chip2, NULL }; \
563I2C_CLIENT_INSMOD_COMMON
564
565#define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
566enum chips { any_chip, chip1, chip2, chip3 }; \
567I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
568 "boldly assume to be present"); \
569I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
570I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
571I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
572static unsigned short *forces[] = { force, force_##chip1, \
573 force_##chip2, force_##chip3, \
574 NULL }; \
575I2C_CLIENT_INSMOD_COMMON
576
577#define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
578enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
579I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
580 "boldly assume to be present"); \
581I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
582I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
583I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
584I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
585static unsigned short *forces[] = { force, force_##chip1, \
586 force_##chip2, force_##chip3, \
587 force_##chip4, NULL}; \
588I2C_CLIENT_INSMOD_COMMON
589
590#define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
591enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
592I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
593 "boldly assume to be present"); \
594I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
595I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
596I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
597I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
598I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
599static unsigned short *forces[] = { force, force_##chip1, \
600 force_##chip2, force_##chip3, \
601 force_##chip4, force_##chip5, \
602 NULL }; \
603I2C_CLIENT_INSMOD_COMMON
604
605#define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
606enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
607I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
608 "boldly assume to be present"); \
609I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
610I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
611I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
612I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
613I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
614I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
615static unsigned short *forces[] = { force, force_##chip1, \
616 force_##chip2, force_##chip3, \
617 force_##chip4, force_##chip5, \
618 force_##chip6, NULL }; \
619I2C_CLIENT_INSMOD_COMMON
620
621#define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
622enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
623 chip7 }; \
624I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
625 "boldly assume to be present"); \
626I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
627I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
628I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
629I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
630I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
631I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
632I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
633static unsigned short *forces[] = { force, force_##chip1, \
634 force_##chip2, force_##chip3, \
635 force_##chip4, force_##chip5, \
636 force_##chip6, force_##chip7, \
637 NULL }; \
638I2C_CLIENT_INSMOD_COMMON
639
640#define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
641enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
642 chip7, chip8 }; \
643I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
644 "boldly assume to be present"); \
645I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
646I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
647I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
648I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
649I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
650I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
651I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
652I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
653static unsigned short *forces[] = { force, force_##chip1, \
654 force_##chip2, force_##chip3, \
655 force_##chip4, force_##chip5, \
656 force_##chip6, force_##chip7, \
657 force_##chip8, NULL }; \
658I2C_CLIENT_INSMOD_COMMON
a1b9298e 659#endif /* __KERNEL__ */
1da177e4 660#endif /* _LINUX_I2C_H */