]>
Commit | Line | Data |
---|---|---|
16216333 | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
76cc9f0e WS |
2 | /* |
3 | * i2c.h - definitions for the Linux i2c bus interface | |
4 | * Copyright (C) 1995-2000 Simon G. Vogl | |
2f5a55c5 | 5 | * Copyright (C) 2013-2019 Wolfram Sang <wsa@kernel.org> |
76cc9f0e WS |
6 | * |
7 | * With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and | |
8 | * Frodo Looijaard <frodol@dds.nl> | |
16216333 | 9 | */ |
1da177e4 LT |
10 | #ifndef _LINUX_I2C_H |
11 | #define _LINUX_I2C_H | |
12 | ||
5213d7ef | 13 | #include <linux/acpi.h> /* for acpi_handle */ |
a9d1b24d | 14 | #include <linux/mod_devicetable.h> |
1da177e4 | 15 | #include <linux/device.h> /* for struct device */ |
4e57b681 | 16 | #include <linux/sched.h> /* for completion */ |
5c085d36 | 17 | #include <linux/mutex.h> |
5a7b95fb | 18 | #include <linux/regulator/consumer.h> |
037741a6 | 19 | #include <linux/rtmutex.h> |
4d5538f5 | 20 | #include <linux/irqdomain.h> /* for Host Notify IRQ */ |
d12d42f7 | 21 | #include <linux/of.h> /* for struct device_node */ |
06a67848 | 22 | #include <linux/swab.h> /* for swab16 */ |
607ca46e | 23 | #include <uapi/linux/i2c.h> |
1da177e4 | 24 | |
e9ca9eb9 | 25 | extern struct bus_type i2c_bus_type; |
0826374b | 26 | extern struct device_type i2c_adapter_type; |
00a06c22 | 27 | extern struct device_type i2c_client_type; |
e9ca9eb9 | 28 | |
1da177e4 LT |
29 | /* --- General options ------------------------------------------------ */ |
30 | ||
31 | struct i2c_msg; | |
32 | struct i2c_algorithm; | |
33 | struct i2c_adapter; | |
34 | struct i2c_client; | |
35 | struct i2c_driver; | |
dde67eb1 | 36 | struct i2c_device_identity; |
1da177e4 | 37 | union i2c_smbus_data; |
4735c98f | 38 | struct i2c_board_info; |
4b1acc43 | 39 | enum i2c_slave_event; |
d68222d4 WS |
40 | typedef int (*i2c_slave_cb_t)(struct i2c_client *client, |
41 | enum i2c_slave_event event, u8 *val); | |
1da177e4 | 42 | |
e6282fc6 AS |
43 | /* I2C Frequency Modes */ |
44 | #define I2C_MAX_STANDARD_MODE_FREQ 100000 | |
45 | #define I2C_MAX_FAST_MODE_FREQ 400000 | |
46 | #define I2C_MAX_FAST_MODE_PLUS_FREQ 1000000 | |
47 | #define I2C_MAX_TURBO_MODE_FREQ 1400000 | |
48 | #define I2C_MAX_HIGH_SPEED_MODE_FREQ 3400000 | |
49 | #define I2C_MAX_ULTRA_FAST_MODE_FREQ 5000000 | |
50 | ||
de477254 | 51 | struct module; |
d3e1b617 | 52 | struct property_entry; |
de477254 | 53 | |
901a891f | 54 | #if IS_ENABLED(CONFIG_I2C) |
3b4c747c YY |
55 | /* Return the Frequency mode string based on the bus frequency */ |
56 | const char *i2c_freq_mode_string(u32 bus_freq_hz); | |
57 | ||
1da177e4 LT |
58 | /* |
59 | * The master routines are the ones normally used to transmit data to devices | |
438d6c2c DB |
60 | * on a bus (or read from them). Apart from two basic transfer functions to |
61 | * transmit one message at a time, a more complex version can be used to | |
1da177e4 | 62 | * transmit an arbitrary number of messages without interruption. |
aca7ed09 | 63 | * @count must be less than 64k since msg.len is u16. |
1da177e4 | 64 | */ |
c807da53 LC |
65 | int i2c_transfer_buffer_flags(const struct i2c_client *client, |
66 | char *buf, int count, u16 flags); | |
8a91732b WS |
67 | |
68 | /** | |
69 | * i2c_master_recv - issue a single I2C message in master receive mode | |
70 | * @client: Handle to slave device | |
71 | * @buf: Where to store data read from slave | |
72 | * @count: How many bytes to read, must be less than 64k since msg.len is u16 | |
73 | * | |
74 | * Returns negative errno, or else the number of bytes read. | |
75 | */ | |
76 | static inline int i2c_master_recv(const struct i2c_client *client, | |
77 | char *buf, int count) | |
78 | { | |
79 | return i2c_transfer_buffer_flags(client, buf, count, I2C_M_RD); | |
80 | }; | |
81 | ||
ba98645c WS |
82 | /** |
83 | * i2c_master_recv_dmasafe - issue a single I2C message in master receive mode | |
84 | * using a DMA safe buffer | |
85 | * @client: Handle to slave device | |
86 | * @buf: Where to store data read from slave, must be safe to use with DMA | |
87 | * @count: How many bytes to read, must be less than 64k since msg.len is u16 | |
88 | * | |
89 | * Returns negative errno, or else the number of bytes read. | |
90 | */ | |
91 | static inline int i2c_master_recv_dmasafe(const struct i2c_client *client, | |
92 | char *buf, int count) | |
93 | { | |
94 | return i2c_transfer_buffer_flags(client, buf, count, | |
95 | I2C_M_RD | I2C_M_DMA_SAFE); | |
96 | }; | |
97 | ||
8a91732b WS |
98 | /** |
99 | * i2c_master_send - issue a single I2C message in master transmit mode | |
100 | * @client: Handle to slave device | |
101 | * @buf: Data that will be written to the slave | |
102 | * @count: How many bytes to write, must be less than 64k since msg.len is u16 | |
103 | * | |
104 | * Returns negative errno, or else the number of bytes written. | |
105 | */ | |
106 | static inline int i2c_master_send(const struct i2c_client *client, | |
107 | const char *buf, int count) | |
108 | { | |
109 | return i2c_transfer_buffer_flags(client, (char *)buf, count, 0); | |
110 | }; | |
1da177e4 | 111 | |
ba98645c WS |
112 | /** |
113 | * i2c_master_send_dmasafe - issue a single I2C message in master transmit mode | |
114 | * using a DMA safe buffer | |
115 | * @client: Handle to slave device | |
116 | * @buf: Data that will be written to the slave, must be safe to use with DMA | |
117 | * @count: How many bytes to write, must be less than 64k since msg.len is u16 | |
118 | * | |
119 | * Returns negative errno, or else the number of bytes written. | |
120 | */ | |
121 | static inline int i2c_master_send_dmasafe(const struct i2c_client *client, | |
122 | const char *buf, int count) | |
123 | { | |
124 | return i2c_transfer_buffer_flags(client, (char *)buf, count, | |
125 | I2C_M_DMA_SAFE); | |
126 | }; | |
127 | ||
1da177e4 LT |
128 | /* Transfer num messages. |
129 | */ | |
c807da53 | 130 | int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num); |
b37d2a3a | 131 | /* Unlocked flavor */ |
c807da53 | 132 | int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num); |
1da177e4 LT |
133 | |
134 | /* This is the very generalized SMBus access routine. You probably do not | |
135 | want to use this, though; one of the functions below may be much easier, | |
438d6c2c | 136 | and probably just as fast. |
1da177e4 LT |
137 | Note that we use i2c_adapter here, because you do not need a specific |
138 | smbus adapter to call this function. */ | |
63453b59 PR |
139 | s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, |
140 | unsigned short flags, char read_write, u8 command, | |
141 | int protocol, union i2c_smbus_data *data); | |
142 | ||
143 | /* Unlocked flavor */ | |
144 | s32 __i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, | |
145 | unsigned short flags, char read_write, u8 command, | |
146 | int protocol, union i2c_smbus_data *data); | |
1da177e4 LT |
147 | |
148 | /* Now follow the 'nice' access routines. These also document the calling | |
ae7193f7 | 149 | conventions of i2c_smbus_xfer. */ |
1da177e4 | 150 | |
87cf5127 | 151 | u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count); |
c807da53 LC |
152 | s32 i2c_smbus_read_byte(const struct i2c_client *client); |
153 | s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value); | |
154 | s32 i2c_smbus_read_byte_data(const struct i2c_client *client, u8 command); | |
155 | s32 i2c_smbus_write_byte_data(const struct i2c_client *client, | |
156 | u8 command, u8 value); | |
157 | s32 i2c_smbus_read_word_data(const struct i2c_client *client, u8 command); | |
158 | s32 i2c_smbus_write_word_data(const struct i2c_client *client, | |
159 | u8 command, u16 value); | |
06a67848 JC |
160 | |
161 | static inline s32 | |
162 | i2c_smbus_read_word_swapped(const struct i2c_client *client, u8 command) | |
163 | { | |
164 | s32 value = i2c_smbus_read_word_data(client, command); | |
165 | ||
166 | return (value < 0) ? value : swab16(value); | |
167 | } | |
168 | ||
169 | static inline s32 | |
170 | i2c_smbus_write_word_swapped(const struct i2c_client *client, | |
171 | u8 command, u16 value) | |
172 | { | |
173 | return i2c_smbus_write_word_data(client, command, swab16(value)); | |
174 | } | |
175 | ||
b86a1bc8 | 176 | /* Returns the number of read bytes */ |
c807da53 LC |
177 | s32 i2c_smbus_read_block_data(const struct i2c_client *client, |
178 | u8 command, u8 *values); | |
179 | s32 i2c_smbus_write_block_data(const struct i2c_client *client, | |
180 | u8 command, u8 length, const u8 *values); | |
31ec5bc5 | 181 | /* Returns the number of read bytes */ |
c807da53 LC |
182 | s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client, |
183 | u8 command, u8 length, u8 *values); | |
184 | s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client, | |
185 | u8 command, u8 length, const u8 *values); | |
186 | s32 i2c_smbus_read_i2c_block_data_or_emulated(const struct i2c_client *client, | |
187 | u8 command, u8 length, | |
188 | u8 *values); | |
dde67eb1 PR |
189 | int i2c_get_device_id(const struct i2c_client *client, |
190 | struct i2c_device_identity *id); | |
23af8400 | 191 | #endif /* I2C */ |
1da177e4 | 192 | |
dde67eb1 PR |
193 | /** |
194 | * struct i2c_device_identity - i2c client device identification | |
195 | * @manufacturer_id: 0 - 4095, database maintained by NXP | |
196 | * @part_id: 0 - 511, according to manufacturer | |
197 | * @die_revision: 0 - 7, according to manufacturer | |
198 | */ | |
199 | struct i2c_device_identity { | |
200 | u16 manufacturer_id; | |
201 | #define I2C_DEVICE_ID_NXP_SEMICONDUCTORS 0 | |
202 | #define I2C_DEVICE_ID_NXP_SEMICONDUCTORS_1 1 | |
203 | #define I2C_DEVICE_ID_NXP_SEMICONDUCTORS_2 2 | |
204 | #define I2C_DEVICE_ID_NXP_SEMICONDUCTORS_3 3 | |
205 | #define I2C_DEVICE_ID_RAMTRON_INTERNATIONAL 4 | |
206 | #define I2C_DEVICE_ID_ANALOG_DEVICES 5 | |
207 | #define I2C_DEVICE_ID_STMICROELECTRONICS 6 | |
208 | #define I2C_DEVICE_ID_ON_SEMICONDUCTOR 7 | |
209 | #define I2C_DEVICE_ID_SPRINTEK_CORPORATION 8 | |
210 | #define I2C_DEVICE_ID_ESPROS_PHOTONICS_AG 9 | |
211 | #define I2C_DEVICE_ID_FUJITSU_SEMICONDUCTOR 10 | |
212 | #define I2C_DEVICE_ID_FLIR 11 | |
213 | #define I2C_DEVICE_ID_O2MICRO 12 | |
214 | #define I2C_DEVICE_ID_ATMEL 13 | |
215 | #define I2C_DEVICE_ID_NONE 0xffff | |
216 | u16 part_id; | |
217 | u8 die_revision; | |
218 | }; | |
219 | ||
b4f21054 BT |
220 | enum i2c_alert_protocol { |
221 | I2C_PROTOCOL_SMBUS_ALERT, | |
e456cd37 | 222 | I2C_PROTOCOL_SMBUS_HOST_NOTIFY, |
b4f21054 BT |
223 | }; |
224 | ||
4735c98f JD |
225 | /** |
226 | * struct i2c_driver - represent an I2C device driver | |
227 | * @class: What kind of i2c device we instantiate (for detect) | |
b8a1a4cd LJ |
228 | * @probe: Callback for device binding - soon to be deprecated |
229 | * @probe_new: New callback for device binding | |
729d6dd5 | 230 | * @remove: Callback for device unbinding |
96e21e4f | 231 | * @shutdown: Callback for device shutdown |
72d2e9f9 | 232 | * @alert: Alert callback, for example for the SMBus alert protocol |
96e21e4f JD |
233 | * @command: Callback for bus-wide signaling (optional) |
234 | * @driver: Device driver model driver | |
235 | * @id_table: List of I2C devices supported by this driver | |
4735c98f | 236 | * @detect: Callback for device detection |
c3813d6a | 237 | * @address_list: The I2C addresses to probe (for detect) |
4735c98f | 238 | * @clients: List of detected clients we created (for i2c-core use only) |
35d8b2e6 LR |
239 | * |
240 | * The driver.owner field should be set to the module owner of this driver. | |
241 | * The driver.name field should be set to the name of this driver. | |
4735c98f | 242 | * |
0ec13867 | 243 | * For automatic device detection, both @detect and @address_list must |
4735c98f JD |
244 | * be defined. @class should also be set, otherwise only devices forced |
245 | * with module parameters will be created. The detect function must | |
246 | * fill at least the name field of the i2c_board_info structure it is | |
247 | * handed upon successful detection, and possibly also the flags field. | |
248 | * | |
249 | * If @detect is missing, the driver will still work fine for enumerated | |
250 | * devices. Detected devices simply won't be supported. This is expected | |
251 | * for the many I2C/SMBus devices which can't be detected reliably, and | |
252 | * the ones which can always be enumerated in practice. | |
253 | * | |
254 | * The i2c_client structure which is handed to the @detect callback is | |
255 | * not a real i2c_client. It is initialized just enough so that you can | |
256 | * call i2c_smbus_read_byte_data and friends on it. Don't do anything | |
257 | * else with it. In particular, calling dev_dbg and friends on it is | |
258 | * not allowed. | |
1da177e4 | 259 | */ |
1da177e4 | 260 | struct i2c_driver { |
1da177e4 | 261 | unsigned int class; |
1da177e4 | 262 | |
729d6dd5 | 263 | /* Standard driver model interfaces */ |
d68222d4 WS |
264 | int (*probe)(struct i2c_client *client, const struct i2c_device_id *id); |
265 | int (*remove)(struct i2c_client *client); | |
7b4fbc50 | 266 | |
b8a1a4cd LJ |
267 | /* New driver model interface to aid the seamless removal of the |
268 | * current probe()'s, more commonly unused than used second parameter. | |
269 | */ | |
d68222d4 | 270 | int (*probe_new)(struct i2c_client *client); |
b8a1a4cd | 271 | |
f37dd80a | 272 | /* driver model interfaces that don't relate to enumeration */ |
d68222d4 | 273 | void (*shutdown)(struct i2c_client *client); |
f37dd80a | 274 | |
b5527a77 JD |
275 | /* Alert callback, for example for the SMBus alert protocol. |
276 | * The format and meaning of the data value depends on the protocol. | |
277 | * For the SMBus alert protocol, there is a single bit of data passed | |
278 | * as the alert response's low bit ("event flag"). | |
e456cd37 BT |
279 | * For the SMBus Host Notify protocol, the data corresponds to the |
280 | * 16-bit payload data reported by the slave device acting as master. | |
b5527a77 | 281 | */ |
d68222d4 | 282 | void (*alert)(struct i2c_client *client, enum i2c_alert_protocol protocol, |
b4f21054 | 283 | unsigned int data); |
b5527a77 | 284 | |
1da177e4 LT |
285 | /* a ioctl like command that can be used to perform specific functions |
286 | * with the device. | |
287 | */ | |
3ae70dee | 288 | int (*command)(struct i2c_client *client, unsigned int cmd, void *arg); |
1da177e4 LT |
289 | |
290 | struct device_driver driver; | |
d2653e92 | 291 | const struct i2c_device_id *id_table; |
4735c98f JD |
292 | |
293 | /* Device detection callback for automatic device creation */ | |
d68222d4 | 294 | int (*detect)(struct i2c_client *client, struct i2c_board_info *info); |
c3813d6a | 295 | const unsigned short *address_list; |
4735c98f | 296 | struct list_head clients; |
1da177e4 LT |
297 | }; |
298 | #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver) | |
299 | ||
2096b956 DB |
300 | /** |
301 | * struct i2c_client - represent an I2C slave device | |
2caea56f | 302 | * @flags: see I2C_CLIENT_* for possible flags |
2096b956 DB |
303 | * @addr: Address used on the I2C bus connected to the parent adapter. |
304 | * @name: Indicates the type of the device, usually a chip name that's | |
305 | * generic enough to hide second-sourcing and compatible revisions. | |
d64f73be | 306 | * @adapter: manages the bus segment hosting this I2C device |
2096b956 | 307 | * @dev: Driver model device node for the slave. |
3ac61258 | 308 | * @init_irq: IRQ that was set at initialization |
d64f73be | 309 | * @irq: indicates the IRQ generated by this device (if any) |
99cd8e25 JD |
310 | * @detected: member of an i2c_driver.clients list or i2c-core's |
311 | * userspace_devices list | |
4b1acc43 WS |
312 | * @slave_cb: Callback when I2C slave mode of an adapter is used. The adapter |
313 | * calls it to pass on slave events to the slave driver. | |
5b547582 DT |
314 | * @devres_group_id: id of the devres group that will be created for resources |
315 | * acquired when probing this device. | |
2096b956 DB |
316 | * |
317 | * An i2c_client identifies a single device (i.e. chip) connected to an | |
d64f73be DB |
318 | * i2c bus. The behaviour exposed to Linux is defined by the driver |
319 | * managing the device. | |
1da177e4 LT |
320 | */ |
321 | struct i2c_client { | |
2096b956 | 322 | unsigned short flags; /* div., see below */ |
2caea56f WS |
323 | #define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */ |
324 | #define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */ | |
325 | /* Must equal I2C_M_TEN below */ | |
326 | #define I2C_CLIENT_SLAVE 0x20 /* we are the slave */ | |
327 | #define I2C_CLIENT_HOST_NOTIFY 0x40 /* We want to use I2C host notify */ | |
328 | #define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */ | |
329 | #define I2C_CLIENT_SCCB 0x9000 /* Use Omnivision SCCB protocol */ | |
330 | /* Must match I2C_M_STOP|IGNORE_NAK */ | |
331 | ||
438d6c2c | 332 | unsigned short addr; /* chip address - NOTE: 7bit */ |
1da177e4 | 333 | /* addresses are stored in the */ |
5071860a | 334 | /* _LOWER_ 7 bits */ |
2096b956 | 335 | char name[I2C_NAME_SIZE]; |
1da177e4 | 336 | struct i2c_adapter *adapter; /* the adapter we sit on */ |
1da177e4 | 337 | struct device dev; /* the device structure */ |
93b6604c | 338 | int init_irq; /* irq set at initialization */ |
8e29da9e | 339 | int irq; /* irq issued by device */ |
4735c98f | 340 | struct list_head detected; |
d5fd120e | 341 | #if IS_ENABLED(CONFIG_I2C_SLAVE) |
4b1acc43 | 342 | i2c_slave_cb_t slave_cb; /* callback for slave mode */ |
d5fd120e | 343 | #endif |
5b547582 | 344 | void *devres_group_id; /* ID of probe devres group */ |
1da177e4 LT |
345 | }; |
346 | #define to_i2c_client(d) container_of(d, struct i2c_client, dev) | |
347 | ||
c807da53 LC |
348 | struct i2c_adapter *i2c_verify_adapter(struct device *dev); |
349 | const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id, | |
350 | const struct i2c_client *client); | |
9b766b81 | 351 | |
a61fc683 BG |
352 | static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj) |
353 | { | |
b1d4dc15 | 354 | struct device * const dev = kobj_to_dev(kobj); |
d75d53cd | 355 | return to_i2c_client(dev); |
a61fc683 BG |
356 | } |
357 | ||
7df915e5 | 358 | static inline void *i2c_get_clientdata(const struct i2c_client *client) |
1da177e4 | 359 | { |
7df915e5 | 360 | return dev_get_drvdata(&client->dev); |
1da177e4 LT |
361 | } |
362 | ||
7df915e5 | 363 | static inline void i2c_set_clientdata(struct i2c_client *client, void *data) |
1da177e4 | 364 | { |
7df915e5 | 365 | dev_set_drvdata(&client->dev, data); |
1da177e4 LT |
366 | } |
367 | ||
4b1acc43 WS |
368 | /* I2C slave support */ |
369 | ||
d5fd120e | 370 | #if IS_ENABLED(CONFIG_I2C_SLAVE) |
4b1acc43 | 371 | enum i2c_slave_event { |
5b77d162 WS |
372 | I2C_SLAVE_READ_REQUESTED, |
373 | I2C_SLAVE_WRITE_REQUESTED, | |
374 | I2C_SLAVE_READ_PROCESSED, | |
375 | I2C_SLAVE_WRITE_RECEIVED, | |
4b1acc43 WS |
376 | I2C_SLAVE_STOP, |
377 | }; | |
378 | ||
c807da53 LC |
379 | int i2c_slave_register(struct i2c_client *client, i2c_slave_cb_t slave_cb); |
380 | int i2c_slave_unregister(struct i2c_client *client); | |
381 | bool i2c_detect_slave_mode(struct device *dev); | |
4b1acc43 WS |
382 | |
383 | static inline int i2c_slave_event(struct i2c_client *client, | |
384 | enum i2c_slave_event event, u8 *val) | |
385 | { | |
386 | return client->slave_cb(client, event, val); | |
387 | } | |
8f1a357d AS |
388 | #else |
389 | static inline bool i2c_detect_slave_mode(struct device *dev) { return false; } | |
d5fd120e | 390 | #endif |
4b1acc43 | 391 | |
9c1600ed DB |
392 | /** |
393 | * struct i2c_board_info - template for device creation | |
eb8a7908 | 394 | * @type: chip type, to initialize i2c_client.name |
9c1600ed DB |
395 | * @flags: to initialize i2c_client.flags |
396 | * @addr: stored in i2c_client.addr | |
728fe6ce | 397 | * @dev_name: Overrides the default <busnr>-<addr> dev_name if set |
9c1600ed | 398 | * @platform_data: stored in i2c_client.dev.platform_data |
72d2e9f9 | 399 | * @of_node: pointer to OpenFirmware device node |
ce793486 | 400 | * @fwnode: device node supplied by the platform firmware |
714638e0 | 401 | * @swnode: software node for the device |
4124c4eb DT |
402 | * @resources: resources associated with the device |
403 | * @num_resources: number of resources in the @resources array | |
9c1600ed | 404 | * @irq: stored in i2c_client.irq |
d64f73be | 405 | * |
9c1600ed DB |
406 | * I2C doesn't actually support hardware probing, although controllers and |
407 | * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's | |
408 | * a device at a given address. Drivers commonly need more information than | |
409 | * that, such as chip type, configuration, associated IRQ, and so on. | |
410 | * | |
411 | * i2c_board_info is used to build tables of information listing I2C devices | |
729d6dd5 JD |
412 | * that are present. This information is used to grow the driver model tree. |
413 | * For mainboards this is done statically using i2c_register_board_info(); | |
414 | * bus numbers identify adapters that aren't yet available. For add-on boards, | |
390fd047 | 415 | * i2c_new_client_device() does this dynamically with the adapter already known. |
9c1600ed DB |
416 | */ |
417 | struct i2c_board_info { | |
9c1600ed DB |
418 | char type[I2C_NAME_SIZE]; |
419 | unsigned short flags; | |
420 | unsigned short addr; | |
728fe6ce | 421 | const char *dev_name; |
9c1600ed | 422 | void *platform_data; |
d12d42f7 | 423 | struct device_node *of_node; |
ce793486 | 424 | struct fwnode_handle *fwnode; |
714638e0 | 425 | const struct software_node *swnode; |
4124c4eb DT |
426 | const struct resource *resources; |
427 | unsigned int num_resources; | |
9c1600ed DB |
428 | int irq; |
429 | }; | |
430 | ||
431 | /** | |
3760f736 JD |
432 | * I2C_BOARD_INFO - macro used to list an i2c device and its address |
433 | * @dev_type: identifies the device type | |
9c1600ed DB |
434 | * @dev_addr: the device's address on the bus. |
435 | * | |
436 | * This macro initializes essential fields of a struct i2c_board_info, | |
437 | * declaring what has been provided on a particular board. Optional | |
3760f736 JD |
438 | * fields (such as associated irq, or device-specific platform_data) |
439 | * are provided using conventional syntax. | |
9c1600ed | 440 | */ |
3ae70dee | 441 | #define I2C_BOARD_INFO(dev_type, dev_addr) \ |
c758e8cf | 442 | .type = dev_type, .addr = (dev_addr) |
9c1600ed DB |
443 | |
444 | ||
901a891f | 445 | #if IS_ENABLED(CONFIG_I2C) |
390fd047 WS |
446 | /* |
447 | * Add-on boards should register/unregister their devices; e.g. a board | |
9c1600ed DB |
448 | * with integrated I2C, a config eeprom, sensors, and a codec that's |
449 | * used in conjunction with the primary hardware. | |
450 | */ | |
c807da53 | 451 | struct i2c_client * |
550113d4 WS |
452 | i2c_new_client_device(struct i2c_adapter *adap, struct i2c_board_info const *info); |
453 | ||
12b5053a JD |
454 | /* If you don't know the exact address of an I2C device, use this variant |
455 | * instead, which can probe for device presence in a list of possible | |
9a94241a JD |
456 | * addresses. The "probe" callback function is optional. If it is provided, |
457 | * it must return 1 on successful probe, 0 otherwise. If it is not provided, | |
458 | * a default probing method is used. | |
12b5053a | 459 | */ |
c807da53 | 460 | struct i2c_client * |
c1d08475 WS |
461 | i2c_new_scanned_device(struct i2c_adapter *adap, |
462 | struct i2c_board_info *info, | |
463 | unsigned short const *addr_list, | |
464 | int (*probe)(struct i2c_adapter *adap, unsigned short addr)); | |
465 | ||
d44f19d5 | 466 | /* Common custom probe functions */ |
c807da53 | 467 | int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr); |
d44f19d5 | 468 | |
c807da53 | 469 | struct i2c_client * |
550113d4 WS |
470 | i2c_new_dummy_device(struct i2c_adapter *adapter, u16 address); |
471 | ||
c807da53 | 472 | struct i2c_client * |
b8f5fe3b HK |
473 | devm_i2c_new_dummy_device(struct device *dev, struct i2c_adapter *adap, u16 address); |
474 | ||
c807da53 | 475 | struct i2c_client * |
af80559b | 476 | i2c_new_ancillary_device(struct i2c_client *client, |
c807da53 LC |
477 | const char *name, |
478 | u16 default_addr); | |
0f614d83 | 479 | |
c807da53 | 480 | void i2c_unregister_device(struct i2c_client *client); |
aa5c8b25 JC |
481 | |
482 | struct i2c_client *i2c_verify_client(struct device *dev); | |
483 | #else | |
484 | static inline struct i2c_client *i2c_verify_client(struct device *dev) | |
485 | { | |
486 | return NULL; | |
487 | } | |
23af8400 | 488 | #endif /* I2C */ |
9c1600ed DB |
489 | |
490 | /* Mainboard arch_initcall() code should register all its I2C devices. | |
491 | * This is done at arch_initcall time, before declaring any i2c adapters. | |
492 | * Modules for add-on boards must use other calls. | |
493 | */ | |
26386763 | 494 | #ifdef CONFIG_I2C_BOARDINFO |
c807da53 | 495 | int |
3ae70dee JD |
496 | i2c_register_board_info(int busnum, struct i2c_board_info const *info, |
497 | unsigned n); | |
26386763 DB |
498 | #else |
499 | static inline int | |
3ae70dee JD |
500 | i2c_register_board_info(int busnum, struct i2c_board_info const *info, |
501 | unsigned n) | |
26386763 DB |
502 | { |
503 | return 0; | |
504 | } | |
23af8400 | 505 | #endif /* I2C_BOARDINFO */ |
9c1600ed | 506 | |
25ee33fb BD |
507 | /** |
508 | * struct i2c_algorithm - represent I2C transfer method | |
509 | * @master_xfer: Issue a set of i2c transactions to the given I2C adapter | |
510 | * defined by the msgs array, with num messages available to transfer via | |
511 | * the adapter specified by adap. | |
63b96983 WS |
512 | * @master_xfer_atomic: same as @master_xfer. Yet, only using atomic context |
513 | * so e.g. PMICs can be accessed very late before shutdown. Optional. | |
25ee33fb BD |
514 | * @smbus_xfer: Issue smbus transactions to the given I2C adapter. If this |
515 | * is not present, then the bus layer will try and convert the SMBus calls | |
516 | * into I2C transfers instead. | |
63b96983 WS |
517 | * @smbus_xfer_atomic: same as @smbus_xfer. Yet, only using atomic context |
518 | * so e.g. PMICs can be accessed very late before shutdown. Optional. | |
25ee33fb | 519 | * @functionality: Return the flags that this algorithm/adapter pair supports |
692b65c8 | 520 | * from the ``I2C_FUNC_*`` flags. |
4b1acc43 WS |
521 | * @reg_slave: Register given client to I2C slave mode of this adapter |
522 | * @unreg_slave: Unregister given client from I2C slave mode of this adapter | |
25ee33fb | 523 | * |
1da177e4 LT |
524 | * The following structs are for those who like to implement new bus drivers: |
525 | * i2c_algorithm is the interface to a class of hardware solutions which can | |
526 | * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584 | |
527 | * to name two of the most common. | |
25ee33fb | 528 | * |
692b65c8 | 529 | * The return codes from the ``master_xfer{_atomic}`` fields should indicate the |
63b96983 | 530 | * type of error code that occurred during the transfer, as documented in the |
ccf988b6 | 531 | * Kernel Documentation file Documentation/i2c/fault-codes.rst. |
1da177e4 LT |
532 | */ |
533 | struct i2c_algorithm { | |
f6ac28d6 WS |
534 | /* |
535 | * If an adapter algorithm can't do I2C-level access, set master_xfer | |
536 | * to NULL. If an adapter algorithm can do SMBus access, set | |
537 | * smbus_xfer. If set to NULL, the SMBus protocol is simulated | |
538 | * using common I2C messages. | |
539 | * | |
540 | * master_xfer should return the number of messages successfully | |
541 | * processed, or a negative value on error | |
542 | */ | |
3ae70dee JD |
543 | int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs, |
544 | int num); | |
63b96983 WS |
545 | int (*master_xfer_atomic)(struct i2c_adapter *adap, |
546 | struct i2c_msg *msgs, int num); | |
f6ac28d6 WS |
547 | int (*smbus_xfer)(struct i2c_adapter *adap, u16 addr, |
548 | unsigned short flags, char read_write, | |
549 | u8 command, int size, union i2c_smbus_data *data); | |
63b96983 WS |
550 | int (*smbus_xfer_atomic)(struct i2c_adapter *adap, u16 addr, |
551 | unsigned short flags, char read_write, | |
552 | u8 command, int size, union i2c_smbus_data *data); | |
1da177e4 | 553 | |
1da177e4 | 554 | /* To determine what the adapter supports */ |
f6ac28d6 | 555 | u32 (*functionality)(struct i2c_adapter *adap); |
4b1acc43 | 556 | |
d5fd120e | 557 | #if IS_ENABLED(CONFIG_I2C_SLAVE) |
4b1acc43 WS |
558 | int (*reg_slave)(struct i2c_client *client); |
559 | int (*unreg_slave)(struct i2c_client *client); | |
d5fd120e | 560 | #endif |
1da177e4 LT |
561 | }; |
562 | ||
d1ed7985 PR |
563 | /** |
564 | * struct i2c_lock_operations - represent I2C locking operations | |
565 | * @lock_bus: Get exclusive access to an I2C bus segment | |
566 | * @trylock_bus: Try to get exclusive access to an I2C bus segment | |
567 | * @unlock_bus: Release exclusive access to an I2C bus segment | |
568 | * | |
569 | * The main operations are wrapped by i2c_lock_bus and i2c_unlock_bus. | |
570 | */ | |
571 | struct i2c_lock_operations { | |
d68222d4 WS |
572 | void (*lock_bus)(struct i2c_adapter *adapter, unsigned int flags); |
573 | int (*trylock_bus)(struct i2c_adapter *adapter, unsigned int flags); | |
574 | void (*unlock_bus)(struct i2c_adapter *adapter, unsigned int flags); | |
d1ed7985 PR |
575 | }; |
576 | ||
e1dba01c WS |
577 | /** |
578 | * struct i2c_timings - I2C timing information | |
579 | * @bus_freq_hz: the bus frequency in Hz | |
580 | * @scl_rise_ns: time SCL signal takes to rise in ns; t(r) in the I2C specification | |
581 | * @scl_fall_ns: time SCL signal takes to fall in ns; t(f) in the I2C specification | |
582 | * @scl_int_delay_ns: time IP core additionally needs to setup SCL in ns | |
583 | * @sda_fall_ns: time SDA signal takes to fall in ns; t(f) in the I2C specification | |
4717be73 | 584 | * @sda_hold_ns: time IP core additionally needs to hold SDA in ns |
b84dfe1a EH |
585 | * @digital_filter_width_ns: width in ns of spikes on i2c lines that the IP core |
586 | * digital filter can filter out | |
587 | * @analog_filter_cutoff_freq_hz: threshold frequency for the low pass IP core | |
588 | * analog filter | |
e1dba01c WS |
589 | */ |
590 | struct i2c_timings { | |
591 | u32 bus_freq_hz; | |
592 | u32 scl_rise_ns; | |
593 | u32 scl_fall_ns; | |
594 | u32 scl_int_delay_ns; | |
595 | u32 sda_fall_ns; | |
4717be73 | 596 | u32 sda_hold_ns; |
b84dfe1a EH |
597 | u32 digital_filter_width_ns; |
598 | u32 analog_filter_cutoff_freq_hz; | |
e1dba01c WS |
599 | }; |
600 | ||
5f9296ba VK |
601 | /** |
602 | * struct i2c_bus_recovery_info - I2C bus recovery information | |
603 | * @recover_bus: Recover routine. Either pass driver's recover_bus() routine, or | |
e1eb7d28 | 604 | * i2c_generic_scl_recovery(). |
5f9296ba | 605 | * @get_scl: This gets current value of SCL line. Mandatory for generic SCL |
766a4f27 WS |
606 | * recovery. Populated internally for generic GPIO recovery. |
607 | * @set_scl: This sets/clears the SCL line. Mandatory for generic SCL recovery. | |
608 | * Populated internally for generic GPIO recovery. | |
ffc59c49 WS |
609 | * @get_sda: This gets current value of SDA line. This or set_sda() is mandatory |
610 | * for generic SCL recovery. Populated internally, if sda_gpio is a valid | |
611 | * GPIO, for generic GPIO recovery. | |
612 | * @set_sda: This sets/clears the SDA line. This or get_sda() is mandatory for | |
613 | * generic SCL recovery. Populated internally, if sda_gpio is a valid GPIO, | |
614 | * for generic GPIO recovery. | |
7ca5f6be WS |
615 | * @get_bus_free: Returns the bus free state as seen from the IP core in case it |
616 | * has a more complex internal logic than just reading SDA. Optional. | |
5f9296ba VK |
617 | * @prepare_recovery: This will be called before starting recovery. Platform may |
618 | * configure padmux here for SDA/SCL line or something else they want. | |
619 | * @unprepare_recovery: This will be called after completing recovery. Platform | |
620 | * may configure padmux here for SDA/SCL line or something else they want. | |
3991c5c8 PR |
621 | * @scl_gpiod: gpiod of the SCL line. Only required for GPIO recovery. |
622 | * @sda_gpiod: gpiod of the SDA line. Only required for GPIO recovery. | |
75820314 CC |
623 | * @pinctrl: pinctrl used by GPIO recovery to change the state of the I2C pins. |
624 | * Optional. | |
625 | * @pins_default: default pinctrl state of SCL/SDA lines, when they are assigned | |
626 | * to the I2C bus. Optional. Populated internally for GPIO recovery, if | |
627 | * state with the name PINCTRL_STATE_DEFAULT is found and pinctrl is valid. | |
628 | * @pins_gpio: recovery pinctrl state of SCL/SDA lines, when they are used as | |
629 | * GPIOs. Optional. Populated internally for GPIO recovery, if this state | |
630 | * is called "gpio" or "recovery" and pinctrl is valid. | |
5f9296ba VK |
631 | */ |
632 | struct i2c_bus_recovery_info { | |
6c92204e | 633 | int (*recover_bus)(struct i2c_adapter *adap); |
5f9296ba | 634 | |
6c92204e WS |
635 | int (*get_scl)(struct i2c_adapter *adap); |
636 | void (*set_scl)(struct i2c_adapter *adap, int val); | |
637 | int (*get_sda)(struct i2c_adapter *adap); | |
8092178f | 638 | void (*set_sda)(struct i2c_adapter *adap, int val); |
7ca5f6be | 639 | int (*get_bus_free)(struct i2c_adapter *adap); |
5f9296ba | 640 | |
6c92204e WS |
641 | void (*prepare_recovery)(struct i2c_adapter *adap); |
642 | void (*unprepare_recovery)(struct i2c_adapter *adap); | |
5f9296ba VK |
643 | |
644 | /* gpio recovery */ | |
3991c5c8 PR |
645 | struct gpio_desc *scl_gpiod; |
646 | struct gpio_desc *sda_gpiod; | |
75820314 CC |
647 | struct pinctrl *pinctrl; |
648 | struct pinctrl_state *pins_default; | |
649 | struct pinctrl_state *pins_gpio; | |
5f9296ba VK |
650 | }; |
651 | ||
652 | int i2c_recover_bus(struct i2c_adapter *adap); | |
653 | ||
654 | /* Generic recovery routines */ | |
5f9296ba VK |
655 | int i2c_generic_scl_recovery(struct i2c_adapter *adap); |
656 | ||
2187f03a WS |
657 | /** |
658 | * struct i2c_adapter_quirks - describe flaws of an i2c adapter | |
659 | * @flags: see I2C_AQ_* for possible flags and read below | |
660 | * @max_num_msgs: maximum number of messages per transfer | |
661 | * @max_write_len: maximum length of a write message | |
662 | * @max_read_len: maximum length of a read message | |
663 | * @max_comb_1st_msg_len: maximum length of the first msg in a combined message | |
664 | * @max_comb_2nd_msg_len: maximum length of the second msg in a combined message | |
665 | * | |
666 | * Note about combined messages: Some I2C controllers can only send one message | |
667 | * per transfer, plus something called combined message or write-then-read. | |
668 | * This is (usually) a small write message followed by a read message and | |
669 | * barely enough to access register based devices like EEPROMs. There is a flag | |
670 | * to support this mode. It implies max_num_msg = 2 and does the length checks | |
671 | * with max_comb_*_len because combined message mode usually has its own | |
672 | * limitations. Because of HW implementations, some controllers can actually do | |
673 | * write-then-anything or other variants. To support that, write-then-read has | |
674 | * been broken out into smaller bits like write-first and read-second which can | |
675 | * be combined as needed. | |
676 | */ | |
677 | ||
678 | struct i2c_adapter_quirks { | |
679 | u64 flags; | |
680 | int max_num_msgs; | |
681 | u16 max_write_len; | |
682 | u16 max_read_len; | |
683 | u16 max_comb_1st_msg_len; | |
684 | u16 max_comb_2nd_msg_len; | |
685 | }; | |
686 | ||
687 | /* enforce max_num_msgs = 2 and use max_comb_*_len for length checks */ | |
688 | #define I2C_AQ_COMB BIT(0) | |
689 | /* first combined message must be write */ | |
690 | #define I2C_AQ_COMB_WRITE_FIRST BIT(1) | |
691 | /* second combined message must be read */ | |
692 | #define I2C_AQ_COMB_READ_SECOND BIT(2) | |
693 | /* both combined messages must have the same target address */ | |
694 | #define I2C_AQ_COMB_SAME_ADDR BIT(3) | |
695 | /* convenience macro for typical write-then read case */ | |
696 | #define I2C_AQ_COMB_WRITE_THEN_READ (I2C_AQ_COMB | I2C_AQ_COMB_WRITE_FIRST | \ | |
697 | I2C_AQ_COMB_READ_SECOND | I2C_AQ_COMB_SAME_ADDR) | |
749de3da NC |
698 | /* clock stretching is not supported */ |
699 | #define I2C_AQ_NO_CLK_STRETCH BIT(4) | |
d9cfe2ce WS |
700 | /* message cannot have length of 0 */ |
701 | #define I2C_AQ_NO_ZERO_LEN_READ BIT(5) | |
702 | #define I2C_AQ_NO_ZERO_LEN_WRITE BIT(6) | |
703 | #define I2C_AQ_NO_ZERO_LEN (I2C_AQ_NO_ZERO_LEN_READ | I2C_AQ_NO_ZERO_LEN_WRITE) | |
aca01415 BC |
704 | /* adapter cannot do repeated START */ |
705 | #define I2C_AQ_NO_REP_START BIT(7) | |
2187f03a | 706 | |
1da177e4 LT |
707 | /* |
708 | * i2c_adapter is the structure used to identify a physical i2c bus along | |
709 | * with the access algorithms necessary to access it. | |
710 | */ | |
711 | struct i2c_adapter { | |
712 | struct module *owner; | |
14f55f7a | 713 | unsigned int class; /* classes to allow probing for */ |
af71ff69 | 714 | const struct i2c_algorithm *algo; /* the algorithm to access the bus */ |
1da177e4 LT |
715 | void *algo_data; |
716 | ||
1da177e4 | 717 | /* data fields that are valid for all devices */ |
d1ed7985 | 718 | const struct i2c_lock_operations *lock_ops; |
194684e5 | 719 | struct rt_mutex bus_lock; |
6ef91fcc | 720 | struct rt_mutex mux_lock; |
1da177e4 | 721 | |
cd97f39b | 722 | int timeout; /* in jiffies */ |
1da177e4 LT |
723 | int retries; |
724 | struct device dev; /* the adapter device */ | |
9ac6cb5f | 725 | unsigned long locked_flags; /* owned by the I2C core */ |
4db61c2a WS |
726 | #define I2C_ALF_IS_SUSPENDED 0 |
727 | #define I2C_ALF_SUSPEND_REPORTED 1 | |
1da177e4 | 728 | |
1da177e4 | 729 | int nr; |
2096b956 | 730 | char name[48]; |
1da177e4 | 731 | struct completion dev_released; |
6629dcff | 732 | |
dafc50d1 | 733 | struct mutex userspace_clients_lock; |
6629dcff | 734 | struct list_head userspace_clients; |
5f9296ba VK |
735 | |
736 | struct i2c_bus_recovery_info *bus_recovery_info; | |
2187f03a | 737 | const struct i2c_adapter_quirks *quirks; |
4d5538f5 BT |
738 | |
739 | struct irq_domain *host_notify_domain; | |
5a7b95fb | 740 | struct regulator *bus_regulator; |
1da177e4 | 741 | }; |
ef2c8321 | 742 | #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev) |
1da177e4 | 743 | |
e1714daa | 744 | static inline void *i2c_get_adapdata(const struct i2c_adapter *adap) |
1da177e4 | 745 | { |
e1714daa | 746 | return dev_get_drvdata(&adap->dev); |
1da177e4 LT |
747 | } |
748 | ||
e1714daa | 749 | static inline void i2c_set_adapdata(struct i2c_adapter *adap, void *data) |
1da177e4 | 750 | { |
e1714daa | 751 | dev_set_drvdata(&adap->dev, data); |
1da177e4 LT |
752 | } |
753 | ||
97cc4d49 JD |
754 | static inline struct i2c_adapter * |
755 | i2c_parent_is_i2c_adapter(const struct i2c_adapter *adapter) | |
0826374b | 756 | { |
2fac2b89 | 757 | #if IS_ENABLED(CONFIG_I2C_MUX) |
97cc4d49 JD |
758 | struct device *parent = adapter->dev.parent; |
759 | ||
760 | if (parent != NULL && parent->type == &i2c_adapter_type) | |
761 | return to_i2c_adapter(parent); | |
762 | else | |
3923172b | 763 | #endif |
97cc4d49 | 764 | return NULL; |
0826374b ML |
765 | } |
766 | ||
d68222d4 | 767 | int i2c_for_each_dev(void *data, int (*fn)(struct device *dev, void *data)); |
7ae31482 | 768 | |
fe61e07e | 769 | /* Adapter locking functions, exported for shared pin cases */ |
8320f495 PR |
770 | #define I2C_LOCK_ROOT_ADAPTER BIT(0) |
771 | #define I2C_LOCK_SEGMENT BIT(1) | |
772 | ||
773 | /** | |
774 | * i2c_lock_bus - Get exclusive access to an I2C bus segment | |
775 | * @adapter: Target I2C bus segment | |
776 | * @flags: I2C_LOCK_ROOT_ADAPTER locks the root i2c adapter, I2C_LOCK_SEGMENT | |
777 | * locks only this branch in the adapter tree | |
778 | */ | |
779 | static inline void | |
780 | i2c_lock_bus(struct i2c_adapter *adapter, unsigned int flags) | |
781 | { | |
d1ed7985 | 782 | adapter->lock_ops->lock_bus(adapter, flags); |
8320f495 PR |
783 | } |
784 | ||
fb79e09a PR |
785 | /** |
786 | * i2c_trylock_bus - Try to get exclusive access to an I2C bus segment | |
787 | * @adapter: Target I2C bus segment | |
788 | * @flags: I2C_LOCK_ROOT_ADAPTER tries to locks the root i2c adapter, | |
789 | * I2C_LOCK_SEGMENT tries to lock only this branch in the adapter tree | |
790 | * | |
791 | * Return: true if the I2C bus segment is locked, false otherwise | |
792 | */ | |
793 | static inline int | |
794 | i2c_trylock_bus(struct i2c_adapter *adapter, unsigned int flags) | |
795 | { | |
d1ed7985 | 796 | return adapter->lock_ops->trylock_bus(adapter, flags); |
fb79e09a PR |
797 | } |
798 | ||
8320f495 PR |
799 | /** |
800 | * i2c_unlock_bus - Release exclusive access to an I2C bus segment | |
801 | * @adapter: Target I2C bus segment | |
802 | * @flags: I2C_LOCK_ROOT_ADAPTER unlocks the root i2c adapter, I2C_LOCK_SEGMENT | |
803 | * unlocks only this branch in the adapter tree | |
804 | */ | |
805 | static inline void | |
806 | i2c_unlock_bus(struct i2c_adapter *adapter, unsigned int flags) | |
807 | { | |
d1ed7985 | 808 | adapter->lock_ops->unlock_bus(adapter, flags); |
8320f495 PR |
809 | } |
810 | ||
9ac6cb5f WS |
811 | /** |
812 | * i2c_mark_adapter_suspended - Report suspended state of the adapter to the core | |
813 | * @adap: Adapter to mark as suspended | |
814 | * | |
815 | * When using this helper to mark an adapter as suspended, the core will reject | |
816 | * further transfers to this adapter. The usage of this helper is optional but | |
817 | * recommended for devices having distinct handlers for system suspend and | |
818 | * runtime suspend. More complex devices are free to implement custom solutions | |
819 | * to reject transfers when suspended. | |
820 | */ | |
821 | static inline void i2c_mark_adapter_suspended(struct i2c_adapter *adap) | |
822 | { | |
823 | i2c_lock_bus(adap, I2C_LOCK_ROOT_ADAPTER); | |
824 | set_bit(I2C_ALF_IS_SUSPENDED, &adap->locked_flags); | |
825 | i2c_unlock_bus(adap, I2C_LOCK_ROOT_ADAPTER); | |
826 | } | |
827 | ||
828 | /** | |
829 | * i2c_mark_adapter_resumed - Report resumed state of the adapter to the core | |
830 | * @adap: Adapter to mark as resumed | |
831 | * | |
832 | * When using this helper to mark an adapter as resumed, the core will allow | |
833 | * further transfers to this adapter. See also further notes to | |
834 | * @i2c_mark_adapter_suspended(). | |
835 | */ | |
836 | static inline void i2c_mark_adapter_resumed(struct i2c_adapter *adap) | |
837 | { | |
838 | i2c_lock_bus(adap, I2C_LOCK_ROOT_ADAPTER); | |
839 | clear_bit(I2C_ALF_IS_SUSPENDED, &adap->locked_flags); | |
840 | i2c_unlock_bus(adap, I2C_LOCK_ROOT_ADAPTER); | |
841 | } | |
842 | ||
1da177e4 LT |
843 | /* i2c adapter classes (bitmask) */ |
844 | #define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */ | |
c1b6b4f2 | 845 | #define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */ |
774466ad | 846 | #define I2C_CLASS_SPD (1<<7) /* Memory modules */ |
9c800349 WS |
847 | /* Warn users that the adapter doesn't support classes anymore */ |
848 | #define I2C_CLASS_DEPRECATED (1<<8) | |
1da177e4 | 849 | |
1da177e4 LT |
850 | /* Internal numbers to terminate lists */ |
851 | #define I2C_CLIENT_END 0xfffeU | |
1da177e4 | 852 | |
c7036673 HV |
853 | /* Construct an I2C_CLIENT_END-terminated array of i2c addresses */ |
854 | #define I2C_ADDRS(addr, addrs...) \ | |
855 | ((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END }) | |
856 | ||
1da177e4 LT |
857 | |
858 | /* ----- functions exported by i2c.o */ | |
859 | ||
860 | /* administration... | |
861 | */ | |
901a891f | 862 | #if IS_ENABLED(CONFIG_I2C) |
c807da53 | 863 | int i2c_add_adapter(struct i2c_adapter *adap); |
07740c92 | 864 | int devm_i2c_add_adapter(struct device *dev, struct i2c_adapter *adapter); |
c807da53 LC |
865 | void i2c_del_adapter(struct i2c_adapter *adap); |
866 | int i2c_add_numbered_adapter(struct i2c_adapter *adap); | |
1da177e4 | 867 | |
c807da53 LC |
868 | int i2c_register_driver(struct module *owner, struct i2c_driver *driver); |
869 | void i2c_del_driver(struct i2c_driver *driver); | |
1da177e4 | 870 | |
eb5589a8 PG |
871 | /* use a define to avoid include chaining to get THIS_MODULE */ |
872 | #define i2c_add_driver(driver) \ | |
873 | i2c_register_driver(THIS_MODULE, driver) | |
de59cf9e | 874 | |
8c9312a9 WS |
875 | static inline bool i2c_client_has_driver(struct i2c_client *client) |
876 | { | |
877 | return !IS_ERR_OR_NULL(client) && client->dev.driver; | |
878 | } | |
879 | ||
1da177e4 LT |
880 | /* call the i2c_client->command() of all attached clients with |
881 | * the given arguments */ | |
c807da53 LC |
882 | void i2c_clients_command(struct i2c_adapter *adap, |
883 | unsigned int cmd, void *arg); | |
1da177e4 | 884 | |
c807da53 LC |
885 | struct i2c_adapter *i2c_get_adapter(int nr); |
886 | void i2c_put_adapter(struct i2c_adapter *adap); | |
887 | unsigned int i2c_adapter_depth(struct i2c_adapter *adapter); | |
1da177e4 | 888 | |
e1dba01c | 889 | void i2c_parse_fw_timings(struct device *dev, struct i2c_timings *t, bool use_defaults); |
1da177e4 LT |
890 | |
891 | /* Return the functionality mask */ | |
892 | static inline u32 i2c_get_functionality(struct i2c_adapter *adap) | |
893 | { | |
894 | return adap->algo->functionality(adap); | |
895 | } | |
896 | ||
897 | /* Return 1 if adapter supports everything we need, 0 if not. */ | |
898 | static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func) | |
899 | { | |
900 | return (func & i2c_get_functionality(adap)) == func; | |
901 | } | |
902 | ||
cfa576db NC |
903 | /** |
904 | * i2c_check_quirks() - Function for checking the quirk flags in an i2c adapter | |
905 | * @adap: i2c adapter | |
906 | * @quirks: quirk flags | |
907 | * | |
908 | * Return: true if the adapter has all the specified quirk flags, false if not | |
909 | */ | |
910 | static inline bool i2c_check_quirks(struct i2c_adapter *adap, u64 quirks) | |
911 | { | |
912 | if (!adap->quirks) | |
913 | return false; | |
914 | return (adap->quirks->flags & quirks) == quirks; | |
915 | } | |
916 | ||
3ae70dee | 917 | /* Return the adapter number for a specific adapter */ |
cdcb1921 JD |
918 | static inline int i2c_adapter_id(struct i2c_adapter *adap) |
919 | { | |
920 | return adap->nr; | |
921 | } | |
7c92784a | 922 | |
a16d6ebc WS |
923 | static inline u8 i2c_8bit_addr_from_msg(const struct i2c_msg *msg) |
924 | { | |
925 | return (msg->addr << 1) | (msg->flags & I2C_M_RD ? 1 : 0); | |
926 | } | |
927 | ||
e94bc5d1 | 928 | u8 *i2c_get_dma_safe_msg_buf(struct i2c_msg *msg, unsigned int threshold); |
82fe39a6 | 929 | void i2c_put_dma_safe_msg_buf(u8 *buf, struct i2c_msg *msg, bool xferred); |
e94bc5d1 | 930 | |
4d5538f5 | 931 | int i2c_handle_smbus_host_notify(struct i2c_adapter *adap, unsigned short addr); |
7c92784a | 932 | /** |
c698d639 | 933 | * module_i2c_driver() - Helper macro for registering a modular I2C driver |
7c92784a LPC |
934 | * @__i2c_driver: i2c_driver struct |
935 | * | |
936 | * Helper macro for I2C drivers which do not do anything special in module | |
937 | * init/exit. This eliminates a lot of boilerplate. Each module may only | |
938 | * use this macro once, and calling it replaces module_init() and module_exit() | |
939 | */ | |
940 | #define module_i2c_driver(__i2c_driver) \ | |
941 | module_driver(__i2c_driver, i2c_add_driver, \ | |
942 | i2c_del_driver) | |
943 | ||
c698d639 PG |
944 | /** |
945 | * builtin_i2c_driver() - Helper macro for registering a builtin I2C driver | |
946 | * @__i2c_driver: i2c_driver struct | |
947 | * | |
948 | * Helper macro for I2C drivers which do not do anything special in their | |
949 | * init. This eliminates a lot of boilerplate. Each driver may only | |
950 | * use this macro once, and calling it replaces device_initcall(). | |
951 | */ | |
952 | #define builtin_i2c_driver(__i2c_driver) \ | |
953 | builtin_driver(__i2c_driver, i2c_add_driver) | |
954 | ||
23af8400 | 955 | #endif /* I2C */ |
907ddf89 | 956 | |
687b81d0 WS |
957 | #if IS_ENABLED(CONFIG_OF) |
958 | /* must call put_device() when done with returned i2c_client device */ | |
c807da53 | 959 | struct i2c_client *of_find_i2c_device_by_node(struct device_node *node); |
687b81d0 WS |
960 | |
961 | /* must call put_device() when done with returned i2c_adapter device */ | |
c807da53 | 962 | struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node); |
687b81d0 | 963 | |
48e9743d VZ |
964 | /* must call i2c_put_adapter() when done with returned i2c_adapter device */ |
965 | struct i2c_adapter *of_get_i2c_adapter_by_node(struct device_node *node); | |
e1dba01c | 966 | |
c807da53 | 967 | const struct of_device_id |
298d4de1 LJ |
968 | *i2c_of_match_device(const struct of_device_id *matches, |
969 | struct i2c_client *client); | |
970 | ||
da0086d0 BB |
971 | int of_i2c_get_board_info(struct device *dev, struct device_node *node, |
972 | struct i2c_board_info *info); | |
973 | ||
687b81d0 WS |
974 | #else |
975 | ||
976 | static inline struct i2c_client *of_find_i2c_device_by_node(struct device_node *node) | |
977 | { | |
978 | return NULL; | |
979 | } | |
980 | ||
981 | static inline struct i2c_adapter *of_find_i2c_adapter_by_node(struct device_node *node) | |
982 | { | |
983 | return NULL; | |
984 | } | |
48e9743d VZ |
985 | |
986 | static inline struct i2c_adapter *of_get_i2c_adapter_by_node(struct device_node *node) | |
987 | { | |
988 | return NULL; | |
989 | } | |
298d4de1 LJ |
990 | |
991 | static inline const struct of_device_id | |
992 | *i2c_of_match_device(const struct of_device_id *matches, | |
993 | struct i2c_client *client) | |
994 | { | |
995 | return NULL; | |
996 | } | |
997 | ||
da0086d0 BB |
998 | static inline int of_i2c_get_board_info(struct device *dev, |
999 | struct device_node *node, | |
1000 | struct i2c_board_info *info) | |
1001 | { | |
1002 | return -ENOTSUPP; | |
1003 | } | |
1004 | ||
687b81d0 WS |
1005 | #endif /* CONFIG_OF */ |
1006 | ||
b33a02aa AS |
1007 | struct acpi_resource; |
1008 | struct acpi_resource_i2c_serialbus; | |
1009 | ||
5853b22d | 1010 | #if IS_ENABLED(CONFIG_ACPI) |
b33a02aa AS |
1011 | bool i2c_acpi_get_i2c_resource(struct acpi_resource *ares, |
1012 | struct acpi_resource_i2c_serialbus **i2c); | |
5853b22d | 1013 | u32 i2c_acpi_find_bus_speed(struct device *dev); |
605f8fc2 HG |
1014 | struct i2c_client *i2c_acpi_new_device(struct device *dev, int index, |
1015 | struct i2c_board_info *info); | |
5213d7ef | 1016 | struct i2c_adapter *i2c_acpi_find_adapter_by_handle(acpi_handle handle); |
5853b22d | 1017 | #else |
b33a02aa AS |
1018 | static inline bool i2c_acpi_get_i2c_resource(struct acpi_resource *ares, |
1019 | struct acpi_resource_i2c_serialbus **i2c) | |
1020 | { | |
1021 | return false; | |
1022 | } | |
5853b22d JN |
1023 | static inline u32 i2c_acpi_find_bus_speed(struct device *dev) |
1024 | { | |
1025 | return 0; | |
1026 | } | |
605f8fc2 HG |
1027 | static inline struct i2c_client *i2c_acpi_new_device(struct device *dev, |
1028 | int index, struct i2c_board_info *info) | |
1029 | { | |
8be23aec | 1030 | return ERR_PTR(-ENODEV); |
605f8fc2 | 1031 | } |
5213d7ef RB |
1032 | static inline struct i2c_adapter *i2c_acpi_find_adapter_by_handle(acpi_handle handle) |
1033 | { | |
1034 | return NULL; | |
1035 | } | |
5853b22d JN |
1036 | #endif /* CONFIG_ACPI */ |
1037 | ||
1da177e4 | 1038 | #endif /* _LINUX_I2C_H */ |