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