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