include/linux/i2c.h

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