blob: 5e19a7ba69b2b9ff449ca5d276fdb27bc233fce7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* ------------------------------------------------------------------------- */
2/* */
3/* i2c.h - definitions for the i2c-bus interface */
4/* */
5/* ------------------------------------------------------------------------- */
6/* Copyright (C) 1995-2000 Simon G. Vogl
7
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
12
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
21/* ------------------------------------------------------------------------- */
22
23/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
24 Frodo Looijaard <frodol@dds.nl> */
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#ifndef _LINUX_I2C_H
27#define _LINUX_I2C_H
28
29#include <linux/module.h>
30#include <linux/types.h>
31#include <linux/i2c-id.h>
Greg Kroah-Hartmana9d1b242005-10-22 00:23:27 +020032#include <linux/mod_devicetable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/device.h> /* for struct device */
Tim Schmielau4e57b682005-10-30 15:03:48 -080034#include <linux/sched.h> /* for completion */
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <asm/semaphore.h>
36
Jean Delvareefde7232005-07-20 23:03:50 +020037/* --- For i2c-isa ---------------------------------------------------- */
38
39extern void i2c_adapter_dev_release(struct device *dev);
40extern struct device_driver i2c_adapter_driver;
41extern struct class i2c_adapter_class;
42extern struct bus_type i2c_bus_type;
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044/* --- General options ------------------------------------------------ */
45
46struct i2c_msg;
47struct i2c_algorithm;
48struct i2c_adapter;
49struct i2c_client;
50struct i2c_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051union i2c_smbus_data;
52
53/*
54 * The master routines are the ones normally used to transmit data to devices
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
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
66/*
67 * Some adapter types (i.e. PCF 8584 based ones) may support slave behaviuor.
68 * This is not tested/implemented yet and will change in the future.
69 */
70extern int i2c_slave_send(struct i2c_client *,char*,int);
71extern int i2c_slave_recv(struct i2c_client *,char*,int);
72
73
74
75/* This is the very generalized SMBus access routine. You probably do not
76 want to use this, though; one of the functions below may be much easier,
77 and probably just as fast.
78 Note that we use i2c_adapter here, because you do not need a specific
79 smbus adapter to call this function. */
80extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
81 unsigned short flags,
82 char read_write, u8 command, int size,
83 union i2c_smbus_data * data);
84
85/* Now follow the 'nice' access routines. These also document the calling
86 conventions of smbus_access. */
87
88extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
89extern s32 i2c_smbus_read_byte(struct i2c_client * client);
90extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
91extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
92extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
93 u8 command, u8 value);
94extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
95extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
96 u8 command, u16 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
98 u8 command, u8 length,
99 u8 *values);
Jean Delvare31ec5bc2005-10-08 00:04:13 +0200100/* Returns the number of read bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
102 u8 command, u8 *values);
103
104/*
105 * A driver is capable of handling one or more physical devices present on
106 * I2C adapters. This information is used to inform the driver of adapter
107 * events.
108 */
109
110struct i2c_driver {
111 struct module *owner;
112 char name[32];
113 int id;
114 unsigned int class;
115 unsigned int flags; /* div., see below */
116
117 /* Notifies the driver that a new bus has appeared. This routine
118 * can be used by the driver to test if the bus meets its conditions
119 * & seek for the presence of the chip(s) it supports. If found, it
120 * registers the client(s) that are on the bus to the i2c admin. via
121 * i2c_attach_client.
122 */
123 int (*attach_adapter)(struct i2c_adapter *);
124 int (*detach_adapter)(struct i2c_adapter *);
125
126 /* tells the driver that a client is about to be deleted & gives it
127 * the chance to remove its private data. Also, if the client struct
128 * has been dynamically allocated by the driver in the function above,
129 * it must be freed here.
130 */
131 int (*detach_client)(struct i2c_client *);
132
133 /* a ioctl like command that can be used to perform specific functions
134 * with the device.
135 */
136 int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
137
138 struct device_driver driver;
139 struct list_head list;
140};
141#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
142
143#define I2C_NAME_SIZE 50
144
145/*
146 * i2c_client identifies a single device (i.e. chip) that is connected to an
147 * i2c bus. The behaviour is defined by the routines of the driver. This
148 * function is mainly used for lookup & other admin. functions.
149 */
150struct i2c_client {
151 unsigned int flags; /* div., see below */
Jean Delvare50718602005-07-20 00:02:32 +0200152 unsigned short addr; /* chip address - NOTE: 7bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 /* addresses are stored in the */
Jean Delvare50718602005-07-20 00:02:32 +0200154 /* _LOWER_ 7 bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 struct i2c_adapter *adapter; /* the adapter we sit on */
156 struct i2c_driver *driver; /* and our access routines */
157 int usage_count; /* How many accesses currently */
158 /* to the client */
159 struct device dev; /* the device structure */
160 struct list_head list;
161 char name[I2C_NAME_SIZE];
162 struct completion released;
163};
164#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
165
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500166static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
167{
168 return to_i2c_client(container_of(kobj, struct device, kobj));
169}
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171static inline void *i2c_get_clientdata (struct i2c_client *dev)
172{
173 return dev_get_drvdata (&dev->dev);
174}
175
176static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
177{
178 dev_set_drvdata (&dev->dev, data);
179}
180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181/*
182 * The following structs are for those who like to implement new bus drivers:
183 * i2c_algorithm is the interface to a class of hardware solutions which can
184 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
185 * to name two of the most common.
186 */
187struct i2c_algorithm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 /* If an adapter algorithm can't do I2C-level access, set master_xfer
189 to NULL. If an adapter algorithm can do SMBus access, set
190 smbus_xfer. If set to NULL, the SMBus protocol is simulated
191 using common I2C messages */
192 int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
193 int num);
194 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
195 unsigned short flags, char read_write,
196 u8 command, int size, union i2c_smbus_data * data);
197
198 /* --- these optional/future use for some adapter types.*/
199 int (*slave_send)(struct i2c_adapter *,char*,int);
200 int (*slave_recv)(struct i2c_adapter *,char*,int);
201
202 /* --- ioctl like call to set div. parameters. */
203 int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
204
205 /* To determine what the adapter supports */
206 u32 (*functionality) (struct i2c_adapter *);
207};
208
209/*
210 * i2c_adapter is the structure used to identify a physical i2c bus along
211 * with the access algorithms necessary to access it.
212 */
213struct i2c_adapter {
214 struct module *owner;
Jean Delvare020789e2005-08-13 13:04:32 +0200215 unsigned int id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 unsigned int class;
217 struct i2c_algorithm *algo;/* the algorithm to access the bus */
218 void *algo_data;
219
220 /* --- administration stuff. */
221 int (*client_register)(struct i2c_client *);
222 int (*client_unregister)(struct i2c_client *);
223
224 /* data fields that are valid for all devices */
225 struct semaphore bus_lock;
226 struct semaphore clist_lock;
227
228 int timeout;
229 int retries;
230 struct device dev; /* the adapter device */
231 struct class_device class_dev; /* the class device */
232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 int nr;
234 struct list_head clients;
235 struct list_head list;
236 char name[I2C_NAME_SIZE];
237 struct completion dev_released;
238 struct completion class_dev_released;
239};
240#define dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
241#define class_dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, class_dev)
242
243static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
244{
245 return dev_get_drvdata (&dev->dev);
246}
247
248static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
249{
250 dev_set_drvdata (&dev->dev, data);
251}
252
253/*flags for the driver struct: */
254#define I2C_DF_NOTIFY 0x01 /* notify on bus (de/a)ttaches */
255#if 0
256/* this flag is gone -- there is a (optional) driver->detach_adapter
257 * callback now which can be used instead */
258# define I2C_DF_DUMMY 0x02
259#endif
260
261/*flags for the client struct: */
262#define I2C_CLIENT_ALLOW_USE 0x01 /* Client allows access */
263#define I2C_CLIENT_ALLOW_MULTIPLE_USE 0x02 /* Allow multiple access-locks */
264 /* on an i2c_client */
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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 unsigned short *probe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 unsigned short *ignore;
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200287 unsigned short **forces;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288};
289
290/* Internal numbers to terminate lists */
291#define I2C_CLIENT_END 0xfffeU
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
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
305extern int i2c_add_driver(struct i2c_driver *);
306extern int i2c_del_driver(struct i2c_driver *);
307
308extern int i2c_attach_client(struct i2c_client *);
309extern int i2c_detach_client(struct i2c_client *);
310
311/* New function: This is to get an i2c_client-struct for controlling the
312 client either by using i2c_control-function or having the
313 client-module export functions that can be used with the i2c_client
314 -struct. */
315extern struct i2c_client *i2c_get_client(int driver_id, int adapter_id,
316 struct i2c_client *prev);
317
318/* Should be used with new function
319 extern struct i2c_client *i2c_get_client(int,int,struct i2c_client *);
320 to make sure that client-struct is valid and that it is okay to access
321 the i2c-client.
322 returns -EACCES if client doesn't allow use (default)
323 returns -EBUSY if client doesn't allow multiple use (default) and
324 usage_count >0 */
325extern int i2c_use_client(struct i2c_client *);
326extern int i2c_release_client(struct i2c_client *);
327
328/* call the i2c_client->command() of all attached clients with
329 * the given arguments */
330extern void i2c_clients_command(struct i2c_adapter *adap,
331 unsigned int cmd, void *arg);
332
333/* returns -EBUSY if address has been taken, 0 if not. Note that the only
334 other place at which this is called is within i2c_attach_client; so
335 you can cheat by simply not registering. Not recommended, of course! */
336extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
337
338/* Detect function. It iterates over all possible addresses itself.
339 * It will only call found_proc if some client is connected at the
340 * specific address (unless a 'force' matched);
341 */
342extern int i2c_probe(struct i2c_adapter *adapter,
343 struct i2c_client_address_data *address_data,
344 int (*found_proc) (struct i2c_adapter *, int, int));
345
346/* An ioctl like call to set div. parameters of the adapter.
347 */
348extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350extern struct i2c_adapter* i2c_get_adapter(int id);
351extern void i2c_put_adapter(struct i2c_adapter *adap);
352
353
354/* Return the functionality mask */
355static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
356{
357 return adap->algo->functionality(adap);
358}
359
360/* Return 1 if adapter supports everything we need, 0 if not. */
361static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
362{
363 return (func & i2c_get_functionality(adap)) == func;
364}
365
Jean Delvarecdcb1922005-07-28 23:09:40 +0200366/* Return id number for a specific adapter */
367static inline int i2c_adapter_id(struct i2c_adapter *adap)
368{
369 return adap->nr;
370}
371
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372/*
373 * I2C Message - used for pure i2c transaction, also from /dev interface
374 */
375struct i2c_msg {
376 __u16 addr; /* slave address */
377 __u16 flags;
378#define I2C_M_TEN 0x10 /* we have a ten bit chip address */
379#define I2C_M_RD 0x01
380#define I2C_M_NOSTART 0x4000
381#define I2C_M_REV_DIR_ADDR 0x2000
382#define I2C_M_IGNORE_NAK 0x1000
383#define I2C_M_NO_RD_ACK 0x0800
384 __u16 len; /* msg length */
385 __u8 *buf; /* pointer to msg data */
386};
387
388/* To determine what functionality is present */
389
390#define I2C_FUNC_I2C 0x00000001
391#define I2C_FUNC_10BIT_ADDR 0x00000002
392#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
393#define I2C_FUNC_SMBUS_HWPEC_CALC 0x00000008 /* SMBus 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
395#define I2C_FUNC_SMBUS_QUICK 0x00010000
396#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
397#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
398#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
399#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
400#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
401#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
402#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
403#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
404#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
405#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
406#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
407#define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 0x10000000 /* I2C-like block xfer */
408#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
410#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
411 I2C_FUNC_SMBUS_WRITE_BYTE)
412#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
413 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
414#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
415 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
416#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
417 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
418#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
419 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
420#define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
421 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
423#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
424 I2C_FUNC_SMBUS_BYTE | \
425 I2C_FUNC_SMBUS_BYTE_DATA | \
426 I2C_FUNC_SMBUS_WORD_DATA | \
427 I2C_FUNC_SMBUS_PROC_CALL | \
428 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 I2C_FUNC_SMBUS_I2C_BLOCK)
430
431/*
432 * Data for SMBus Messages
433 */
434#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435union i2c_smbus_data {
436 __u8 byte;
437 __u16 word;
Hideki Iwamoto332bf922005-09-25 16:56:43 +0200438 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
Jean Delvare421ef472005-10-26 21:28:55 +0200439 /* and one more for user-space compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440};
441
442/* smbus_access read or write markers */
443#define I2C_SMBUS_READ 1
444#define I2C_SMBUS_WRITE 0
445
446/* SMBus transaction types (size parameter in the above functions)
447 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
448#define I2C_SMBUS_QUICK 0
449#define I2C_SMBUS_BYTE 1
450#define I2C_SMBUS_BYTE_DATA 2
451#define I2C_SMBUS_WORD_DATA 3
452#define I2C_SMBUS_PROC_CALL 4
453#define I2C_SMBUS_BLOCK_DATA 5
454#define I2C_SMBUS_I2C_BLOCK_DATA 6
455#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457
458/* ----- commands for the ioctl like i2c_command call:
459 * note that additional calls are defined in the algorithm and hw
460 * dependent layers - these can be listed here, or see the
461 * corresponding header files.
462 */
463 /* -> bit-adapter specific ioctls */
464#define I2C_RETRIES 0x0701 /* number of times a device address */
465 /* should be polled when not */
466 /* acknowledging */
467#define I2C_TIMEOUT 0x0702 /* set timeout - call with int */
468
469
470/* this is for i2c-dev.c */
471#define I2C_SLAVE 0x0703 /* Change slave address */
472 /* Attn.: Slave address is 7 or 10 bits */
473#define I2C_SLAVE_FORCE 0x0706 /* Change slave address */
474 /* Attn.: Slave address is 7 or 10 bits */
475 /* This changes the address, even if it */
476 /* is already taken! */
477#define I2C_TENBIT 0x0704 /* 0 for 7 bit addrs, != 0 for 10 bit */
478
479#define I2C_FUNCS 0x0705 /* Get the adapter functionality */
480#define I2C_RDWR 0x0707 /* Combined R/W transfer (one stop only)*/
481#define I2C_PEC 0x0708 /* != 0 for SMBus PEC */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483#define I2C_SMBUS 0x0720 /* SMBus-level access */
484
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485/* ----- I2C-DEV: char device interface stuff ------------------------- */
486
487#define I2C_MAJOR 89 /* Device major number */
488
489/* These defines are used for probing i2c client addresses */
490/* The length of the option lists */
491#define I2C_CLIENT_MAX_OPTS 48
492
493/* Default fill of many variables */
494#define I2C_CLIENT_DEFAULTS {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 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
508 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
509 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
510
511/* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
512 module header */
513
514#define I2C_CLIENT_MODULE_PARM(var,desc) \
515 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
516 static unsigned int var##_num; \
517 module_param_array(var, short, &var##_num, 0); \
518 MODULE_PARM_DESC(var,desc)
519
Jean Delvaref4b50262005-07-31 21:49:03 +0200520#define I2C_CLIENT_MODULE_PARM_FORCE(name) \
521I2C_CLIENT_MODULE_PARM(force_##name, \
522 "List of adapter,address pairs which are " \
523 "unquestionably assumed to contain a `" \
524 # name "' chip")
525
526
527#define I2C_CLIENT_INSMOD_COMMON \
528I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
529 "additionally"); \
530I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
531 "scan"); \
532static struct i2c_client_address_data addr_data = { \
533 .normal_i2c = normal_i2c, \
534 .probe = probe, \
535 .ignore = ignore, \
536 .forces = forces, \
537}
538
539/* These are the ones you want to use in your own drivers. Pick the one
540 which matches the number of devices the driver differenciates between. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541#define I2C_CLIENT_INSMOD \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 I2C_CLIENT_MODULE_PARM(force, \
543 "List of adapter,address pairs to boldly assume " \
544 "to be present"); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200545 static unsigned short *forces[] = { \
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200546 force, \
547 NULL \
548 }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200549I2C_CLIENT_INSMOD_COMMON
550
551#define I2C_CLIENT_INSMOD_1(chip1) \
552enum chips { any_chip, chip1 }; \
553I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
554 "boldly assume to be present"); \
555I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
556static unsigned short *forces[] = { force, force_##chip1, NULL }; \
557I2C_CLIENT_INSMOD_COMMON
558
559#define I2C_CLIENT_INSMOD_2(chip1, chip2) \
560enum chips { any_chip, chip1, chip2 }; \
561I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
562 "boldly assume to be present"); \
563I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
564I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
565static unsigned short *forces[] = { force, force_##chip1, \
566 force_##chip2, NULL }; \
567I2C_CLIENT_INSMOD_COMMON
568
569#define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
570enum chips { any_chip, chip1, chip2, chip3 }; \
571I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
572 "boldly assume to be present"); \
573I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
574I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
575I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
576static unsigned short *forces[] = { force, force_##chip1, \
577 force_##chip2, force_##chip3, \
578 NULL }; \
579I2C_CLIENT_INSMOD_COMMON
580
581#define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
582enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
583I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
584 "boldly assume to be present"); \
585I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
586I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
587I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
588I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
589static unsigned short *forces[] = { force, force_##chip1, \
590 force_##chip2, force_##chip3, \
591 force_##chip4, NULL}; \
592I2C_CLIENT_INSMOD_COMMON
593
594#define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
595enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
596I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
597 "boldly assume to be present"); \
598I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
599I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
600I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
601I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
602I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
603static unsigned short *forces[] = { force, force_##chip1, \
604 force_##chip2, force_##chip3, \
605 force_##chip4, force_##chip5, \
606 NULL }; \
607I2C_CLIENT_INSMOD_COMMON
608
609#define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
610enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
611I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
612 "boldly assume to be present"); \
613I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
614I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
615I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
616I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
617I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
618I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
619static unsigned short *forces[] = { force, force_##chip1, \
620 force_##chip2, force_##chip3, \
621 force_##chip4, force_##chip5, \
622 force_##chip6, NULL }; \
623I2C_CLIENT_INSMOD_COMMON
624
625#define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
626enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
627 chip7 }; \
628I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
629 "boldly assume to be present"); \
630I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
631I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
632I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
633I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
634I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
635I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
636I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
637static unsigned short *forces[] = { force, force_##chip1, \
638 force_##chip2, force_##chip3, \
639 force_##chip4, force_##chip5, \
640 force_##chip6, force_##chip7, \
641 NULL }; \
642I2C_CLIENT_INSMOD_COMMON
643
644#define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
645enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
646 chip7, chip8 }; \
647I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
648 "boldly assume to be present"); \
649I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
650I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
651I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
652I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
653I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
654I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
655I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
656I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
657static unsigned short *forces[] = { force, force_##chip1, \
658 force_##chip2, force_##chip3, \
659 force_##chip4, force_##chip5, \
660 force_##chip6, force_##chip7, \
661 force_##chip8, NULL }; \
662I2C_CLIENT_INSMOD_COMMON
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664#endif /* _LINUX_I2C_H */