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 /* $Id: i2c.h,v 1.68 2003/01/21 08:08:16 kmalkki Exp $ */
  27
  28 #ifndef _LINUX_I2C_H
  29 #define _LINUX_I2C_H
  30
  31 #include <linux/module.h>
  32 #include <linux/types.h>
  33 #include <linux/i2c-id.h>
  34 #include <linux/device.h>       /* for struct device */
  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 /* Returns the number of bytes transferred */
  98 extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
  99                                       u8 command, u8 length,
 100                                       u8 *values);
 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         unsigned int flags;             /* div., see below              */
 116
 117         /* Notifies the driver that a new bus has appeared. This routine
 118          * can be used by the driver to test if the bus meets its conditions
 119          * & seek for the presence of the chip(s) it supports. If found, it
 120          * registers the client(s) that are on the bus to the i2c admin. via
 121          * i2c_attach_client.
 122          */
 123         int (*attach_adapter)(struct i2c_adapter *);
 124         int (*detach_adapter)(struct i2c_adapter *);
 125
 126         /* tells the driver that a client is about to be deleted & gives it
 127          * the chance to remove its private data. Also, if the client struct
 128          * has been dynamically allocated by the driver in the function above,
 129          * it must be freed here.
 130          */
 131         int (*detach_client)(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   50
 144
 145 /*
 146  * i2c_client identifies a single device (i.e. chip) that is connected to an
 147  * i2c bus. The behaviour is defined by the routines of the driver. This
 148  * function is mainly used for lookup & other admin. functions.
 149  */
 150 struct i2c_client {
 151         unsigned int flags;             /* div., see below              */
 152         unsigned short addr;            /* chip address - NOTE: 7bit    */
 153                                         /* addresses are stored in the  */
 154                                         /* _LOWER_ 7 bits               */
 155         struct i2c_adapter *adapter;    /* the adapter we sit on        */
 156         struct i2c_driver *driver;      /* and our access routines      */
 157         int usage_count;                /* How many accesses currently  */
 158                                         /* to the client                */
 159         struct device dev;              /* the device structure         */
 160         struct list_head list;
 161         char name[I2C_NAME_SIZE];
 162         struct completion released;
 163 };
 164 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
 165
 166 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
 167 {
 168         return to_i2c_client(container_of(kobj, struct device, kobj));
 169 }
 170
 171 static inline void *i2c_get_clientdata (struct i2c_client *dev)
 172 {
 173         return dev_get_drvdata (&dev->dev);
 174 }
 175
 176 static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
 177 {
 178         dev_set_drvdata (&dev->dev, data);
 179 }
 180
 181 #define I2C_DEVNAME(str)        .name = str
 182
 183 static inline char *i2c_clientname(struct i2c_client *c)
 184 {
 185         return &c->name[0];
 186 }
 187
 188 /*
 189  * The following structs are for those who like to implement new bus drivers:
 190  * i2c_algorithm is the interface to a class of hardware solutions which can
 191  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
 192  * to name two of the most common.
 193  */
 194 struct i2c_algorithm {
 195         char name[32];                          /* textual description  */
 196         unsigned int id;
 197
 198         /* If an adapter algorithm can't do I2C-level access, set master_xfer
 199            to NULL. If an adapter algorithm can do SMBus access, set
 200            smbus_xfer. If set to NULL, the SMBus protocol is simulated
 201            using common I2C messages */
 202         int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
 203                            int num);
 204         int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
 205                            unsigned short flags, char read_write,
 206                            u8 command, int size, union i2c_smbus_data * data);
 207
 208         /* --- these optional/future use for some adapter types.*/
 209         int (*slave_send)(struct i2c_adapter *,char*,int);
 210         int (*slave_recv)(struct i2c_adapter *,char*,int);
 211
 212         /* --- ioctl like call to set div. parameters. */
 213         int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
 214
 215         /* To determine what the adapter supports */
 216         u32 (*functionality) (struct i2c_adapter *);
 217 };
 218
 219 /*
 220  * i2c_adapter is the structure used to identify a physical i2c bus along
 221  * with the access algorithms necessary to access it.
 222  */
 223 struct i2c_adapter {
 224         struct module *owner;
 225         unsigned int id;/* == is algo->id | hwdep.struct->id,           */
 226                         /* for registered values see below              */
 227         unsigned int class;
 228         struct i2c_algorithm *algo;/* the algorithm to access the bus   */
 229         void *algo_data;
 230
 231         /* --- administration stuff. */
 232         int (*client_register)(struct i2c_client *);
 233         int (*client_unregister)(struct i2c_client *);
 234
 235         /* data fields that are valid for all devices   */
 236         struct semaphore bus_lock;
 237         struct semaphore clist_lock;
 238
 239         int timeout;
 240         int retries;
 241         struct device dev;              /* the adapter device */
 242         struct class_device class_dev;  /* the class device */
 243
 244 #ifdef CONFIG_PROC_FS
 245         /* No need to set this when you initialize the adapter          */
 246         int inode;
 247 #endif /* def CONFIG_PROC_FS */
 248
 249         int nr;
 250         struct list_head clients;
 251         struct list_head list;
 252         char name[I2C_NAME_SIZE];
 253         struct completion dev_released;
 254         struct completion class_dev_released;
 255 };
 256 #define dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
 257 #define class_dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, class_dev)
 258
 259 static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
 260 {
 261         return dev_get_drvdata (&dev->dev);
 262 }
 263
 264 static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
 265 {
 266         dev_set_drvdata (&dev->dev, data);
 267 }
 268
 269 /*flags for the driver struct: */
 270 #define I2C_DF_NOTIFY   0x01            /* notify on bus (de/a)ttaches  */
 271 #if 0
 272 /* this flag is gone -- there is a (optional) driver->detach_adapter
 273  * callback now which can be used instead */
 274 # define I2C_DF_DUMMY   0x02
 275 #endif
 276
 277 /*flags for the client struct: */
 278 #define I2C_CLIENT_ALLOW_USE            0x01    /* Client allows access */
 279 #define I2C_CLIENT_ALLOW_MULTIPLE_USE   0x02    /* Allow multiple access-locks */
 280                                                 /* on an i2c_client */
 281 #define I2C_CLIENT_PEC  0x04                    /* Use Packet Error Checking */
 282 #define I2C_CLIENT_TEN  0x10                    /* we have a ten bit chip address       */
 283                                                 /* Must equal I2C_M_TEN below */
 284
 285 /* i2c adapter classes (bitmask) */
 286 #define I2C_CLASS_HWMON         (1<<0)  /* lm_sensors, ... */
 287 #define I2C_CLASS_TV_ANALOG     (1<<1)  /* bttv + friends */
 288 #define I2C_CLASS_TV_DIGITAL    (1<<2)  /* dvb cards */
 289 #define I2C_CLASS_DDC           (1<<3)  /* i2c-matroxfb ? */
 290 #define I2C_CLASS_CAM_ANALOG    (1<<4)  /* camera with analog CCD */
 291 #define I2C_CLASS_CAM_DIGITAL   (1<<5)  /* most webcams */
 292 #define I2C_CLASS_SOUND         (1<<6)  /* sound devices */
 293 #define I2C_CLASS_ALL           (UINT_MAX) /* all of the above */
 294
 295 /* i2c_client_address_data is the struct for holding default client
 296  * addresses for a driver and for the parameters supplied on the
 297  * command line
 298  */
 299 struct i2c_client_address_data {
 300         unsigned short *normal_i2c;
 301         unsigned short *probe;
 302         unsigned short *ignore;
 303         unsigned short **forces;
 304 };
 305
 306 /* Internal numbers to terminate lists */
 307 #define I2C_CLIENT_END          0xfffeU
 308
 309 /* The numbers to use to set I2C bus address */
 310 #define ANY_I2C_BUS             0xffff
 311 #define ANY_I2C_ISA_BUS         9191
 312
 313
 314 /* ----- functions exported by i2c.o */
 315
 316 /* administration...
 317  */
 318 extern int i2c_add_adapter(struct i2c_adapter *);
 319 extern int i2c_del_adapter(struct i2c_adapter *);
 320
 321 extern int i2c_add_driver(struct i2c_driver *);
 322 extern int i2c_del_driver(struct i2c_driver *);
 323
 324 extern int i2c_attach_client(struct i2c_client *);
 325 extern int i2c_detach_client(struct i2c_client *);
 326
 327 /* New function: This is to get an i2c_client-struct for controlling the
 328    client either by using i2c_control-function or having the
 329    client-module export functions that can be used with the i2c_client
 330    -struct. */
 331 extern struct i2c_client *i2c_get_client(int driver_id, int adapter_id,
 332                                         struct i2c_client *prev);
 333
 334 /* Should be used with new function
 335    extern struct i2c_client *i2c_get_client(int,int,struct i2c_client *);
 336    to make sure that client-struct is valid and that it is okay to access
 337    the i2c-client.
 338    returns -EACCES if client doesn't allow use (default)
 339    returns -EBUSY if client doesn't allow multiple use (default) and
 340    usage_count >0 */
 341 extern int i2c_use_client(struct i2c_client *);
 342 extern int i2c_release_client(struct i2c_client *);
 343
 344 /* call the i2c_client->command() of all attached clients with
 345  * the given arguments */
 346 extern void i2c_clients_command(struct i2c_adapter *adap,
 347                                 unsigned int cmd, void *arg);
 348
 349 /* returns -EBUSY if address has been taken, 0 if not. Note that the only
 350    other place at which this is called is within i2c_attach_client; so
 351    you can cheat by simply not registering. Not recommended, of course! */
 352 extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
 353
 354 /* Detect function. It iterates over all possible addresses itself.
 355  * It will only call found_proc if some client is connected at the
 356  * specific address (unless a 'force' matched);
 357  */
 358 extern int i2c_probe(struct i2c_adapter *adapter,
 359                 struct i2c_client_address_data *address_data,
 360                 int (*found_proc) (struct i2c_adapter *, int, int));
 361
 362 /* An ioctl like call to set div. parameters of the adapter.
 363  */
 364 extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
 365
 366 extern struct i2c_adapter* i2c_get_adapter(int id);
 367 extern void i2c_put_adapter(struct i2c_adapter *adap);
 368
 369
 370 /* Return the functionality mask */
 371 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
 372 {
 373         return adap->algo->functionality(adap);
 374 }
 375
 376 /* Return 1 if adapter supports everything we need, 0 if not. */
 377 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
 378 {
 379         return (func & i2c_get_functionality(adap)) == func;
 380 }
 381
 382 /* Return id number for a specific adapter */
 383 static inline int i2c_adapter_id(struct i2c_adapter *adap)
 384 {
 385         return adap->nr;
 386 }
 387
 388 /*
 389  * I2C Message - used for pure i2c transaction, also from /dev interface
 390  */
 391 struct i2c_msg {
 392         __u16 addr;     /* slave address                        */
 393         __u16 flags;
 394 #define I2C_M_TEN       0x10    /* we have a ten bit chip address       */
 395 #define I2C_M_RD        0x01
 396 #define I2C_M_NOSTART   0x4000
 397 #define I2C_M_REV_DIR_ADDR      0x2000
 398 #define I2C_M_IGNORE_NAK        0x1000
 399 #define I2C_M_NO_RD_ACK         0x0800
 400         __u16 len;              /* msg length                           */
 401         __u8 *buf;              /* pointer to msg data                  */
 402 };
 403
 404 /* To determine what functionality is present */
 405
 406 #define I2C_FUNC_I2C                    0x00000001
 407 #define I2C_FUNC_10BIT_ADDR             0x00000002
 408 #define I2C_FUNC_PROTOCOL_MANGLING      0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
 409 #define I2C_FUNC_SMBUS_HWPEC_CALC       0x00000008 /* SMBus 2.0 */
 410 #define I2C_FUNC_SMBUS_READ_WORD_DATA_PEC  0x00000800 /* SMBus 2.0 */
 411 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA_PEC 0x00001000 /* SMBus 2.0 */
 412 #define I2C_FUNC_SMBUS_PROC_CALL_PEC    0x00002000 /* SMBus 2.0 */
 413 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL_PEC 0x00004000 /* SMBus 2.0 */
 414 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL  0x00008000 /* SMBus 2.0 */
 415 #define I2C_FUNC_SMBUS_QUICK            0x00010000
 416 #define I2C_FUNC_SMBUS_READ_BYTE        0x00020000
 417 #define I2C_FUNC_SMBUS_WRITE_BYTE       0x00040000
 418 #define I2C_FUNC_SMBUS_READ_BYTE_DATA   0x00080000
 419 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA  0x00100000
 420 #define I2C_FUNC_SMBUS_READ_WORD_DATA   0x00200000
 421 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA  0x00400000
 422 #define I2C_FUNC_SMBUS_PROC_CALL        0x00800000
 423 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA  0x01000000
 424 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
 425 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK   0x04000000 /* I2C-like block xfer  */
 426 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK  0x08000000 /* w/ 1-byte reg. addr. */
 427 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2  0x10000000 /* I2C-like block xfer  */
 428 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
 429 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA_PEC  0x40000000 /* SMBus 2.0 */
 430 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC 0x80000000 /* SMBus 2.0 */
 431
 432 #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
 433                              I2C_FUNC_SMBUS_WRITE_BYTE)
 434 #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
 435                                   I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
 436 #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
 437                                   I2C_FUNC_SMBUS_WRITE_WORD_DATA)
 438 #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
 439                                    I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
 440 #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
 441                                   I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
 442 #define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
 443                                     I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
 444 #define I2C_FUNC_SMBUS_BLOCK_DATA_PEC (I2C_FUNC_SMBUS_READ_BLOCK_DATA_PEC | \
 445                                        I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC)
 446 #define I2C_FUNC_SMBUS_WORD_DATA_PEC  (I2C_FUNC_SMBUS_READ_WORD_DATA_PEC | \
 447                                        I2C_FUNC_SMBUS_WRITE_WORD_DATA_PEC)
 448
 449 #define I2C_FUNC_SMBUS_READ_BYTE_PEC            I2C_FUNC_SMBUS_READ_BYTE_DATA
 450 #define I2C_FUNC_SMBUS_WRITE_BYTE_PEC           I2C_FUNC_SMBUS_WRITE_BYTE_DATA
 451 #define I2C_FUNC_SMBUS_READ_BYTE_DATA_PEC       I2C_FUNC_SMBUS_READ_WORD_DATA
 452 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA_PEC      I2C_FUNC_SMBUS_WRITE_WORD_DATA
 453 #define I2C_FUNC_SMBUS_BYTE_PEC                 I2C_FUNC_SMBUS_BYTE_DATA
 454 #define I2C_FUNC_SMBUS_BYTE_DATA_PEC            I2C_FUNC_SMBUS_WORD_DATA
 455
 456 #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
 457                              I2C_FUNC_SMBUS_BYTE | \
 458                              I2C_FUNC_SMBUS_BYTE_DATA | \
 459                              I2C_FUNC_SMBUS_WORD_DATA | \
 460                              I2C_FUNC_SMBUS_PROC_CALL | \
 461                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
 462                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC | \
 463                              I2C_FUNC_SMBUS_I2C_BLOCK)
 464
 465 /*
 466  * Data for SMBus Messages
 467  */
 468 #define I2C_SMBUS_BLOCK_MAX     32      /* As specified in SMBus standard */
 469 #define I2C_SMBUS_I2C_BLOCK_MAX 32      /* Not specified but we use same structure */
 470 union i2c_smbus_data {
 471         __u8 byte;
 472         __u16 word;
 473         __u8 block[I2C_SMBUS_BLOCK_MAX + 3]; /* block[0] is used for length */
 474                           /* one more for read length in block process call */
 475                                                     /* and one more for PEC */
 476 };
 477
 478 /* smbus_access read or write markers */
 479 #define I2C_SMBUS_READ  1
 480 #define I2C_SMBUS_WRITE 0
 481
 482 /* SMBus transaction types (size parameter in the above functions)
 483    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
 484 #define I2C_SMBUS_QUICK             0
 485 #define I2C_SMBUS_BYTE              1
 486 #define I2C_SMBUS_BYTE_DATA         2
 487 #define I2C_SMBUS_WORD_DATA         3
 488 #define I2C_SMBUS_PROC_CALL         4
 489 #define I2C_SMBUS_BLOCK_DATA        5
 490 #define I2C_SMBUS_I2C_BLOCK_DATA    6
 491 #define I2C_SMBUS_BLOCK_PROC_CALL   7           /* SMBus 2.0 */
 492 #define I2C_SMBUS_BLOCK_DATA_PEC    8           /* SMBus 2.0 */
 493 #define I2C_SMBUS_PROC_CALL_PEC     9           /* SMBus 2.0 */
 494 #define I2C_SMBUS_BLOCK_PROC_CALL_PEC  10       /* SMBus 2.0 */
 495 #define I2C_SMBUS_WORD_DATA_PEC    11           /* SMBus 2.0 */
 496
 497
 498 /* ----- commands for the ioctl like i2c_command call:
 499  * note that additional calls are defined in the algorithm and hw
 500  *      dependent layers - these can be listed here, or see the
 501  *      corresponding header files.
 502  */
 503                                 /* -> bit-adapter specific ioctls       */
 504 #define I2C_RETRIES     0x0701  /* number of times a device address      */
 505                                 /* should be polled when not            */
 506                                 /* acknowledging                        */
 507 #define I2C_TIMEOUT     0x0702  /* set timeout - call with int          */
 508
 509
 510 /* this is for i2c-dev.c        */
 511 #define I2C_SLAVE       0x0703  /* Change slave address                 */
 512                                 /* Attn.: Slave address is 7 or 10 bits */
 513 #define I2C_SLAVE_FORCE 0x0706  /* Change slave address                 */
 514                                 /* Attn.: Slave address is 7 or 10 bits */
 515                                 /* This changes the address, even if it */
 516                                 /* is already taken!                    */
 517 #define I2C_TENBIT      0x0704  /* 0 for 7 bit addrs, != 0 for 10 bit   */
 518
 519 #define I2C_FUNCS       0x0705  /* Get the adapter functionality */
 520 #define I2C_RDWR        0x0707  /* Combined R/W transfer (one stop only)*/
 521 #define I2C_PEC         0x0708  /* != 0 for SMBus PEC                   */
 522 #if 0
 523 #define I2C_ACK_TEST    0x0710  /* See if a slave is at a specific address */
 524 #endif
 525
 526 #define I2C_SMBUS       0x0720  /* SMBus-level access */
 527
 528 /* ... algo-bit.c recognizes */
 529 #define I2C_UDELAY      0x0705  /* set delay in microsecs between each  */
 530                                 /* written byte (except address)        */
 531 #define I2C_MDELAY      0x0706  /* millisec delay between written bytes */
 532
 533 /* ----- I2C-DEV: char device interface stuff ------------------------- */
 534
 535 #define I2C_MAJOR       89              /* Device major number          */
 536
 537 /* These defines are used for probing i2c client addresses */
 538 /* The length of the option lists */
 539 #define I2C_CLIENT_MAX_OPTS 48
 540
 541 /* Default fill of many variables */
 542 #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 543                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 544                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 545                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 546                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 547                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 548                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 549                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 550                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 551                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 552                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 553                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 554                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 555                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 556                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 557                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
 558
 559 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
 560    module header */
 561
 562 #define I2C_CLIENT_MODULE_PARM(var,desc) \
 563   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
 564   static unsigned int var##_num; \
 565   module_param_array(var, short, &var##_num, 0); \
 566   MODULE_PARM_DESC(var,desc)
 567
 568 #define I2C_CLIENT_MODULE_PARM_FORCE(name)                              \
 569 I2C_CLIENT_MODULE_PARM(force_##name,                                    \
 570                        "List of adapter,address pairs which are "       \
 571                        "unquestionably assumed to contain a `"          \
 572                        # name "' chip")
 573
 574
 575 #define I2C_CLIENT_INSMOD_COMMON                                        \
 576 I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan "  \
 577                        "additionally");                                 \
 578 I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to "  \
 579                        "scan");                                         \
 580 static struct i2c_client_address_data addr_data = {                     \
 581         .normal_i2c     = normal_i2c,                                   \
 582         .probe          = probe,                                        \
 583         .ignore         = ignore,                                       \
 584         .forces         = forces,                                       \
 585 }
 586
 587 /* These are the ones you want to use in your own drivers. Pick the one
 588    which matches the number of devices the driver differenciates between. */
 589 #define I2C_CLIENT_INSMOD \
 590   I2C_CLIENT_MODULE_PARM(force, \
 591                       "List of adapter,address pairs to boldly assume " \
 592                       "to be present"); \
 593         static unsigned short *forces[] = {                             \
 594                         force,                                          \
 595                         NULL                                            \
 596                 };                                                      \
 597 I2C_CLIENT_INSMOD_COMMON
 598
 599 #define I2C_CLIENT_INSMOD_1(chip1)                                      \
 600 enum chips { any_chip, chip1 };                                         \
 601 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 602                        "boldly assume to be present");                  \
 603 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 604 static unsigned short *forces[] = { force, force_##chip1, NULL };       \
 605 I2C_CLIENT_INSMOD_COMMON
 606
 607 #define I2C_CLIENT_INSMOD_2(chip1, chip2)                               \
 608 enum chips { any_chip, chip1, chip2 };                                  \
 609 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 610                        "boldly assume to be present");                  \
 611 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 612 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 613 static unsigned short *forces[] = { force, force_##chip1,               \
 614                                     force_##chip2, NULL };              \
 615 I2C_CLIENT_INSMOD_COMMON
 616
 617 #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3)                        \
 618 enum chips { any_chip, chip1, chip2, chip3 };                           \
 619 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 620                        "boldly assume to be present");                  \
 621 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 622 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 623 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 624 static unsigned short *forces[] = { force, force_##chip1,               \
 625                                     force_##chip2, force_##chip3,       \
 626                                     NULL };                             \
 627 I2C_CLIENT_INSMOD_COMMON
 628
 629 #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4)                 \
 630 enum chips { any_chip, chip1, chip2, chip3, chip4 };                    \
 631 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 632                        "boldly assume to be present");                  \
 633 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 634 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 635 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 636 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 637 static unsigned short *forces[] = { force, force_##chip1,               \
 638                                     force_##chip2, force_##chip3,       \
 639                                     force_##chip4, NULL};               \
 640 I2C_CLIENT_INSMOD_COMMON
 641
 642 #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5)          \
 643 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 };             \
 644 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 645                        "boldly assume to be present");                  \
 646 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 647 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 648 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 649 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 650 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
 651 static unsigned short *forces[] = { force, force_##chip1,               \
 652                                     force_##chip2, force_##chip3,       \
 653                                     force_##chip4, force_##chip5,       \
 654                                     NULL };                             \
 655 I2C_CLIENT_INSMOD_COMMON
 656
 657 #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6)   \
 658 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 };      \
 659 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 660                        "boldly assume to be present");                  \
 661 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 662 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 663 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 664 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 665 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
 666 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
 667 static unsigned short *forces[] = { force, force_##chip1,               \
 668                                     force_##chip2, force_##chip3,       \
 669                                     force_##chip4, force_##chip5,       \
 670                                     force_##chip6, NULL };              \
 671 I2C_CLIENT_INSMOD_COMMON
 672
 673 #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
 674 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
 675              chip7 };                                                   \
 676 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 677                        "boldly assume to be present");                  \
 678 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 679 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 680 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 681 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 682 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
 683 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
 684 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
 685 static unsigned short *forces[] = { force, force_##chip1,               \
 686                                     force_##chip2, force_##chip3,       \
 687                                     force_##chip4, force_##chip5,       \
 688                                     force_##chip6, force_##chip7,       \
 689                                     NULL };                             \
 690 I2C_CLIENT_INSMOD_COMMON
 691
 692 #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
 693 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
 694              chip7, chip8 };                                            \
 695 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 696                        "boldly assume to be present");                  \
 697 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 698 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 699 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 700 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 701 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
 702 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
 703 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
 704 I2C_CLIENT_MODULE_PARM_FORCE(chip8);                                    \
 705 static unsigned short *forces[] = { force, force_##chip1,               \
 706                                     force_##chip2, force_##chip3,       \
 707                                     force_##chip4, force_##chip5,       \
 708                                     force_##chip6, force_##chip7,       \
 709                                     force_##chip8, NULL };              \
 710 I2C_CLIENT_INSMOD_COMMON
 711
 712 #endif /* _LINUX_I2C_H */