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