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 /* $Id: i2c.h,v 1.68 2003/01/21 08:08:16 kmalkki Exp $ */
  27
  28 #ifndef _LINUX_I2C_H
  29 #define _LINUX_I2C_H
  30
  31 #include <linux/module.h>
  32 #include <linux/types.h>
  33 #include <linux/i2c-id.h>
  34 #include <linux/device.h>       /* for struct device */
  35 #include <asm/semaphore.h>
  36
  37 /* --- General options ------------------------------------------------ */
  38
  39 struct i2c_msg;
  40 struct i2c_algorithm;
  41 struct i2c_adapter;
  42 struct i2c_client;
  43 struct i2c_driver;
  44 struct i2c_client_address_data;
  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 msg[],int num);
  59
  60 /*
  61  * Some adapter types (i.e. PCF 8584 based ones) may support slave behaviuor.
  62  * This is not tested/implemented yet and will change in the future.
  63  */
  64 extern int i2c_slave_send(struct i2c_client *,char*,int);
  65 extern int i2c_slave_recv(struct i2c_client *,char*,int);
  66
  67
  68
  69 /* This is the very generalized SMBus access routine. You probably do not
  70    want to use this, though; one of the functions below may be much easier,
  71    and probably just as fast.
  72    Note that we use i2c_adapter here, because you do not need a specific
  73    smbus adapter to call this function. */
  74 extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
  75                            unsigned short flags,
  76                            char read_write, u8 command, int size,
  77                            union i2c_smbus_data * data);
  78
  79 /* Now follow the 'nice' access routines. These also document the calling
  80    conventions of smbus_access. */
  81
  82 extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
  83 extern s32 i2c_smbus_read_byte(struct i2c_client * client);
  84 extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
  85 extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
  86 extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
  87                                      u8 command, u8 value);
  88 extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
  89 extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
  90                                      u8 command, u16 value);
  91 /* Returns the number of bytes transferred */
  92 extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
  93                                       u8 command, u8 length,
  94                                       u8 *values);
  95 extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
  96                                          u8 command, 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
 104 struct i2c_driver {
 105         struct module *owner;
 106         char name[32];
 107         int id;
 108         unsigned int class;
 109         unsigned int flags;             /* div., see below              */
 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.
 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.
 124          */
 125         int (*detach_client)(struct i2c_client *);
 126
 127         /* a ioctl like command that can be used to perform specific functions
 128          * with the device.
 129          */
 130         int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
 131
 132         struct device_driver driver;
 133         struct list_head list;
 134 };
 135 #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
 136
 137 extern struct bus_type i2c_bus_type;
 138
 139 #define I2C_NAME_SIZE   50
 140
 141 /*
 142  * i2c_client identifies a single device (i.e. chip) that is connected to an
 143  * i2c bus. The behaviour is defined by the routines of the driver. This
 144  * function is mainly used for lookup & other admin. functions.
 145  */
 146 struct i2c_client {
 147         int id;
 148         unsigned int flags;             /* div., see below              */
 149         unsigned int addr;              /* chip address - NOTE: 7bit    */
 150                                         /* addresses are stored in the  */
 151                                         /* _LOWER_ 7 bits of this char  */
 152         /* addr: unsigned int to make lm_sensors i2c-isa adapter work
 153           more cleanly. It does not take any more memory space, due to
 154           alignment considerations */
 155         struct i2c_adapter *adapter;    /* the adapter we sit on        */
 156         struct i2c_driver *driver;      /* and our access routines      */
 157         int usage_count;                /* How many accesses currently  */
 158                                         /* to the client                */
 159         struct device dev;              /* the device structure         */
 160         struct list_head list;
 161         char name[I2C_NAME_SIZE];
 162         struct completion released;
 163 };
 164 #define to_i2c_client(d) container_of(d, struct i2c_client, dev)
 165
 166 static inline void *i2c_get_clientdata (struct i2c_client *dev)
 167 {
 168         return dev_get_drvdata (&dev->dev);
 169 }
 170
 171 static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
 172 {
 173         dev_set_drvdata (&dev->dev, data);
 174 }
 175
 176 #define I2C_DEVNAME(str)        .name = str
 177
 178 static inline char *i2c_clientname(struct i2c_client *c)
 179 {
 180         return &c->name[0];
 181 }
 182
 183 /*
 184  * The following structs are for those who like to implement new bus drivers:
 185  * i2c_algorithm is the interface to a class of hardware solutions which can
 186  * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
 187  * to name two of the most common.
 188  */
 189 struct i2c_algorithm {
 190         char name[32];                          /* textual description  */
 191         unsigned int id;
 192
 193         /* If an adapter algorithm can't to I2C-level access, set master_xfer
 194            to NULL. If an adapter algorithm can do SMBus access, set
 195            smbus_xfer. If set to NULL, the SMBus protocol is simulated
 196            using common I2C messages */
 197         int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg msgs[],
 198                            int num);
 199         int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
 200                            unsigned short flags, char read_write,
 201                            u8 command, int size, union i2c_smbus_data * data);
 202
 203         /* --- these optional/future use for some adapter types.*/
 204         int (*slave_send)(struct i2c_adapter *,char*,int);
 205         int (*slave_recv)(struct i2c_adapter *,char*,int);
 206
 207         /* --- ioctl like call to set div. parameters. */
 208         int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
 209
 210         /* To determine what the adapter supports */
 211         u32 (*functionality) (struct i2c_adapter *);
 212 };
 213
 214 /*
 215  * i2c_adapter is the structure used to identify a physical i2c bus along
 216  * with the access algorithms necessary to access it.
 217  */
 218 struct i2c_adapter {
 219         struct module *owner;
 220         unsigned int id;/* == is algo->id | hwdep.struct->id,           */
 221                         /* for registered values see below              */
 222         unsigned int class;
 223         struct i2c_algorithm *algo;/* the algorithm to access the bus   */
 224         void *algo_data;
 225
 226         /* --- administration stuff. */
 227         int (*client_register)(struct i2c_client *);
 228         int (*client_unregister)(struct i2c_client *);
 229
 230         /* data fields that are valid for all devices   */
 231         struct semaphore bus_lock;
 232         struct semaphore clist_lock;
 233
 234         int timeout;
 235         int retries;
 236         struct device dev;              /* the adapter device */
 237         struct class_device class_dev;  /* the class device */
 238
 239 #ifdef CONFIG_PROC_FS
 240         /* No need to set this when you initialize the adapter          */
 241         int inode;
 242 #endif /* def CONFIG_PROC_FS */
 243
 244         int nr;
 245         struct list_head clients;
 246         struct list_head list;
 247         char name[I2C_NAME_SIZE];
 248         struct completion dev_released;
 249         struct completion class_dev_released;
 250 };
 251 #define dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
 252 #define class_dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, class_dev)
 253
 254 static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
 255 {
 256         return dev_get_drvdata (&dev->dev);
 257 }
 258
 259 static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
 260 {
 261         dev_set_drvdata (&dev->dev, data);
 262 }
 263
 264 /*flags for the driver struct: */
 265 #define I2C_DF_NOTIFY   0x01            /* notify on bus (de/a)ttaches  */
 266 #if 0
 267 /* this flag is gone -- there is a (optional) driver->detach_adapter
 268  * callback now which can be used instead */
 269 # define I2C_DF_DUMMY   0x02
 270 #endif
 271
 272 /*flags for the client struct: */
 273 #define I2C_CLIENT_ALLOW_USE            0x01    /* Client allows access */
 274 #define I2C_CLIENT_ALLOW_MULTIPLE_USE   0x02    /* Allow multiple access-locks */
 275                                                 /* on an i2c_client */
 276 #define I2C_CLIENT_PEC  0x04                    /* Use Packet Error Checking */
 277 #define I2C_CLIENT_TEN  0x10                    /* we have a ten bit chip address       */
 278                                                 /* Must equal I2C_M_TEN below */
 279
 280 /* i2c adapter classes (bitmask) */
 281 #define I2C_CLASS_HWMON         (1<<0)  /* lm_sensors, ... */
 282 #define I2C_CLASS_TV_ANALOG     (1<<1)  /* bttv + friends */
 283 #define I2C_CLASS_TV_DIGITAL    (1<<2)  /* dvb cards */
 284 #define I2C_CLASS_DDC           (1<<3)  /* i2c-matroxfb ? */
 285 #define I2C_CLASS_CAM_ANALOG    (1<<4)  /* camera with analog CCD */
 286 #define I2C_CLASS_CAM_DIGITAL   (1<<5)  /* most webcams */
 287 #define I2C_CLASS_SOUND         (1<<6)  /* sound devices */
 288 #define I2C_CLASS_ALL           (UINT_MAX) /* all of the above */
 289
 290 /* i2c_client_address_data is the struct for holding default client
 291  * addresses for a driver and for the parameters supplied on the
 292  * command line
 293  */
 294 struct i2c_client_address_data {
 295         unsigned short *normal_i2c;
 296         unsigned short *normal_i2c_range;
 297         unsigned short *probe;
 298         unsigned short *probe_range;
 299         unsigned short *ignore;
 300         unsigned short *ignore_range;
 301         unsigned short *force;
 302 };
 303
 304 /* Internal numbers to terminate lists */
 305 #define I2C_CLIENT_END          0xfffe
 306 #define I2C_CLIENT_ISA_END      0xfffefffe
 307
 308 /* The numbers to use to set I2C bus address */
 309 #define ANY_I2C_BUS             0xffff
 310 #define ANY_I2C_ISA_BUS         9191
 311
 312 /* The length of the option lists */
 313 #define I2C_CLIENT_MAX_OPTS 48
 314
 315
 316 /* ----- functions exported by i2c.o */
 317
 318 /* administration...
 319  */
 320 extern int i2c_add_adapter(struct i2c_adapter *);
 321 extern int i2c_del_adapter(struct i2c_adapter *);
 322
 323 extern int i2c_add_driver(struct i2c_driver *);
 324 extern int i2c_del_driver(struct i2c_driver *);
 325
 326 extern int i2c_attach_client(struct i2c_client *);
 327 extern int i2c_detach_client(struct i2c_client *);
 328
 329 /* New function: This is to get an i2c_client-struct for controlling the
 330    client either by using i2c_control-function or having the
 331    client-module export functions that can be used with the i2c_client
 332    -struct. */
 333 extern struct i2c_client *i2c_get_client(int driver_id, int adapter_id,
 334                                         struct i2c_client *prev);
 335
 336 /* Should be used with new function
 337    extern struct i2c_client *i2c_get_client(int,int,struct i2c_client *);
 338    to make sure that client-struct is valid and that it is okay to access
 339    the i2c-client.
 340    returns -EACCES if client doesn't allow use (default)
 341    returns -EBUSY if client doesn't allow multiple use (default) and
 342    usage_count >0 */
 343 extern int i2c_use_client(struct i2c_client *);
 344 extern int i2c_release_client(struct i2c_client *);
 345
 346 /* call the i2c_client->command() of all attached clients with
 347  * the given arguments */
 348 extern void i2c_clients_command(struct i2c_adapter *adap,
 349                                 unsigned int cmd, void *arg);
 350
 351 /* returns -EBUSY if address has been taken, 0 if not. Note that the only
 352    other place at which this is called is within i2c_attach_client; so
 353    you can cheat by simply not registering. Not recommended, of course! */
 354 extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
 355
 356 /* Detect function. It iterates over all possible addresses itself.
 357  * It will only call found_proc if some client is connected at the
 358  * specific address (unless a 'force' matched);
 359  */
 360 extern int i2c_probe(struct i2c_adapter *adapter,
 361                 struct i2c_client_address_data *address_data,
 362                 int (*found_proc) (struct i2c_adapter *, int, int));
 363
 364 /* An ioctl like call to set div. parameters of the adapter.
 365  */
 366 extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
 367
 368 /* This call returns a unique low identifier for each registered adapter,
 369  * or -1 if the adapter was not registered.
 370  */
 371 extern int i2c_adapter_id(struct i2c_adapter *adap);
 372 extern struct i2c_adapter* i2c_get_adapter(int id);
 373 extern void i2c_put_adapter(struct i2c_adapter *adap);
 374
 375
 376 /* Return the functionality mask */
 377 extern u32 i2c_get_functionality (struct i2c_adapter *adap);
 378
 379 /* Return 1 if adapter supports everything we need, 0 if not. */
 380 extern int i2c_check_functionality (struct i2c_adapter *adap, u32 func);
 381
 382 /*
 383  * I2C Message - used for pure i2c transaction, also from /dev interface
 384  */
 385 struct i2c_msg {
 386         __u16 addr;     /* slave address                        */
 387         __u16 flags;
 388 #define I2C_M_TEN       0x10    /* we have a ten bit chip address       */
 389 #define I2C_M_RD        0x01
 390 #define I2C_M_NOSTART   0x4000
 391 #define I2C_M_REV_DIR_ADDR      0x2000
 392 #define I2C_M_IGNORE_NAK        0x1000
 393 #define I2C_M_NO_RD_ACK         0x0800
 394         __u16 len;              /* msg length                           */
 395         __u8 *buf;              /* pointer to msg data                  */
 396 };
 397
 398 /* To determine what functionality is present */
 399
 400 #define I2C_FUNC_I2C                    0x00000001
 401 #define I2C_FUNC_10BIT_ADDR             0x00000002
 402 #define I2C_FUNC_PROTOCOL_MANGLING      0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
 403 #define I2C_FUNC_SMBUS_HWPEC_CALC       0x00000008 /* SMBus 2.0 */
 404 #define I2C_FUNC_SMBUS_READ_WORD_DATA_PEC  0x00000800 /* SMBus 2.0 */
 405 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA_PEC 0x00001000 /* SMBus 2.0 */
 406 #define I2C_FUNC_SMBUS_PROC_CALL_PEC    0x00002000 /* SMBus 2.0 */
 407 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL_PEC 0x00004000 /* SMBus 2.0 */
 408 #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL  0x00008000 /* SMBus 2.0 */
 409 #define I2C_FUNC_SMBUS_QUICK            0x00010000
 410 #define I2C_FUNC_SMBUS_READ_BYTE        0x00020000
 411 #define I2C_FUNC_SMBUS_WRITE_BYTE       0x00040000
 412 #define I2C_FUNC_SMBUS_READ_BYTE_DATA   0x00080000
 413 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA  0x00100000
 414 #define I2C_FUNC_SMBUS_READ_WORD_DATA   0x00200000
 415 #define I2C_FUNC_SMBUS_WRITE_WORD_DATA  0x00400000
 416 #define I2C_FUNC_SMBUS_PROC_CALL        0x00800000
 417 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA  0x01000000
 418 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
 419 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK   0x04000000 /* I2C-like block xfer  */
 420 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK  0x08000000 /* w/ 1-byte reg. addr. */
 421 #define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2  0x10000000 /* I2C-like block xfer  */
 422 #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
 423 #define I2C_FUNC_SMBUS_READ_BLOCK_DATA_PEC  0x40000000 /* SMBus 2.0 */
 424 #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC 0x80000000 /* SMBus 2.0 */
 425
 426 #define I2C_FUNC_SMBUS_BYTE I2C_FUNC_SMBUS_READ_BYTE | \
 427                             I2C_FUNC_SMBUS_WRITE_BYTE
 428 #define I2C_FUNC_SMBUS_BYTE_DATA I2C_FUNC_SMBUS_READ_BYTE_DATA | \
 429                                  I2C_FUNC_SMBUS_WRITE_BYTE_DATA
 430 #define I2C_FUNC_SMBUS_WORD_DATA I2C_FUNC_SMBUS_READ_WORD_DATA | \
 431                                  I2C_FUNC_SMBUS_WRITE_WORD_DATA
 432 #define I2C_FUNC_SMBUS_BLOCK_DATA I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
 433                                   I2C_FUNC_SMBUS_WRITE_BLOCK_DATA
 434 #define I2C_FUNC_SMBUS_I2C_BLOCK I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
 435                                   I2C_FUNC_SMBUS_WRITE_I2C_BLOCK
 436 #define I2C_FUNC_SMBUS_I2C_BLOCK_2 I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
 437                                    I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2
 438 #define I2C_FUNC_SMBUS_BLOCK_DATA_PEC I2C_FUNC_SMBUS_READ_BLOCK_DATA_PEC | \
 439                                       I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC
 440 #define I2C_FUNC_SMBUS_WORD_DATA_PEC  I2C_FUNC_SMBUS_READ_WORD_DATA_PEC | \
 441                                       I2C_FUNC_SMBUS_WRITE_WORD_DATA_PEC
 442
 443 #define I2C_FUNC_SMBUS_READ_BYTE_PEC            I2C_FUNC_SMBUS_READ_BYTE_DATA
 444 #define I2C_FUNC_SMBUS_WRITE_BYTE_PEC           I2C_FUNC_SMBUS_WRITE_BYTE_DATA
 445 #define I2C_FUNC_SMBUS_READ_BYTE_DATA_PEC       I2C_FUNC_SMBUS_READ_WORD_DATA
 446 #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA_PEC      I2C_FUNC_SMBUS_WRITE_WORD_DATA
 447 #define I2C_FUNC_SMBUS_BYTE_PEC                 I2C_FUNC_SMBUS_BYTE_DATA
 448 #define I2C_FUNC_SMBUS_BYTE_DATA_PEC            I2C_FUNC_SMBUS_WORD_DATA
 449
 450 #define I2C_FUNC_SMBUS_EMUL I2C_FUNC_SMBUS_QUICK | \
 451                             I2C_FUNC_SMBUS_BYTE | \
 452                             I2C_FUNC_SMBUS_BYTE_DATA | \
 453                             I2C_FUNC_SMBUS_WORD_DATA | \
 454                             I2C_FUNC_SMBUS_PROC_CALL | \
 455                             I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
 456                             I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC | \
 457                             I2C_FUNC_SMBUS_I2C_BLOCK
 458
 459 /*
 460  * Data for SMBus Messages
 461  */
 462 #define I2C_SMBUS_BLOCK_MAX     32      /* As specified in SMBus standard */
 463 #define I2C_SMBUS_I2C_BLOCK_MAX 32      /* Not specified but we use same structure */
 464 union i2c_smbus_data {
 465         __u8 byte;
 466         __u16 word;
 467         __u8 block[I2C_SMBUS_BLOCK_MAX + 3]; /* block[0] is used for length */
 468                           /* one more for read length in block process call */
 469                                                     /* and one more for PEC */
 470 };
 471
 472 /* smbus_access read or write markers */
 473 #define I2C_SMBUS_READ  1
 474 #define I2C_SMBUS_WRITE 0
 475
 476 /* SMBus transaction types (size parameter in the above functions)
 477    Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
 478 #define I2C_SMBUS_QUICK             0
 479 #define I2C_SMBUS_BYTE              1
 480 #define I2C_SMBUS_BYTE_DATA         2
 481 #define I2C_SMBUS_WORD_DATA         3
 482 #define I2C_SMBUS_PROC_CALL         4
 483 #define I2C_SMBUS_BLOCK_DATA        5
 484 #define I2C_SMBUS_I2C_BLOCK_DATA    6
 485 #define I2C_SMBUS_BLOCK_PROC_CALL   7           /* SMBus 2.0 */
 486 #define I2C_SMBUS_BLOCK_DATA_PEC    8           /* SMBus 2.0 */
 487 #define I2C_SMBUS_PROC_CALL_PEC     9           /* SMBus 2.0 */
 488 #define I2C_SMBUS_BLOCK_PROC_CALL_PEC  10       /* SMBus 2.0 */
 489 #define I2C_SMBUS_WORD_DATA_PEC    11           /* SMBus 2.0 */
 490
 491
 492 /* ----- commands for the ioctl like i2c_command call:
 493  * note that additional calls are defined in the algorithm and hw
 494  *      dependent layers - these can be listed here, or see the
 495  *      corresponding header files.
 496  */
 497                                 /* -> bit-adapter specific ioctls       */
 498 #define I2C_RETRIES     0x0701  /* number of times a device address      */
 499                                 /* should be polled when not            */
 500                                 /* acknowledging                        */
 501 #define I2C_TIMEOUT     0x0702  /* set timeout - call with int          */
 502
 503
 504 /* this is for i2c-dev.c        */
 505 #define I2C_SLAVE       0x0703  /* Change slave address                 */
 506                                 /* Attn.: Slave address is 7 or 10 bits */
 507 #define I2C_SLAVE_FORCE 0x0706  /* Change slave address                 */
 508                                 /* Attn.: Slave address is 7 or 10 bits */
 509                                 /* This changes the address, even if it */
 510                                 /* is already taken!                    */
 511 #define I2C_TENBIT      0x0704  /* 0 for 7 bit addrs, != 0 for 10 bit   */
 512
 513 #define I2C_FUNCS       0x0705  /* Get the adapter functionality */
 514 #define I2C_RDWR        0x0707  /* Combined R/W transfer (one stop only)*/
 515 #define I2C_PEC         0x0708  /* != 0 for SMBus PEC                   */
 516 #if 0
 517 #define I2C_ACK_TEST    0x0710  /* See if a slave is at a specific address */
 518 #endif
 519
 520 #define I2C_SMBUS       0x0720  /* SMBus-level access */
 521
 522 /* ... algo-bit.c recognizes */
 523 #define I2C_UDELAY      0x0705  /* set delay in microsecs between each  */
 524                                 /* written byte (except address)        */
 525 #define I2C_MDELAY      0x0706  /* millisec delay between written bytes */
 526
 527 /* ----- I2C-DEV: char device interface stuff ------------------------- */
 528
 529 #define I2C_MAJOR       89              /* Device major number          */
 530
 531 /* These defines are used for probing i2c client addresses */
 532 /* Default fill of many variables */
 533 #define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 534                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 535                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 536                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 537                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 538                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 539                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 540                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 541                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 542                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 543                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 544                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 545                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 546                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 547                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
 548                           I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
 549
 550 /* This is ugly. We need to evaluate I2C_CLIENT_MAX_OPTS before it is
 551    stringified */
 552 #define I2C_CLIENT_MODPARM_AUX1(x) "1-" #x "h"
 553 #define I2C_CLIENT_MODPARM_AUX(x) I2C_CLIENT_MODPARM_AUX1(x)
 554 #define I2C_CLIENT_MODPARM I2C_CLIENT_MODPARM_AUX(I2C_CLIENT_MAX_OPTS)
 555
 556 /* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
 557    module header */
 558
 559 #define I2C_CLIENT_MODULE_PARM(var,desc) \
 560   static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
 561   static unsigned int var##_num; \
 562   /*MODULE_PARM(var,I2C_CLIENT_MODPARM);*/ \
 563   module_param_array(var, short, &var##_num, 0); \
 564   MODULE_PARM_DESC(var,desc)
 565
 566 /* This is the one you want to use in your own modules */
 567 #define I2C_CLIENT_INSMOD \
 568   I2C_CLIENT_MODULE_PARM(probe, \
 569                       "List of adapter,address pairs to scan additionally"); \
 570   I2C_CLIENT_MODULE_PARM(probe_range, \
 571                       "List of adapter,start-addr,end-addr triples to scan " \
 572                       "additionally"); \
 573   I2C_CLIENT_MODULE_PARM(ignore, \
 574                       "List of adapter,address pairs not to scan"); \
 575   I2C_CLIENT_MODULE_PARM(ignore_range, \
 576                       "List of adapter,start-addr,end-addr triples not to " \
 577                       "scan"); \
 578   I2C_CLIENT_MODULE_PARM(force, \
 579                       "List of adapter,address pairs to boldly assume " \
 580                       "to be present"); \
 581         static struct i2c_client_address_data addr_data = {             \
 582                         .normal_i2c =           normal_i2c,             \
 583                         .normal_i2c_range =     normal_i2c_range,       \
 584                         .probe =                probe,                  \
 585                         .probe_range =          probe_range,            \
 586                         .ignore =               ignore,                 \
 587                         .ignore_range =         ignore_range,           \
 588                         .force =                force,                  \
 589                 }
 590
 591 /* Detect whether we are on the isa bus. If this returns true, all i2c
 592    access will fail! */
 593 #define i2c_is_isa_client(clientptr) \
 594         ((clientptr)->adapter->algo->id == I2C_ALGO_ISA)
 595 #define i2c_is_isa_adapter(adapptr) \
 596         ((adapptr)->algo->id == I2C_ALGO_ISA)
 597
 598 #endif /* _LINUX_I2C_H */