include/linux/i2c.h

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