blob: 47529f4b283fe1b1c73157148cb615480f46f15a [file] [log] [blame]
wdenk1f045212002-03-10 14:37:15 +00001/*
Heiko Schocher385c9ef2012-01-16 21:12:23 +00002 * Copyright (C) 2009 Sergey Kubushyn <ksi@koi8.net>
3 * Copyright (C) 2009 - 2013 Heiko Schocher <hs@denx.de>
4 * Changes for multibus/multiadapter I2C support.
5 *
wdenk1f045212002-03-10 14:37:15 +00006 * (C) Copyright 2001
7 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com.
8 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02009 * SPDX-License-Identifier: GPL-2.0+
wdenk1f045212002-03-10 14:37:15 +000010 *
11 * The original I2C interface was
12 * (C) 2000 by Paolo Scaffardi (arsenio@tin.it)
13 * AIRVENT SAM s.p.a - RIMINI(ITALY)
14 * but has been changed substantially.
15 */
16
17#ifndef _I2C_H_
18#define _I2C_H_
19
20/*
Simon Glassc6202d82014-12-10 08:55:47 -070021 * For now there are essentially two parts to this file - driver model
22 * here at the top, and the older code below (with CONFIG_SYS_I2C being
23 * most recent). The plan is to migrate everything to driver model.
24 * The driver model structures and API are separate as they are different
25 * enough as to be incompatible for compilation purposes.
26 */
27
28#ifdef CONFIG_DM_I2C
29
30enum dm_i2c_chip_flags {
31 DM_I2C_CHIP_10BIT = 1 << 0, /* Use 10-bit addressing */
32 DM_I2C_CHIP_RD_ADDRESS = 1 << 1, /* Send address for each read byte */
33 DM_I2C_CHIP_WR_ADDRESS = 1 << 2, /* Send address for each write byte */
34};
35
36/**
37 * struct dm_i2c_chip - information about an i2c chip
38 *
39 * An I2C chip is a device on the I2C bus. It sits at a particular address
40 * and normally supports 7-bit or 10-bit addressing.
41 *
42 * To obtain this structure, use dev_get_parentdata(dev) where dev is the
43 * chip to examine.
44 *
45 * @chip_addr: Chip address on bus
46 * @offset_len: Length of offset in bytes. A single byte offset can
47 * represent up to 256 bytes. A value larger than 1 may be
48 * needed for larger devices.
49 * @flags: Flags for this chip (dm_i2c_chip_flags)
50 * @emul: Emulator for this chip address (only used for emulation)
51 */
52struct dm_i2c_chip {
53 uint chip_addr;
54 uint offset_len;
55 uint flags;
56#ifdef CONFIG_SANDBOX
57 struct udevice *emul;
58#endif
59};
60
61/**
62 * struct dm_i2c_bus- information about an i2c bus
63 *
64 * An I2C bus contains 0 or more chips on it, each at its own address. The
65 * bus can operate at different speeds (measured in Hz, typically 100KHz
66 * or 400KHz).
67 *
68 * To obtain this structure, use bus->uclass_priv where bus is the I2C
69 * bus udevice.
70 *
71 * @speed_hz: Bus speed in hertz (typically 100000)
72 */
73struct dm_i2c_bus {
74 int speed_hz;
75};
76
77/**
Simon Glassf9a4c2d2015-01-12 18:02:07 -070078 * dm_i2c_read() - read bytes from an I2C chip
Simon Glassc6202d82014-12-10 08:55:47 -070079 *
80 * To obtain an I2C device (called a 'chip') given the I2C bus address you
81 * can use i2c_get_chip(). To obtain a bus by bus number use
82 * uclass_get_device_by_seq(UCLASS_I2C, <bus number>).
83 *
84 * To set the address length of a devce use i2c_set_addr_len(). It
85 * defaults to 1.
86 *
87 * @dev: Chip to read from
88 * @offset: Offset within chip to start reading
89 * @buffer: Place to put data
90 * @len: Number of bytes to read
91 *
92 * @return 0 on success, -ve on failure
93 */
Simon Glassf9a4c2d2015-01-12 18:02:07 -070094int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len);
Simon Glassc6202d82014-12-10 08:55:47 -070095
96/**
Simon Glassf9a4c2d2015-01-12 18:02:07 -070097 * dm_i2c_write() - write bytes to an I2C chip
Simon Glassc6202d82014-12-10 08:55:47 -070098 *
Simon Glassf9a4c2d2015-01-12 18:02:07 -070099 * See notes for dm_i2c_read() above.
Simon Glassc6202d82014-12-10 08:55:47 -0700100 *
101 * @dev: Chip to write to
102 * @offset: Offset within chip to start writing
103 * @buffer: Buffer containing data to write
104 * @len: Number of bytes to write
105 *
106 * @return 0 on success, -ve on failure
107 */
Simon Glassf9a4c2d2015-01-12 18:02:07 -0700108int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer,
109 int len);
Simon Glassc6202d82014-12-10 08:55:47 -0700110
111/**
Simon Glassf9a4c2d2015-01-12 18:02:07 -0700112 * dm_i2c_probe() - probe a particular chip address
Simon Glassc6202d82014-12-10 08:55:47 -0700113 *
114 * This can be useful to check for the existence of a chip on the bus.
115 * It is typically implemented by writing the chip address to the bus
116 * and checking that the chip replies with an ACK.
117 *
118 * @bus: Bus to probe
119 * @chip_addr: 7-bit address to probe (10-bit and others are not supported)
120 * @chip_flags: Flags for the probe (see enum dm_i2c_chip_flags)
121 * @devp: Returns the device found, or NULL if none
122 * @return 0 if a chip was found at that address, -ve if not
123 */
Simon Glassf9a4c2d2015-01-12 18:02:07 -0700124int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags,
125 struct udevice **devp);
Simon Glassc6202d82014-12-10 08:55:47 -0700126
127/**
128 * i2c_set_bus_speed() - set the speed of a bus
129 *
130 * @bus: Bus to adjust
131 * @speed: Requested speed in Hz
132 * @return 0 if OK, -EINVAL for invalid values
133 */
134int i2c_set_bus_speed(struct udevice *bus, unsigned int speed);
135
136/**
137 * i2c_get_bus_speed() - get the speed of a bus
138 *
139 * @bus: Bus to check
140 * @return speed of selected I2C bus in Hz, -ve on error
141 */
142int i2c_get_bus_speed(struct udevice *bus);
143
144/**
145 * i2c_set_chip_flags() - set flags for a chip
146 *
147 * Typically addresses are 7 bits, but for 10-bit addresses you should set
148 * flags to DM_I2C_CHIP_10BIT. All accesses will then use 10-bit addressing.
149 *
150 * @dev: Chip to adjust
151 * @flags: New flags
152 * @return 0 if OK, -EINVAL if value is unsupported, other -ve value on error
153 */
154int i2c_set_chip_flags(struct udevice *dev, uint flags);
155
156/**
157 * i2c_get_chip_flags() - get flags for a chip
158 *
159 * @dev: Chip to check
160 * @flagsp: Place to put flags
161 * @return 0 if OK, other -ve value on error
162 */
163int i2c_get_chip_flags(struct udevice *dev, uint *flagsp);
164
165/**
166 * i2c_set_offset_len() - set the offset length for a chip
167 *
168 * The offset used to access a chip may be up to 4 bytes long. Typically it
169 * is only 1 byte, which is enough for chips with 256 bytes of memory or
170 * registers. The default value is 1, but you can call this function to
171 * change it.
172 *
173 * @offset_len: New offset length value (typically 1 or 2)
174 */
175
176int i2c_set_chip_offset_len(struct udevice *dev, uint offset_len);
177/**
178 * i2c_deblock() - recover a bus that is in an unknown state
179 *
180 * See the deblock() method in 'struct dm_i2c_ops' for full information
181 *
182 * @bus: Bus to recover
183 * @return 0 if OK, -ve on error
184 */
185int i2c_deblock(struct udevice *bus);
186
Simon Glass73845352015-01-12 18:02:08 -0700187#ifdef CONFIG_DM_I2C_COMPAT
188/**
189 * i2c_probe() - Compatibility function for driver model
190 *
191 * Calls dm_i2c_probe() on the current bus
192 */
193int i2c_probe(uint8_t chip_addr);
194
195/**
196 * i2c_read() - Compatibility function for driver model
197 *
198 * Calls dm_i2c_read() with the device corresponding to @chip_addr, and offset
199 * set to @addr. @alen must match the current setting for the device.
200 */
201int i2c_read(uint8_t chip_addr, unsigned int addr, int alen, uint8_t *buffer,
202 int len);
203
204/**
205 * i2c_write() - Compatibility function for driver model
206 *
207 * Calls dm_i2c_write() with the device corresponding to @chip_addr, and offset
208 * set to @addr. @alen must match the current setting for the device.
209 */
210int i2c_write(uint8_t chip_addr, unsigned int addr, int alen, uint8_t *buffer,
211 int len);
212
213/**
214 * i2c_get_bus_num_fdt() - Compatibility function for driver model
215 *
216 * @return the bus number associated with the given device tree node
217 */
218int i2c_get_bus_num_fdt(int node);
219
220/**
221 * i2c_get_bus_num() - Compatibility function for driver model
222 *
223 * @return the 'current' bus number
224 */
225unsigned int i2c_get_bus_num(void);
226
227/**
228 * i2c_set_bus_num(): Compatibility function for driver model
229 *
230 * Sets the 'current' bus
231 */
232int i2c_set_bus_num(unsigned int bus);
233
234static inline void I2C_SET_BUS(unsigned int bus)
235{
236 i2c_set_bus_num(bus);
237}
238
239static inline unsigned int I2C_GET_BUS(void)
240{
241 return i2c_get_bus_num();
242}
243
244#endif
245
Simon Glassc6202d82014-12-10 08:55:47 -0700246/*
247 * Not all of these flags are implemented in the U-Boot API
248 */
249enum dm_i2c_msg_flags {
250 I2C_M_TEN = 0x0010, /* ten-bit chip address */
251 I2C_M_RD = 0x0001, /* read data, from slave to master */
252 I2C_M_STOP = 0x8000, /* send stop after this message */
253 I2C_M_NOSTART = 0x4000, /* no start before this message */
254 I2C_M_REV_DIR_ADDR = 0x2000, /* invert polarity of R/W bit */
255 I2C_M_IGNORE_NAK = 0x1000, /* continue after NAK */
256 I2C_M_NO_RD_ACK = 0x0800, /* skip the Ack bit on reads */
257 I2C_M_RECV_LEN = 0x0400, /* length is first received byte */
258};
259
260/**
261 * struct i2c_msg - an I2C message
262 *
263 * @addr: Slave address
264 * @flags: Flags (see enum dm_i2c_msg_flags)
265 * @len: Length of buffer in bytes, may be 0 for a probe
266 * @buf: Buffer to send/receive, or NULL if no data
267 */
268struct i2c_msg {
269 uint addr;
270 uint flags;
271 uint len;
272 u8 *buf;
273};
274
275/**
276 * struct i2c_msg_list - a list of I2C messages
277 *
278 * This is called i2c_rdwr_ioctl_data in Linux but the name does not seem
279 * appropriate in U-Boot.
280 *
281 * @msg: Pointer to i2c_msg array
282 * @nmsgs: Number of elements in the array
283 */
284struct i2c_msg_list {
285 struct i2c_msg *msgs;
286 uint nmsgs;
287};
288
289/**
290 * struct dm_i2c_ops - driver operations for I2C uclass
291 *
292 * Drivers should support these operations unless otherwise noted. These
293 * operations are intended to be used by uclass code, not directly from
294 * other code.
295 */
296struct dm_i2c_ops {
297 /**
298 * xfer() - transfer a list of I2C messages
299 *
300 * @bus: Bus to read from
301 * @msg: List of messages to transfer
302 * @nmsgs: Number of messages in the list
303 * @return 0 if OK, -EREMOTEIO if the slave did not ACK a byte,
304 * -ECOMM if the speed cannot be supported, -EPROTO if the chip
305 * flags cannot be supported, other -ve value on some other error
306 */
307 int (*xfer)(struct udevice *bus, struct i2c_msg *msg, int nmsgs);
308
309 /**
310 * probe_chip() - probe for the presense of a chip address
311 *
312 * This function is optional. If omitted, the uclass will send a zero
313 * length message instead.
314 *
315 * @bus: Bus to probe
316 * @chip_addr: Chip address to probe
317 * @chip_flags: Probe flags (enum dm_i2c_chip_flags)
318 * @return 0 if chip was found, -EREMOTEIO if not, -ENOSYS to fall back
319 * to default probem other -ve value on error
320 */
321 int (*probe_chip)(struct udevice *bus, uint chip_addr, uint chip_flags);
322
323 /**
324 * set_bus_speed() - set the speed of a bus (optional)
325 *
326 * The bus speed value will be updated by the uclass if this function
327 * does not return an error. This method is optional - if it is not
328 * provided then the driver can read the speed from
329 * bus->uclass_priv->speed_hz
330 *
331 * @bus: Bus to adjust
332 * @speed: Requested speed in Hz
333 * @return 0 if OK, -EINVAL for invalid values
334 */
335 int (*set_bus_speed)(struct udevice *bus, unsigned int speed);
336
337 /**
338 * get_bus_speed() - get the speed of a bus (optional)
339 *
340 * Normally this can be provided by the uclass, but if you want your
341 * driver to check the bus speed by looking at the hardware, you can
342 * implement that here. This method is optional. This method would
343 * normally be expected to return bus->uclass_priv->speed_hz.
344 *
345 * @bus: Bus to check
346 * @return speed of selected I2C bus in Hz, -ve on error
347 */
348 int (*get_bus_speed)(struct udevice *bus);
349
350 /**
351 * set_flags() - set the flags for a chip (optional)
352 *
353 * This is generally implemented by the uclass, but drivers can
354 * check the value to ensure that unsupported options are not used.
355 * This method is optional. If provided, this method will always be
356 * called when the flags change.
357 *
358 * @dev: Chip to adjust
359 * @flags: New flags value
360 * @return 0 if OK, -EINVAL if value is unsupported
361 */
362 int (*set_flags)(struct udevice *dev, uint flags);
363
364 /**
365 * deblock() - recover a bus that is in an unknown state
366 *
367 * I2C is a synchronous protocol and resets of the processor in the
368 * middle of an access can block the I2C Bus until a powerdown of
369 * the full unit is done. This is because slaves can be stuck
370 * waiting for addition bus transitions for a transaction that will
371 * never complete. Resetting the I2C master does not help. The only
372 * way is to force the bus through a series of transitions to make
373 * sure that all slaves are done with the transaction. This method
374 * performs this 'deblocking' if support by the driver.
375 *
376 * This method is optional.
377 */
378 int (*deblock)(struct udevice *bus);
379};
380
381#define i2c_get_ops(dev) ((struct dm_i2c_ops *)(dev)->driver->ops)
382
383/**
384 * i2c_get_chip() - get a device to use to access a chip on a bus
385 *
386 * This returns the device for the given chip address. The device can then
387 * be used with calls to i2c_read(), i2c_write(), i2c_probe(), etc.
388 *
389 * @bus: Bus to examine
390 * @chip_addr: Chip address for the new device
391 * @devp: Returns pointer to new device if found or -ENODEV if not
392 * found
393 */
394int i2c_get_chip(struct udevice *bus, uint chip_addr, struct udevice **devp);
395
396/**
397 * i2c_get_chip() - get a device to use to access a chip on a bus number
398 *
399 * This returns the device for the given chip address on a particular bus
400 * number.
401 *
402 * @busnum: Bus number to examine
403 * @chip_addr: Chip address for the new device
404 * @devp: Returns pointer to new device if found or -ENODEV if not
405 * found
406 */
407int i2c_get_chip_for_busnum(int busnum, int chip_addr, struct udevice **devp);
408
409/**
410 * i2c_chip_ofdata_to_platdata() - Decode standard I2C platform data
411 *
412 * This decodes the chip address from a device tree node and puts it into
413 * its dm_i2c_chip structure. This should be called in your driver's
414 * ofdata_to_platdata() method.
415 *
416 * @blob: Device tree blob
417 * @node: Node offset to read from
418 * @spi: Place to put the decoded information
419 */
420int i2c_chip_ofdata_to_platdata(const void *blob, int node,
421 struct dm_i2c_chip *chip);
422
423#endif
424
425#ifndef CONFIG_DM_I2C
426
427/*
wdenk1f045212002-03-10 14:37:15 +0000428 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
429 *
430 * The implementation MUST NOT use static or global variables if the
431 * I2C routines are used to read SDRAM configuration information
432 * because this is done before the memories are initialized. Limited
433 * use of stack-based variables are OK (the initial stack size is
434 * limited).
435 *
436 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
437 */
438
439/*
440 * Configuration items.
441 */
442#define I2C_RXTX_LEN 128 /* maximum tx/rx buffer length */
443
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000444#if !defined(CONFIG_SYS_I2C_MAX_HOPS)
445/* no muxes used bus = i2c adapters */
446#define CONFIG_SYS_I2C_DIRECT_BUS 1
447#define CONFIG_SYS_I2C_MAX_HOPS 0
448#define CONFIG_SYS_NUM_I2C_BUSES ll_entry_count(struct i2c_adapter, i2c)
Stefan Roese79b2d0b2007-02-20 10:27:08 +0100449#else
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000450/* we use i2c muxes */
451#undef CONFIG_SYS_I2C_DIRECT_BUS
Stefan Roese79b2d0b2007-02-20 10:27:08 +0100452#endif
453
Stefan Roese8c120452007-03-01 07:03:25 +0100454/* define the I2C bus number for RTC and DTT if not already done */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200455#if !defined(CONFIG_SYS_RTC_BUS_NUM)
456#define CONFIG_SYS_RTC_BUS_NUM 0
Stefan Roese8c120452007-03-01 07:03:25 +0100457#endif
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200458#if !defined(CONFIG_SYS_DTT_BUS_NUM)
459#define CONFIG_SYS_DTT_BUS_NUM 0
Stefan Roese8c120452007-03-01 07:03:25 +0100460#endif
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200461#if !defined(CONFIG_SYS_SPD_BUS_NUM)
462#define CONFIG_SYS_SPD_BUS_NUM 0
Matthias Fuchsd8a8ea52007-03-08 16:20:32 +0100463#endif
Stefan Roese8c120452007-03-01 07:03:25 +0100464
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000465struct i2c_adapter {
466 void (*init)(struct i2c_adapter *adap, int speed,
467 int slaveaddr);
468 int (*probe)(struct i2c_adapter *adap, uint8_t chip);
469 int (*read)(struct i2c_adapter *adap, uint8_t chip,
470 uint addr, int alen, uint8_t *buffer,
471 int len);
472 int (*write)(struct i2c_adapter *adap, uint8_t chip,
473 uint addr, int alen, uint8_t *buffer,
474 int len);
475 uint (*set_bus_speed)(struct i2c_adapter *adap,
476 uint speed);
477 int speed;
Hannes Petermaierd5243352014-02-03 21:22:18 +0100478 int waitdelay;
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000479 int slaveaddr;
480 int init_done;
481 int hwadapnr;
482 char *name;
483};
484
485#define U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \
486 _set_speed, _speed, _slaveaddr, _hwadapnr, _name) \
487 { \
488 .init = _init, \
489 .probe = _probe, \
490 .read = _read, \
491 .write = _write, \
492 .set_bus_speed = _set_speed, \
493 .speed = _speed, \
494 .slaveaddr = _slaveaddr, \
495 .init_done = 0, \
496 .hwadapnr = _hwadapnr, \
497 .name = #_name \
498};
499
500#define U_BOOT_I2C_ADAP_COMPLETE(_name, _init, _probe, _read, _write, \
501 _set_speed, _speed, _slaveaddr, _hwadapnr) \
502 ll_entry_declare(struct i2c_adapter, _name, i2c) = \
503 U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \
504 _set_speed, _speed, _slaveaddr, _hwadapnr, _name);
505
506struct i2c_adapter *i2c_get_adapter(int index);
507
508#ifndef CONFIG_SYS_I2C_DIRECT_BUS
509struct i2c_mux {
510 int id;
511 char name[16];
512};
513
514struct i2c_next_hop {
515 struct i2c_mux mux;
516 uint8_t chip;
517 uint8_t channel;
518};
519
520struct i2c_bus_hose {
521 int adapter;
522 struct i2c_next_hop next_hop[CONFIG_SYS_I2C_MAX_HOPS];
523};
524#define I2C_NULL_HOP {{-1, ""}, 0, 0}
525extern struct i2c_bus_hose i2c_bus[];
526
527#define I2C_ADAPTER(bus) i2c_bus[bus].adapter
528#else
529#define I2C_ADAPTER(bus) bus
530#endif
531#define I2C_BUS gd->cur_i2c_bus
532
533#define I2C_ADAP_NR(bus) i2c_get_adapter(I2C_ADAPTER(bus))
534#define I2C_ADAP I2C_ADAP_NR(gd->cur_i2c_bus)
535#define I2C_ADAP_HWNR (I2C_ADAP->hwadapnr)
536
537#ifndef CONFIG_SYS_I2C_DIRECT_BUS
538#define I2C_MUX_PCA9540_ID 1
539#define I2C_MUX_PCA9540 {I2C_MUX_PCA9540_ID, "PCA9540B"}
540#define I2C_MUX_PCA9542_ID 2
541#define I2C_MUX_PCA9542 {I2C_MUX_PCA9542_ID, "PCA9542A"}
542#define I2C_MUX_PCA9544_ID 3
543#define I2C_MUX_PCA9544 {I2C_MUX_PCA9544_ID, "PCA9544A"}
544#define I2C_MUX_PCA9547_ID 4
545#define I2C_MUX_PCA9547 {I2C_MUX_PCA9547_ID, "PCA9547A"}
Michael Burre6658742013-09-23 22:35:45 +0000546#define I2C_MUX_PCA9548_ID 5
547#define I2C_MUX_PCA9548 {I2C_MUX_PCA9548_ID, "PCA9548"}
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000548#endif
549
Heiko Schocher98aed372008-10-15 09:35:26 +0200550#ifndef I2C_SOFT_DECLARATIONS
551# if defined(CONFIG_MPC8260)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200552# define I2C_SOFT_DECLARATIONS volatile ioport_t *iop = ioport_addr((immap_t *)CONFIG_SYS_IMMR, I2C_PORT);
Heiko Schocher98aed372008-10-15 09:35:26 +0200553# elif defined(CONFIG_8xx)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200554# define I2C_SOFT_DECLARATIONS volatile immap_t *immr = (immap_t *)CONFIG_SYS_IMMR;
Jens Scharsig0cf0b932010-02-03 22:46:58 +0100555
556# elif (defined(CONFIG_AT91RM9200) || \
557 defined(CONFIG_AT91SAM9260) || defined(CONFIG_AT91SAM9261) || \
Andreas Bießmanncb96a0a2013-10-30 15:18:18 +0100558 defined(CONFIG_AT91SAM9263))
esw@bus-elektronik.de78132272011-12-20 06:05:30 +0000559# define I2C_SOFT_DECLARATIONS at91_pio_t *pio = (at91_pio_t *) ATMEL_BASE_PIOA;
Heiko Schocher98aed372008-10-15 09:35:26 +0200560# else
561# define I2C_SOFT_DECLARATIONS
562# endif
563#endif
Timur Tabiecf5f072008-12-03 11:28:30 -0600564
565#ifdef CONFIG_8xx
Peter Tyser9c90a2c2009-04-24 15:34:05 -0500566/* Set default value for the I2C bus speed on 8xx. In the
Timur Tabiecf5f072008-12-03 11:28:30 -0600567 * future, we'll define these in all 8xx board config files.
568 */
569#ifndef CONFIG_SYS_I2C_SPEED
570#define CONFIG_SYS_I2C_SPEED 50000
571#endif
Timur Tabiecf5f072008-12-03 11:28:30 -0600572#endif
Peter Tyser9c90a2c2009-04-24 15:34:05 -0500573
574/*
575 * Many boards/controllers/drivers don't support an I2C slave interface so
576 * provide a default slave address for them for use in common code. A real
577 * value for CONFIG_SYS_I2C_SLAVE should be defined for any board which does
578 * support a slave interface.
579 */
580#ifndef CONFIG_SYS_I2C_SLAVE
581#define CONFIG_SYS_I2C_SLAVE 0xfe
Timur Tabiecf5f072008-12-03 11:28:30 -0600582#endif
583
wdenk1f045212002-03-10 14:37:15 +0000584/*
585 * Initialization, must be called once on start up, may be called
586 * repeatedly to change the speed and slave addresses.
587 */
588void i2c_init(int speed, int slaveaddr);
wdenk06d01db2003-03-14 20:47:52 +0000589void i2c_init_board(void);
Richard Retanubun26a33502010-04-12 15:08:17 -0400590#ifdef CONFIG_SYS_I2C_BOARD_LATE_INIT
591void i2c_board_late_init(void);
592#endif
wdenk1f045212002-03-10 14:37:15 +0000593
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000594#ifdef CONFIG_SYS_I2C
595/*
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000596 * i2c_get_bus_num:
597 *
598 * Returns index of currently active I2C bus. Zero-based.
599 */
600unsigned int i2c_get_bus_num(void);
Heiko Schocher67b23a32008-10-15 09:39:47 +0200601
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000602/*
603 * i2c_set_bus_num:
604 *
605 * Change the active I2C bus. Subsequent read/write calls will
606 * go to this one.
607 *
608 * bus - bus index, zero based
609 *
610 * Returns: 0 on success, not 0 on failure
611 *
612 */
613int i2c_set_bus_num(unsigned int bus);
Heiko Schocher67b23a32008-10-15 09:39:47 +0200614
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000615/*
616 * i2c_init_all():
617 *
618 * Initializes all I2C adapters in the system. All i2c_adap structures must
619 * be initialized beforehead with function pointers and data, including
620 * speed and slaveaddr. Returns 0 on success, non-0 on failure.
621 */
622void i2c_init_all(void);
Heiko Schocher67b23a32008-10-15 09:39:47 +0200623
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000624/*
625 * Probe the given I2C chip address. Returns 0 if a chip responded,
626 * not 0 on failure.
627 */
628int i2c_probe(uint8_t chip);
629
630/*
631 * Read/Write interface:
632 * chip: I2C chip address, range 0..127
633 * addr: Memory (register) address within the chip
634 * alen: Number of bytes to use for addr (typically 1, 2 for larger
635 * memories, 0 for register type devices with only one
636 * register)
637 * buffer: Where to read/write the data
638 * len: How many bytes to read/write
639 *
640 * Returns: 0 on success, not 0 on failure
641 */
642int i2c_read(uint8_t chip, unsigned int addr, int alen,
643 uint8_t *buffer, int len);
644
645int i2c_write(uint8_t chip, unsigned int addr, int alen,
646 uint8_t *buffer, int len);
647
648/*
649 * Utility routines to read/write registers.
650 */
651uint8_t i2c_reg_read(uint8_t addr, uint8_t reg);
652
653void i2c_reg_write(uint8_t addr, uint8_t reg, uint8_t val);
654
655/*
656 * i2c_set_bus_speed:
657 *
658 * Change the speed of the active I2C bus
659 *
660 * speed - bus speed in Hz
661 *
662 * Returns: new bus speed
663 *
664 */
665unsigned int i2c_set_bus_speed(unsigned int speed);
666
667/*
668 * i2c_get_bus_speed:
669 *
670 * Returns speed of currently active I2C bus in Hz
671 */
672
673unsigned int i2c_get_bus_speed(void);
674
675/*
676 * i2c_reloc_fixup:
677 *
678 * Adjusts I2C pointers after U-Boot is relocated to DRAM
679 */
680void i2c_reloc_fixup(void);
Heiko Schocherea818db2013-01-29 08:53:15 +0100681#if defined(CONFIG_SYS_I2C_SOFT)
682void i2c_soft_init(void);
683void i2c_soft_active(void);
684void i2c_soft_tristate(void);
685int i2c_soft_read(void);
686void i2c_soft_sda(int bit);
687void i2c_soft_scl(int bit);
688void i2c_soft_delay(void);
Heiko Schocher67b23a32008-10-15 09:39:47 +0200689#endif
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000690#else
Heiko Schocher67b23a32008-10-15 09:39:47 +0200691
wdenk1f045212002-03-10 14:37:15 +0000692/*
693 * Probe the given I2C chip address. Returns 0 if a chip responded,
694 * not 0 on failure.
695 */
696int i2c_probe(uchar chip);
697
698/*
699 * Read/Write interface:
700 * chip: I2C chip address, range 0..127
701 * addr: Memory (register) address within the chip
702 * alen: Number of bytes to use for addr (typically 1, 2 for larger
703 * memories, 0 for register type devices with only one
704 * register)
705 * buffer: Where to read/write the data
706 * len: How many bytes to read/write
707 *
708 * Returns: 0 on success, not 0 on failure
709 */
710int i2c_read(uchar chip, uint addr, int alen, uchar *buffer, int len);
711int i2c_write(uchar chip, uint addr, int alen, uchar *buffer, int len);
712
713/*
714 * Utility routines to read/write registers.
715 */
Timur Tabiecf5f072008-12-03 11:28:30 -0600716static inline u8 i2c_reg_read(u8 addr, u8 reg)
717{
718 u8 buf;
719
720#ifdef CONFIG_8xx
721 /* MPC8xx needs this. Maybe one day we can get rid of it. */
722 i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
723#endif
724
725#ifdef DEBUG
726 printf("%s: addr=0x%02x, reg=0x%02x\n", __func__, addr, reg);
727#endif
728
Timur Tabiecf5f072008-12-03 11:28:30 -0600729 i2c_read(addr, reg, 1, &buf, 1);
Timur Tabiecf5f072008-12-03 11:28:30 -0600730
731 return buf;
732}
733
734static inline void i2c_reg_write(u8 addr, u8 reg, u8 val)
735{
736#ifdef CONFIG_8xx
737 /* MPC8xx needs this. Maybe one day we can get rid of it. */
738 i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
739#endif
740
741#ifdef DEBUG
742 printf("%s: addr=0x%02x, reg=0x%02x, val=0x%02x\n",
743 __func__, addr, reg, val);
744#endif
745
Timur Tabiecf5f072008-12-03 11:28:30 -0600746 i2c_write(addr, reg, 1, &val, 1);
Timur Tabiecf5f072008-12-03 11:28:30 -0600747}
wdenk1f045212002-03-10 14:37:15 +0000748
Ben Warrenbb99ad62006-09-07 16:50:54 -0400749/*
750 * Functions for setting the current I2C bus and its speed
751 */
752
753/*
754 * i2c_set_bus_num:
755 *
756 * Change the active I2C bus. Subsequent read/write calls will
757 * go to this one.
758 *
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200759 * bus - bus index, zero based
Ben Warrenbb99ad62006-09-07 16:50:54 -0400760 *
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200761 * Returns: 0 on success, not 0 on failure
Ben Warrenbb99ad62006-09-07 16:50:54 -0400762 *
763 */
Timur Tabi9ca880a2006-10-31 21:23:16 -0600764int i2c_set_bus_num(unsigned int bus);
Ben Warrenbb99ad62006-09-07 16:50:54 -0400765
766/*
767 * i2c_get_bus_num:
768 *
769 * Returns index of currently active I2C bus. Zero-based.
770 */
771
Timur Tabi9ca880a2006-10-31 21:23:16 -0600772unsigned int i2c_get_bus_num(void);
Ben Warrenbb99ad62006-09-07 16:50:54 -0400773
774/*
775 * i2c_set_bus_speed:
776 *
777 * Change the speed of the active I2C bus
778 *
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200779 * speed - bus speed in Hz
Ben Warrenbb99ad62006-09-07 16:50:54 -0400780 *
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200781 * Returns: 0 on success, not 0 on failure
Ben Warrenbb99ad62006-09-07 16:50:54 -0400782 *
783 */
Timur Tabi9ca880a2006-10-31 21:23:16 -0600784int i2c_set_bus_speed(unsigned int);
Ben Warrenbb99ad62006-09-07 16:50:54 -0400785
786/*
787 * i2c_get_bus_speed:
788 *
789 * Returns speed of currently active I2C bus in Hz
790 */
791
Timur Tabi9ca880a2006-10-31 21:23:16 -0600792unsigned int i2c_get_bus_speed(void);
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000793#endif /* CONFIG_SYS_I2C */
794
795/*
796 * only for backwardcompatibility, should go away if we switched
797 * completely to new multibus support.
798 */
799#if defined(CONFIG_SYS_I2C) || defined(CONFIG_I2C_MULTI_BUS)
800# if !defined(CONFIG_SYS_MAX_I2C_BUS)
801# define CONFIG_SYS_MAX_I2C_BUS 2
802# endif
Łukasz Majewskiea0f73a2013-08-16 15:31:45 +0200803# define I2C_MULTI_BUS 1
Heiko Schocher385c9ef2012-01-16 21:12:23 +0000804#else
805# define CONFIG_SYS_MAX_I2C_BUS 1
806# define I2C_MULTI_BUS 0
807#endif
Ben Warrenbb99ad62006-09-07 16:50:54 -0400808
Marek Vasutcd7b4e82011-10-25 11:40:57 +0200809/* NOTE: These two functions MUST be always_inline to avoid code growth! */
810static inline unsigned int I2C_GET_BUS(void) __attribute__((always_inline));
811static inline unsigned int I2C_GET_BUS(void)
812{
813 return I2C_MULTI_BUS ? i2c_get_bus_num() : 0;
814}
815
816static inline void I2C_SET_BUS(unsigned int bus) __attribute__((always_inline));
817static inline void I2C_SET_BUS(unsigned int bus)
818{
819 if (I2C_MULTI_BUS)
820 i2c_set_bus_num(bus);
821}
822
Łukasz Majewski7ca8f732012-09-04 23:15:20 +0000823/* Multi I2C definitions */
824enum {
825 I2C_0, I2C_1, I2C_2, I2C_3, I2C_4, I2C_5, I2C_6, I2C_7,
826 I2C_8, I2C_9, I2C_10,
827};
828
829/* Multi I2C busses handling */
830#ifdef CONFIG_SOFT_I2C_MULTI_BUS
831extern int get_multi_scl_pin(void);
832extern int get_multi_sda_pin(void);
833extern int multi_i2c_init(void);
834#endif
Rajeshwari Shindea9d2ae72012-12-26 20:03:12 +0000835
836/**
837 * Get FDT values for i2c bus.
838 *
839 * @param blob Device tree blbo
840 * @return the number of I2C bus
841 */
842void board_i2c_init(const void *blob);
843
844/**
845 * Find the I2C bus number by given a FDT I2C node.
846 *
847 * @param blob Device tree blbo
848 * @param node FDT I2C node to find
849 * @return the number of I2C bus (zero based), or -1 on error
850 */
851int i2c_get_bus_num_fdt(int node);
852
853/**
854 * Reset the I2C bus represented by the given a FDT I2C node.
855 *
856 * @param blob Device tree blbo
857 * @param node FDT I2C node to find
858 * @return 0 if port was reset, -1 if not found
859 */
860int i2c_reset_port_fdt(const void *blob, int node);
Simon Glassc6202d82014-12-10 08:55:47 -0700861
862#endif /* !CONFIG_DM_I2C */
863
wdenk1f045212002-03-10 14:37:15 +0000864#endif /* _I2C_H_ */