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
  49 /*
  50  * The master routines are the ones normally used to transmit data to devices
  51  * on a bus (or read from them). Apart from two basic transfer functions to
  52  * transmit one message at a time, a more complex version can be used to
  53  * transmit an arbitrary number of messages without interruption.
  54  */
  55 extern int i2c_master_send(struct i2c_client *,const char* ,int);
  56 extern int i2c_master_recv(struct i2c_client *,char* ,int);
  57
  58 /* Transfer num messages.
  59  */
  60 extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
  61
  62
  63 /* This is the very generalized SMBus access routine. You probably do not
  64    want to use this, though; one of the functions below may be much easier,
  65    and probably just as fast.
  66    Note that we use i2c_adapter here, because you do not need a specific
  67    smbus adapter to call this function. */
  68 extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
  69                            unsigned short flags,
  70                            char read_write, u8 command, int size,
  71                            union i2c_smbus_data * data);
  72
  73 /* Now follow the 'nice' access routines. These also document the calling
  74    conventions of smbus_access. */
  75
  76 extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
  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 *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  * A driver is capable of handling one or more physical devices present on
 100  * I2C adapters. This information is used to inform the driver of adapter
 101  * events.
 102  *
 103  * The driver.owner field should be set to the module owner of this driver.
 104  * The driver.name field should be set to the name of this driver.
 105  */
 106
 107 struct i2c_driver {
 108         int id;
 109         unsigned int class;
 110
 111         /* Notifies the driver that a new bus has appeared. This routine
 112          * can be used by the driver to test if the bus meets its conditions
 113          * & seek for the presence of the chip(s) it supports. If found, it
 114          * registers the client(s) that are on the bus to the i2c admin. via
 115          * i2c_attach_client.  (LEGACY I2C DRIVERS ONLY)
 116          */
 117         int (*attach_adapter)(struct i2c_adapter *);
 118         int (*detach_adapter)(struct i2c_adapter *);
 119
 120         /* tells the driver that a client is about to be deleted & gives it
 121          * the chance to remove its private data. Also, if the client struct
 122          * has been dynamically allocated by the driver in the function above,
 123          * it must be freed here.  (LEGACY I2C DRIVERS ONLY)
 124          */
 125         int (*detach_client)(struct i2c_client *);
 126
 127         /* Standard driver model interfaces, for "new style" i2c drivers.
 128          * With the driver model, device enumeration is NEVER done by drivers;
 129          * it's done by infrastructure.  (NEW STYLE DRIVERS ONLY)
 130          */
 131         int (*probe)(struct i2c_client *);
 132         int (*remove)(struct i2c_client *);
 133
 134         /* driver model interfaces that don't relate to enumeration  */
 135         void (*shutdown)(struct i2c_client *);
 136         int (*suspend)(struct i2c_client *, pm_message_t mesg);
 137         int (*resume)(struct i2c_client *);
 138
 139         /* a ioctl like command that can be used to perform specific functions
 140          * with the device.
 141          */
 142         int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
 143
 144         struct device_driver driver;
 145         struct list_head list;
 146 };
 147 #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
 148
 149 #define I2C_NAME_SIZE   20
 150
 151 /**
 152  * struct i2c_client - represent an I2C slave device
 153  * @addr: Address used on the I2C bus connected to the parent adapter.
 154  * @name: Indicates the type of the device, usually a chip name that's
 155  *      generic enough to hide second-sourcing and compatible revisions.
 156  * @dev: Driver model device node for the slave.
 157  * @driver_name: Identifies new-style driver used with this device; also
 158  *      used as the module name for hotplug/coldplug modprobe support.
 159  *
 160  * An i2c_client identifies a single device (i.e. chip) connected to an
 161  * i2c bus. The behaviour is defined by the routines of the driver.
 162  */
 163 struct i2c_client {
 164         unsigned short flags;           /* div., see below              */
 165         unsigned short addr;            /* chip address - NOTE: 7bit    */
 166                                         /* addresses are stored in the  */
 167                                         /* _LOWER_ 7 bits               */
 168         char name[I2C_NAME_SIZE];
 169         struct i2c_adapter *adapter;    /* the adapter we sit on        */
 170         struct i2c_driver *driver;      /* and our access routines      */
 171         int usage_count;                /* How many accesses currently  */
 172                                         /* to the client                */
 173         struct device dev;              /* the device structure         */
 174         int irq;                        /* irq issued by device (or -1) */
 175         char driver_name[KOBJ_NAME_LEN];
 176         struct list_head list;
 177         struct completion released;
 178 };
 179 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
 180
 181 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
 182 {
 183         return to_i2c_client(container_of(kobj, struct device, kobj));
 184 }
 185
 186 static inline void *i2c_get_clientdata (struct i2c_client *dev)
 187 {
 188         return dev_get_drvdata (&dev->dev);
 189 }
 190
 191 static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
 192 {
 193         dev_set_drvdata (&dev->dev, data);
 194 }
 195
 196 /**
 197  * struct i2c_board_info - template for device creation
 198  * @driver_name: identifies the driver to be bound to the device
 199  * @type: optional chip type information, to initialize i2c_client.name
 200  * @flags: to initialize i2c_client.flags
 201  * @addr: stored in i2c_client.addr
 202  * @platform_data: stored in i2c_client.dev.platform_data
 203  * @irq: stored in i2c_client.irq
 204
 205  * I2C doesn't actually support hardware probing, although controllers and
 206  * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
 207  * a device at a given address.  Drivers commonly need more information than
 208  * that, such as chip type, configuration, associated IRQ, and so on.
 209  *
 210  * i2c_board_info is used to build tables of information listing I2C devices
 211  * that are present.  This information is used to grow the driver model tree
 212  * for "new style" I2C drivers.  For mainboards this is done statically using
 213  * i2c_register_board_info(), where @bus_num represents an adapter that isn't
 214  * yet available.  For add-on boards, i2c_new_device() does this dynamically
 215  * with the adapter already known.
 216  */
 217 struct i2c_board_info {
 218         char            driver_name[KOBJ_NAME_LEN];
 219         char            type[I2C_NAME_SIZE];
 220         unsigned short  flags;
 221         unsigned short  addr;
 222         void            *platform_data;
 223         int             irq;
 224 };
 225
 226 /**
 227  * I2C_BOARD_INFO - macro used to list an i2c device and its driver
 228  * @driver: identifies the driver to use with the device
 229  * @dev_addr: the device's address on the bus.
 230  *
 231  * This macro initializes essential fields of a struct i2c_board_info,
 232  * declaring what has been provided on a particular board.  Optional
 233  * fields (such as the chip type, its associated irq, or device-specific
 234  * platform_data) are provided using conventional syntax.
 235  */
 236 #define I2C_BOARD_INFO(driver,dev_addr) \
 237         .driver_name = (driver), .addr = (dev_addr)
 238
 239
 240 /* Add-on boards should register/unregister their devices; e.g. a board
 241  * with integrated I2C, a config eeprom, sensors, and a codec that's
 242  * used in conjunction with the primary hardware.
 243  */
 244 extern struct i2c_client *
 245 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
 246
 247 /* If you don't know the exact address of an I2C device, use this variant
 248  * instead, which can probe for device presence in a list of possible
 249  * addresses.
 250  */
 251 extern struct i2c_client *
 252 i2c_new_probed_device(struct i2c_adapter *adap,
 253                       struct i2c_board_info *info,
 254                       unsigned short const *addr_list);
 255
 256 extern void i2c_unregister_device(struct i2c_client *);
 257
 258 /* Mainboard arch_initcall() code should register all its I2C devices.
 259  * This is done at arch_initcall time, before declaring any i2c adapters.
 260  * Modules for add-on boards must use other calls.
 261  */
 262 extern int
 263 i2c_register_board_info(int busnum, struct i2c_board_info const *info, unsigned n);
 264
 265
 266 /*
 267  * The following structs are for those who like to implement new bus drivers:
 268  * i2c_algorithm is the interface to a class of hardware solutions which can
 269  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
 270  * to name two of the most common.
 271  */
 272 struct i2c_algorithm {
 273         /* If an adapter algorithm can't do I2C-level access, set master_xfer
 274            to NULL. If an adapter algorithm can do SMBus access, set
 275            smbus_xfer. If set to NULL, the SMBus protocol is simulated
 276            using common I2C messages */
 277         /* master_xfer should return the number of messages successfully
 278            processed, or a negative value on error */
 279         int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
 280                            int num);
 281         int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
 282                            unsigned short flags, char read_write,
 283                            u8 command, int size, union i2c_smbus_data * data);
 284
 285         /* --- ioctl like call to set div. parameters. */
 286         int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
 287
 288         /* To determine what the adapter supports */
 289         u32 (*functionality) (struct i2c_adapter *);
 290 };
 291
 292 /*
 293  * i2c_adapter is the structure used to identify a physical i2c bus along
 294  * with the access algorithms necessary to access it.
 295  */
 296 struct i2c_adapter {
 297         struct module *owner;
 298         unsigned int id;
 299         unsigned int class;
 300         const struct i2c_algorithm *algo; /* the algorithm to access the bus */
 301         void *algo_data;
 302
 303         /* --- administration stuff. */
 304         int (*client_register)(struct i2c_client *);
 305         int (*client_unregister)(struct i2c_client *);
 306
 307         /* data fields that are valid for all devices   */
 308         u8 level;                       /* nesting level for lockdep */
 309         struct mutex bus_lock;
 310         struct mutex clist_lock;
 311
 312         int timeout;
 313         int retries;
 314         struct device dev;              /* the adapter device */
 315
 316         int nr;
 317         struct list_head clients;
 318         struct list_head list;
 319         char name[48];
 320         struct completion dev_released;
 321 };
 322 #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
 323
 324 static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
 325 {
 326         return dev_get_drvdata (&dev->dev);
 327 }
 328
 329 static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
 330 {
 331         dev_set_drvdata (&dev->dev, data);
 332 }
 333
 334 /*flags for the client struct: */
 335 #define I2C_CLIENT_PEC  0x04                    /* Use Packet Error Checking */
 336 #define I2C_CLIENT_TEN  0x10                    /* we have a ten bit chip address       */
 337                                                 /* Must equal I2C_M_TEN below */
 338
 339 /* i2c adapter classes (bitmask) */
 340 #define I2C_CLASS_HWMON         (1<<0)  /* lm_sensors, ... */
 341 #define I2C_CLASS_TV_ANALOG     (1<<1)  /* bttv + friends */
 342 #define I2C_CLASS_TV_DIGITAL    (1<<2)  /* dvb cards */
 343 #define I2C_CLASS_DDC           (1<<3)  /* i2c-matroxfb ? */
 344 #define I2C_CLASS_CAM_ANALOG    (1<<4)  /* camera with analog CCD */
 345 #define I2C_CLASS_CAM_DIGITAL   (1<<5)  /* most webcams */
 346 #define I2C_CLASS_SOUND         (1<<6)  /* sound devices */
 347 #define I2C_CLASS_ALL           (UINT_MAX) /* all of the above */
 348
 349 /* i2c_client_address_data is the struct for holding default client
 350  * addresses for a driver and for the parameters supplied on the
 351  * command line
 352  */
 353 struct i2c_client_address_data {
 354         unsigned short *normal_i2c;
 355         unsigned short *probe;
 356         unsigned short *ignore;
 357         unsigned short **forces;
 358 };
 359
 360 /* Internal numbers to terminate lists */
 361 #define I2C_CLIENT_END          0xfffeU
 362
 363 /* The numbers to use to set I2C bus address */
 364 #define ANY_I2C_BUS             0xffff
 365 #define ANY_I2C_ISA_BUS         9191
 366
 367
 368 /* ----- functions exported by i2c.o */
 369
 370 /* administration...
 371  */
 372 extern int i2c_add_adapter(struct i2c_adapter *);
 373 extern int i2c_del_adapter(struct i2c_adapter *);
 374 extern int i2c_add_numbered_adapter(struct i2c_adapter *);
 375
 376 extern int i2c_register_driver(struct module *, struct i2c_driver *);
 377 extern void i2c_del_driver(struct i2c_driver *);
 378
 379 static inline int i2c_add_driver(struct i2c_driver *driver)
 380 {
 381         return i2c_register_driver(THIS_MODULE, driver);
 382 }
 383
 384 extern int i2c_attach_client(struct i2c_client *);
 385 extern int i2c_detach_client(struct i2c_client *);
 386
 387 /* Should be used to make sure that client-struct is valid and that it
 388    is okay to access the i2c-client.
 389    returns -ENODEV if client has gone in the meantime */
 390 extern int i2c_use_client(struct i2c_client *);
 391 extern int i2c_release_client(struct i2c_client *);
 392
 393 /* call the i2c_client->command() of all attached clients with
 394  * the given arguments */
 395 extern void i2c_clients_command(struct i2c_adapter *adap,
 396                                 unsigned int cmd, void *arg);
 397
 398 /* returns -EBUSY if address has been taken, 0 if not. Note that the only
 399    other place at which this is called is within i2c_attach_client; so
 400    you can cheat by simply not registering. Not recommended, of course! */
 401 extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
 402
 403 /* Detect function. It iterates over all possible addresses itself.
 404  * It will only call found_proc if some client is connected at the
 405  * specific address (unless a 'force' matched);
 406  */
 407 extern int i2c_probe(struct i2c_adapter *adapter,
 408                 struct i2c_client_address_data *address_data,
 409                 int (*found_proc) (struct i2c_adapter *, int, int));
 410
 411 /* An ioctl like call to set div. parameters of the adapter.
 412  */
 413 extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
 414
 415 extern struct i2c_adapter* i2c_get_adapter(int id);
 416 extern void i2c_put_adapter(struct i2c_adapter *adap);
 417
 418
 419 /* Return the functionality mask */
 420 static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
 421 {
 422         return adap->algo->functionality(adap);
 423 }
 424
 425 /* Return 1 if adapter supports everything we need, 0 if not. */
 426 static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
 427 {
 428         return (func & i2c_get_functionality(adap)) == func;
 429 }
 430
 431 /* Return id number for a specific adapter */
 432 static inline int i2c_adapter_id(struct i2c_adapter *adap)
 433 {
 434         return adap->nr;
 435 }
 436 #endif /* __KERNEL__ */
 437
 438 /*
 439  * I2C Message - used for pure i2c transaction, also from /dev interface
 440  */
 441 struct i2c_msg {
 442         __u16 addr;     /* slave address                        */
 443         __u16 flags;
 444 #define I2C_M_TEN       0x10    /* we have a ten bit chip address       */
 445 #define I2C_M_RD        0x01
 446 #define I2C_M_NOSTART   0x4000
 447 #define I2C_M_REV_DIR_ADDR      0x2000
 448 #define I2C_M_IGNORE_NAK        0x1000
 449 #define I2C_M_NO_RD_ACK         0x0800
 450 #define I2C_M_RECV_LEN          0x0400 /* length will be first received byte */
 451         __u16 len;              /* msg length                           */
 452         __u8 *buf;              /* pointer to msg data                  */
 453 };
 454
 455 /* To determine what functionality is present */
 456
 457 #define I2C_FUNC_I2C                    0x00000001
 458 #define I2C_FUNC_10BIT_ADDR             0x00000002
 459 #define I2C_FUNC_PROTOCOL_MANGLING      0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
 460 #define I2C_FUNC_SMBUS_HWPEC_CALC       0x00000008 /* SMBus 2.0 */
 461 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL  0x00008000 /* SMBus 2.0 */
 462 #define I2C_FUNC_SMBUS_QUICK            0x00010000
 463 #define I2C_FUNC_SMBUS_READ_BYTE        0x00020000
 464 #define I2C_FUNC_SMBUS_WRITE_BYTE       0x00040000
 465 #define I2C_FUNC_SMBUS_READ_BYTE_DATA   0x00080000
 466 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA  0x00100000
 467 #define I2C_FUNC_SMBUS_READ_WORD_DATA   0x00200000
 468 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA  0x00400000
 469 #define I2C_FUNC_SMBUS_PROC_CALL        0x00800000
 470 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA  0x01000000
 471 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
 472 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK   0x04000000 /* I2C-like block xfer  */
 473 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK  0x08000000 /* w/ 1-byte reg. addr. */
 474 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2  0x10000000 /* I2C-like block xfer  */
 475 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
 476
 477 #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
 478                              I2C_FUNC_SMBUS_WRITE_BYTE)
 479 #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
 480                                   I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
 481 #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
 482                                   I2C_FUNC_SMBUS_WRITE_WORD_DATA)
 483 #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
 484                                    I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
 485 #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
 486                                   I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
 487 #define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
 488                                     I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
 489
 490 #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
 491                              I2C_FUNC_SMBUS_BYTE | \
 492                              I2C_FUNC_SMBUS_BYTE_DATA | \
 493                              I2C_FUNC_SMBUS_WORD_DATA | \
 494                              I2C_FUNC_SMBUS_PROC_CALL | \
 495                              I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
 496                              I2C_FUNC_SMBUS_I2C_BLOCK)
 497
 498 /*
 499  * Data for SMBus Messages
 500  */
 501 #define I2C_SMBUS_BLOCK_MAX     32      /* As specified in SMBus standard */
 502 union i2c_smbus_data {
 503         __u8 byte;
 504         __u16 word;
 505         __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
 506                                /* and one more for user-space compatibility */
 507 };
 508
 509 /* smbus_access read or write markers */
 510 #define I2C_SMBUS_READ  1
 511 #define I2C_SMBUS_WRITE 0
 512
 513 /* SMBus transaction types (size parameter in the above functions)
 514    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
 515 #define I2C_SMBUS_QUICK             0
 516 #define I2C_SMBUS_BYTE              1
 517 #define I2C_SMBUS_BYTE_DATA         2
 518 #define I2C_SMBUS_WORD_DATA         3
 519 #define I2C_SMBUS_PROC_CALL         4
 520 #define I2C_SMBUS_BLOCK_DATA        5
 521 #define I2C_SMBUS_I2C_BLOCK_DATA    6
 522 #define I2C_SMBUS_BLOCK_PROC_CALL   7           /* SMBus 2.0 */
 523
 524
 525 /* ----- commands for the ioctl like i2c_command call:
 526  * note that additional calls are defined in the algorithm and hw
 527  *      dependent layers - these can be listed here, or see the
 528  *      corresponding header files.
 529  */
 530                                 /* -> bit-adapter specific ioctls       */
 531 #define I2C_RETRIES     0x0701  /* number of times a device address      */
 532                                 /* should be polled when not            */
 533                                 /* acknowledging                        */
 534 #define I2C_TIMEOUT     0x0702  /* set timeout - call with int          */
 535
 536
 537 /* this is for i2c-dev.c        */
 538 #define I2C_SLAVE       0x0703  /* Change slave address                 */
 539                                 /* Attn.: Slave address is 7 or 10 bits */
 540 #define I2C_SLAVE_FORCE 0x0706  /* Change slave address                 */
 541                                 /* Attn.: Slave address is 7 or 10 bits */
 542                                 /* This changes the address, even if it */
 543                                 /* is already taken!                    */
 544 #define I2C_TENBIT      0x0704  /* 0 for 7 bit addrs, != 0 for 10 bit   */
 545
 546 #define I2C_FUNCS       0x0705  /* Get the adapter functionality */
 547 #define I2C_RDWR        0x0707  /* Combined R/W transfer (one stop only)*/
 548 #define I2C_PEC         0x0708  /* != 0 for SMBus PEC                   */
 549
 550 #define I2C_SMBUS       0x0720  /* SMBus-level access */
 551
 552 /* ----- I2C-DEV: char device interface stuff ------------------------- */
 553 #ifdef __KERNEL__
 554
 555 #define I2C_MAJOR       89              /* Device major number          */
 556
 557 /* These defines are used for probing i2c client addresses */
 558 /* The length of the option lists */
 559 #define I2C_CLIENT_MAX_OPTS 48
 560
 561 /* Default fill of many variables */
 562 #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 563                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 564                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 565                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 566                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 567                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 568                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 569                           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
 579 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
 580    module header */
 581
 582 #define I2C_CLIENT_MODULE_PARM(var,desc) \
 583   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
 584   static unsigned int var##_num; \
 585   module_param_array(var, short, &var##_num, 0); \
 586   MODULE_PARM_DESC(var,desc)
 587
 588 #define I2C_CLIENT_MODULE_PARM_FORCE(name)                              \
 589 I2C_CLIENT_MODULE_PARM(force_##name,                                    \
 590                        "List of adapter,address pairs which are "       \
 591                        "unquestionably assumed to contain a `"          \
 592                        # name "' chip")
 593
 594
 595 #define I2C_CLIENT_INSMOD_COMMON                                        \
 596 I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan "  \
 597                        "additionally");                                 \
 598 I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to "  \
 599                        "scan");                                         \
 600 static struct i2c_client_address_data addr_data = {                     \
 601         .normal_i2c     = normal_i2c,                                   \
 602         .probe          = probe,                                        \
 603         .ignore         = ignore,                                       \
 604         .forces         = forces,                                       \
 605 }
 606
 607 /* These are the ones you want to use in your own drivers. Pick the one
 608    which matches the number of devices the driver differenciates between. */
 609 #define I2C_CLIENT_INSMOD \
 610   I2C_CLIENT_MODULE_PARM(force, \
 611                       "List of adapter,address pairs to boldly assume " \
 612                       "to be present"); \
 613         static unsigned short *forces[] = {                             \
 614                         force,                                          \
 615                         NULL                                            \
 616                 };                                                      \
 617 I2C_CLIENT_INSMOD_COMMON
 618
 619 #define I2C_CLIENT_INSMOD_1(chip1)                                      \
 620 enum chips { any_chip, chip1 };                                         \
 621 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 622                        "boldly assume to be present");                  \
 623 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 624 static unsigned short *forces[] = { force, force_##chip1, NULL };       \
 625 I2C_CLIENT_INSMOD_COMMON
 626
 627 #define I2C_CLIENT_INSMOD_2(chip1, chip2)                               \
 628 enum chips { any_chip, chip1, chip2 };                                  \
 629 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 630                        "boldly assume to be present");                  \
 631 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 632 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 633 static unsigned short *forces[] = { force, force_##chip1,               \
 634                                     force_##chip2, NULL };              \
 635 I2C_CLIENT_INSMOD_COMMON
 636
 637 #define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3)                        \
 638 enum chips { any_chip, chip1, chip2, chip3 };                           \
 639 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 640                        "boldly assume to be present");                  \
 641 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 642 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 643 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 644 static unsigned short *forces[] = { force, force_##chip1,               \
 645                                     force_##chip2, force_##chip3,       \
 646                                     NULL };                             \
 647 I2C_CLIENT_INSMOD_COMMON
 648
 649 #define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4)                 \
 650 enum chips { any_chip, chip1, chip2, chip3, chip4 };                    \
 651 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 652                        "boldly assume to be present");                  \
 653 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 654 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 655 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 656 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 657 static unsigned short *forces[] = { force, force_##chip1,               \
 658                                     force_##chip2, force_##chip3,       \
 659                                     force_##chip4, NULL};               \
 660 I2C_CLIENT_INSMOD_COMMON
 661
 662 #define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5)          \
 663 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 };             \
 664 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 665                        "boldly assume to be present");                  \
 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 unsigned short *forces[] = { force, force_##chip1,               \
 672                                     force_##chip2, force_##chip3,       \
 673                                     force_##chip4, force_##chip5,       \
 674                                     NULL };                             \
 675 I2C_CLIENT_INSMOD_COMMON
 676
 677 #define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6)   \
 678 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 };      \
 679 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 680                        "boldly assume to be present");                  \
 681 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 682 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 683 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 684 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 685 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
 686 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
 687 static unsigned short *forces[] = { force, force_##chip1,               \
 688                                     force_##chip2, force_##chip3,       \
 689                                     force_##chip4, force_##chip5,       \
 690                                     force_##chip6, NULL };              \
 691 I2C_CLIENT_INSMOD_COMMON
 692
 693 #define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
 694 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
 695              chip7 };                                                   \
 696 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 697                        "boldly assume to be present");                  \
 698 I2C_CLIENT_MODULE_PARM_FORCE(chip1);                                    \
 699 I2C_CLIENT_MODULE_PARM_FORCE(chip2);                                    \
 700 I2C_CLIENT_MODULE_PARM_FORCE(chip3);                                    \
 701 I2C_CLIENT_MODULE_PARM_FORCE(chip4);                                    \
 702 I2C_CLIENT_MODULE_PARM_FORCE(chip5);                                    \
 703 I2C_CLIENT_MODULE_PARM_FORCE(chip6);                                    \
 704 I2C_CLIENT_MODULE_PARM_FORCE(chip7);                                    \
 705 static unsigned short *forces[] = { force, force_##chip1,               \
 706                                     force_##chip2, force_##chip3,       \
 707                                     force_##chip4, force_##chip5,       \
 708                                     force_##chip6, force_##chip7,       \
 709                                     NULL };                             \
 710 I2C_CLIENT_INSMOD_COMMON
 711
 712 #define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
 713 enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6,        \
 714              chip7, chip8 };                                            \
 715 I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to "       \
 716                        "boldly assume to be present");                  \
 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 I2C_CLIENT_MODULE_PARM_FORCE(chip8);                                    \
 725 static unsigned short *forces[] = { force, force_##chip1,               \
 726                                     force_##chip2, force_##chip3,       \
 727                                     force_##chip4, force_##chip5,       \
 728                                     force_##chip6, force_##chip7,       \
 729                                     force_##chip8, NULL };              \
 730 I2C_CLIENT_INSMOD_COMMON
 731 #endif /* __KERNEL__ */
 732 #endif /* _LINUX_I2C_H */