i2c: Make i2c_del_driver a void function
[linux-2.6.git] / include / linux / i2c.h
1 /* ------------------------------------------------------------------------- */
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
26 #ifndef _LINUX_I2C_H
27 #define _LINUX_I2C_H
28
29 #include <linux/types.h>
30 #ifdef __KERNEL__
31 #include <linux/module.h>
32 #include <linux/i2c-id.h>
33 #include <linux/mod_devicetable.h>
34 #include <linux/device.h>       /* for struct device */
35 #include <linux/sched.h>        /* for completion */
36 #include <linux/mutex.h>
37
38 extern struct bus_type i2c_bus_type;
39
40 /* --- General options ------------------------------------------------ */
41
42 struct i2c_msg;
43 struct i2c_algorithm;
44 struct i2c_adapter;
45 struct i2c_client;
46 struct i2c_driver;
47 union i2c_smbus_data;
48
49 /*
50  * The master routines are the ones normally used to transmit data to devices
51  * on a bus (or read from them). Apart from two basic transfer functions to
52  * transmit one message at a time, a more complex version can be used to
53  * transmit an arbitrary number of messages without interruption.
54  */
55 extern int i2c_master_send(struct i2c_client *,const char* ,int);
56 extern int i2c_master_recv(struct i2c_client *,char* ,int);
57
58 /* Transfer num messages.
59  */
60 extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
61
62
63 /* This is the very generalized SMBus access routine. You probably do not
64    want to use this, though; one of the functions below may be much easier,
65    and probably just as fast.
66    Note that we use i2c_adapter here, because you do not need a specific
67    smbus adapter to call this function. */
68 extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
69                            unsigned short flags,
70                            char read_write, u8 command, int size,
71                            union i2c_smbus_data * data);
72
73 /* Now follow the 'nice' access routines. These also document the calling
74    conventions of smbus_access. */
75
76 extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
77 extern s32 i2c_smbus_read_byte(struct i2c_client * client);
78 extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
79 extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
80 extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
81                                      u8 command, u8 value);
82 extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
83 extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
84                                      u8 command, u16 value);
85 extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
86                                       u8 command, u8 length,
87                                       const u8 *values);
88 /* Returns the number of read bytes */
89 extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
90                                          u8 command, u8 *values);
91 extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,
92                                           u8 command, u8 length,
93                                           const u8 *values);
94
95 /*
96  * A driver is capable of handling one or more physical devices present on
97  * I2C adapters. This information is used to inform the driver of adapter
98  * events.
99  *
100  * The driver.owner field should be set to the module owner of this driver.
101  * The driver.name field should be set to the name of this driver.
102  */
103
104 struct i2c_driver {
105         int id;
106         unsigned int class;
107
108         /* Notifies the driver that a new bus has appeared. This routine
109          * can be used by the driver to test if the bus meets its conditions
110          * & seek for the presence of the chip(s) it supports. If found, it
111          * registers the client(s) that are on the bus to the i2c admin. via
112          * i2c_attach_client.  (LEGACY I2C DRIVERS ONLY)
113          */
114         int (*attach_adapter)(struct i2c_adapter *);
115         int (*detach_adapter)(struct i2c_adapter *);
116
117         /* tells the driver that a client is about to be deleted & gives it
118          * the chance to remove its private data. Also, if the client struct
119          * has been dynamically allocated by the driver in the function above,
120          * it must be freed here.  (LEGACY I2C DRIVERS ONLY)
121          */
122         int (*detach_client)(struct i2c_client *);
123
124         /* Standard driver model interfaces, for "new style" i2c drivers.
125          * With the driver model, device enumeration is NEVER done by drivers;
126          * it's done by infrastructure.  (NEW STYLE DRIVERS ONLY)
127          */
128         int (*probe)(struct i2c_client *);
129         int (*remove)(struct i2c_client *);
130
131         /* driver model interfaces that don't relate to enumeration  */
132         void (*shutdown)(struct i2c_client *);
133         int (*suspend)(struct i2c_client *, pm_message_t mesg);
134         int (*resume)(struct i2c_client *);
135
136         /* a ioctl like command that can be used to perform specific functions
137          * with the device.
138          */
139         int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
140
141         struct device_driver driver;
142         struct list_head list;
143 };
144 #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
145
146 #define I2C_NAME_SIZE   20
147
148 /**
149  * struct i2c_client - represent an I2C slave device
150  * @addr: Address used on the I2C bus connected to the parent adapter.
151  * @name: Indicates the type of the device, usually a chip name that's
152  *      generic enough to hide second-sourcing and compatible revisions.
153  * @dev: Driver model device node for the slave.
154  * @driver_name: Identifies new-style driver used with this device; also
155  *      used as the module name for hotplug/coldplug modprobe support.
156  *
157  * An i2c_client identifies a single device (i.e. chip) connected to an
158  * i2c bus. The behaviour is defined by the routines of the driver.
159  */
160 struct i2c_client {
161         unsigned short flags;           /* div., see below              */
162         unsigned short addr;            /* chip address - NOTE: 7bit    */
163                                         /* addresses are stored in the  */
164                                         /* _LOWER_ 7 bits               */
165         char name[I2C_NAME_SIZE];
166         struct i2c_adapter *adapter;    /* the adapter we sit on        */
167         struct i2c_driver *driver;      /* and our access routines      */
168         int usage_count;                /* How many accesses currently  */
169                                         /* to the client                */
170         struct device dev;              /* the device structure         */
171         int irq;                        /* irq issued by device (or -1) */
172         char driver_name[KOBJ_NAME_LEN];
173         struct list_head list;
174         struct completion released;
175 };
176 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
177
178 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
179 {
180         return to_i2c_client(container_of(kobj, struct device, kobj));
181 }
182
183 static inline void *i2c_get_clientdata (struct i2c_client *dev)
184 {
185         return dev_get_drvdata (&dev->dev);
186 }
187
188 static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
189 {
190         dev_set_drvdata (&dev->dev, data);
191 }
192
193 /**
194  * struct i2c_board_info - template for device creation
195  * @driver_name: identifies the driver to be bound to the device
196  * @type: optional chip type information, to initialize i2c_client.name
197  * @flags: to initialize i2c_client.flags
198  * @addr: stored in i2c_client.addr
199  * @platform_data: stored in i2c_client.dev.platform_data
200  * @irq: stored in i2c_client.irq
201
202  * I2C doesn't actually support hardware probing, although controllers and
203  * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
204  * a device at a given address.  Drivers commonly need more information than
205  * that, such as chip type, configuration, associated IRQ, and so on.
206  *
207  * i2c_board_info is used to build tables of information listing I2C devices
208  * that are present.  This information is used to grow the driver model tree
209  * for "new style" I2C drivers.  For mainboards this is done statically using
210  * i2c_register_board_info(), where @bus_num represents an adapter that isn't
211  * yet available.  For add-on boards, i2c_new_device() does this dynamically
212  * with the adapter already known.
213  */
214 struct i2c_board_info {
215         char            driver_name[KOBJ_NAME_LEN];
216         char            type[I2C_NAME_SIZE];
217         unsigned short  flags;
218         unsigned short  addr;
219         void            *platform_data;
220         int             irq;
221 };
222
223 /**
224  * I2C_BOARD_INFO - macro used to list an i2c device and its driver
225  * @driver: identifies the driver to use with the device
226  * @dev_addr: the device's address on the bus.
227  *
228  * This macro initializes essential fields of a struct i2c_board_info,
229  * declaring what has been provided on a particular board.  Optional
230  * fields (such as the chip type, its associated irq, or device-specific
231  * platform_data) are provided using conventional syntax.
232  */
233 #define I2C_BOARD_INFO(driver,dev_addr) \
234         .driver_name = (driver), .addr = (dev_addr)
235
236
237 /* Add-on boards should register/unregister their devices; e.g. a board
238  * with integrated I2C, a config eeprom, sensors, and a codec that's
239  * used in conjunction with the primary hardware.
240  */
241 extern struct i2c_client *
242 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
243
244 /* If you don't know the exact address of an I2C device, use this variant
245  * instead, which can probe for device presence in a list of possible
246  * addresses.
247  */
248 extern struct i2c_client *
249 i2c_new_probed_device(struct i2c_adapter *adap,
250                       struct i2c_board_info *info,
251                       unsigned short const *addr_list);
252
253 extern void i2c_unregister_device(struct i2c_client *);
254
255 /* Mainboard arch_initcall() code should register all its I2C devices.
256  * This is done at arch_initcall time, before declaring any i2c adapters.
257  * Modules for add-on boards must use other calls.
258  */
259 extern int
260 i2c_register_board_info(int busnum, struct i2c_board_info const *info, unsigned n);
261
262
263 /*
264  * The following structs are for those who like to implement new bus drivers:
265  * i2c_algorithm is the interface to a class of hardware solutions which can
266  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
267  * to name two of the most common.
268  */
269 struct i2c_algorithm {
270         /* If an adapter algorithm can't do I2C-level access, set master_xfer
271            to NULL. If an adapter algorithm can do SMBus access, set
272            smbus_xfer. If set to NULL, the SMBus protocol is simulated
273            using common I2C messages */
274         /* master_xfer should return the number of messages successfully
275            processed, or a negative value on error */
276         int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
277                            int num);
278         int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
279                            unsigned short flags, char read_write,
280                            u8 command, int size, union i2c_smbus_data * data);
281
282         /* --- ioctl like call to set div. parameters. */
283         int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
284
285         /* To determine what the adapter supports */
286         u32 (*functionality) (struct i2c_adapter *);
287 };
288
289 /*
290  * i2c_adapter is the structure used to identify a physical i2c bus along
291  * with the access algorithms necessary to access it.
292  */
293 struct i2c_adapter {
294         struct module *owner;
295         unsigned int id;
296         unsigned int class;
297         const struct i2c_algorithm *algo; /* the algorithm to access the bus */
298         void *algo_data;
299
300         /* --- administration stuff. */
301         int (*client_register)(struct i2c_client *);
302         int (*client_unregister)(struct i2c_client *);
303
304         /* data fields that are valid for all devices   */
305         u8 level;                       /* nesting level for lockdep */
306         struct mutex bus_lock;
307         struct mutex clist_lock;
308
309         int timeout;
310         int retries;
311         struct device dev;              /* the adapter device */
312
313         int nr;
314         struct list_head clients;
315         struct list_head list;
316         char name[48];
317         struct completion dev_released;
318 };
319 #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
320
321 static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
322 {
323         return dev_get_drvdata (&dev->dev);
324 }
325
326 static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
327 {
328         dev_set_drvdata (&dev->dev, data);
329 }
330
331 /*flags for the client struct: */
332 #define I2C_CLIENT_PEC  0x04                    /* Use Packet Error Checking */
333 #define I2C_CLIENT_TEN  0x10                    /* we have a ten bit chip address       */
334                                                 /* Must equal I2C_M_TEN below */
335
336 /* i2c adapter classes (bitmask) */
337 #define I2C_CLASS_HWMON         (1<<0)  /* lm_sensors, ... */
338 #define I2C_CLASS_TV_ANALOG     (1<<1)  /* bttv + friends */
339 #define I2C_CLASS_TV_DIGITAL    (1<<2)  /* dvb cards */
340 #define I2C_CLASS_DDC           (1<<3)  /* i2c-matroxfb ? */
341 #define I2C_CLASS_CAM_ANALOG    (1<<4)  /* camera with analog CCD */
342 #define I2C_CLASS_CAM_DIGITAL   (1<<5)  /* most webcams */
343 #define I2C_CLASS_SOUND         (1<<6)  /* sound devices */
344 #define I2C_CLASS_ALL           (UINT_MAX) /* all of the above */
345
346 /* i2c_client_address_data is the struct for holding default client
347  * addresses for a driver and for the parameters supplied on the
348  * command line
349  */
350 struct i2c_client_address_data {
351         unsigned short *normal_i2c;
352         unsigned short *probe;
353         unsigned short *ignore;
354         unsigned short **forces;
355 };
356
357 /* Internal numbers to terminate lists */
358 #define I2C_CLIENT_END          0xfffeU
359
360 /* The numbers to use to set I2C bus address */
361 #define ANY_I2C_BUS             0xffff
362 #define ANY_I2C_ISA_BUS         9191
363
364
365 /* ----- functions exported by i2c.o */
366
367 /* administration...
368  */
369 extern int i2c_add_adapter(struct i2c_adapter *);
370 extern int i2c_del_adapter(struct i2c_adapter *);
371 extern int i2c_add_numbered_adapter(struct i2c_adapter *);
372
373 extern int i2c_register_driver(struct module *, struct i2c_driver *);
374 extern void i2c_del_driver(struct i2c_driver *);
375
376 static inline int i2c_add_driver(struct i2c_driver *driver)
377 {
378         return i2c_register_driver(THIS_MODULE, driver);
379 }
380
381 extern int i2c_attach_client(struct i2c_client *);
382 extern int i2c_detach_client(struct i2c_client *);
383
384 /* Should be used to make sure that client-struct is valid and that it
385    is okay to access the i2c-client.
386    returns -ENODEV if client has gone in the meantime */
387 extern int i2c_use_client(struct i2c_client *);
388 extern int i2c_release_client(struct i2c_client *);
389
390 /* call the i2c_client->command() of all attached clients with
391  * the given arguments */
392 extern void i2c_clients_command(struct i2c_adapter *adap,
393                                 unsigned int cmd, void *arg);
394
395 /* returns -EBUSY if address has been taken, 0 if not. Note that the only
396    other place at which this is called is within i2c_attach_client; so
397    you can cheat by simply not registering. Not recommended, of course! */
398 extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
399
400 /* Detect function. It iterates over all possible addresses itself.
401  * It will only call found_proc if some client is connected at the
402  * specific address (unless a 'force' matched);
403  */
404 extern int i2c_probe(struct i2c_adapter *adapter,
405                 struct i2c_client_address_data *address_data,
406                 int (*found_proc) (struct i2c_adapter *, int, int));
407
408 /* An ioctl like call to set div. parameters of the adapter.
409  */
410 extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
411
412 extern struct i2c_adapter* i2c_get_adapter(int id);
413 extern void i2c_put_adapter(struct i2c_adapter *adap);
414
415
416 /* Return the functionality mask */
417 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
418 {
419         return adap->algo->functionality(adap);
420 }
421
422 /* Return 1 if adapter supports everything we need, 0 if not. */
423 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
424 {
425         return (func & i2c_get_functionality(adap)) == func;
426 }
427
428 /* Return id number for a specific adapter */
429 static inline int i2c_adapter_id(struct i2c_adapter *adap)
430 {
431         return adap->nr;
432 }
433 #endif /* __KERNEL__ */
434
435 /*
436  * I2C Message - used for pure i2c transaction, also from /dev interface
437  */
438 struct i2c_msg {
439         __u16 addr;     /* slave address                        */
440         __u16 flags;
441 #define I2C_M_TEN       0x10    /* we have a ten bit chip address       */
442 #define I2C_M_RD        0x01
443 #define I2C_M_NOSTART   0x4000
444 #define I2C_M_REV_DIR_ADDR      0x2000
445 #define I2C_M_IGNORE_NAK        0x1000
446 #define I2C_M_NO_RD_ACK         0x0800
447 #define I2C_M_RECV_LEN          0x0400 /* length will be first received byte */
448         __u16 len;              /* msg length                           */
449         __u8 *buf;              /* pointer to msg data                  */
450 };
451
452 /* To determine what functionality is present */
453
454 #define I2C_FUNC_I2C                    0x00000001
455 #define I2C_FUNC_10BIT_ADDR             0x00000002
456 #define I2C_FUNC_PROTOCOL_MANGLING      0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
457 #define I2C_FUNC_SMBUS_HWPEC_CALC       0x00000008 /* SMBus 2.0 */
458 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL  0x00008000 /* SMBus 2.0 */
459 #define I2C_FUNC_SMBUS_QUICK            0x00010000
460 #define I2C_FUNC_SMBUS_READ_BYTE        0x00020000
461 #define I2C_FUNC_SMBUS_WRITE_BYTE       0x00040000
462 #define I2C_FUNC_SMBUS_READ_BYTE_DATA   0x00080000
463 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA  0x00100000
464 #define I2C_FUNC_SMBUS_READ_WORD_DATA   0x00200000
465 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA  0x00400000
466 #define I2C_FUNC_SMBUS_PROC_CALL        0x00800000
467 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA  0x01000000
468 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
469 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK   0x04000000 /* I2C-like block xfer  */
470 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK  0x08000000 /* w/ 1-byte reg. addr. */
471 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2  0x10000000 /* I2C-like block xfer  */
472 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
473
474 #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
475                              I2C_FUNC_SMBUS_WRITE_BYTE)
476 #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
477                                   I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
478 #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
479                                   I2C_FUNC_SMBUS_WRITE_WORD_DATA)
480 #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
481                                    I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
482 #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
483                                   I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
484 #define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
485                                     I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
486
487 #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
488                              I2C_FUNC_SMBUS_BYTE | \
489                              I2C_FUNC_SMBUS_BYTE_DATA | \
490                              I2C_FUNC_SMBUS_WORD_DATA | \
491                              I2C_FUNC_SMBUS_PROC_CALL | \
492                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
493                              I2C_FUNC_SMBUS_I2C_BLOCK)
494
495 /*
496  * Data for SMBus Messages
497  */
498 #define I2C_SMBUS_BLOCK_MAX     32      /* As specified in SMBus standard */
499 union i2c_smbus_data {
500         __u8 byte;
501         __u16 word;
502         __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
503                                /* and one more for user-space compatibility */
504 };
505
506 /* smbus_access read or write markers */
507 #define I2C_SMBUS_READ  1
508 #define I2C_SMBUS_WRITE 0
509
510 /* SMBus transaction types (size parameter in the above functions)
511    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
512 #define I2C_SMBUS_QUICK             0
513 #define I2C_SMBUS_BYTE              1
514 #define I2C_SMBUS_BYTE_DATA         2
515 #define I2C_SMBUS_WORD_DATA         3
516 #define I2C_SMBUS_PROC_CALL         4
517 #define I2C_SMBUS_BLOCK_DATA        5
518 #define I2C_SMBUS_I2C_BLOCK_DATA    6
519 #define I2C_SMBUS_BLOCK_PROC_CALL   7           /* SMBus 2.0 */
520
521
522 /* ----- commands for the ioctl like i2c_command call:
523  * note that additional calls are defined in the algorithm and hw
524  *      dependent layers - these can be listed here, or see the
525  *      corresponding header files.
526  */
527                                 /* -> bit-adapter specific ioctls       */
528 #define I2C_RETRIES     0x0701  /* number of times a device address      */
529                                 /* should be polled when not            */
530                                 /* acknowledging                        */
531 #define I2C_TIMEOUT     0x0702  /* set timeout - call with int          */
532
533
534 /* this is for i2c-dev.c        */
535 #define I2C_SLAVE       0x0703  /* Change slave address                 */
536                                 /* Attn.: Slave address is 7 or 10 bits */
537 #define I2C_SLAVE_FORCE 0x0706  /* Change slave address                 */
538                                 /* Attn.: Slave address is 7 or 10 bits */
539                                 /* This changes the address, even if it */
540                                 /* is already taken!                    */
541 #define I2C_TENBIT      0x0704  /* 0 for 7 bit addrs, != 0 for 10 bit   */
542
543 #define I2C_FUNCS       0x0705  /* Get the adapter functionality */
544 #define I2C_RDWR        0x0707  /* Combined R/W transfer (one stop only)*/
545 #define I2C_PEC         0x0708  /* != 0 for SMBus PEC                   */
546
547 #define I2C_SMBUS       0x0720  /* SMBus-level access */
548
549 /* ----- I2C-DEV: char device interface stuff ------------------------- */
550 #ifdef __KERNEL__
551
552 #define I2C_MAJOR       89              /* Device major number          */
553
554 /* These defines are used for probing i2c client addresses */
555 /* The length of the option lists */
556 #define I2C_CLIENT_MAX_OPTS 48
557
558 /* Default fill of many variables */
559 #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
560                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
561                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
562                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
563                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
564                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
565                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
566                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
567                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
568                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
569                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
570                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
571                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
572                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
573                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
574                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
575
576 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
577    module header */
578
579 #define I2C_CLIENT_MODULE_PARM(var,desc) \
580   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
581   static unsigned int var##_num; \
582   module_param_array(var, short, &var##_num, 0); \
583   MODULE_PARM_DESC(var,desc)
584
585 #define I2C_CLIENT_MODULE_PARM_FORCE(name)                              \
586 I2C_CLIENT_MODULE_PARM(force_##name,                                    \
587                        "List of adapter,address pairs which are "       \
588                        "unquestionably assumed to contain a `"          \
589                        # name "' chip")
590
591
592 #define I2C_CLIENT_INSMOD_COMMON                                        \
593 I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan "  \
594                        "additionally");                                 \
595 I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to "  \
596                        "scan");                                         \
597 static struct i2c_client_address_data addr_data = {                     \
598         .normal_i2c     = normal_i2c,                                   \
599         .probe          = probe,                                        \
600         .ignore         = ignore,                                       \
601         .forces         = forces,                                       \
602 }
603
604 /* These are the ones you want to use in your own drivers. Pick the one
605    which matches the number of devices the driver differenciates between. */
606 #define I2C_CLIENT_INSMOD \
607   I2C_CLIENT_MODULE_PARM(force, \
608                       "List of adapter,address pairs to boldly assume " \
609                       "to be present"); \
610         static unsigned short *forces[] = {                             \
611                         force,                                          \
612                         NULL                                            \
613                 };                                                      \
614 I2C_CLIENT_INSMOD_COMMON
615
616 #define I2C_CLIENT_INSMOD_1(chip1)                                      \
617 enum chips { any_chip, chip1 };                                         \
618 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
619                        "boldly assume to be present");                  \
620 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
621 static unsigned short *forces[] = { force, force_##chip1, NULL };       \
622 I2C_CLIENT_INSMOD_COMMON
623
624 #define I2C_CLIENT_INSMOD_2(chip1, chip2)                               \
625 enum chips { any_chip, chip1, chip2 };                                  \
626 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
627                        "boldly assume to be present");                  \
628 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
629 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
630 static unsigned short *forces[] = { force, force_##chip1,               \
631                                     force_##chip2, NULL };              \
632 I2C_CLIENT_INSMOD_COMMON
633
634 #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3)                        \
635 enum chips { any_chip, chip1, chip2, chip3 };                           \
636 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
637                        "boldly assume to be present");                  \
638 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
639 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
640 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
641 static unsigned short *forces[] = { force, force_##chip1,               \
642                                     force_##chip2, force_##chip3,       \
643                                     NULL };                             \
644 I2C_CLIENT_INSMOD_COMMON
645
646 #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4)                 \
647 enum chips { any_chip, chip1, chip2, chip3, chip4 };                    \
648 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
649                        "boldly assume to be present");                  \
650 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
651 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
652 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
653 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
654 static unsigned short *forces[] = { force, force_##chip1,               \
655                                     force_##chip2, force_##chip3,       \
656                                     force_##chip4, NULL};               \
657 I2C_CLIENT_INSMOD_COMMON
658
659 #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5)          \
660 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 };             \
661 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
662                        "boldly assume to be present");                  \
663 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
664 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
665 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
666 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
667 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
668 static unsigned short *forces[] = { force, force_##chip1,               \
669                                     force_##chip2, force_##chip3,       \
670                                     force_##chip4, force_##chip5,       \
671                                     NULL };                             \
672 I2C_CLIENT_INSMOD_COMMON
673
674 #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6)   \
675 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 };      \
676 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
677                        "boldly assume to be present");                  \
678 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
679 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
680 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
681 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
682 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
683 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
684 static unsigned short *forces[] = { force, force_##chip1,               \
685                                     force_##chip2, force_##chip3,       \
686                                     force_##chip4, force_##chip5,       \
687                                     force_##chip6, NULL };              \
688 I2C_CLIENT_INSMOD_COMMON
689
690 #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
691 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
692              chip7 };                                                   \
693 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
694                        "boldly assume to be present");                  \
695 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
696 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
697 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
698 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
699 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
700 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
701 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
702 static unsigned short *forces[] = { force, force_##chip1,               \
703                                     force_##chip2, force_##chip3,       \
704                                     force_##chip4, force_##chip5,       \
705                                     force_##chip6, force_##chip7,       \
706                                     NULL };                             \
707 I2C_CLIENT_INSMOD_COMMON
708
709 #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
710 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
711              chip7, chip8 };                                            \
712 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
713                        "boldly assume to be present");                  \
714 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
715 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
716 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
717 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
718 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
719 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
720 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
721 I2C_CLIENT_MODULE_PARM_FORCE(chip8);                                    \
722 static unsigned short *forces[] = { force, force_##chip1,               \
723                                     force_##chip2, force_##chip3,       \
724                                     force_##chip4, force_##chip5,       \
725                                     force_##chip6, force_##chip7,       \
726                                     force_##chip8, NULL };              \
727 I2C_CLIENT_INSMOD_COMMON
728 #endif /* __KERNEL__ */
729 #endif /* _LINUX_I2C_H */