]>
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 | |
5694f8a8 JD |
20 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, |
21 | MA 02110-1301 USA. */ | |
1da177e4 LT |
22 | /* ------------------------------------------------------------------------- */ |
23 | ||
a1b9298e | 24 | /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and |
1da177e4 | 25 | Frodo Looijaard <frodol@dds.nl> */ |
1da177e4 LT |
26 | #ifndef _LINUX_I2C_H |
27 | #define _LINUX_I2C_H | |
28 | ||
a9d1b24d | 29 | #include <linux/mod_devicetable.h> |
1da177e4 | 30 | #include <linux/device.h> /* for struct device */ |
4e57b681 | 31 | #include <linux/sched.h> /* for completion */ |
5c085d36 | 32 | #include <linux/mutex.h> |
d12d42f7 | 33 | #include <linux/of.h> /* for struct device_node */ |
06a67848 | 34 | #include <linux/swab.h> /* for swab16 */ |
607ca46e | 35 | #include <uapi/linux/i2c.h> |
1da177e4 | 36 | |
e9ca9eb9 | 37 | extern struct bus_type i2c_bus_type; |
0826374b | 38 | extern struct device_type i2c_adapter_type; |
e9ca9eb9 | 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; |
4b1acc43 WS |
49 | enum i2c_slave_event; |
50 | typedef int (*i2c_slave_cb_t)(struct i2c_client *, enum i2c_slave_event, u8 *); | |
1da177e4 | 51 | |
de477254 PG |
52 | struct module; |
53 | ||
23af8400 | 54 | #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE) |
1da177e4 LT |
55 | /* |
56 | * The master routines are the ones normally used to transmit data to devices | |
438d6c2c DB |
57 | * on a bus (or read from them). Apart from two basic transfer functions to |
58 | * transmit one message at a time, a more complex version can be used to | |
1da177e4 | 59 | * transmit an arbitrary number of messages without interruption. |
0c43ea54 | 60 | * @count must be be less than 64k since msg.len is u16. |
1da177e4 | 61 | */ |
0cc43a18 JD |
62 | extern int i2c_master_send(const struct i2c_client *client, const char *buf, |
63 | int count); | |
64 | extern int i2c_master_recv(const struct i2c_client *client, char *buf, | |
3ae70dee | 65 | int count); |
1da177e4 LT |
66 | |
67 | /* Transfer num messages. | |
68 | */ | |
3ae70dee JD |
69 | extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, |
70 | int num); | |
b37d2a3a JD |
71 | /* Unlocked flavor */ |
72 | extern int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, | |
73 | int num); | |
1da177e4 LT |
74 | |
75 | /* This is the very generalized SMBus access routine. You probably do not | |
76 | want to use this, though; one of the functions below may be much easier, | |
438d6c2c | 77 | and probably just as fast. |
1da177e4 LT |
78 | Note that we use i2c_adapter here, because you do not need a specific |
79 | smbus adapter to call this function. */ | |
3ae70dee JD |
80 | extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, |
81 | unsigned short flags, char read_write, u8 command, | |
82 | int size, union i2c_smbus_data *data); | |
1da177e4 LT |
83 | |
84 | /* Now follow the 'nice' access routines. These also document the calling | |
ae7193f7 | 85 | conventions of i2c_smbus_xfer. */ |
1da177e4 | 86 | |
0cc43a18 JD |
87 | extern s32 i2c_smbus_read_byte(const struct i2c_client *client); |
88 | extern s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value); | |
89 | extern s32 i2c_smbus_read_byte_data(const struct i2c_client *client, | |
90 | u8 command); | |
91 | extern s32 i2c_smbus_write_byte_data(const struct i2c_client *client, | |
3ae70dee | 92 | u8 command, u8 value); |
0cc43a18 JD |
93 | extern s32 i2c_smbus_read_word_data(const struct i2c_client *client, |
94 | u8 command); | |
95 | extern s32 i2c_smbus_write_word_data(const struct i2c_client *client, | |
3ae70dee | 96 | u8 command, u16 value); |
06a67848 JC |
97 | |
98 | static inline s32 | |
99 | i2c_smbus_read_word_swapped(const struct i2c_client *client, u8 command) | |
100 | { | |
101 | s32 value = i2c_smbus_read_word_data(client, command); | |
102 | ||
103 | return (value < 0) ? value : swab16(value); | |
104 | } | |
105 | ||
106 | static inline s32 | |
107 | i2c_smbus_write_word_swapped(const struct i2c_client *client, | |
108 | u8 command, u16 value) | |
109 | { | |
110 | return i2c_smbus_write_word_data(client, command, swab16(value)); | |
111 | } | |
112 | ||
b86a1bc8 | 113 | /* Returns the number of read bytes */ |
0cc43a18 | 114 | extern s32 i2c_smbus_read_block_data(const struct i2c_client *client, |
b86a1bc8 | 115 | u8 command, u8 *values); |
0cc43a18 | 116 | extern s32 i2c_smbus_write_block_data(const struct i2c_client *client, |
3ae70dee | 117 | u8 command, u8 length, const u8 *values); |
31ec5bc5 | 118 | /* Returns the number of read bytes */ |
0cc43a18 | 119 | extern s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client, |
4b2643d7 | 120 | u8 command, u8 length, u8 *values); |
0cc43a18 | 121 | extern s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client, |
21bbd691 | 122 | u8 command, u8 length, |
46f5ed75 | 123 | const u8 *values); |
23af8400 | 124 | #endif /* I2C */ |
1da177e4 | 125 | |
4735c98f JD |
126 | /** |
127 | * struct i2c_driver - represent an I2C device driver | |
128 | * @class: What kind of i2c device we instantiate (for detect) | |
fe6fc258 | 129 | * @attach_adapter: Callback for bus addition (deprecated) |
729d6dd5 JD |
130 | * @probe: Callback for device binding |
131 | * @remove: Callback for device unbinding | |
96e21e4f | 132 | * @shutdown: Callback for device shutdown |
72d2e9f9 | 133 | * @alert: Alert callback, for example for the SMBus alert protocol |
96e21e4f JD |
134 | * @command: Callback for bus-wide signaling (optional) |
135 | * @driver: Device driver model driver | |
136 | * @id_table: List of I2C devices supported by this driver | |
4735c98f | 137 | * @detect: Callback for device detection |
c3813d6a | 138 | * @address_list: The I2C addresses to probe (for detect) |
4735c98f | 139 | * @clients: List of detected clients we created (for i2c-core use only) |
35d8b2e6 LR |
140 | * |
141 | * The driver.owner field should be set to the module owner of this driver. | |
142 | * The driver.name field should be set to the name of this driver. | |
4735c98f | 143 | * |
0ec13867 | 144 | * For automatic device detection, both @detect and @address_list must |
4735c98f JD |
145 | * be defined. @class should also be set, otherwise only devices forced |
146 | * with module parameters will be created. The detect function must | |
147 | * fill at least the name field of the i2c_board_info structure it is | |
148 | * handed upon successful detection, and possibly also the flags field. | |
149 | * | |
150 | * If @detect is missing, the driver will still work fine for enumerated | |
151 | * devices. Detected devices simply won't be supported. This is expected | |
152 | * for the many I2C/SMBus devices which can't be detected reliably, and | |
153 | * the ones which can always be enumerated in practice. | |
154 | * | |
155 | * The i2c_client structure which is handed to the @detect callback is | |
156 | * not a real i2c_client. It is initialized just enough so that you can | |
157 | * call i2c_smbus_read_byte_data and friends on it. Don't do anything | |
158 | * else with it. In particular, calling dev_dbg and friends on it is | |
159 | * not allowed. | |
1da177e4 | 160 | */ |
1da177e4 | 161 | struct i2c_driver { |
1da177e4 | 162 | unsigned int class; |
1da177e4 | 163 | |
19baba4c LPC |
164 | /* Notifies the driver that a new bus has appeared. You should avoid |
165 | * using this, it will be removed in a near future. | |
1da177e4 | 166 | */ |
fe6fc258 | 167 | int (*attach_adapter)(struct i2c_adapter *) __deprecated; |
1da177e4 | 168 | |
729d6dd5 | 169 | /* Standard driver model interfaces */ |
d2653e92 | 170 | int (*probe)(struct i2c_client *, const struct i2c_device_id *); |
a1d9e6e4 | 171 | int (*remove)(struct i2c_client *); |
7b4fbc50 | 172 | |
f37dd80a DB |
173 | /* driver model interfaces that don't relate to enumeration */ |
174 | void (*shutdown)(struct i2c_client *); | |
f37dd80a | 175 | |
b5527a77 JD |
176 | /* Alert callback, for example for the SMBus alert protocol. |
177 | * The format and meaning of the data value depends on the protocol. | |
178 | * For the SMBus alert protocol, there is a single bit of data passed | |
179 | * as the alert response's low bit ("event flag"). | |
180 | */ | |
181 | void (*alert)(struct i2c_client *, unsigned int data); | |
182 | ||
1da177e4 LT |
183 | /* a ioctl like command that can be used to perform specific functions |
184 | * with the device. | |
185 | */ | |
3ae70dee | 186 | int (*command)(struct i2c_client *client, unsigned int cmd, void *arg); |
1da177e4 LT |
187 | |
188 | struct device_driver driver; | |
d2653e92 | 189 | const struct i2c_device_id *id_table; |
4735c98f JD |
190 | |
191 | /* Device detection callback for automatic device creation */ | |
310ec792 | 192 | int (*detect)(struct i2c_client *, struct i2c_board_info *); |
c3813d6a | 193 | const unsigned short *address_list; |
4735c98f | 194 | struct list_head clients; |
1da177e4 LT |
195 | }; |
196 | #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver) | |
197 | ||
2096b956 DB |
198 | /** |
199 | * struct i2c_client - represent an I2C slave device | |
d64f73be DB |
200 | * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address; |
201 | * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking | |
2096b956 DB |
202 | * @addr: Address used on the I2C bus connected to the parent adapter. |
203 | * @name: Indicates the type of the device, usually a chip name that's | |
204 | * generic enough to hide second-sourcing and compatible revisions. | |
d64f73be | 205 | * @adapter: manages the bus segment hosting this I2C device |
2096b956 | 206 | * @dev: Driver model device node for the slave. |
d64f73be | 207 | * @irq: indicates the IRQ generated by this device (if any) |
99cd8e25 JD |
208 | * @detected: member of an i2c_driver.clients list or i2c-core's |
209 | * userspace_devices list | |
4b1acc43 WS |
210 | * @slave_cb: Callback when I2C slave mode of an adapter is used. The adapter |
211 | * calls it to pass on slave events to the slave driver. | |
2096b956 DB |
212 | * |
213 | * An i2c_client identifies a single device (i.e. chip) connected to an | |
d64f73be DB |
214 | * i2c bus. The behaviour exposed to Linux is defined by the driver |
215 | * managing the device. | |
1da177e4 LT |
216 | */ |
217 | struct i2c_client { | |
2096b956 | 218 | unsigned short flags; /* div., see below */ |
438d6c2c | 219 | unsigned short addr; /* chip address - NOTE: 7bit */ |
1da177e4 | 220 | /* addresses are stored in the */ |
5071860a | 221 | /* _LOWER_ 7 bits */ |
2096b956 | 222 | char name[I2C_NAME_SIZE]; |
1da177e4 | 223 | struct i2c_adapter *adapter; /* the adapter we sit on */ |
1da177e4 | 224 | struct device dev; /* the device structure */ |
8e29da9e | 225 | int irq; /* irq issued by device */ |
4735c98f | 226 | struct list_head detected; |
d5fd120e | 227 | #if IS_ENABLED(CONFIG_I2C_SLAVE) |
4b1acc43 | 228 | i2c_slave_cb_t slave_cb; /* callback for slave mode */ |
d5fd120e | 229 | #endif |
1da177e4 LT |
230 | }; |
231 | #define to_i2c_client(d) container_of(d, struct i2c_client, dev) | |
232 | ||
9b766b81 | 233 | extern struct i2c_client *i2c_verify_client(struct device *dev); |
643dd09e | 234 | extern struct i2c_adapter *i2c_verify_adapter(struct device *dev); |
9b766b81 | 235 | |
a61fc683 BG |
236 | static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj) |
237 | { | |
d75d53cd MH |
238 | struct device * const dev = container_of(kobj, struct device, kobj); |
239 | return to_i2c_client(dev); | |
a61fc683 BG |
240 | } |
241 | ||
7d1d8999 | 242 | static inline void *i2c_get_clientdata(const struct i2c_client *dev) |
1da177e4 | 243 | { |
3ae70dee | 244 | return dev_get_drvdata(&dev->dev); |
1da177e4 LT |
245 | } |
246 | ||
3ae70dee | 247 | static inline void i2c_set_clientdata(struct i2c_client *dev, void *data) |
1da177e4 | 248 | { |
3ae70dee | 249 | dev_set_drvdata(&dev->dev, data); |
1da177e4 LT |
250 | } |
251 | ||
4b1acc43 WS |
252 | /* I2C slave support */ |
253 | ||
d5fd120e | 254 | #if IS_ENABLED(CONFIG_I2C_SLAVE) |
4b1acc43 WS |
255 | enum i2c_slave_event { |
256 | I2C_SLAVE_REQ_READ_START, | |
257 | I2C_SLAVE_REQ_READ_END, | |
258 | I2C_SLAVE_REQ_WRITE_START, | |
259 | I2C_SLAVE_REQ_WRITE_END, | |
260 | I2C_SLAVE_STOP, | |
261 | }; | |
262 | ||
263 | extern int i2c_slave_register(struct i2c_client *client, i2c_slave_cb_t slave_cb); | |
264 | extern int i2c_slave_unregister(struct i2c_client *client); | |
265 | ||
266 | static inline int i2c_slave_event(struct i2c_client *client, | |
267 | enum i2c_slave_event event, u8 *val) | |
268 | { | |
269 | return client->slave_cb(client, event, val); | |
270 | } | |
d5fd120e | 271 | #endif |
4b1acc43 | 272 | |
9c1600ed DB |
273 | /** |
274 | * struct i2c_board_info - template for device creation | |
eb8a7908 | 275 | * @type: chip type, to initialize i2c_client.name |
9c1600ed DB |
276 | * @flags: to initialize i2c_client.flags |
277 | * @addr: stored in i2c_client.addr | |
278 | * @platform_data: stored in i2c_client.dev.platform_data | |
11f1f2af | 279 | * @archdata: copied into i2c_client.dev.archdata |
72d2e9f9 | 280 | * @of_node: pointer to OpenFirmware device node |
907ddf89 | 281 | * @acpi_node: ACPI device node |
9c1600ed | 282 | * @irq: stored in i2c_client.irq |
d64f73be | 283 | * |
9c1600ed DB |
284 | * I2C doesn't actually support hardware probing, although controllers and |
285 | * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's | |
286 | * a device at a given address. Drivers commonly need more information than | |
287 | * that, such as chip type, configuration, associated IRQ, and so on. | |
288 | * | |
289 | * i2c_board_info is used to build tables of information listing I2C devices | |
729d6dd5 JD |
290 | * that are present. This information is used to grow the driver model tree. |
291 | * For mainboards this is done statically using i2c_register_board_info(); | |
292 | * bus numbers identify adapters that aren't yet available. For add-on boards, | |
293 | * i2c_new_device() does this dynamically with the adapter already known. | |
9c1600ed DB |
294 | */ |
295 | struct i2c_board_info { | |
9c1600ed DB |
296 | char type[I2C_NAME_SIZE]; |
297 | unsigned short flags; | |
298 | unsigned short addr; | |
299 | void *platform_data; | |
11f1f2af | 300 | struct dev_archdata *archdata; |
d12d42f7 | 301 | struct device_node *of_node; |
907ddf89 | 302 | struct acpi_dev_node acpi_node; |
9c1600ed DB |
303 | int irq; |
304 | }; | |
305 | ||
306 | /** | |
3760f736 JD |
307 | * I2C_BOARD_INFO - macro used to list an i2c device and its address |
308 | * @dev_type: identifies the device type | |
9c1600ed DB |
309 | * @dev_addr: the device's address on the bus. |
310 | * | |
311 | * This macro initializes essential fields of a struct i2c_board_info, | |
312 | * declaring what has been provided on a particular board. Optional | |
3760f736 JD |
313 | * fields (such as associated irq, or device-specific platform_data) |
314 | * are provided using conventional syntax. | |
9c1600ed | 315 | */ |
3ae70dee | 316 | #define I2C_BOARD_INFO(dev_type, dev_addr) \ |
c758e8cf | 317 | .type = dev_type, .addr = (dev_addr) |
9c1600ed DB |
318 | |
319 | ||
23af8400 | 320 | #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE) |
9c1600ed DB |
321 | /* Add-on boards should register/unregister their devices; e.g. a board |
322 | * with integrated I2C, a config eeprom, sensors, and a codec that's | |
323 | * used in conjunction with the primary hardware. | |
324 | */ | |
325 | extern struct i2c_client * | |
326 | i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info); | |
327 | ||
12b5053a JD |
328 | /* If you don't know the exact address of an I2C device, use this variant |
329 | * instead, which can probe for device presence in a list of possible | |
9a94241a JD |
330 | * addresses. The "probe" callback function is optional. If it is provided, |
331 | * it must return 1 on successful probe, 0 otherwise. If it is not provided, | |
332 | * a default probing method is used. | |
12b5053a JD |
333 | */ |
334 | extern struct i2c_client * | |
335 | i2c_new_probed_device(struct i2c_adapter *adap, | |
336 | struct i2c_board_info *info, | |
9a94241a JD |
337 | unsigned short const *addr_list, |
338 | int (*probe)(struct i2c_adapter *, unsigned short addr)); | |
12b5053a | 339 | |
d44f19d5 JD |
340 | /* Common custom probe functions */ |
341 | extern int i2c_probe_func_quick_read(struct i2c_adapter *, unsigned short addr); | |
342 | ||
e9f1373b DB |
343 | /* For devices that use several addresses, use i2c_new_dummy() to make |
344 | * client handles for the extra addresses. | |
345 | */ | |
346 | extern struct i2c_client * | |
60b129d7 | 347 | i2c_new_dummy(struct i2c_adapter *adap, u16 address); |
e9f1373b | 348 | |
9c1600ed | 349 | extern void i2c_unregister_device(struct i2c_client *); |
23af8400 | 350 | #endif /* I2C */ |
9c1600ed DB |
351 | |
352 | /* Mainboard arch_initcall() code should register all its I2C devices. | |
353 | * This is done at arch_initcall time, before declaring any i2c adapters. | |
354 | * Modules for add-on boards must use other calls. | |
355 | */ | |
26386763 | 356 | #ifdef CONFIG_I2C_BOARDINFO |
9c1600ed | 357 | extern int |
3ae70dee JD |
358 | i2c_register_board_info(int busnum, struct i2c_board_info const *info, |
359 | unsigned n); | |
26386763 DB |
360 | #else |
361 | static inline int | |
3ae70dee JD |
362 | i2c_register_board_info(int busnum, struct i2c_board_info const *info, |
363 | unsigned n) | |
26386763 DB |
364 | { |
365 | return 0; | |
366 | } | |
23af8400 | 367 | #endif /* I2C_BOARDINFO */ |
9c1600ed | 368 | |
25ee33fb BD |
369 | /** |
370 | * struct i2c_algorithm - represent I2C transfer method | |
371 | * @master_xfer: Issue a set of i2c transactions to the given I2C adapter | |
372 | * defined by the msgs array, with num messages available to transfer via | |
373 | * the adapter specified by adap. | |
374 | * @smbus_xfer: Issue smbus transactions to the given I2C adapter. If this | |
375 | * is not present, then the bus layer will try and convert the SMBus calls | |
376 | * into I2C transfers instead. | |
377 | * @functionality: Return the flags that this algorithm/adapter pair supports | |
378 | * from the I2C_FUNC_* flags. | |
4b1acc43 WS |
379 | * @reg_slave: Register given client to I2C slave mode of this adapter |
380 | * @unreg_slave: Unregister given client from I2C slave mode of this adapter | |
25ee33fb | 381 | * |
1da177e4 LT |
382 | * The following structs are for those who like to implement new bus drivers: |
383 | * i2c_algorithm is the interface to a class of hardware solutions which can | |
384 | * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584 | |
385 | * to name two of the most common. | |
25ee33fb BD |
386 | * |
387 | * The return codes from the @master_xfer field should indicate the type of | |
f353d71f | 388 | * error code that occurred during the transfer, as documented in the kernel |
25ee33fb | 389 | * Documentation file Documentation/i2c/fault-codes. |
1da177e4 LT |
390 | */ |
391 | struct i2c_algorithm { | |
1da177e4 | 392 | /* If an adapter algorithm can't do I2C-level access, set master_xfer |
438d6c2c | 393 | to NULL. If an adapter algorithm can do SMBus access, set |
1da177e4 LT |
394 | smbus_xfer. If set to NULL, the SMBus protocol is simulated |
395 | using common I2C messages */ | |
8ced8eee JD |
396 | /* master_xfer should return the number of messages successfully |
397 | processed, or a negative value on error */ | |
3ae70dee JD |
398 | int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs, |
399 | int num); | |
438d6c2c | 400 | int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr, |
3ae70dee JD |
401 | unsigned short flags, char read_write, |
402 | u8 command, int size, union i2c_smbus_data *data); | |
1da177e4 | 403 | |
1da177e4 LT |
404 | /* To determine what the adapter supports */ |
405 | u32 (*functionality) (struct i2c_adapter *); | |
4b1acc43 | 406 | |
d5fd120e | 407 | #if IS_ENABLED(CONFIG_I2C_SLAVE) |
4b1acc43 WS |
408 | int (*reg_slave)(struct i2c_client *client); |
409 | int (*unreg_slave)(struct i2c_client *client); | |
d5fd120e | 410 | #endif |
1da177e4 LT |
411 | }; |
412 | ||
5f9296ba VK |
413 | /** |
414 | * struct i2c_bus_recovery_info - I2C bus recovery information | |
415 | * @recover_bus: Recover routine. Either pass driver's recover_bus() routine, or | |
416 | * i2c_generic_scl_recovery() or i2c_generic_gpio_recovery(). | |
417 | * @get_scl: This gets current value of SCL line. Mandatory for generic SCL | |
418 | * recovery. Used internally for generic GPIO recovery. | |
419 | * @set_scl: This sets/clears SCL line. Mandatory for generic SCL recovery. Used | |
420 | * internally for generic GPIO recovery. | |
421 | * @get_sda: This gets current value of SDA line. Optional for generic SCL | |
422 | * recovery. Used internally, if sda_gpio is a valid GPIO, for generic GPIO | |
423 | * recovery. | |
424 | * @prepare_recovery: This will be called before starting recovery. Platform may | |
425 | * configure padmux here for SDA/SCL line or something else they want. | |
426 | * @unprepare_recovery: This will be called after completing recovery. Platform | |
427 | * may configure padmux here for SDA/SCL line or something else they want. | |
428 | * @scl_gpio: gpio number of the SCL line. Only required for GPIO recovery. | |
429 | * @sda_gpio: gpio number of the SDA line. Only required for GPIO recovery. | |
430 | */ | |
431 | struct i2c_bus_recovery_info { | |
432 | int (*recover_bus)(struct i2c_adapter *); | |
433 | ||
434 | int (*get_scl)(struct i2c_adapter *); | |
435 | void (*set_scl)(struct i2c_adapter *, int val); | |
436 | int (*get_sda)(struct i2c_adapter *); | |
437 | ||
438 | void (*prepare_recovery)(struct i2c_bus_recovery_info *bri); | |
439 | void (*unprepare_recovery)(struct i2c_bus_recovery_info *bri); | |
440 | ||
441 | /* gpio recovery */ | |
442 | int scl_gpio; | |
443 | int sda_gpio; | |
444 | }; | |
445 | ||
446 | int i2c_recover_bus(struct i2c_adapter *adap); | |
447 | ||
448 | /* Generic recovery routines */ | |
449 | int i2c_generic_gpio_recovery(struct i2c_adapter *adap); | |
450 | int i2c_generic_scl_recovery(struct i2c_adapter *adap); | |
451 | ||
1da177e4 LT |
452 | /* |
453 | * i2c_adapter is the structure used to identify a physical i2c bus along | |
454 | * with the access algorithms necessary to access it. | |
455 | */ | |
456 | struct i2c_adapter { | |
457 | struct module *owner; | |
14f55f7a | 458 | unsigned int class; /* classes to allow probing for */ |
af71ff69 | 459 | const struct i2c_algorithm *algo; /* the algorithm to access the bus */ |
1da177e4 LT |
460 | void *algo_data; |
461 | ||
1da177e4 | 462 | /* data fields that are valid for all devices */ |
194684e5 | 463 | struct rt_mutex bus_lock; |
1da177e4 | 464 | |
cd97f39b | 465 | int timeout; /* in jiffies */ |
1da177e4 LT |
466 | int retries; |
467 | struct device dev; /* the adapter device */ | |
1da177e4 | 468 | |
1da177e4 | 469 | int nr; |
2096b956 | 470 | char name[48]; |
1da177e4 | 471 | struct completion dev_released; |
6629dcff | 472 | |
dafc50d1 | 473 | struct mutex userspace_clients_lock; |
6629dcff | 474 | struct list_head userspace_clients; |
5f9296ba VK |
475 | |
476 | struct i2c_bus_recovery_info *bus_recovery_info; | |
1da177e4 | 477 | }; |
ef2c8321 | 478 | #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev) |
1da177e4 | 479 | |
7d1d8999 | 480 | static inline void *i2c_get_adapdata(const struct i2c_adapter *dev) |
1da177e4 | 481 | { |
3ae70dee | 482 | return dev_get_drvdata(&dev->dev); |
1da177e4 LT |
483 | } |
484 | ||
3ae70dee | 485 | static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data) |
1da177e4 | 486 | { |
3ae70dee | 487 | dev_set_drvdata(&dev->dev, data); |
1da177e4 LT |
488 | } |
489 | ||
97cc4d49 JD |
490 | static inline struct i2c_adapter * |
491 | i2c_parent_is_i2c_adapter(const struct i2c_adapter *adapter) | |
0826374b | 492 | { |
2fac2b89 | 493 | #if IS_ENABLED(CONFIG_I2C_MUX) |
97cc4d49 JD |
494 | struct device *parent = adapter->dev.parent; |
495 | ||
496 | if (parent != NULL && parent->type == &i2c_adapter_type) | |
497 | return to_i2c_adapter(parent); | |
498 | else | |
3923172b | 499 | #endif |
97cc4d49 | 500 | return NULL; |
0826374b ML |
501 | } |
502 | ||
7ae31482 JD |
503 | int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *)); |
504 | ||
fe61e07e JD |
505 | /* Adapter locking functions, exported for shared pin cases */ |
506 | void i2c_lock_adapter(struct i2c_adapter *); | |
507 | void i2c_unlock_adapter(struct i2c_adapter *); | |
afa08974 | 508 | |
1da177e4 | 509 | /*flags for the client struct: */ |
3bbb835d DB |
510 | #define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */ |
511 | #define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */ | |
512 | /* Must equal I2C_M_TEN below */ | |
513 | #define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */ | |
d47726c5 LP |
514 | #define I2C_CLIENT_SCCB 0x9000 /* Use Omnivision SCCB protocol */ |
515 | /* Must match I2C_M_STOP|IGNORE_NAK */ | |
1da177e4 LT |
516 | |
517 | /* i2c adapter classes (bitmask) */ | |
518 | #define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */ | |
c1b6b4f2 | 519 | #define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */ |
774466ad | 520 | #define I2C_CLASS_SPD (1<<7) /* Memory modules */ |
0c176170 | 521 | #define I2C_CLASS_DEPRECATED (1<<8) /* Warn users that adapter will stop using classes */ |
1da177e4 | 522 | |
1da177e4 LT |
523 | /* Internal numbers to terminate lists */ |
524 | #define I2C_CLIENT_END 0xfffeU | |
1da177e4 | 525 | |
c7036673 HV |
526 | /* Construct an I2C_CLIENT_END-terminated array of i2c addresses */ |
527 | #define I2C_ADDRS(addr, addrs...) \ | |
528 | ((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END }) | |
529 | ||
1da177e4 LT |
530 | |
531 | /* ----- functions exported by i2c.o */ | |
532 | ||
533 | /* administration... | |
534 | */ | |
23af8400 | 535 | #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE) |
1da177e4 | 536 | extern int i2c_add_adapter(struct i2c_adapter *); |
71546300 | 537 | extern void i2c_del_adapter(struct i2c_adapter *); |
6e13e641 | 538 | extern int i2c_add_numbered_adapter(struct i2c_adapter *); |
1da177e4 | 539 | |
de59cf9e | 540 | extern int i2c_register_driver(struct module *, struct i2c_driver *); |
b3e82096 | 541 | extern void i2c_del_driver(struct i2c_driver *); |
1da177e4 | 542 | |
eb5589a8 PG |
543 | /* use a define to avoid include chaining to get THIS_MODULE */ |
544 | #define i2c_add_driver(driver) \ | |
545 | i2c_register_driver(THIS_MODULE, driver) | |
de59cf9e | 546 | |
e48d3319 JD |
547 | extern struct i2c_client *i2c_use_client(struct i2c_client *client); |
548 | extern void i2c_release_client(struct i2c_client *client); | |
1da177e4 LT |
549 | |
550 | /* call the i2c_client->command() of all attached clients with | |
551 | * the given arguments */ | |
552 | extern void i2c_clients_command(struct i2c_adapter *adap, | |
553 | unsigned int cmd, void *arg); | |
554 | ||
d735b34d | 555 | extern struct i2c_adapter *i2c_get_adapter(int nr); |
1da177e4 LT |
556 | extern void i2c_put_adapter(struct i2c_adapter *adap); |
557 | ||
558 | ||
559 | /* Return the functionality mask */ | |
560 | static inline u32 i2c_get_functionality(struct i2c_adapter *adap) | |
561 | { | |
562 | return adap->algo->functionality(adap); | |
563 | } | |
564 | ||
565 | /* Return 1 if adapter supports everything we need, 0 if not. */ | |
566 | static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func) | |
567 | { | |
568 | return (func & i2c_get_functionality(adap)) == func; | |
569 | } | |
570 | ||
3ae70dee | 571 | /* Return the adapter number for a specific adapter */ |
cdcb1921 JD |
572 | static inline int i2c_adapter_id(struct i2c_adapter *adap) |
573 | { | |
574 | return adap->nr; | |
575 | } | |
7c92784a LPC |
576 | |
577 | /** | |
578 | * module_i2c_driver() - Helper macro for registering a I2C driver | |
579 | * @__i2c_driver: i2c_driver struct | |
580 | * | |
581 | * Helper macro for I2C drivers which do not do anything special in module | |
582 | * init/exit. This eliminates a lot of boilerplate. Each module may only | |
583 | * use this macro once, and calling it replaces module_init() and module_exit() | |
584 | */ | |
585 | #define module_i2c_driver(__i2c_driver) \ | |
586 | module_driver(__i2c_driver, i2c_add_driver, \ | |
587 | i2c_del_driver) | |
588 | ||
23af8400 | 589 | #endif /* I2C */ |
907ddf89 | 590 | |
687b81d0 WS |
591 | #if IS_ENABLED(CONFIG_OF) |
592 | /* must call put_device() when done with returned i2c_client device */ | |
593 | extern struct i2c_client *of_find_i2c_device_by_node(struct device_node *node); | |
594 | ||
595 | /* must call put_device() when done with returned i2c_adapter device */ | |
596 | extern struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node); | |
597 | ||
598 | #else | |
599 | ||
600 | static inline struct i2c_client *of_find_i2c_device_by_node(struct device_node *node) | |
601 | { | |
602 | return NULL; | |
603 | } | |
604 | ||
605 | static inline struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node) | |
606 | { | |
607 | return NULL; | |
608 | } | |
609 | #endif /* CONFIG_OF */ | |
610 | ||
1da177e4 | 611 | #endif /* _LINUX_I2C_H */ |