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