blob: a9cea62fd486af8cac138bdb9b455af75255e98d [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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
116 /* Notifies the driver that a new bus has appeared. This routine
117 * can be used by the driver to test if the bus meets its conditions
118 * & seek for the presence of the chip(s) it supports. If found, it
119 * registers the client(s) that are on the bus to the i2c admin. via
120 * i2c_attach_client.
121 */
122 int (*attach_adapter)(struct i2c_adapter *);
123 int (*detach_adapter)(struct i2c_adapter *);
124
125 /* tells the driver that a client is about to be deleted & gives it
126 * the chance to remove its private data. Also, if the client struct
127 * has been dynamically allocated by the driver in the function above,
128 * it must be freed here.
129 */
130 int (*detach_client)(struct i2c_client *);
131
132 /* a ioctl like command that can be used to perform specific functions
133 * with the device.
134 */
135 int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
136
137 struct device_driver driver;
138 struct list_head list;
139};
140#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
141
142#define I2C_NAME_SIZE 50
143
144/*
145 * i2c_client identifies a single device (i.e. chip) that is connected to an
146 * i2c bus. The behaviour is defined by the routines of the driver. This
147 * function is mainly used for lookup & other admin. functions.
148 */
149struct i2c_client {
150 unsigned int flags; /* div., see below */
Jean Delvare50718602005-07-20 00:02:32 +0200151 unsigned short addr; /* chip address - NOTE: 7bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 /* addresses are stored in the */
Jean Delvare50718602005-07-20 00:02:32 +0200153 /* _LOWER_ 7 bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 struct i2c_adapter *adapter; /* the adapter we sit on */
155 struct i2c_driver *driver; /* and our access routines */
156 int usage_count; /* How many accesses currently */
157 /* to the client */
158 struct device dev; /* the device structure */
159 struct list_head list;
160 char name[I2C_NAME_SIZE];
161 struct completion released;
162};
163#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
164
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500165static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
166{
167 return to_i2c_client(container_of(kobj, struct device, kobj));
168}
169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170static inline void *i2c_get_clientdata (struct i2c_client *dev)
171{
172 return dev_get_drvdata (&dev->dev);
173}
174
175static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
176{
177 dev_set_drvdata (&dev->dev, data);
178}
179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180/*
181 * The following structs are for those who like to implement new bus drivers:
182 * i2c_algorithm is the interface to a class of hardware solutions which can
183 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
184 * to name two of the most common.
185 */
186struct i2c_algorithm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 /* If an adapter algorithm can't do I2C-level access, set master_xfer
188 to NULL. If an adapter algorithm can do SMBus access, set
189 smbus_xfer. If set to NULL, the SMBus protocol is simulated
190 using common I2C messages */
191 int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
192 int num);
193 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
194 unsigned short flags, char read_write,
195 u8 command, int size, union i2c_smbus_data * data);
196
197 /* --- these optional/future use for some adapter types.*/
198 int (*slave_send)(struct i2c_adapter *,char*,int);
199 int (*slave_recv)(struct i2c_adapter *,char*,int);
200
201 /* --- ioctl like call to set div. parameters. */
202 int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
203
204 /* To determine what the adapter supports */
205 u32 (*functionality) (struct i2c_adapter *);
206};
207
208/*
209 * i2c_adapter is the structure used to identify a physical i2c bus along
210 * with the access algorithms necessary to access it.
211 */
212struct i2c_adapter {
213 struct module *owner;
Jean Delvare020789e2005-08-13 13:04:32 +0200214 unsigned int id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 unsigned int class;
216 struct i2c_algorithm *algo;/* the algorithm to access the bus */
217 void *algo_data;
218
219 /* --- administration stuff. */
220 int (*client_register)(struct i2c_client *);
221 int (*client_unregister)(struct i2c_client *);
222
223 /* data fields that are valid for all devices */
224 struct semaphore bus_lock;
225 struct semaphore clist_lock;
226
227 int timeout;
228 int retries;
229 struct device dev; /* the adapter device */
230 struct class_device class_dev; /* the class device */
231
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 int nr;
233 struct list_head clients;
234 struct list_head list;
235 char name[I2C_NAME_SIZE];
236 struct completion dev_released;
237 struct completion class_dev_released;
238};
239#define dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
240#define class_dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, class_dev)
241
242static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
243{
244 return dev_get_drvdata (&dev->dev);
245}
246
247static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
248{
249 dev_set_drvdata (&dev->dev, data);
250}
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252/*flags for the client struct: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
254#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
255 /* Must equal I2C_M_TEN below */
256
257/* i2c adapter classes (bitmask) */
258#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
259#define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
260#define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
261#define I2C_CLASS_DDC (1<<3) /* i2c-matroxfb ? */
262#define I2C_CLASS_CAM_ANALOG (1<<4) /* camera with analog CCD */
263#define I2C_CLASS_CAM_DIGITAL (1<<5) /* most webcams */
264#define I2C_CLASS_SOUND (1<<6) /* sound devices */
265#define I2C_CLASS_ALL (UINT_MAX) /* all of the above */
266
267/* i2c_client_address_data is the struct for holding default client
268 * addresses for a driver and for the parameters supplied on the
269 * command line
270 */
271struct i2c_client_address_data {
272 unsigned short *normal_i2c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 unsigned short *probe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 unsigned short *ignore;
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200275 unsigned short **forces;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276};
277
278/* Internal numbers to terminate lists */
279#define I2C_CLIENT_END 0xfffeU
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
281/* The numbers to use to set I2C bus address */
282#define ANY_I2C_BUS 0xffff
283#define ANY_I2C_ISA_BUS 9191
284
285
286/* ----- functions exported by i2c.o */
287
288/* administration...
289 */
290extern int i2c_add_adapter(struct i2c_adapter *);
291extern int i2c_del_adapter(struct i2c_adapter *);
292
293extern int i2c_add_driver(struct i2c_driver *);
294extern int i2c_del_driver(struct i2c_driver *);
295
296extern int i2c_attach_client(struct i2c_client *);
297extern int i2c_detach_client(struct i2c_client *);
298
Jean Delvare482c7882005-11-26 21:06:08 +0100299/* Should be used to make sure that client-struct is valid and that it
300 is okay to access the i2c-client.
Jean Delvarecf02df72005-11-26 21:03:41 +0100301 returns -ENODEV if client has gone in the meantime */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302extern int i2c_use_client(struct i2c_client *);
303extern int i2c_release_client(struct i2c_client *);
304
305/* call the i2c_client->command() of all attached clients with
306 * the given arguments */
307extern void i2c_clients_command(struct i2c_adapter *adap,
308 unsigned int cmd, void *arg);
309
310/* returns -EBUSY if address has been taken, 0 if not. Note that the only
311 other place at which this is called is within i2c_attach_client; so
312 you can cheat by simply not registering. Not recommended, of course! */
313extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
314
315/* Detect function. It iterates over all possible addresses itself.
316 * It will only call found_proc if some client is connected at the
317 * specific address (unless a 'force' matched);
318 */
319extern int i2c_probe(struct i2c_adapter *adapter,
320 struct i2c_client_address_data *address_data,
321 int (*found_proc) (struct i2c_adapter *, int, int));
322
323/* An ioctl like call to set div. parameters of the adapter.
324 */
325extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
326
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327extern struct i2c_adapter* i2c_get_adapter(int id);
328extern void i2c_put_adapter(struct i2c_adapter *adap);
329
330
331/* Return the functionality mask */
332static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
333{
334 return adap->algo->functionality(adap);
335}
336
337/* Return 1 if adapter supports everything we need, 0 if not. */
338static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
339{
340 return (func & i2c_get_functionality(adap)) == func;
341}
342
Jean Delvarecdcb1922005-07-28 23:09:40 +0200343/* Return id number for a specific adapter */
344static inline int i2c_adapter_id(struct i2c_adapter *adap)
345{
346 return adap->nr;
347}
348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349/*
350 * I2C Message - used for pure i2c transaction, also from /dev interface
351 */
352struct i2c_msg {
353 __u16 addr; /* slave address */
354 __u16 flags;
355#define I2C_M_TEN 0x10 /* we have a ten bit chip address */
356#define I2C_M_RD 0x01
357#define I2C_M_NOSTART 0x4000
358#define I2C_M_REV_DIR_ADDR 0x2000
359#define I2C_M_IGNORE_NAK 0x1000
360#define I2C_M_NO_RD_ACK 0x0800
361 __u16 len; /* msg length */
362 __u8 *buf; /* pointer to msg data */
363};
364
365/* To determine what functionality is present */
366
367#define I2C_FUNC_I2C 0x00000001
368#define I2C_FUNC_10BIT_ADDR 0x00000002
369#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
370#define I2C_FUNC_SMBUS_HWPEC_CALC 0x00000008 /* SMBus 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
372#define I2C_FUNC_SMBUS_QUICK 0x00010000
373#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
374#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
375#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
376#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
377#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
378#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
379#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
380#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
381#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
382#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
383#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
384#define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 0x10000000 /* I2C-like block xfer */
385#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
387#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
388 I2C_FUNC_SMBUS_WRITE_BYTE)
389#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
390 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
391#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
392 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
393#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
394 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
395#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
396 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
397#define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
398 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
400#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
401 I2C_FUNC_SMBUS_BYTE | \
402 I2C_FUNC_SMBUS_BYTE_DATA | \
403 I2C_FUNC_SMBUS_WORD_DATA | \
404 I2C_FUNC_SMBUS_PROC_CALL | \
405 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 I2C_FUNC_SMBUS_I2C_BLOCK)
407
408/*
409 * Data for SMBus Messages
410 */
411#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412union i2c_smbus_data {
413 __u8 byte;
414 __u16 word;
Hideki Iwamoto332bf922005-09-25 16:56:43 +0200415 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
Jean Delvare421ef472005-10-26 21:28:55 +0200416 /* and one more for user-space compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417};
418
419/* smbus_access read or write markers */
420#define I2C_SMBUS_READ 1
421#define I2C_SMBUS_WRITE 0
422
423/* SMBus transaction types (size parameter in the above functions)
424 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
425#define I2C_SMBUS_QUICK 0
426#define I2C_SMBUS_BYTE 1
427#define I2C_SMBUS_BYTE_DATA 2
428#define I2C_SMBUS_WORD_DATA 3
429#define I2C_SMBUS_PROC_CALL 4
430#define I2C_SMBUS_BLOCK_DATA 5
431#define I2C_SMBUS_I2C_BLOCK_DATA 6
432#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
434
435/* ----- commands for the ioctl like i2c_command call:
436 * note that additional calls are defined in the algorithm and hw
437 * dependent layers - these can be listed here, or see the
438 * corresponding header files.
439 */
440 /* -> bit-adapter specific ioctls */
441#define I2C_RETRIES 0x0701 /* number of times a device address */
442 /* should be polled when not */
443 /* acknowledging */
444#define I2C_TIMEOUT 0x0702 /* set timeout - call with int */
445
446
447/* this is for i2c-dev.c */
448#define I2C_SLAVE 0x0703 /* Change slave address */
449 /* Attn.: Slave address is 7 or 10 bits */
450#define I2C_SLAVE_FORCE 0x0706 /* Change slave address */
451 /* Attn.: Slave address is 7 or 10 bits */
452 /* This changes the address, even if it */
453 /* is already taken! */
454#define I2C_TENBIT 0x0704 /* 0 for 7 bit addrs, != 0 for 10 bit */
455
456#define I2C_FUNCS 0x0705 /* Get the adapter functionality */
457#define I2C_RDWR 0x0707 /* Combined R/W transfer (one stop only)*/
458#define I2C_PEC 0x0708 /* != 0 for SMBus PEC */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
460#define I2C_SMBUS 0x0720 /* SMBus-level access */
461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462/* ----- I2C-DEV: char device interface stuff ------------------------- */
463
464#define I2C_MAJOR 89 /* Device major number */
465
466/* These defines are used for probing i2c client addresses */
467/* The length of the option lists */
468#define I2C_CLIENT_MAX_OPTS 48
469
470/* Default fill of many variables */
471#define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
472 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
488/* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
489 module header */
490
491#define I2C_CLIENT_MODULE_PARM(var,desc) \
492 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
493 static unsigned int var##_num; \
494 module_param_array(var, short, &var##_num, 0); \
495 MODULE_PARM_DESC(var,desc)
496
Jean Delvaref4b50262005-07-31 21:49:03 +0200497#define I2C_CLIENT_MODULE_PARM_FORCE(name) \
498I2C_CLIENT_MODULE_PARM(force_##name, \
499 "List of adapter,address pairs which are " \
500 "unquestionably assumed to contain a `" \
501 # name "' chip")
502
503
504#define I2C_CLIENT_INSMOD_COMMON \
505I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
506 "additionally"); \
507I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
508 "scan"); \
509static struct i2c_client_address_data addr_data = { \
510 .normal_i2c = normal_i2c, \
511 .probe = probe, \
512 .ignore = ignore, \
513 .forces = forces, \
514}
515
516/* These are the ones you want to use in your own drivers. Pick the one
517 which matches the number of devices the driver differenciates between. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518#define I2C_CLIENT_INSMOD \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 I2C_CLIENT_MODULE_PARM(force, \
520 "List of adapter,address pairs to boldly assume " \
521 "to be present"); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200522 static unsigned short *forces[] = { \
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200523 force, \
524 NULL \
525 }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200526I2C_CLIENT_INSMOD_COMMON
527
528#define I2C_CLIENT_INSMOD_1(chip1) \
529enum chips { any_chip, chip1 }; \
530I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
531 "boldly assume to be present"); \
532I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
533static unsigned short *forces[] = { force, force_##chip1, NULL }; \
534I2C_CLIENT_INSMOD_COMMON
535
536#define I2C_CLIENT_INSMOD_2(chip1, chip2) \
537enum chips { any_chip, chip1, chip2 }; \
538I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
539 "boldly assume to be present"); \
540I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
541I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
542static unsigned short *forces[] = { force, force_##chip1, \
543 force_##chip2, NULL }; \
544I2C_CLIENT_INSMOD_COMMON
545
546#define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
547enum chips { any_chip, chip1, chip2, chip3 }; \
548I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
549 "boldly assume to be present"); \
550I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
551I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
552I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
553static unsigned short *forces[] = { force, force_##chip1, \
554 force_##chip2, force_##chip3, \
555 NULL }; \
556I2C_CLIENT_INSMOD_COMMON
557
558#define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
559enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
560I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
561 "boldly assume to be present"); \
562I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
563I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
564I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
565I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
566static unsigned short *forces[] = { force, force_##chip1, \
567 force_##chip2, force_##chip3, \
568 force_##chip4, NULL}; \
569I2C_CLIENT_INSMOD_COMMON
570
571#define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
572enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
573I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
574 "boldly assume to be present"); \
575I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
576I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
577I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
578I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
579I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
580static unsigned short *forces[] = { force, force_##chip1, \
581 force_##chip2, force_##chip3, \
582 force_##chip4, force_##chip5, \
583 NULL }; \
584I2C_CLIENT_INSMOD_COMMON
585
586#define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
587enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
588I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
589 "boldly assume to be present"); \
590I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
591I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
592I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
593I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
594I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
595I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
596static unsigned short *forces[] = { force, force_##chip1, \
597 force_##chip2, force_##chip3, \
598 force_##chip4, force_##chip5, \
599 force_##chip6, NULL }; \
600I2C_CLIENT_INSMOD_COMMON
601
602#define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
603enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
604 chip7 }; \
605I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
606 "boldly assume to be present"); \
607I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
608I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
609I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
610I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
611I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
612I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
613I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
614static unsigned short *forces[] = { force, force_##chip1, \
615 force_##chip2, force_##chip3, \
616 force_##chip4, force_##chip5, \
617 force_##chip6, force_##chip7, \
618 NULL }; \
619I2C_CLIENT_INSMOD_COMMON
620
621#define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
622enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
623 chip7, chip8 }; \
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); \
633I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
634static unsigned short *forces[] = { force, force_##chip1, \
635 force_##chip2, force_##chip3, \
636 force_##chip4, force_##chip5, \
637 force_##chip6, force_##chip7, \
638 force_##chip8, NULL }; \
639I2C_CLIENT_INSMOD_COMMON
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641#endif /* _LINUX_I2C_H */