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