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