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