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