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