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