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