SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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 /* --- For i2c-isa ---------------------------------------------------- */
  39
  40 extern void i2c_adapter_dev_release(struct device *dev);
  41 extern struct class i2c_adapter_class;
  42 extern struct bus_type i2c_bus_type;
  43
  44 /* --- General options ------------------------------------------------ */
  45
  46 struct i2c_msg;
  47 struct i2c_algorithm;
  48 struct i2c_adapter;
  49 struct i2c_client;
  50 struct i2c_driver;
  51 union 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  */
  59 extern int i2c_master_send(struct i2c_client *,const char* ,int);
  60 extern int i2c_master_recv(struct i2c_client *,char* ,int);
  61
  62 /* Transfer num messages.
  63  */
  64 extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
  65
  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,
  69    and probably just as fast.
  70    Note that we use i2c_adapter here, because you do not need a specific
  71    smbus adapter to call this function. */
  72 extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
  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
  80 extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
  81 extern s32 i2c_smbus_read_byte(struct i2c_client * client);
  82 extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
  83 extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
  84 extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
  85                                      u8 command, u8 value);
  86 extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
  87 extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
  88                                      u8 command, u16 value);
  89 extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
  90                                       u8 command, u8 length,
  91                                       const u8 *values);
  92 /* Returns the number of read bytes */
  93 extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
  94                                          u8 command, u8 *values);
  95 extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,
  96                                           u8 command, u8 length,
  97                                           const u8 *values);
  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.
 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.
 106  */
 107
 108 struct i2c_driver {
 109         int id;
 110         unsigned int class;
 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
 114          * & seek for the presence of the chip(s) it supports. If found, it
 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
 121         /* tells the driver that a client is about to be deleted & gives it
 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 *);
 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
 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   20
 144
 145 /**
 146  * struct i2c_client - represent an I2C slave device
 147  * @addr: Address used on the I2C bus connected to the parent adapter.
 148  * @name: Indicates the type of the device, usually a chip name that's
 149  *      generic enough to hide second-sourcing and compatible revisions.
 150  * @dev: Driver model device node for the slave.
 151  *
 152  * An i2c_client identifies a single device (i.e. chip) connected to an
 153  * i2c bus. The behaviour is defined by the routines of the driver.
 154  */
 155 struct i2c_client {
 156         unsigned short flags;           /* div., see below              */
 157         unsigned short addr;            /* chip address - NOTE: 7bit    */
 158                                         /* addresses are stored in the  */
 159                                         /* _LOWER_ 7 bits               */
 160         char name[I2C_NAME_SIZE];
 161         struct i2c_adapter *adapter;    /* the adapter we sit on        */
 162         struct i2c_driver *driver;      /* and our access routines      */
 163         int usage_count;                /* How many accesses currently  */
 164                                         /* to the client                */
 165         struct device dev;              /* the device structure         */
 166         struct list_head list;
 167         struct completion released;
 168 };
 169 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
 170
 171 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
 172 {
 173         return to_i2c_client(container_of(kobj, struct device, kobj));
 174 }
 175
 176 static inline void *i2c_get_clientdata (struct i2c_client *dev)
 177 {
 178         return dev_get_drvdata (&dev->dev);
 179 }
 180
 181 static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
 182 {
 183         dev_set_drvdata (&dev->dev, data);
 184 }
 185
 186 /*
 187  * The following structs are for those who like to implement new bus drivers:
 188  * i2c_algorithm is the interface to a class of hardware solutions which can
 189  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
 190  * to name two of the most common.
 191  */
 192 struct i2c_algorithm {
 193         /* If an adapter algorithm can't do I2C-level access, set master_xfer
 194            to NULL. If an adapter algorithm can do SMBus access, set
 195            smbus_xfer. If set to NULL, the SMBus protocol is simulated
 196            using common I2C messages */
 197         /* master_xfer should return the number of messages successfully
 198            processed, or a negative value on error */
 199         int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
 200                            int num);
 201         int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
 202                            unsigned short flags, char read_write,
 203                            u8 command, int size, union i2c_smbus_data * data);
 204
 205         /* --- ioctl like call to set div. parameters. */
 206         int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
 207
 208         /* To determine what the adapter supports */
 209         u32 (*functionality) (struct i2c_adapter *);
 210 };
 211
 212 /*
 213  * i2c_adapter is the structure used to identify a physical i2c bus along
 214  * with the access algorithms necessary to access it.
 215  */
 216 struct i2c_adapter {
 217         struct module *owner;
 218         unsigned int id;
 219         unsigned int class;
 220         const struct i2c_algorithm *algo; /* the algorithm to access the bus */
 221         void *algo_data;
 222
 223         /* --- administration stuff. */
 224         int (*client_register)(struct i2c_client *);
 225         int (*client_unregister)(struct i2c_client *);
 226
 227         /* data fields that are valid for all devices   */
 228         u8 level;                       /* nesting level for lockdep */
 229         struct mutex bus_lock;
 230         struct mutex clist_lock;
 231
 232         int timeout;
 233         int retries;
 234         struct device dev;              /* the adapter device */
 235
 236         int nr;
 237         struct list_head clients;
 238         struct list_head list;
 239         char name[48];
 240         struct completion dev_released;
 241 };
 242 #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
 243
 244 static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
 245 {
 246         return dev_get_drvdata (&dev->dev);
 247 }
 248
 249 static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
 250 {
 251         dev_set_drvdata (&dev->dev, data);
 252 }
 253
 254 /*flags for the client struct: */
 255 #define I2C_CLIENT_PEC  0x04                    /* Use Packet Error Checking */
 256 #define I2C_CLIENT_TEN  0x10                    /* we have a ten bit chip address       */
 257                                                 /* Must equal I2C_M_TEN below */
 258
 259 /* i2c adapter classes (bitmask) */
 260 #define I2C_CLASS_HWMON         (1<<0)  /* lm_sensors, ... */
 261 #define I2C_CLASS_TV_ANALOG     (1<<1)  /* bttv + friends */
 262 #define I2C_CLASS_TV_DIGITAL    (1<<2)  /* dvb cards */
 263 #define I2C_CLASS_DDC           (1<<3)  /* i2c-matroxfb ? */
 264 #define I2C_CLASS_CAM_ANALOG    (1<<4)  /* camera with analog CCD */
 265 #define I2C_CLASS_CAM_DIGITAL   (1<<5)  /* most webcams */
 266 #define I2C_CLASS_SOUND         (1<<6)  /* sound devices */
 267 #define I2C_CLASS_ALL           (UINT_MAX) /* all of the above */
 268
 269 /* i2c_client_address_data is the struct for holding default client
 270  * addresses for a driver and for the parameters supplied on the
 271  * command line
 272  */
 273 struct i2c_client_address_data {
 274         unsigned short *normal_i2c;
 275         unsigned short *probe;
 276         unsigned short *ignore;
 277         unsigned short **forces;
 278 };
 279
 280 /* Internal numbers to terminate lists */
 281 #define I2C_CLIENT_END          0xfffeU
 282
 283 /* The numbers to use to set I2C bus address */
 284 #define ANY_I2C_BUS             0xffff
 285 #define ANY_I2C_ISA_BUS         9191
 286
 287
 288 /* ----- functions exported by i2c.o */
 289
 290 /* administration...
 291  */
 292 extern int i2c_add_adapter(struct i2c_adapter *);
 293 extern int i2c_del_adapter(struct i2c_adapter *);
 294
 295 extern int i2c_register_driver(struct module *, struct i2c_driver *);
 296 extern int i2c_del_driver(struct i2c_driver *);
 297
 298 static inline int i2c_add_driver(struct i2c_driver *driver)
 299 {
 300         return i2c_register_driver(THIS_MODULE, driver);
 301 }
 302
 303 extern int i2c_attach_client(struct i2c_client *);
 304 extern int i2c_detach_client(struct i2c_client *);
 305
 306 /* Should be used to make sure that client-struct is valid and that it
 307    is okay to access the i2c-client.
 308    returns -ENODEV if client has gone in the meantime */
 309 extern int i2c_use_client(struct i2c_client *);
 310 extern int i2c_release_client(struct i2c_client *);
 311
 312 /* call the i2c_client->command() of all attached clients with
 313  * the given arguments */
 314 extern void i2c_clients_command(struct i2c_adapter *adap,
 315                                 unsigned int cmd, void *arg);
 316
 317 /* returns -EBUSY if address has been taken, 0 if not. Note that the only
 318    other place at which this is called is within i2c_attach_client; so
 319    you can cheat by simply not registering. Not recommended, of course! */
 320 extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
 321
 322 /* Detect function. It iterates over all possible addresses itself.
 323  * It will only call found_proc if some client is connected at the
 324  * specific address (unless a 'force' matched);
 325  */
 326 extern int i2c_probe(struct i2c_adapter *adapter,
 327                 struct i2c_client_address_data *address_data,
 328                 int (*found_proc) (struct i2c_adapter *, int, int));
 329
 330 /* An ioctl like call to set div. parameters of the adapter.
 331  */
 332 extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
 333
 334 extern struct i2c_adapter* i2c_get_adapter(int id);
 335 extern void i2c_put_adapter(struct i2c_adapter *adap);
 336
 337
 338 /* Return the functionality mask */
 339 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
 340 {
 341         return adap->algo->functionality(adap);
 342 }
 343
 344 /* Return 1 if adapter supports everything we need, 0 if not. */
 345 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
 346 {
 347         return (func & i2c_get_functionality(adap)) == func;
 348 }
 349
 350 /* Return id number for a specific adapter */
 351 static inline int i2c_adapter_id(struct i2c_adapter *adap)
 352 {
 353         return adap->nr;
 354 }
 355 #endif /* __KERNEL__ */
 356
 357 /*
 358  * I2C Message - used for pure i2c transaction, also from /dev interface
 359  */
 360 struct i2c_msg {
 361         __u16 addr;     /* slave address                        */
 362         __u16 flags;
 363 #define I2C_M_TEN       0x10    /* we have a ten bit chip address       */
 364 #define I2C_M_RD        0x01
 365 #define I2C_M_NOSTART   0x4000
 366 #define I2C_M_REV_DIR_ADDR      0x2000
 367 #define I2C_M_IGNORE_NAK        0x1000
 368 #define I2C_M_NO_RD_ACK         0x0800
 369 #define I2C_M_RECV_LEN          0x0400 /* length will be first received byte */
 370         __u16 len;              /* msg length                           */
 371         __u8 *buf;              /* pointer to msg data                  */
 372 };
 373
 374 /* To determine what functionality is present */
 375
 376 #define I2C_FUNC_I2C                    0x00000001
 377 #define I2C_FUNC_10BIT_ADDR             0x00000002
 378 #define I2C_FUNC_PROTOCOL_MANGLING      0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
 379 #define I2C_FUNC_SMBUS_HWPEC_CALC       0x00000008 /* SMBus 2.0 */
 380 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL  0x00008000 /* SMBus 2.0 */
 381 #define I2C_FUNC_SMBUS_QUICK            0x00010000
 382 #define I2C_FUNC_SMBUS_READ_BYTE        0x00020000
 383 #define I2C_FUNC_SMBUS_WRITE_BYTE       0x00040000
 384 #define I2C_FUNC_SMBUS_READ_BYTE_DATA   0x00080000
 385 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA  0x00100000
 386 #define I2C_FUNC_SMBUS_READ_WORD_DATA   0x00200000
 387 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA  0x00400000
 388 #define I2C_FUNC_SMBUS_PROC_CALL        0x00800000
 389 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA  0x01000000
 390 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
 391 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK   0x04000000 /* I2C-like block xfer  */
 392 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK  0x08000000 /* w/ 1-byte reg. addr. */
 393 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2  0x10000000 /* I2C-like block xfer  */
 394 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
 395
 396 #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
 397                              I2C_FUNC_SMBUS_WRITE_BYTE)
 398 #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
 399                                   I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
 400 #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
 401                                   I2C_FUNC_SMBUS_WRITE_WORD_DATA)
 402 #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
 403                                    I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
 404 #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
 405                                   I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
 406 #define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
 407                                     I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
 408
 409 #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
 410                              I2C_FUNC_SMBUS_BYTE | \
 411                              I2C_FUNC_SMBUS_BYTE_DATA | \
 412                              I2C_FUNC_SMBUS_WORD_DATA | \
 413                              I2C_FUNC_SMBUS_PROC_CALL | \
 414                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
 415                              I2C_FUNC_SMBUS_I2C_BLOCK)
 416
 417 /*
 418  * Data for SMBus Messages
 419  */
 420 #define I2C_SMBUS_BLOCK_MAX     32      /* As specified in SMBus standard */
 421 union i2c_smbus_data {
 422         __u8 byte;
 423         __u16 word;
 424         __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
 425                                /* and one more for user-space compatibility */
 426 };
 427
 428 /* smbus_access read or write markers */
 429 #define I2C_SMBUS_READ  1
 430 #define I2C_SMBUS_WRITE 0
 431
 432 /* SMBus transaction types (size parameter in the above functions)
 433    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
 434 #define I2C_SMBUS_QUICK             0
 435 #define I2C_SMBUS_BYTE              1
 436 #define I2C_SMBUS_BYTE_DATA         2
 437 #define I2C_SMBUS_WORD_DATA         3
 438 #define I2C_SMBUS_PROC_CALL         4
 439 #define I2C_SMBUS_BLOCK_DATA        5
 440 #define I2C_SMBUS_I2C_BLOCK_DATA    6
 441 #define I2C_SMBUS_BLOCK_PROC_CALL   7           /* SMBus 2.0 */
 442
 443
 444 /* ----- commands for the ioctl like i2c_command call:
 445  * note that additional calls are defined in the algorithm and hw
 446  *      dependent layers - these can be listed here, or see the
 447  *      corresponding header files.
 448  */
 449                                 /* -> bit-adapter specific ioctls       */
 450 #define I2C_RETRIES     0x0701  /* number of times a device address      */
 451                                 /* should be polled when not            */
 452                                 /* acknowledging                        */
 453 #define I2C_TIMEOUT     0x0702  /* set timeout - call with int          */
 454
 455
 456 /* this is for i2c-dev.c        */
 457 #define I2C_SLAVE       0x0703  /* Change slave address                 */
 458                                 /* Attn.: Slave address is 7 or 10 bits */
 459 #define I2C_SLAVE_FORCE 0x0706  /* Change slave address                 */
 460                                 /* Attn.: Slave address is 7 or 10 bits */
 461                                 /* This changes the address, even if it */
 462                                 /* is already taken!                    */
 463 #define I2C_TENBIT      0x0704  /* 0 for 7 bit addrs, != 0 for 10 bit   */
 464
 465 #define I2C_FUNCS       0x0705  /* Get the adapter functionality */
 466 #define I2C_RDWR        0x0707  /* Combined R/W transfer (one stop only)*/
 467 #define I2C_PEC         0x0708  /* != 0 for SMBus PEC                   */
 468
 469 #define I2C_SMBUS       0x0720  /* SMBus-level access */
 470
 471 /* ----- I2C-DEV: char device interface stuff ------------------------- */
 472 #ifdef __KERNEL__
 473
 474 #define I2C_MAJOR       89              /* Device major number          */
 475
 476 /* These defines are used for probing i2c client addresses */
 477 /* The length of the option lists */
 478 #define I2C_CLIENT_MAX_OPTS 48
 479
 480 /* Default fill of many variables */
 481 #define I2C_CLIENT_DEFAULTS {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                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 492                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 493                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 494                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 495                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 496                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
 497
 498 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
 499    module header */
 500
 501 #define I2C_CLIENT_MODULE_PARM(var,desc) \
 502   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
 503   static unsigned int var##_num; \
 504   module_param_array(var, short, &var##_num, 0); \
 505   MODULE_PARM_DESC(var,desc)
 506
 507 #define I2C_CLIENT_MODULE_PARM_FORCE(name)                              \
 508 I2C_CLIENT_MODULE_PARM(force_##name,                                    \
 509                        "List of adapter,address pairs which are "       \
 510                        "unquestionably assumed to contain a `"          \
 511                        # name "' chip")
 512
 513
 514 #define I2C_CLIENT_INSMOD_COMMON                                        \
 515 I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan "  \
 516                        "additionally");                                 \
 517 I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to "  \
 518                        "scan");                                         \
 519 static struct i2c_client_address_data addr_data = {                     \
 520         .normal_i2c     = normal_i2c,                                   \
 521         .probe          = probe,                                        \
 522         .ignore         = ignore,                                       \
 523         .forces         = forces,                                       \
 524 }
 525
 526 /* These are the ones you want to use in your own drivers. Pick the one
 527    which matches the number of devices the driver differenciates between. */
 528 #define I2C_CLIENT_INSMOD \
 529   I2C_CLIENT_MODULE_PARM(force, \
 530                       "List of adapter,address pairs to boldly assume " \
 531                       "to be present"); \
 532         static unsigned short *forces[] = {                             \
 533                         force,                                          \
 534                         NULL                                            \
 535                 };                                                      \
 536 I2C_CLIENT_INSMOD_COMMON
 537
 538 #define I2C_CLIENT_INSMOD_1(chip1)                                      \
 539 enum chips { any_chip, chip1 };                                         \
 540 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 541                        "boldly assume to be present");                  \
 542 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 543 static unsigned short *forces[] = { force, force_##chip1, NULL };       \
 544 I2C_CLIENT_INSMOD_COMMON
 545
 546 #define I2C_CLIENT_INSMOD_2(chip1, chip2)                               \
 547 enum chips { any_chip, chip1, chip2 };                                  \
 548 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 549                        "boldly assume to be present");                  \
 550 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 551 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 552 static unsigned short *forces[] = { force, force_##chip1,               \
 553                                     force_##chip2, NULL };              \
 554 I2C_CLIENT_INSMOD_COMMON
 555
 556 #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3)                        \
 557 enum chips { any_chip, chip1, chip2, chip3 };                           \
 558 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 559                        "boldly assume to be present");                  \
 560 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 561 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 562 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 563 static unsigned short *forces[] = { force, force_##chip1,               \
 564                                     force_##chip2, force_##chip3,       \
 565                                     NULL };                             \
 566 I2C_CLIENT_INSMOD_COMMON
 567
 568 #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4)                 \
 569 enum chips { any_chip, chip1, chip2, chip3, chip4 };                    \
 570 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 571                        "boldly assume to be present");                  \
 572 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 573 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 574 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 575 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 576 static unsigned short *forces[] = { force, force_##chip1,               \
 577                                     force_##chip2, force_##chip3,       \
 578                                     force_##chip4, NULL};               \
 579 I2C_CLIENT_INSMOD_COMMON
 580
 581 #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5)          \
 582 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 };             \
 583 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 584                        "boldly assume to be present");                  \
 585 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 586 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 587 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 588 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 589 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
 590 static unsigned short *forces[] = { force, force_##chip1,               \
 591                                     force_##chip2, force_##chip3,       \
 592                                     force_##chip4, force_##chip5,       \
 593                                     NULL };                             \
 594 I2C_CLIENT_INSMOD_COMMON
 595
 596 #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6)   \
 597 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 };      \
 598 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 599                        "boldly assume to be present");                  \
 600 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 601 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 602 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 603 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 604 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
 605 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
 606 static unsigned short *forces[] = { force, force_##chip1,               \
 607                                     force_##chip2, force_##chip3,       \
 608                                     force_##chip4, force_##chip5,       \
 609                                     force_##chip6, NULL };              \
 610 I2C_CLIENT_INSMOD_COMMON
 611
 612 #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
 613 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
 614              chip7 };                                                   \
 615 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 616                        "boldly assume to be present");                  \
 617 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 618 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 619 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 620 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 621 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
 622 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
 623 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
 624 static unsigned short *forces[] = { force, force_##chip1,               \
 625                                     force_##chip2, force_##chip3,       \
 626                                     force_##chip4, force_##chip5,       \
 627                                     force_##chip6, force_##chip7,       \
 628                                     NULL };                             \
 629 I2C_CLIENT_INSMOD_COMMON
 630
 631 #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
 632 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
 633              chip7, chip8 };                                            \
 634 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 635                        "boldly assume to be present");                  \
 636 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 637 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 638 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 639 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 640 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
 641 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
 642 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
 643 I2C_CLIENT_MODULE_PARM_FORCE(chip8);                                    \
 644 static unsigned short *forces[] = { force, force_##chip1,               \
 645                                     force_##chip2, force_##chip3,       \
 646                                     force_##chip4, force_##chip5,       \
 647                                     force_##chip6, force_##chip7,       \
 648                                     force_##chip8, NULL };              \
 649 I2C_CLIENT_INSMOD_COMMON
 650 #endif /* __KERNEL__ */
 651 #endif /* _LINUX_I2C_H */