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