blob: 75aa18e865da33e2d19a177bec5a923c6c0040f6 [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.
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100108 *
109 * The driver.owner field should be set to the module owner of this driver.
110 * The driver.name field should be set to the name of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 */
112
113struct i2c_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 int id;
115 unsigned int class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253/*flags for the client struct: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
255#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
256 /* Must equal I2C_M_TEN below */
257
258/* i2c adapter classes (bitmask) */
259#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
260#define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
261#define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
262#define I2C_CLASS_DDC (1<<3) /* i2c-matroxfb ? */
263#define I2C_CLASS_CAM_ANALOG (1<<4) /* camera with analog CCD */
264#define I2C_CLASS_CAM_DIGITAL (1<<5) /* most webcams */
265#define I2C_CLASS_SOUND (1<<6) /* sound devices */
266#define I2C_CLASS_ALL (UINT_MAX) /* all of the above */
267
268/* i2c_client_address_data is the struct for holding default client
269 * addresses for a driver and for the parameters supplied on the
270 * command line
271 */
272struct i2c_client_address_data {
273 unsigned short *normal_i2c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 unsigned short *probe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 unsigned short *ignore;
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200276 unsigned short **forces;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277};
278
279/* Internal numbers to terminate lists */
280#define I2C_CLIENT_END 0xfffeU
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
282/* The numbers to use to set I2C bus address */
283#define ANY_I2C_BUS 0xffff
284#define ANY_I2C_ISA_BUS 9191
285
286
287/* ----- functions exported by i2c.o */
288
289/* administration...
290 */
291extern int i2c_add_adapter(struct i2c_adapter *);
292extern int i2c_del_adapter(struct i2c_adapter *);
293
294extern int i2c_add_driver(struct i2c_driver *);
295extern int i2c_del_driver(struct i2c_driver *);
296
297extern int i2c_attach_client(struct i2c_client *);
298extern int i2c_detach_client(struct i2c_client *);
299
Jean Delvare482c7882005-11-26 21:06:08 +0100300/* Should be used to make sure that client-struct is valid and that it
301 is okay to access the i2c-client.
Jean Delvarecf02df72005-11-26 21:03:41 +0100302 returns -ENODEV if client has gone in the meantime */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303extern int i2c_use_client(struct i2c_client *);
304extern int i2c_release_client(struct i2c_client *);
305
306/* call the i2c_client->command() of all attached clients with
307 * the given arguments */
308extern void i2c_clients_command(struct i2c_adapter *adap,
309 unsigned int cmd, void *arg);
310
311/* returns -EBUSY if address has been taken, 0 if not. Note that the only
312 other place at which this is called is within i2c_attach_client; so
313 you can cheat by simply not registering. Not recommended, of course! */
314extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
315
316/* Detect function. It iterates over all possible addresses itself.
317 * It will only call found_proc if some client is connected at the
318 * specific address (unless a 'force' matched);
319 */
320extern int i2c_probe(struct i2c_adapter *adapter,
321 struct i2c_client_address_data *address_data,
322 int (*found_proc) (struct i2c_adapter *, int, int));
323
324/* An ioctl like call to set div. parameters of the adapter.
325 */
326extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
327
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328extern struct i2c_adapter* i2c_get_adapter(int id);
329extern void i2c_put_adapter(struct i2c_adapter *adap);
330
331
332/* Return the functionality mask */
333static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
334{
335 return adap->algo->functionality(adap);
336}
337
338/* Return 1 if adapter supports everything we need, 0 if not. */
339static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
340{
341 return (func & i2c_get_functionality(adap)) == func;
342}
343
Jean Delvarecdcb1922005-07-28 23:09:40 +0200344/* Return id number for a specific adapter */
345static inline int i2c_adapter_id(struct i2c_adapter *adap)
346{
347 return adap->nr;
348}
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350/*
351 * I2C Message - used for pure i2c transaction, also from /dev interface
352 */
353struct i2c_msg {
354 __u16 addr; /* slave address */
355 __u16 flags;
356#define I2C_M_TEN 0x10 /* we have a ten bit chip address */
357#define I2C_M_RD 0x01
358#define I2C_M_NOSTART 0x4000
359#define I2C_M_REV_DIR_ADDR 0x2000
360#define I2C_M_IGNORE_NAK 0x1000
361#define I2C_M_NO_RD_ACK 0x0800
362 __u16 len; /* msg length */
363 __u8 *buf; /* pointer to msg data */
364};
365
366/* To determine what functionality is present */
367
368#define I2C_FUNC_I2C 0x00000001
369#define I2C_FUNC_10BIT_ADDR 0x00000002
370#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
371#define I2C_FUNC_SMBUS_HWPEC_CALC 0x00000008 /* SMBus 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
373#define I2C_FUNC_SMBUS_QUICK 0x00010000
374#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
375#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
376#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
377#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
378#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
379#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
380#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
381#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
382#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
383#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
384#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
385#define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 0x10000000 /* I2C-like block xfer */
386#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
389 I2C_FUNC_SMBUS_WRITE_BYTE)
390#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
391 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
392#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
393 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
394#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
395 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
396#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
397 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
398#define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
399 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
402 I2C_FUNC_SMBUS_BYTE | \
403 I2C_FUNC_SMBUS_BYTE_DATA | \
404 I2C_FUNC_SMBUS_WORD_DATA | \
405 I2C_FUNC_SMBUS_PROC_CALL | \
406 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 I2C_FUNC_SMBUS_I2C_BLOCK)
408
409/*
410 * Data for SMBus Messages
411 */
412#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413union i2c_smbus_data {
414 __u8 byte;
415 __u16 word;
Hideki Iwamoto332bf922005-09-25 16:56:43 +0200416 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
Jean Delvare421ef472005-10-26 21:28:55 +0200417 /* and one more for user-space compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418};
419
420/* smbus_access read or write markers */
421#define I2C_SMBUS_READ 1
422#define I2C_SMBUS_WRITE 0
423
424/* SMBus transaction types (size parameter in the above functions)
425 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
426#define I2C_SMBUS_QUICK 0
427#define I2C_SMBUS_BYTE 1
428#define I2C_SMBUS_BYTE_DATA 2
429#define I2C_SMBUS_WORD_DATA 3
430#define I2C_SMBUS_PROC_CALL 4
431#define I2C_SMBUS_BLOCK_DATA 5
432#define I2C_SMBUS_I2C_BLOCK_DATA 6
433#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
435
436/* ----- commands for the ioctl like i2c_command call:
437 * note that additional calls are defined in the algorithm and hw
438 * dependent layers - these can be listed here, or see the
439 * corresponding header files.
440 */
441 /* -> bit-adapter specific ioctls */
442#define I2C_RETRIES 0x0701 /* number of times a device address */
443 /* should be polled when not */
444 /* acknowledging */
445#define I2C_TIMEOUT 0x0702 /* set timeout - call with int */
446
447
448/* this is for i2c-dev.c */
449#define I2C_SLAVE 0x0703 /* Change slave address */
450 /* Attn.: Slave address is 7 or 10 bits */
451#define I2C_SLAVE_FORCE 0x0706 /* Change slave address */
452 /* Attn.: Slave address is 7 or 10 bits */
453 /* This changes the address, even if it */
454 /* is already taken! */
455#define I2C_TENBIT 0x0704 /* 0 for 7 bit addrs, != 0 for 10 bit */
456
457#define I2C_FUNCS 0x0705 /* Get the adapter functionality */
458#define I2C_RDWR 0x0707 /* Combined R/W transfer (one stop only)*/
459#define I2C_PEC 0x0708 /* != 0 for SMBus PEC */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
461#define I2C_SMBUS 0x0720 /* SMBus-level access */
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463/* ----- I2C-DEV: char device interface stuff ------------------------- */
464
465#define I2C_MAJOR 89 /* Device major number */
466
467/* These defines are used for probing i2c client addresses */
468/* The length of the option lists */
469#define I2C_CLIENT_MAX_OPTS 48
470
471/* Default fill of many variables */
472#define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
473 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
474 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
475 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
476 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
477 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
478 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
479 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
480 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
481 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
482 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
483 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
484 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
485 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
486 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
487 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
488
489/* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
490 module header */
491
492#define I2C_CLIENT_MODULE_PARM(var,desc) \
493 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
494 static unsigned int var##_num; \
495 module_param_array(var, short, &var##_num, 0); \
496 MODULE_PARM_DESC(var,desc)
497
Jean Delvaref4b50262005-07-31 21:49:03 +0200498#define I2C_CLIENT_MODULE_PARM_FORCE(name) \
499I2C_CLIENT_MODULE_PARM(force_##name, \
500 "List of adapter,address pairs which are " \
501 "unquestionably assumed to contain a `" \
502 # name "' chip")
503
504
505#define I2C_CLIENT_INSMOD_COMMON \
506I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
507 "additionally"); \
508I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
509 "scan"); \
510static struct i2c_client_address_data addr_data = { \
511 .normal_i2c = normal_i2c, \
512 .probe = probe, \
513 .ignore = ignore, \
514 .forces = forces, \
515}
516
517/* These are the ones you want to use in your own drivers. Pick the one
518 which matches the number of devices the driver differenciates between. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519#define I2C_CLIENT_INSMOD \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 I2C_CLIENT_MODULE_PARM(force, \
521 "List of adapter,address pairs to boldly assume " \
522 "to be present"); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200523 static unsigned short *forces[] = { \
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200524 force, \
525 NULL \
526 }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200527I2C_CLIENT_INSMOD_COMMON
528
529#define I2C_CLIENT_INSMOD_1(chip1) \
530enum chips { any_chip, chip1 }; \
531I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
532 "boldly assume to be present"); \
533I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
534static unsigned short *forces[] = { force, force_##chip1, NULL }; \
535I2C_CLIENT_INSMOD_COMMON
536
537#define I2C_CLIENT_INSMOD_2(chip1, chip2) \
538enum chips { any_chip, chip1, chip2 }; \
539I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
540 "boldly assume to be present"); \
541I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
542I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
543static unsigned short *forces[] = { force, force_##chip1, \
544 force_##chip2, NULL }; \
545I2C_CLIENT_INSMOD_COMMON
546
547#define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
548enum chips { any_chip, chip1, chip2, chip3 }; \
549I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
550 "boldly assume to be present"); \
551I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
552I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
553I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
554static unsigned short *forces[] = { force, force_##chip1, \
555 force_##chip2, force_##chip3, \
556 NULL }; \
557I2C_CLIENT_INSMOD_COMMON
558
559#define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
560enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
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); \
565I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
566I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
567static unsigned short *forces[] = { force, force_##chip1, \
568 force_##chip2, force_##chip3, \
569 force_##chip4, NULL}; \
570I2C_CLIENT_INSMOD_COMMON
571
572#define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
573enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
574I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
575 "boldly assume to be present"); \
576I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
577I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
578I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
579I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
580I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
581static unsigned short *forces[] = { force, force_##chip1, \
582 force_##chip2, force_##chip3, \
583 force_##chip4, force_##chip5, \
584 NULL }; \
585I2C_CLIENT_INSMOD_COMMON
586
587#define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
588enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
589I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
590 "boldly assume to be present"); \
591I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
592I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
593I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
594I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
595I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
596I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
597static unsigned short *forces[] = { force, force_##chip1, \
598 force_##chip2, force_##chip3, \
599 force_##chip4, force_##chip5, \
600 force_##chip6, NULL }; \
601I2C_CLIENT_INSMOD_COMMON
602
603#define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
604enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
605 chip7 }; \
606I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
607 "boldly assume to be present"); \
608I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
609I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
610I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
611I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
612I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
613I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
614I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
615static unsigned short *forces[] = { force, force_##chip1, \
616 force_##chip2, force_##chip3, \
617 force_##chip4, force_##chip5, \
618 force_##chip6, force_##chip7, \
619 NULL }; \
620I2C_CLIENT_INSMOD_COMMON
621
622#define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
623enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
624 chip7, chip8 }; \
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); \
634I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
635static unsigned short *forces[] = { force, force_##chip1, \
636 force_##chip2, force_##chip3, \
637 force_##chip4, force_##chip5, \
638 force_##chip6, force_##chip7, \
639 force_##chip8, NULL }; \
640I2C_CLIENT_INSMOD_COMMON
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642#endif /* _LINUX_I2C_H */