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