blob: e45e33f5037dacd5b805e89ae9caf7a419c9fb7c [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
wdenk1f045212002-03-10 14:37:15 +00002/*
Heiko Schocher385c9ef2012-01-16 21:12:23 +00003 * Copyright (C) 2009 Sergey Kubushyn <ksi@koi8.net>
4 * Copyright (C) 2009 - 2013 Heiko Schocher <hs@denx.de>
5 * Changes for multibus/multiadapter I2C support.
6 *
wdenk1f045212002-03-10 14:37:15 +00007 * (C) Copyright 2001
8 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com.
9 *
wdenk1f045212002-03-10 14:37:15 +000010 * The original I2C interface was
11 * (C) 2000 by Paolo Scaffardi (arsenio@tin.it)
12 * AIRVENT SAM s.p.a - RIMINI(ITALY)
13 * but has been changed substantially.
14 */
15
16#ifndef _I2C_H_
17#define _I2C_H_
18
Simon Glassf7ae49f2020-05-10 11:40:05 -060019#include <linker_lists.h>
20
wdenk1f045212002-03-10 14:37:15 +000021/*
Simon Glassc6202d82014-12-10 08:55:47 -070022 * For now there are essentially two parts to this file - driver model
23 * here at the top, and the older code below (with CONFIG_SYS_I2C being
24 * most recent). The plan is to migrate everything to driver model.
25 * The driver model structures and API are separate as they are different
26 * enough as to be incompatible for compilation purposes.
27 */
28
Simon Glassc6202d82014-12-10 08:55:47 -070029enum dm_i2c_chip_flags {
30 DM_I2C_CHIP_10BIT = 1 << 0, /* Use 10-bit addressing */
31 DM_I2C_CHIP_RD_ADDRESS = 1 << 1, /* Send address for each read byte */
32 DM_I2C_CHIP_WR_ADDRESS = 1 << 2, /* Send address for each write byte */
33};
34
Simon Glass7bd21b62020-01-23 11:48:16 -070035/** enum i2c_speed_mode - standard I2C speed modes */
36enum i2c_speed_mode {
37 IC_SPEED_MODE_STANDARD,
38 IC_SPEED_MODE_FAST,
39 IC_SPEED_MODE_FAST_PLUS,
40 IC_SPEED_MODE_HIGH,
41 IC_SPEED_MODE_FAST_ULTRA,
42
43 IC_SPEED_MODE_COUNT,
44};
45
46/** enum i2c_speed_rate - standard I2C speeds in Hz */
47enum i2c_speed_rate {
48 I2C_SPEED_STANDARD_RATE = 100000,
49 I2C_SPEED_FAST_RATE = 400000,
50 I2C_SPEED_FAST_PLUS_RATE = 1000000,
51 I2C_SPEED_HIGH_RATE = 3400000,
52 I2C_SPEED_FAST_ULTRA_RATE = 5000000,
53};
54
55/** enum i2c_address_mode - available address modes */
56enum i2c_address_mode {
57 I2C_MODE_7_BIT,
58 I2C_MODE_10_BIT
59};
60
Simon Glassfd42f262020-09-22 12:45:01 -060061/** enum i2c_device_t - Types of I2C devices, used for compatible strings */
62enum i2c_device_t {
63 I2C_DEVICE_GENERIC,
64 I2C_DEVICE_HID_OVER_I2C,
65};
66
Simon Glassfffff722015-02-05 21:41:33 -070067struct udevice;
Simon Glassc6202d82014-12-10 08:55:47 -070068/**
69 * struct dm_i2c_chip - information about an i2c chip
70 *
71 * An I2C chip is a device on the I2C bus. It sits at a particular address
72 * and normally supports 7-bit or 10-bit addressing.
73 *
Simon Glasscaa4daa2020-12-03 16:55:18 -070074 * To obtain this structure, use dev_get_parent_plat(dev) where dev is
Simon Glasse6f66ec2015-01-25 08:27:13 -070075 * the chip to examine.
Simon Glassc6202d82014-12-10 08:55:47 -070076 *
77 * @chip_addr: Chip address on bus
78 * @offset_len: Length of offset in bytes. A single byte offset can
79 * represent up to 256 bytes. A value larger than 1 may be
80 * needed for larger devices.
81 * @flags: Flags for this chip (dm_i2c_chip_flags)
Robert Beckett85968522019-10-28 17:44:57 +000082 * @chip_addr_offset_mask: Mask of offset bits within chip_addr. Used for
83 * devices which steal addresses as part of offset.
84 * If offset_len is zero, then the offset is encoded
85 * completely within the chip address itself.
86 * e.g. a devce with chip address of 0x2c with 512
87 * registers might use the bottom bit of the address
88 * to indicate which half of the address space is being
89 * accessed while still only using 1 byte offset.
90 * This means it will respond to chip address 0x2c and
91 * 0x2d.
92 * A real world example is the Atmel AT24C04. It's
93 * datasheet explains it's usage of this addressing
94 * mode.
Simon Glassc6202d82014-12-10 08:55:47 -070095 * @emul: Emulator for this chip address (only used for emulation)
96 */
97struct dm_i2c_chip {
98 uint chip_addr;
99 uint offset_len;
100 uint flags;
Robert Beckett85968522019-10-28 17:44:57 +0000101 uint chip_addr_offset_mask;
Simon Glassc6202d82014-12-10 08:55:47 -0700102#ifdef CONFIG_SANDBOX
103 struct udevice *emul;
Simon Glass182bf922015-04-20 12:37:15 -0600104 bool test_mode;
Simon Glassc6202d82014-12-10 08:55:47 -0700105#endif
106};
107
108/**
109 * struct dm_i2c_bus- information about an i2c bus
110 *
111 * An I2C bus contains 0 or more chips on it, each at its own address. The
112 * bus can operate at different speeds (measured in Hz, typically 100KHz
113 * or 400KHz).
114 *
Simon Glasse564f052015-03-05 12:25:20 -0700115 * To obtain this structure, use dev_get_uclass_priv(bus) where bus is the
116 * I2C bus udevice.
Simon Glassc6202d82014-12-10 08:55:47 -0700117 *
118 * @speed_hz: Bus speed in hertz (typically 100000)
Lukasz Majewskia40fe212019-04-04 12:35:34 +0200119 * @max_transaction_bytes: Maximal size of single I2C transfer
Simon Glassc6202d82014-12-10 08:55:47 -0700120 */
121struct dm_i2c_bus {
122 int speed_hz;
Lukasz Majewskia40fe212019-04-04 12:35:34 +0200123 int max_transaction_bytes;
Simon Glassc6202d82014-12-10 08:55:47 -0700124};
125
Simon Glass7fc65bc2015-07-02 18:15:41 -0600126/*
127 * Not all of these flags are implemented in the U-Boot API
128 */
129enum dm_i2c_msg_flags {
130 I2C_M_TEN = 0x0010, /* ten-bit chip address */
131 I2C_M_RD = 0x0001, /* read data, from slave to master */
132 I2C_M_STOP = 0x8000, /* send stop after this message */
133 I2C_M_NOSTART = 0x4000, /* no start before this message */
134 I2C_M_REV_DIR_ADDR = 0x2000, /* invert polarity of R/W bit */
135 I2C_M_IGNORE_NAK = 0x1000, /* continue after NAK */
136 I2C_M_NO_RD_ACK = 0x0800, /* skip the Ack bit on reads */
137 I2C_M_RECV_LEN = 0x0400, /* length is first received byte */
138};
139
140/**
141 * struct i2c_msg - an I2C message
142 *
143 * @addr: Slave address
144 * @flags: Flags (see enum dm_i2c_msg_flags)
145 * @len: Length of buffer in bytes, may be 0 for a probe
146 * @buf: Buffer to send/receive, or NULL if no data
147 */
148struct i2c_msg {
149 uint addr;
150 uint flags;
151 uint len;
152 u8 *buf;
153};
154
155/**
156 * struct i2c_msg_list - a list of I2C messages
157 *
158 * This is called i2c_rdwr_ioctl_data in Linux but the name does not seem
159 * appropriate in U-Boot.
160 *
161 * @msg: Pointer to i2c_msg array
162 * @nmsgs: Number of elements in the array
163 */
164struct i2c_msg_list {
165 struct i2c_msg *msgs;
166 uint nmsgs;
167};
168
Simon Glassc6202d82014-12-10 08:55:47 -0700169/**
Simon Glassf9a4c2d2015-01-12 18:02:07 -0700170 * dm_i2c_read() - read bytes from an I2C chip
Simon Glassc6202d82014-12-10 08:55:47 -0700171 *
172 * To obtain an I2C device (called a 'chip') given the I2C bus address you
173 * can use i2c_get_chip(). To obtain a bus by bus number use
174 * uclass_get_device_by_seq(UCLASS_I2C, <bus number>).
175 *
176 * To set the address length of a devce use i2c_set_addr_len(). It
177 * defaults to 1.
178 *
179 * @dev: Chip to read from
180 * @offset: Offset within chip to start reading
181 * @buffer: Place to put data
182 * @len: Number of bytes to read
183 *
184 * @return 0 on success, -ve on failure
185 */
Simon Glassf9a4c2d2015-01-12 18:02:07 -0700186int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len);
Simon Glassc6202d82014-12-10 08:55:47 -0700187
188/**
Simon Glassf9a4c2d2015-01-12 18:02:07 -0700189 * dm_i2c_write() - write bytes to an I2C chip
Simon Glassc6202d82014-12-10 08:55:47 -0700190 *
Simon Glassf9a4c2d2015-01-12 18:02:07 -0700191 * See notes for dm_i2c_read() above.
Simon Glassc6202d82014-12-10 08:55:47 -0700192 *
193 * @dev: Chip to write to
194 * @offset: Offset within chip to start writing
195 * @buffer: Buffer containing data to write
196 * @len: Number of bytes to write
197 *
198 * @return 0 on success, -ve on failure
199 */
Simon Glassf9a4c2d2015-01-12 18:02:07 -0700200int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer,
201 int len);
Simon Glassc6202d82014-12-10 08:55:47 -0700202
203/**
Simon Glassf9a4c2d2015-01-12 18:02:07 -0700204 * dm_i2c_probe() - probe a particular chip address
Simon Glassc6202d82014-12-10 08:55:47 -0700205 *
206 * This can be useful to check for the existence of a chip on the bus.
207 * It is typically implemented by writing the chip address to the bus
208 * and checking that the chip replies with an ACK.
209 *
210 * @bus: Bus to probe
211 * @chip_addr: 7-bit address to probe (10-bit and others are not supported)
212 * @chip_flags: Flags for the probe (see enum dm_i2c_chip_flags)
213 * @devp: Returns the device found, or NULL if none
214 * @return 0 if a chip was found at that address, -ve if not
215 */
Simon Glassf9a4c2d2015-01-12 18:02:07 -0700216int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags,
217 struct udevice **devp);
Simon Glassc6202d82014-12-10 08:55:47 -0700218
219/**
Simon Glassba3864f2015-04-20 12:37:14 -0600220 * dm_i2c_reg_read() - Read a value from an I2C register
221 *
222 * This reads a single value from the given address in an I2C chip
223 *
Simon Glass25a0fb42015-07-02 18:15:40 -0600224 * @dev: Device to use for transfer
Simon Glassba3864f2015-04-20 12:37:14 -0600225 * @addr: Address to read from
226 * @return value read, or -ve on error
227 */
228int dm_i2c_reg_read(struct udevice *dev, uint offset);
229
230/**
231 * dm_i2c_reg_write() - Write a value to an I2C register
232 *
233 * This writes a single value to the given address in an I2C chip
234 *
Simon Glass25a0fb42015-07-02 18:15:40 -0600235 * @dev: Device to use for transfer
Simon Glassba3864f2015-04-20 12:37:14 -0600236 * @addr: Address to write to
237 * @val: Value to write (normally a byte)
238 * @return 0 on success, -ve on error
239 */
240int dm_i2c_reg_write(struct udevice *dev, uint offset, unsigned int val);
241
242/**
Simon Glassdf358c62015-07-02 18:15:42 -0600243 * dm_i2c_xfer() - Transfer messages over I2C
244 *
245 * This transfers a raw message. It is best to use dm_i2c_reg_read/write()
246 * instead.
247 *
248 * @dev: Device to use for transfer
249 * @msg: List of messages to transfer
250 * @nmsgs: Number of messages to transfer
251 * @return 0 on success, -ve on error
252 */
253int dm_i2c_xfer(struct udevice *dev, struct i2c_msg *msg, int nmsgs);
254
255/**
Simon Glassca88b9b2015-02-05 21:41:32 -0700256 * dm_i2c_set_bus_speed() - set the speed of a bus
Simon Glassc6202d82014-12-10 08:55:47 -0700257 *
258 * @bus: Bus to adjust
259 * @speed: Requested speed in Hz
260 * @return 0 if OK, -EINVAL for invalid values
261 */
Simon Glassca88b9b2015-02-05 21:41:32 -0700262int dm_i2c_set_bus_speed(struct udevice *bus, unsigned int speed);
Simon Glassc6202d82014-12-10 08:55:47 -0700263
264/**
Simon Glassca88b9b2015-02-05 21:41:32 -0700265 * dm_i2c_get_bus_speed() - get the speed of a bus
Simon Glassc6202d82014-12-10 08:55:47 -0700266 *
267 * @bus: Bus to check
268 * @return speed of selected I2C bus in Hz, -ve on error
269 */
Simon Glassca88b9b2015-02-05 21:41:32 -0700270int dm_i2c_get_bus_speed(struct udevice *bus);
Simon Glassc6202d82014-12-10 08:55:47 -0700271
272/**
273 * i2c_set_chip_flags() - set flags for a chip
274 *
275 * Typically addresses are 7 bits, but for 10-bit addresses you should set
276 * flags to DM_I2C_CHIP_10BIT. All accesses will then use 10-bit addressing.
277 *
278 * @dev: Chip to adjust
279 * @flags: New flags
280 * @return 0 if OK, -EINVAL if value is unsupported, other -ve value on error
281 */
282int i2c_set_chip_flags(struct udevice *dev, uint flags);
283
284/**
285 * i2c_get_chip_flags() - get flags for a chip
286 *
287 * @dev: Chip to check
288 * @flagsp: Place to put flags
289 * @return 0 if OK, other -ve value on error
290 */
291int i2c_get_chip_flags(struct udevice *dev, uint *flagsp);
292
293/**
294 * i2c_set_offset_len() - set the offset length for a chip
295 *
296 * The offset used to access a chip may be up to 4 bytes long. Typically it
297 * is only 1 byte, which is enough for chips with 256 bytes of memory or
298 * registers. The default value is 1, but you can call this function to
299 * change it.
300 *
301 * @offset_len: New offset length value (typically 1 or 2)
302 */
Simon Glassc6202d82014-12-10 08:55:47 -0700303int i2c_set_chip_offset_len(struct udevice *dev, uint offset_len);
Simon Glass01501802015-05-04 11:30:58 -0600304
305/**
306 * i2c_get_offset_len() - get the offset length for a chip
307 *
308 * @return: Current offset length value (typically 1 or 2)
309 */
310int i2c_get_chip_offset_len(struct udevice *dev);
311
Simon Glassc6202d82014-12-10 08:55:47 -0700312/**
Robert Beckett85968522019-10-28 17:44:57 +0000313 * i2c_set_chip_addr_offset_mask() - set mask of address bits usable by offset
314 *
315 * Some devices listen on multiple chip addresses to achieve larger offsets
316 * than their single or multiple byte offsets would allow for. You can use this
317 * function to set the bits that are valid to be used for offset overflow.
318 *
319 * @mask: The mask to be used for high offset bits within address
320 * @return 0 if OK, other -ve value on error
321 */
322int i2c_set_chip_addr_offset_mask(struct udevice *dev, uint mask);
323
324/*
325 * i2c_get_chip_addr_offset_mask() - get mask of address bits usable by offset
326 *
327 * @return current chip addr offset mask
328 */
329uint i2c_get_chip_addr_offset_mask(struct udevice *dev);
330
331/**
Simon Glassc6202d82014-12-10 08:55:47 -0700332 * i2c_deblock() - recover a bus that is in an unknown state
333 *
334 * See the deblock() method in 'struct dm_i2c_ops' for full information
335 *
336 * @bus: Bus to recover
337 * @return 0 if OK, -ve on error
338 */
339int i2c_deblock(struct udevice *bus);
340
Simon Glassc6202d82014-12-10 08:55:47 -0700341/**
Marek Vasut72315222020-02-07 16:57:50 +0100342 * i2c_deblock_gpio_loop() - recover a bus from an unknown state by toggling SDA/SCL
343 *
344 * This is the inner logic used for toggling I2C SDA/SCL lines as GPIOs
345 * for deblocking the I2C bus.
346 *
347 * @sda_pin: SDA GPIO
348 * @scl_pin: SCL GPIO
349 * @scl_count: Number of SCL clock cycles generated to deblock SDA
Marek Vasuta1917282020-02-07 16:57:51 +0100350 * @start_count:Number of I2C start conditions sent after deblocking SDA
Marek Vasut72315222020-02-07 16:57:50 +0100351 * @delay: Delay between SCL clock line changes
352 * @return 0 if OK, -ve on error
353 */
354struct gpio_desc;
355int i2c_deblock_gpio_loop(struct gpio_desc *sda_pin, struct gpio_desc *scl_pin,
Marek Vasuta1917282020-02-07 16:57:51 +0100356 unsigned int scl_count, unsigned int start_count,
357 unsigned int delay);
Marek Vasut72315222020-02-07 16:57:50 +0100358
359/**
Simon Glassc6202d82014-12-10 08:55:47 -0700360 * struct dm_i2c_ops - driver operations for I2C uclass
361 *
362 * Drivers should support these operations unless otherwise noted. These
363 * operations are intended to be used by uclass code, not directly from
364 * other code.
365 */
366struct dm_i2c_ops {
367 /**
368 * xfer() - transfer a list of I2C messages
369 *
370 * @bus: Bus to read from
371 * @msg: List of messages to transfer
372 * @nmsgs: Number of messages in the list
373 * @return 0 if OK, -EREMOTEIO if the slave did not ACK a byte,
374 * -ECOMM if the speed cannot be supported, -EPROTO if the chip
375 * flags cannot be supported, other -ve value on some other error
376 */
377 int (*xfer)(struct udevice *bus, struct i2c_msg *msg, int nmsgs);
378
379 /**
380 * probe_chip() - probe for the presense of a chip address
381 *
382 * This function is optional. If omitted, the uclass will send a zero
383 * length message instead.
384 *
385 * @bus: Bus to probe
386 * @chip_addr: Chip address to probe
387 * @chip_flags: Probe flags (enum dm_i2c_chip_flags)
388 * @return 0 if chip was found, -EREMOTEIO if not, -ENOSYS to fall back
389 * to default probem other -ve value on error
390 */
391 int (*probe_chip)(struct udevice *bus, uint chip_addr, uint chip_flags);
392
393 /**
394 * set_bus_speed() - set the speed of a bus (optional)
395 *
396 * The bus speed value will be updated by the uclass if this function
397 * does not return an error. This method is optional - if it is not
398 * provided then the driver can read the speed from
Simon Glasse564f052015-03-05 12:25:20 -0700399 * dev_get_uclass_priv(bus)->speed_hz
Simon Glassc6202d82014-12-10 08:55:47 -0700400 *
401 * @bus: Bus to adjust
402 * @speed: Requested speed in Hz
403 * @return 0 if OK, -EINVAL for invalid values
404 */
405 int (*set_bus_speed)(struct udevice *bus, unsigned int speed);
406
407 /**
408 * get_bus_speed() - get the speed of a bus (optional)
409 *
410 * Normally this can be provided by the uclass, but if you want your
411 * driver to check the bus speed by looking at the hardware, you can
412 * implement that here. This method is optional. This method would
Simon Glasse564f052015-03-05 12:25:20 -0700413 * normally be expected to return dev_get_uclass_priv(bus)->speed_hz.
Simon Glassc6202d82014-12-10 08:55:47 -0700414 *
415 * @bus: Bus to check
416 * @return speed of selected I2C bus in Hz, -ve on error
417 */
418 int (*get_bus_speed)(struct udevice *bus);
419
420 /**
421 * set_flags() - set the flags for a chip (optional)
422 *
423 * This is generally implemented by the uclass, but drivers can
424 * check the value to ensure that unsupported options are not used.
425 * This method is optional. If provided, this method will always be
426 * called when the flags change.
427 *
428 * @dev: Chip to adjust
429 * @flags: New flags value
430 * @return 0 if OK, -EINVAL if value is unsupported
431 */
432 int (*set_flags)(struct udevice *dev, uint flags);
433
434 /**
435 * deblock() - recover a bus that is in an unknown state
436 *
437 * I2C is a synchronous protocol and resets of the processor in the
438 * middle of an access can block the I2C Bus until a powerdown of
439 * the full unit is done. This is because slaves can be stuck
440 * waiting for addition bus transitions for a transaction that will
441 * never complete. Resetting the I2C master does not help. The only
442 * way is to force the bus through a series of transitions to make
443 * sure that all slaves are done with the transaction. This method
444 * performs this 'deblocking' if support by the driver.
445 *
446 * This method is optional.
447 */
448 int (*deblock)(struct udevice *bus);
449};
450
451#define i2c_get_ops(dev) ((struct dm_i2c_ops *)(dev)->driver->ops)
452
453/**
Simon Glass3d1957f2015-08-03 08:19:21 -0600454 * struct i2c_mux_ops - operations for an I2C mux
455 *
456 * The current mux state is expected to be stored in the mux itself since
457 * it is the only thing that knows how to make things work. The mux can
458 * record the current state and then avoid switching unless it is necessary.
459 * So select() can be skipped if the mux is already in the correct state.
460 * Also deselect() can be made a nop if required.
461 */
462struct i2c_mux_ops {
463 /**
464 * select() - select one of of I2C buses attached to a mux
465 *
466 * This will be called when there is no bus currently selected by the
467 * mux. This method does not need to deselect the old bus since
468 * deselect() will be already have been called if necessary.
469 *
470 * @mux: Mux device
471 * @bus: I2C bus to select
472 * @channel: Channel number correponding to the bus to select
473 * @return 0 if OK, -ve on error
474 */
475 int (*select)(struct udevice *mux, struct udevice *bus, uint channel);
476
477 /**
478 * deselect() - select one of of I2C buses attached to a mux
479 *
480 * This is used to deselect the currently selected I2C bus.
481 *
482 * @mux: Mux device
483 * @bus: I2C bus to deselect
484 * @channel: Channel number correponding to the bus to deselect
485 * @return 0 if OK, -ve on error
486 */
487 int (*deselect)(struct udevice *mux, struct udevice *bus, uint channel);
488};
489
490#define i2c_mux_get_ops(dev) ((struct i2c_mux_ops *)(dev)->driver->ops)
491
492/**
Simon Glassc6202d82014-12-10 08:55:47 -0700493 * i2c_get_chip() - get a device to use to access a chip on a bus
494 *
495 * This returns the device for the given chip address. The device can then
496 * be used with calls to i2c_read(), i2c_write(), i2c_probe(), etc.
497 *
498 * @bus: Bus to examine
499 * @chip_addr: Chip address for the new device
Simon Glass25ab4b02015-01-25 08:26:55 -0700500 * @offset_len: Length of a register offset in bytes (normally 1)
Simon Glassc6202d82014-12-10 08:55:47 -0700501 * @devp: Returns pointer to new device if found or -ENODEV if not
502 * found
503 */
Simon Glass25ab4b02015-01-25 08:26:55 -0700504int i2c_get_chip(struct udevice *bus, uint chip_addr, uint offset_len,
505 struct udevice **devp);
Simon Glassc6202d82014-12-10 08:55:47 -0700506
507/**
Stefan Roesea06728c2015-11-25 07:41:58 +0100508 * i2c_get_chip_for_busnum() - get a device to use to access a chip on
509 * a bus number
Simon Glassc6202d82014-12-10 08:55:47 -0700510 *
511 * This returns the device for the given chip address on a particular bus
512 * number.
513 *
514 * @busnum: Bus number to examine
515 * @chip_addr: Chip address for the new device
Simon Glass25ab4b02015-01-25 08:26:55 -0700516 * @offset_len: Length of a register offset in bytes (normally 1)
Simon Glassc6202d82014-12-10 08:55:47 -0700517 * @devp: Returns pointer to new device if found or -ENODEV if not
518 * found
519 */
Simon Glass25ab4b02015-01-25 08:26:55 -0700520int i2c_get_chip_for_busnum(int busnum, int chip_addr, uint offset_len,
521 struct udevice **devp);
Simon Glassc6202d82014-12-10 08:55:47 -0700522
523/**
Simon Glassd1998a92020-12-03 16:55:21 -0700524 * i2c_chip_of_to_plat() - Decode standard I2C platform data
Simon Glassc6202d82014-12-10 08:55:47 -0700525 *
526 * This decodes the chip address from a device tree node and puts it into
527 * its dm_i2c_chip structure. This should be called in your driver's
Simon Glassd1998a92020-12-03 16:55:21 -0700528 * of_to_plat() method.
Simon Glassc6202d82014-12-10 08:55:47 -0700529 *
530 * @blob: Device tree blob
531 * @node: Node offset to read from
532 * @spi: Place to put the decoded information
533 */
Simon Glassd1998a92020-12-03 16:55:21 -0700534int i2c_chip_of_to_plat(struct udevice *dev, struct dm_i2c_chip *chip);
Simon Glassc6202d82014-12-10 08:55:47 -0700535
Simon Glass7d7db222015-07-02 18:15:39 -0600536/**
537 * i2c_dump_msgs() - Dump a list of I2C messages
538 *
539 * This may be useful for debugging.
540 *
541 * @msg: Message list to dump
542 * @nmsgs: Number of messages
543 */
544void i2c_dump_msgs(struct i2c_msg *msg, int nmsgs);
545
Simon Glassb7c25b12018-11-18 08:14:33 -0700546/**
547 * i2c_emul_find() - Find an emulator for an i2c sandbox device
548 *
549 * This looks at the device's 'emul' phandle
550 *
551 * @dev: Device to find an emulator for
552 * @emulp: Returns the associated emulator, if found *
553 * @return 0 if OK, -ENOENT or -ENODEV if not found
554 */
555int i2c_emul_find(struct udevice *dev, struct udevice **emulp);
556
557/**
558 * i2c_emul_get_device() - Find the device being emulated
559 *
560 * Given an emulator this returns the associated device
561 *
562 * @emul: Emulator for the device
563 * @return device that @emul is emulating
564 */
565struct udevice *i2c_emul_get_device(struct udevice *emul);
566
Simon Glassfd42f262020-09-22 12:45:01 -0600567/* ACPI operations for generic I2C devices */
568extern struct acpi_ops i2c_acpi_ops;
569
570/**
Simon Glassd1998a92020-12-03 16:55:21 -0700571 * acpi_i2c_of_to_plat() - Read properties intended for ACPI
Simon Glassfd42f262020-09-22 12:45:01 -0600572 *
573 * This reads the generic I2C properties from the device tree, so that these
574 * can be used to create ACPI information for the device.
575 *
576 * See the i2c/generic-acpi.txt binding file for information about the
577 * properties.
578 *
579 * @dev: I2C device to process
580 * @return 0 if OK, -EINVAL if acpi,hid is not present
581 */
Simon Glassd1998a92020-12-03 16:55:21 -0700582int acpi_i2c_of_to_plat(struct udevice *dev);
Simon Glassfd42f262020-09-22 12:45:01 -0600583
Simon Glassc6202d82014-12-10 08:55:47 -0700584#ifndef CONFIG_DM_I2C
585
586/*
wdenk1f045212002-03-10 14:37:15 +0000587 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
588 *
589 * The implementation MUST NOT use static or global variables if the
590 * I2C routines are used to read SDRAM configuration information
591 * because this is done before the memories are initialized. Limited
592 * use of stack-based variables are OK (the initial stack size is
593 * limited).
594 *
595 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
596 */
597
598/*
599 * Configuration items.
600 */
601#define I2C_RXTX_LEN 128 /* maximum tx/rx buffer length */
602
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000603#if !defined(CONFIG_SYS_I2C_MAX_HOPS)
604/* no muxes used bus = i2c adapters */
605#define CONFIG_SYS_I2C_DIRECT_BUS 1
606#define CONFIG_SYS_I2C_MAX_HOPS 0
607#define CONFIG_SYS_NUM_I2C_BUSES ll_entry_count(struct i2c_adapter, i2c)
Stefan Roese79b2d0b2007-02-20 10:27:08 +0100608#else
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000609/* we use i2c muxes */
610#undef CONFIG_SYS_I2C_DIRECT_BUS
Stefan Roese79b2d0b2007-02-20 10:27:08 +0100611#endif
612
Stefan Roese8c120452007-03-01 07:03:25 +0100613/* define the I2C bus number for RTC and DTT if not already done */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200614#if !defined(CONFIG_SYS_RTC_BUS_NUM)
615#define CONFIG_SYS_RTC_BUS_NUM 0
Stefan Roese8c120452007-03-01 07:03:25 +0100616#endif
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200617#if !defined(CONFIG_SYS_SPD_BUS_NUM)
618#define CONFIG_SYS_SPD_BUS_NUM 0
Matthias Fuchsd8a8ea52007-03-08 16:20:32 +0100619#endif
Stefan Roese8c120452007-03-01 07:03:25 +0100620
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000621struct i2c_adapter {
622 void (*init)(struct i2c_adapter *adap, int speed,
623 int slaveaddr);
624 int (*probe)(struct i2c_adapter *adap, uint8_t chip);
625 int (*read)(struct i2c_adapter *adap, uint8_t chip,
626 uint addr, int alen, uint8_t *buffer,
627 int len);
628 int (*write)(struct i2c_adapter *adap, uint8_t chip,
629 uint addr, int alen, uint8_t *buffer,
630 int len);
631 uint (*set_bus_speed)(struct i2c_adapter *adap,
632 uint speed);
633 int speed;
Hannes Petermaierd5243352014-02-03 21:22:18 +0100634 int waitdelay;
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000635 int slaveaddr;
636 int init_done;
637 int hwadapnr;
638 char *name;
639};
640
641#define U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \
642 _set_speed, _speed, _slaveaddr, _hwadapnr, _name) \
643 { \
644 .init = _init, \
645 .probe = _probe, \
646 .read = _read, \
647 .write = _write, \
648 .set_bus_speed = _set_speed, \
649 .speed = _speed, \
650 .slaveaddr = _slaveaddr, \
651 .init_done = 0, \
652 .hwadapnr = _hwadapnr, \
653 .name = #_name \
654};
655
656#define U_BOOT_I2C_ADAP_COMPLETE(_name, _init, _probe, _read, _write, \
657 _set_speed, _speed, _slaveaddr, _hwadapnr) \
658 ll_entry_declare(struct i2c_adapter, _name, i2c) = \
659 U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \
660 _set_speed, _speed, _slaveaddr, _hwadapnr, _name);
661
662struct i2c_adapter *i2c_get_adapter(int index);
663
664#ifndef CONFIG_SYS_I2C_DIRECT_BUS
665struct i2c_mux {
666 int id;
667 char name[16];
668};
669
670struct i2c_next_hop {
671 struct i2c_mux mux;
672 uint8_t chip;
673 uint8_t channel;
674};
675
676struct i2c_bus_hose {
677 int adapter;
678 struct i2c_next_hop next_hop[CONFIG_SYS_I2C_MAX_HOPS];
679};
680#define I2C_NULL_HOP {{-1, ""}, 0, 0}
681extern struct i2c_bus_hose i2c_bus[];
682
683#define I2C_ADAPTER(bus) i2c_bus[bus].adapter
684#else
685#define I2C_ADAPTER(bus) bus
686#endif
687#define I2C_BUS gd->cur_i2c_bus
688
689#define I2C_ADAP_NR(bus) i2c_get_adapter(I2C_ADAPTER(bus))
690#define I2C_ADAP I2C_ADAP_NR(gd->cur_i2c_bus)
691#define I2C_ADAP_HWNR (I2C_ADAP->hwadapnr)
692
693#ifndef CONFIG_SYS_I2C_DIRECT_BUS
694#define I2C_MUX_PCA9540_ID 1
695#define I2C_MUX_PCA9540 {I2C_MUX_PCA9540_ID, "PCA9540B"}
696#define I2C_MUX_PCA9542_ID 2
697#define I2C_MUX_PCA9542 {I2C_MUX_PCA9542_ID, "PCA9542A"}
698#define I2C_MUX_PCA9544_ID 3
699#define I2C_MUX_PCA9544 {I2C_MUX_PCA9544_ID, "PCA9544A"}
700#define I2C_MUX_PCA9547_ID 4
701#define I2C_MUX_PCA9547 {I2C_MUX_PCA9547_ID, "PCA9547A"}
Michael Burre6658742013-09-23 22:35:45 +0000702#define I2C_MUX_PCA9548_ID 5
703#define I2C_MUX_PCA9548 {I2C_MUX_PCA9548_ID, "PCA9548"}
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000704#endif
705
Heiko Schocher98aed372008-10-15 09:35:26 +0200706#ifndef I2C_SOFT_DECLARATIONS
Heiko Schocher2eb48ff2017-06-07 17:33:10 +0200707# if (defined(CONFIG_AT91RM9200) || \
Jens Scharsig0cf0b932010-02-03 22:46:58 +0100708 defined(CONFIG_AT91SAM9260) || defined(CONFIG_AT91SAM9261) || \
Andreas Bießmanncb96a0a2013-10-30 15:18:18 +0100709 defined(CONFIG_AT91SAM9263))
esw@bus-elektronik.de78132272011-12-20 06:05:30 +0000710# define I2C_SOFT_DECLARATIONS at91_pio_t *pio = (at91_pio_t *) ATMEL_BASE_PIOA;
Heiko Schocher98aed372008-10-15 09:35:26 +0200711# else
712# define I2C_SOFT_DECLARATIONS
713# endif
714#endif
Timur Tabiecf5f072008-12-03 11:28:30 -0600715
Peter Tyser9c90a2c2009-04-24 15:34:05 -0500716/*
717 * Many boards/controllers/drivers don't support an I2C slave interface so
718 * provide a default slave address for them for use in common code. A real
719 * value for CONFIG_SYS_I2C_SLAVE should be defined for any board which does
720 * support a slave interface.
721 */
722#ifndef CONFIG_SYS_I2C_SLAVE
723#define CONFIG_SYS_I2C_SLAVE 0xfe
Timur Tabiecf5f072008-12-03 11:28:30 -0600724#endif
725
wdenk1f045212002-03-10 14:37:15 +0000726/*
727 * Initialization, must be called once on start up, may be called
728 * repeatedly to change the speed and slave addresses.
729 */
Yuan Yao9d10c2d2016-06-08 18:24:51 +0800730#ifdef CONFIG_SYS_I2C_EARLY_INIT
731void i2c_early_init_f(void);
732#endif
wdenk1f045212002-03-10 14:37:15 +0000733void i2c_init(int speed, int slaveaddr);
wdenk06d01db2003-03-14 20:47:52 +0000734void i2c_init_board(void);
wdenk1f045212002-03-10 14:37:15 +0000735
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000736#ifdef CONFIG_SYS_I2C
737/*
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000738 * i2c_get_bus_num:
739 *
740 * Returns index of currently active I2C bus. Zero-based.
741 */
742unsigned int i2c_get_bus_num(void);
Heiko Schocher67b23a32008-10-15 09:39:47 +0200743
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000744/*
745 * i2c_set_bus_num:
746 *
747 * Change the active I2C bus. Subsequent read/write calls will
748 * go to this one.
749 *
750 * bus - bus index, zero based
751 *
752 * Returns: 0 on success, not 0 on failure
753 *
754 */
755int i2c_set_bus_num(unsigned int bus);
Heiko Schocher67b23a32008-10-15 09:39:47 +0200756
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000757/*
758 * i2c_init_all():
759 *
760 * Initializes all I2C adapters in the system. All i2c_adap structures must
761 * be initialized beforehead with function pointers and data, including
762 * speed and slaveaddr. Returns 0 on success, non-0 on failure.
763 */
764void i2c_init_all(void);
Heiko Schocher67b23a32008-10-15 09:39:47 +0200765
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000766/*
767 * Probe the given I2C chip address. Returns 0 if a chip responded,
768 * not 0 on failure.
769 */
770int i2c_probe(uint8_t chip);
771
772/*
773 * Read/Write interface:
774 * chip: I2C chip address, range 0..127
775 * addr: Memory (register) address within the chip
776 * alen: Number of bytes to use for addr (typically 1, 2 for larger
777 * memories, 0 for register type devices with only one
778 * register)
779 * buffer: Where to read/write the data
780 * len: How many bytes to read/write
781 *
782 * Returns: 0 on success, not 0 on failure
783 */
784int i2c_read(uint8_t chip, unsigned int addr, int alen,
785 uint8_t *buffer, int len);
786
787int i2c_write(uint8_t chip, unsigned int addr, int alen,
788 uint8_t *buffer, int len);
789
790/*
791 * Utility routines to read/write registers.
792 */
793uint8_t i2c_reg_read(uint8_t addr, uint8_t reg);
794
795void i2c_reg_write(uint8_t addr, uint8_t reg, uint8_t val);
796
797/*
798 * i2c_set_bus_speed:
799 *
800 * Change the speed of the active I2C bus
801 *
802 * speed - bus speed in Hz
803 *
804 * Returns: new bus speed
805 *
806 */
807unsigned int i2c_set_bus_speed(unsigned int speed);
808
809/*
810 * i2c_get_bus_speed:
811 *
812 * Returns speed of currently active I2C bus in Hz
813 */
814
815unsigned int i2c_get_bus_speed(void);
816
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000817#else
Heiko Schocher67b23a32008-10-15 09:39:47 +0200818
wdenk1f045212002-03-10 14:37:15 +0000819/*
820 * Probe the given I2C chip address. Returns 0 if a chip responded,
821 * not 0 on failure.
822 */
823int i2c_probe(uchar chip);
824
825/*
826 * Read/Write interface:
827 * chip: I2C chip address, range 0..127
828 * addr: Memory (register) address within the chip
829 * alen: Number of bytes to use for addr (typically 1, 2 for larger
830 * memories, 0 for register type devices with only one
831 * register)
832 * buffer: Where to read/write the data
833 * len: How many bytes to read/write
834 *
835 * Returns: 0 on success, not 0 on failure
836 */
837int i2c_read(uchar chip, uint addr, int alen, uchar *buffer, int len);
838int i2c_write(uchar chip, uint addr, int alen, uchar *buffer, int len);
839
840/*
841 * Utility routines to read/write registers.
842 */
Timur Tabiecf5f072008-12-03 11:28:30 -0600843static inline u8 i2c_reg_read(u8 addr, u8 reg)
844{
845 u8 buf;
846
Timur Tabiecf5f072008-12-03 11:28:30 -0600847#ifdef DEBUG
848 printf("%s: addr=0x%02x, reg=0x%02x\n", __func__, addr, reg);
849#endif
850
Timur Tabiecf5f072008-12-03 11:28:30 -0600851 i2c_read(addr, reg, 1, &buf, 1);
Timur Tabiecf5f072008-12-03 11:28:30 -0600852
853 return buf;
854}
855
856static inline void i2c_reg_write(u8 addr, u8 reg, u8 val)
857{
Timur Tabiecf5f072008-12-03 11:28:30 -0600858#ifdef DEBUG
859 printf("%s: addr=0x%02x, reg=0x%02x, val=0x%02x\n",
860 __func__, addr, reg, val);
861#endif
862
Timur Tabiecf5f072008-12-03 11:28:30 -0600863 i2c_write(addr, reg, 1, &val, 1);
Timur Tabiecf5f072008-12-03 11:28:30 -0600864}
wdenk1f045212002-03-10 14:37:15 +0000865
Ben Warrenbb99ad62006-09-07 16:50:54 -0400866/*
867 * Functions for setting the current I2C bus and its speed
868 */
869
870/*
871 * i2c_set_bus_num:
872 *
873 * Change the active I2C bus. Subsequent read/write calls will
874 * go to this one.
875 *
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200876 * bus - bus index, zero based
Ben Warrenbb99ad62006-09-07 16:50:54 -0400877 *
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200878 * Returns: 0 on success, not 0 on failure
Ben Warrenbb99ad62006-09-07 16:50:54 -0400879 *
880 */
Timur Tabi9ca880a2006-10-31 21:23:16 -0600881int i2c_set_bus_num(unsigned int bus);
Ben Warrenbb99ad62006-09-07 16:50:54 -0400882
883/*
884 * i2c_get_bus_num:
885 *
886 * Returns index of currently active I2C bus. Zero-based.
887 */
888
Timur Tabi9ca880a2006-10-31 21:23:16 -0600889unsigned int i2c_get_bus_num(void);
Ben Warrenbb99ad62006-09-07 16:50:54 -0400890
891/*
892 * i2c_set_bus_speed:
893 *
894 * Change the speed of the active I2C bus
895 *
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200896 * speed - bus speed in Hz
Ben Warrenbb99ad62006-09-07 16:50:54 -0400897 *
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200898 * Returns: 0 on success, not 0 on failure
Ben Warrenbb99ad62006-09-07 16:50:54 -0400899 *
900 */
Timur Tabi9ca880a2006-10-31 21:23:16 -0600901int i2c_set_bus_speed(unsigned int);
Ben Warrenbb99ad62006-09-07 16:50:54 -0400902
903/*
904 * i2c_get_bus_speed:
905 *
906 * Returns speed of currently active I2C bus in Hz
907 */
908
Timur Tabi9ca880a2006-10-31 21:23:16 -0600909unsigned int i2c_get_bus_speed(void);
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000910#endif /* CONFIG_SYS_I2C */
911
912/*
913 * only for backwardcompatibility, should go away if we switched
914 * completely to new multibus support.
915 */
916#if defined(CONFIG_SYS_I2C) || defined(CONFIG_I2C_MULTI_BUS)
917# if !defined(CONFIG_SYS_MAX_I2C_BUS)
918# define CONFIG_SYS_MAX_I2C_BUS 2
919# endif
Łukasz Majewskiea0f73a2013-08-16 15:31:45 +0200920# define I2C_MULTI_BUS 1
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000921#else
922# define CONFIG_SYS_MAX_I2C_BUS 1
923# define I2C_MULTI_BUS 0
924#endif
Ben Warrenbb99ad62006-09-07 16:50:54 -0400925
Marek Vasutcd7b4e82011-10-25 11:40:57 +0200926/* NOTE: These two functions MUST be always_inline to avoid code growth! */
927static inline unsigned int I2C_GET_BUS(void) __attribute__((always_inline));
928static inline unsigned int I2C_GET_BUS(void)
929{
930 return I2C_MULTI_BUS ? i2c_get_bus_num() : 0;
931}
932
933static inline void I2C_SET_BUS(unsigned int bus) __attribute__((always_inline));
934static inline void I2C_SET_BUS(unsigned int bus)
935{
936 if (I2C_MULTI_BUS)
937 i2c_set_bus_num(bus);
938}
939
Łukasz Majewski7ca8f732012-09-04 23:15:20 +0000940/* Multi I2C definitions */
941enum {
942 I2C_0, I2C_1, I2C_2, I2C_3, I2C_4, I2C_5, I2C_6, I2C_7,
943 I2C_8, I2C_9, I2C_10,
944};
945
Rajeshwari Shindea9d2ae72012-12-26 20:03:12 +0000946/**
947 * Get FDT values for i2c bus.
948 *
949 * @param blob Device tree blbo
950 * @return the number of I2C bus
951 */
952void board_i2c_init(const void *blob);
953
954/**
955 * Find the I2C bus number by given a FDT I2C node.
956 *
957 * @param blob Device tree blbo
958 * @param node FDT I2C node to find
959 * @return the number of I2C bus (zero based), or -1 on error
960 */
961int i2c_get_bus_num_fdt(int node);
962
963/**
964 * Reset the I2C bus represented by the given a FDT I2C node.
965 *
966 * @param blob Device tree blbo
967 * @param node FDT I2C node to find
968 * @return 0 if port was reset, -1 if not found
969 */
970int i2c_reset_port_fdt(const void *blob, int node);
Simon Glassc6202d82014-12-10 08:55:47 -0700971
972#endif /* !CONFIG_DM_I2C */
973
wdenk1f045212002-03-10 14:37:15 +0000974#endif /* _I2C_H_ */