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