wdenk | 1f04521 | 2002-03-10 14:37:15 +0000 | [diff] [blame] | 1 | /* |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 2 | * 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 | * |
wdenk | 1f04521 | 2002-03-10 14:37:15 +0000 | [diff] [blame] | 6 | * (C) Copyright 2001 |
| 7 | * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com. |
| 8 | * |
Wolfgang Denk | d79de1d | 2013-07-08 09:37:19 +0200 | [diff] [blame] | 9 | * SPDX-License-Identifier: GPL-2.0+ |
wdenk | 1f04521 | 2002-03-10 14:37:15 +0000 | [diff] [blame] | 10 | * |
| 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 Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 21 | * 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 | |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 28 | enum dm_i2c_chip_flags { |
| 29 | DM_I2C_CHIP_10BIT = 1 << 0, /* Use 10-bit addressing */ |
| 30 | DM_I2C_CHIP_RD_ADDRESS = 1 << 1, /* Send address for each read byte */ |
| 31 | DM_I2C_CHIP_WR_ADDRESS = 1 << 2, /* Send address for each write byte */ |
| 32 | }; |
| 33 | |
Simon Glass | d5ff0b9 | 2015-02-05 21:41:33 -0700 | [diff] [blame] | 34 | struct udevice; |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 35 | /** |
| 36 | * struct dm_i2c_chip - information about an i2c chip |
| 37 | * |
| 38 | * An I2C chip is a device on the I2C bus. It sits at a particular address |
| 39 | * and normally supports 7-bit or 10-bit addressing. |
| 40 | * |
Simon Glass | 713c3f0 | 2015-01-25 08:27:13 -0700 | [diff] [blame] | 41 | * To obtain this structure, use dev_get_parent_platdata(dev) where dev is |
| 42 | * the chip to examine. |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 43 | * |
| 44 | * @chip_addr: Chip address on bus |
| 45 | * @offset_len: Length of offset in bytes. A single byte offset can |
| 46 | * represent up to 256 bytes. A value larger than 1 may be |
| 47 | * needed for larger devices. |
| 48 | * @flags: Flags for this chip (dm_i2c_chip_flags) |
| 49 | * @emul: Emulator for this chip address (only used for emulation) |
| 50 | */ |
| 51 | struct dm_i2c_chip { |
| 52 | uint chip_addr; |
| 53 | uint offset_len; |
| 54 | uint flags; |
| 55 | #ifdef CONFIG_SANDBOX |
| 56 | struct udevice *emul; |
Simon Glass | 4c70ed9 | 2015-04-20 12:37:15 -0600 | [diff] [blame] | 57 | bool test_mode; |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 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 | * |
Simon Glass | de0977b | 2015-03-05 12:25:20 -0700 | [diff] [blame] | 68 | * To obtain this structure, use dev_get_uclass_priv(bus) where bus is the |
| 69 | * I2C bus udevice. |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 70 | * |
| 71 | * @speed_hz: Bus speed in hertz (typically 100000) |
| 72 | */ |
| 73 | struct dm_i2c_bus { |
| 74 | int speed_hz; |
| 75 | }; |
| 76 | |
Simon Glass | 727ff7d | 2015-07-02 18:15:41 -0600 | [diff] [blame] | 77 | /* |
| 78 | * Not all of these flags are implemented in the U-Boot API |
| 79 | */ |
| 80 | enum dm_i2c_msg_flags { |
| 81 | I2C_M_TEN = 0x0010, /* ten-bit chip address */ |
| 82 | I2C_M_RD = 0x0001, /* read data, from slave to master */ |
| 83 | I2C_M_STOP = 0x8000, /* send stop after this message */ |
| 84 | I2C_M_NOSTART = 0x4000, /* no start before this message */ |
| 85 | I2C_M_REV_DIR_ADDR = 0x2000, /* invert polarity of R/W bit */ |
| 86 | I2C_M_IGNORE_NAK = 0x1000, /* continue after NAK */ |
| 87 | I2C_M_NO_RD_ACK = 0x0800, /* skip the Ack bit on reads */ |
| 88 | I2C_M_RECV_LEN = 0x0400, /* length is first received byte */ |
| 89 | }; |
| 90 | |
| 91 | /** |
| 92 | * struct i2c_msg - an I2C message |
| 93 | * |
| 94 | * @addr: Slave address |
| 95 | * @flags: Flags (see enum dm_i2c_msg_flags) |
| 96 | * @len: Length of buffer in bytes, may be 0 for a probe |
| 97 | * @buf: Buffer to send/receive, or NULL if no data |
| 98 | */ |
| 99 | struct i2c_msg { |
| 100 | uint addr; |
| 101 | uint flags; |
| 102 | uint len; |
| 103 | u8 *buf; |
| 104 | }; |
| 105 | |
| 106 | /** |
| 107 | * struct i2c_msg_list - a list of I2C messages |
| 108 | * |
| 109 | * This is called i2c_rdwr_ioctl_data in Linux but the name does not seem |
| 110 | * appropriate in U-Boot. |
| 111 | * |
| 112 | * @msg: Pointer to i2c_msg array |
| 113 | * @nmsgs: Number of elements in the array |
| 114 | */ |
| 115 | struct i2c_msg_list { |
| 116 | struct i2c_msg *msgs; |
| 117 | uint nmsgs; |
| 118 | }; |
| 119 | |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 120 | /** |
Simon Glass | 7d72276 | 2015-01-12 18:02:07 -0700 | [diff] [blame] | 121 | * dm_i2c_read() - read bytes from an I2C chip |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 122 | * |
| 123 | * To obtain an I2C device (called a 'chip') given the I2C bus address you |
| 124 | * can use i2c_get_chip(). To obtain a bus by bus number use |
| 125 | * uclass_get_device_by_seq(UCLASS_I2C, <bus number>). |
| 126 | * |
| 127 | * To set the address length of a devce use i2c_set_addr_len(). It |
| 128 | * defaults to 1. |
| 129 | * |
| 130 | * @dev: Chip to read from |
| 131 | * @offset: Offset within chip to start reading |
| 132 | * @buffer: Place to put data |
| 133 | * @len: Number of bytes to read |
| 134 | * |
| 135 | * @return 0 on success, -ve on failure |
| 136 | */ |
Simon Glass | 7d72276 | 2015-01-12 18:02:07 -0700 | [diff] [blame] | 137 | int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len); |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 138 | |
| 139 | /** |
Simon Glass | 7d72276 | 2015-01-12 18:02:07 -0700 | [diff] [blame] | 140 | * dm_i2c_write() - write bytes to an I2C chip |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 141 | * |
Simon Glass | 7d72276 | 2015-01-12 18:02:07 -0700 | [diff] [blame] | 142 | * See notes for dm_i2c_read() above. |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 143 | * |
| 144 | * @dev: Chip to write to |
| 145 | * @offset: Offset within chip to start writing |
| 146 | * @buffer: Buffer containing data to write |
| 147 | * @len: Number of bytes to write |
| 148 | * |
| 149 | * @return 0 on success, -ve on failure |
| 150 | */ |
Simon Glass | 7d72276 | 2015-01-12 18:02:07 -0700 | [diff] [blame] | 151 | int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer, |
| 152 | int len); |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 153 | |
| 154 | /** |
Simon Glass | 7d72276 | 2015-01-12 18:02:07 -0700 | [diff] [blame] | 155 | * dm_i2c_probe() - probe a particular chip address |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 156 | * |
| 157 | * This can be useful to check for the existence of a chip on the bus. |
| 158 | * It is typically implemented by writing the chip address to the bus |
| 159 | * and checking that the chip replies with an ACK. |
| 160 | * |
| 161 | * @bus: Bus to probe |
| 162 | * @chip_addr: 7-bit address to probe (10-bit and others are not supported) |
| 163 | * @chip_flags: Flags for the probe (see enum dm_i2c_chip_flags) |
| 164 | * @devp: Returns the device found, or NULL if none |
| 165 | * @return 0 if a chip was found at that address, -ve if not |
| 166 | */ |
Simon Glass | 7d72276 | 2015-01-12 18:02:07 -0700 | [diff] [blame] | 167 | int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags, |
| 168 | struct udevice **devp); |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 169 | |
| 170 | /** |
Simon Glass | 0c70261 | 2015-04-20 12:37:14 -0600 | [diff] [blame] | 171 | * dm_i2c_reg_read() - Read a value from an I2C register |
| 172 | * |
| 173 | * This reads a single value from the given address in an I2C chip |
| 174 | * |
Simon Glass | cefb0ef | 2015-07-02 18:15:40 -0600 | [diff] [blame] | 175 | * @dev: Device to use for transfer |
Simon Glass | 0c70261 | 2015-04-20 12:37:14 -0600 | [diff] [blame] | 176 | * @addr: Address to read from |
| 177 | * @return value read, or -ve on error |
| 178 | */ |
| 179 | int dm_i2c_reg_read(struct udevice *dev, uint offset); |
| 180 | |
| 181 | /** |
| 182 | * dm_i2c_reg_write() - Write a value to an I2C register |
| 183 | * |
| 184 | * This writes a single value to the given address in an I2C chip |
| 185 | * |
Simon Glass | cefb0ef | 2015-07-02 18:15:40 -0600 | [diff] [blame] | 186 | * @dev: Device to use for transfer |
Simon Glass | 0c70261 | 2015-04-20 12:37:14 -0600 | [diff] [blame] | 187 | * @addr: Address to write to |
| 188 | * @val: Value to write (normally a byte) |
| 189 | * @return 0 on success, -ve on error |
| 190 | */ |
| 191 | int dm_i2c_reg_write(struct udevice *dev, uint offset, unsigned int val); |
| 192 | |
| 193 | /** |
Simon Glass | f281885 | 2015-07-02 18:15:42 -0600 | [diff] [blame] | 194 | * dm_i2c_xfer() - Transfer messages over I2C |
| 195 | * |
| 196 | * This transfers a raw message. It is best to use dm_i2c_reg_read/write() |
| 197 | * instead. |
| 198 | * |
| 199 | * @dev: Device to use for transfer |
| 200 | * @msg: List of messages to transfer |
| 201 | * @nmsgs: Number of messages to transfer |
| 202 | * @return 0 on success, -ve on error |
| 203 | */ |
| 204 | int dm_i2c_xfer(struct udevice *dev, struct i2c_msg *msg, int nmsgs); |
| 205 | |
| 206 | /** |
Simon Glass | e4e8ff2 | 2015-02-05 21:41:32 -0700 | [diff] [blame] | 207 | * dm_i2c_set_bus_speed() - set the speed of a bus |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 208 | * |
| 209 | * @bus: Bus to adjust |
| 210 | * @speed: Requested speed in Hz |
| 211 | * @return 0 if OK, -EINVAL for invalid values |
| 212 | */ |
Simon Glass | e4e8ff2 | 2015-02-05 21:41:32 -0700 | [diff] [blame] | 213 | int dm_i2c_set_bus_speed(struct udevice *bus, unsigned int speed); |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 214 | |
| 215 | /** |
Simon Glass | e4e8ff2 | 2015-02-05 21:41:32 -0700 | [diff] [blame] | 216 | * dm_i2c_get_bus_speed() - get the speed of a bus |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 217 | * |
| 218 | * @bus: Bus to check |
| 219 | * @return speed of selected I2C bus in Hz, -ve on error |
| 220 | */ |
Simon Glass | e4e8ff2 | 2015-02-05 21:41:32 -0700 | [diff] [blame] | 221 | int dm_i2c_get_bus_speed(struct udevice *bus); |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 222 | |
| 223 | /** |
| 224 | * i2c_set_chip_flags() - set flags for a chip |
| 225 | * |
| 226 | * Typically addresses are 7 bits, but for 10-bit addresses you should set |
| 227 | * flags to DM_I2C_CHIP_10BIT. All accesses will then use 10-bit addressing. |
| 228 | * |
| 229 | * @dev: Chip to adjust |
| 230 | * @flags: New flags |
| 231 | * @return 0 if OK, -EINVAL if value is unsupported, other -ve value on error |
| 232 | */ |
| 233 | int i2c_set_chip_flags(struct udevice *dev, uint flags); |
| 234 | |
| 235 | /** |
| 236 | * i2c_get_chip_flags() - get flags for a chip |
| 237 | * |
| 238 | * @dev: Chip to check |
| 239 | * @flagsp: Place to put flags |
| 240 | * @return 0 if OK, other -ve value on error |
| 241 | */ |
| 242 | int i2c_get_chip_flags(struct udevice *dev, uint *flagsp); |
| 243 | |
| 244 | /** |
| 245 | * i2c_set_offset_len() - set the offset length for a chip |
| 246 | * |
| 247 | * The offset used to access a chip may be up to 4 bytes long. Typically it |
| 248 | * is only 1 byte, which is enough for chips with 256 bytes of memory or |
| 249 | * registers. The default value is 1, but you can call this function to |
| 250 | * change it. |
| 251 | * |
| 252 | * @offset_len: New offset length value (typically 1 or 2) |
| 253 | */ |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 254 | int i2c_set_chip_offset_len(struct udevice *dev, uint offset_len); |
Simon Glass | 9a1589a | 2015-05-04 11:30:58 -0600 | [diff] [blame] | 255 | |
| 256 | /** |
| 257 | * i2c_get_offset_len() - get the offset length for a chip |
| 258 | * |
| 259 | * @return: Current offset length value (typically 1 or 2) |
| 260 | */ |
| 261 | int i2c_get_chip_offset_len(struct udevice *dev); |
| 262 | |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 263 | /** |
| 264 | * i2c_deblock() - recover a bus that is in an unknown state |
| 265 | * |
| 266 | * See the deblock() method in 'struct dm_i2c_ops' for full information |
| 267 | * |
| 268 | * @bus: Bus to recover |
| 269 | * @return 0 if OK, -ve on error |
| 270 | */ |
| 271 | int i2c_deblock(struct udevice *bus); |
| 272 | |
Simon Glass | 0275eb1 | 2015-01-12 18:02:08 -0700 | [diff] [blame] | 273 | #ifdef CONFIG_DM_I2C_COMPAT |
| 274 | /** |
| 275 | * i2c_probe() - Compatibility function for driver model |
| 276 | * |
| 277 | * Calls dm_i2c_probe() on the current bus |
| 278 | */ |
| 279 | int i2c_probe(uint8_t chip_addr); |
| 280 | |
| 281 | /** |
| 282 | * i2c_read() - Compatibility function for driver model |
| 283 | * |
| 284 | * Calls dm_i2c_read() with the device corresponding to @chip_addr, and offset |
| 285 | * set to @addr. @alen must match the current setting for the device. |
| 286 | */ |
| 287 | int i2c_read(uint8_t chip_addr, unsigned int addr, int alen, uint8_t *buffer, |
| 288 | int len); |
| 289 | |
| 290 | /** |
| 291 | * i2c_write() - Compatibility function for driver model |
| 292 | * |
| 293 | * Calls dm_i2c_write() with the device corresponding to @chip_addr, and offset |
| 294 | * set to @addr. @alen must match the current setting for the device. |
| 295 | */ |
| 296 | int i2c_write(uint8_t chip_addr, unsigned int addr, int alen, uint8_t *buffer, |
| 297 | int len); |
| 298 | |
| 299 | /** |
| 300 | * i2c_get_bus_num_fdt() - Compatibility function for driver model |
| 301 | * |
| 302 | * @return the bus number associated with the given device tree node |
| 303 | */ |
| 304 | int i2c_get_bus_num_fdt(int node); |
| 305 | |
| 306 | /** |
| 307 | * i2c_get_bus_num() - Compatibility function for driver model |
| 308 | * |
| 309 | * @return the 'current' bus number |
| 310 | */ |
| 311 | unsigned int i2c_get_bus_num(void); |
| 312 | |
| 313 | /** |
Simon Glass | 4e003c5 | 2015-01-26 20:29:39 -0700 | [diff] [blame] | 314 | * i2c_set_bus_num() - Compatibility function for driver model |
Simon Glass | 0275eb1 | 2015-01-12 18:02:08 -0700 | [diff] [blame] | 315 | * |
| 316 | * Sets the 'current' bus |
| 317 | */ |
| 318 | int i2c_set_bus_num(unsigned int bus); |
| 319 | |
| 320 | static inline void I2C_SET_BUS(unsigned int bus) |
| 321 | { |
| 322 | i2c_set_bus_num(bus); |
| 323 | } |
| 324 | |
| 325 | static inline unsigned int I2C_GET_BUS(void) |
| 326 | { |
| 327 | return i2c_get_bus_num(); |
| 328 | } |
| 329 | |
Simon Glass | 4e003c5 | 2015-01-26 20:29:39 -0700 | [diff] [blame] | 330 | /** |
| 331 | * i2c_init() - Compatibility function for driver model |
| 332 | * |
| 333 | * This function does nothing. |
| 334 | */ |
| 335 | void i2c_init(int speed, int slaveaddr); |
| 336 | |
| 337 | /** |
| 338 | * board_i2c_init() - Compatibility function for driver model |
| 339 | * |
| 340 | * @param blob Device tree blbo |
| 341 | * @return the number of I2C bus |
| 342 | */ |
| 343 | void board_i2c_init(const void *blob); |
| 344 | |
Simon Glass | 8a18dd8 | 2015-05-16 15:01:41 -0600 | [diff] [blame] | 345 | /* |
| 346 | * Compatibility functions for driver model. |
| 347 | */ |
| 348 | uint8_t i2c_reg_read(uint8_t addr, uint8_t reg); |
| 349 | void i2c_reg_write(uint8_t addr, uint8_t reg, uint8_t val); |
| 350 | |
Simon Glass | 0275eb1 | 2015-01-12 18:02:08 -0700 | [diff] [blame] | 351 | #endif |
| 352 | |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 353 | /** |
| 354 | * struct dm_i2c_ops - driver operations for I2C uclass |
| 355 | * |
| 356 | * Drivers should support these operations unless otherwise noted. These |
| 357 | * operations are intended to be used by uclass code, not directly from |
| 358 | * other code. |
| 359 | */ |
| 360 | struct dm_i2c_ops { |
| 361 | /** |
| 362 | * xfer() - transfer a list of I2C messages |
| 363 | * |
| 364 | * @bus: Bus to read from |
| 365 | * @msg: List of messages to transfer |
| 366 | * @nmsgs: Number of messages in the list |
| 367 | * @return 0 if OK, -EREMOTEIO if the slave did not ACK a byte, |
| 368 | * -ECOMM if the speed cannot be supported, -EPROTO if the chip |
| 369 | * flags cannot be supported, other -ve value on some other error |
| 370 | */ |
| 371 | int (*xfer)(struct udevice *bus, struct i2c_msg *msg, int nmsgs); |
| 372 | |
| 373 | /** |
| 374 | * probe_chip() - probe for the presense of a chip address |
| 375 | * |
| 376 | * This function is optional. If omitted, the uclass will send a zero |
| 377 | * length message instead. |
| 378 | * |
| 379 | * @bus: Bus to probe |
| 380 | * @chip_addr: Chip address to probe |
| 381 | * @chip_flags: Probe flags (enum dm_i2c_chip_flags) |
| 382 | * @return 0 if chip was found, -EREMOTEIO if not, -ENOSYS to fall back |
| 383 | * to default probem other -ve value on error |
| 384 | */ |
| 385 | int (*probe_chip)(struct udevice *bus, uint chip_addr, uint chip_flags); |
| 386 | |
| 387 | /** |
| 388 | * set_bus_speed() - set the speed of a bus (optional) |
| 389 | * |
| 390 | * The bus speed value will be updated by the uclass if this function |
| 391 | * does not return an error. This method is optional - if it is not |
| 392 | * provided then the driver can read the speed from |
Simon Glass | de0977b | 2015-03-05 12:25:20 -0700 | [diff] [blame] | 393 | * dev_get_uclass_priv(bus)->speed_hz |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 394 | * |
| 395 | * @bus: Bus to adjust |
| 396 | * @speed: Requested speed in Hz |
| 397 | * @return 0 if OK, -EINVAL for invalid values |
| 398 | */ |
| 399 | int (*set_bus_speed)(struct udevice *bus, unsigned int speed); |
| 400 | |
| 401 | /** |
| 402 | * get_bus_speed() - get the speed of a bus (optional) |
| 403 | * |
| 404 | * Normally this can be provided by the uclass, but if you want your |
| 405 | * driver to check the bus speed by looking at the hardware, you can |
| 406 | * implement that here. This method is optional. This method would |
Simon Glass | de0977b | 2015-03-05 12:25:20 -0700 | [diff] [blame] | 407 | * normally be expected to return dev_get_uclass_priv(bus)->speed_hz. |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 408 | * |
| 409 | * @bus: Bus to check |
| 410 | * @return speed of selected I2C bus in Hz, -ve on error |
| 411 | */ |
| 412 | int (*get_bus_speed)(struct udevice *bus); |
| 413 | |
| 414 | /** |
| 415 | * set_flags() - set the flags for a chip (optional) |
| 416 | * |
| 417 | * This is generally implemented by the uclass, but drivers can |
| 418 | * check the value to ensure that unsupported options are not used. |
| 419 | * This method is optional. If provided, this method will always be |
| 420 | * called when the flags change. |
| 421 | * |
| 422 | * @dev: Chip to adjust |
| 423 | * @flags: New flags value |
| 424 | * @return 0 if OK, -EINVAL if value is unsupported |
| 425 | */ |
| 426 | int (*set_flags)(struct udevice *dev, uint flags); |
| 427 | |
| 428 | /** |
| 429 | * deblock() - recover a bus that is in an unknown state |
| 430 | * |
| 431 | * I2C is a synchronous protocol and resets of the processor in the |
| 432 | * middle of an access can block the I2C Bus until a powerdown of |
| 433 | * the full unit is done. This is because slaves can be stuck |
| 434 | * waiting for addition bus transitions for a transaction that will |
| 435 | * never complete. Resetting the I2C master does not help. The only |
| 436 | * way is to force the bus through a series of transitions to make |
| 437 | * sure that all slaves are done with the transaction. This method |
| 438 | * performs this 'deblocking' if support by the driver. |
| 439 | * |
| 440 | * This method is optional. |
| 441 | */ |
| 442 | int (*deblock)(struct udevice *bus); |
| 443 | }; |
| 444 | |
| 445 | #define i2c_get_ops(dev) ((struct dm_i2c_ops *)(dev)->driver->ops) |
| 446 | |
| 447 | /** |
Simon Glass | 2a80c40 | 2015-08-03 08:19:21 -0600 | [diff] [blame] | 448 | * struct i2c_mux_ops - operations for an I2C mux |
| 449 | * |
| 450 | * The current mux state is expected to be stored in the mux itself since |
| 451 | * it is the only thing that knows how to make things work. The mux can |
| 452 | * record the current state and then avoid switching unless it is necessary. |
| 453 | * So select() can be skipped if the mux is already in the correct state. |
| 454 | * Also deselect() can be made a nop if required. |
| 455 | */ |
| 456 | struct i2c_mux_ops { |
| 457 | /** |
| 458 | * select() - select one of of I2C buses attached to a mux |
| 459 | * |
| 460 | * This will be called when there is no bus currently selected by the |
| 461 | * mux. This method does not need to deselect the old bus since |
| 462 | * deselect() will be already have been called if necessary. |
| 463 | * |
| 464 | * @mux: Mux device |
| 465 | * @bus: I2C bus to select |
| 466 | * @channel: Channel number correponding to the bus to select |
| 467 | * @return 0 if OK, -ve on error |
| 468 | */ |
| 469 | int (*select)(struct udevice *mux, struct udevice *bus, uint channel); |
| 470 | |
| 471 | /** |
| 472 | * deselect() - select one of of I2C buses attached to a mux |
| 473 | * |
| 474 | * This is used to deselect the currently selected I2C bus. |
| 475 | * |
| 476 | * @mux: Mux device |
| 477 | * @bus: I2C bus to deselect |
| 478 | * @channel: Channel number correponding to the bus to deselect |
| 479 | * @return 0 if OK, -ve on error |
| 480 | */ |
| 481 | int (*deselect)(struct udevice *mux, struct udevice *bus, uint channel); |
| 482 | }; |
| 483 | |
| 484 | #define i2c_mux_get_ops(dev) ((struct i2c_mux_ops *)(dev)->driver->ops) |
| 485 | |
| 486 | /** |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 487 | * i2c_get_chip() - get a device to use to access a chip on a bus |
| 488 | * |
| 489 | * This returns the device for the given chip address. The device can then |
| 490 | * be used with calls to i2c_read(), i2c_write(), i2c_probe(), etc. |
| 491 | * |
| 492 | * @bus: Bus to examine |
| 493 | * @chip_addr: Chip address for the new device |
Simon Glass | a2723ae | 2015-01-25 08:26:55 -0700 | [diff] [blame] | 494 | * @offset_len: Length of a register offset in bytes (normally 1) |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 495 | * @devp: Returns pointer to new device if found or -ENODEV if not |
| 496 | * found |
| 497 | */ |
Simon Glass | a2723ae | 2015-01-25 08:26:55 -0700 | [diff] [blame] | 498 | int i2c_get_chip(struct udevice *bus, uint chip_addr, uint offset_len, |
| 499 | struct udevice **devp); |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 500 | |
| 501 | /** |
Stefan Roese | c2df68ff | 2015-11-25 07:41:58 +0100 | [diff] [blame] | 502 | * i2c_get_chip_for_busnum() - get a device to use to access a chip on |
| 503 | * a bus number |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 504 | * |
| 505 | * This returns the device for the given chip address on a particular bus |
| 506 | * number. |
| 507 | * |
| 508 | * @busnum: Bus number to examine |
| 509 | * @chip_addr: Chip address for the new device |
Simon Glass | a2723ae | 2015-01-25 08:26:55 -0700 | [diff] [blame] | 510 | * @offset_len: Length of a register offset in bytes (normally 1) |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 511 | * @devp: Returns pointer to new device if found or -ENODEV if not |
| 512 | * found |
| 513 | */ |
Simon Glass | a2723ae | 2015-01-25 08:26:55 -0700 | [diff] [blame] | 514 | int i2c_get_chip_for_busnum(int busnum, int chip_addr, uint offset_len, |
| 515 | struct udevice **devp); |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 516 | |
| 517 | /** |
| 518 | * i2c_chip_ofdata_to_platdata() - Decode standard I2C platform data |
| 519 | * |
| 520 | * This decodes the chip address from a device tree node and puts it into |
| 521 | * its dm_i2c_chip structure. This should be called in your driver's |
| 522 | * ofdata_to_platdata() method. |
| 523 | * |
| 524 | * @blob: Device tree blob |
| 525 | * @node: Node offset to read from |
| 526 | * @spi: Place to put the decoded information |
| 527 | */ |
| 528 | int i2c_chip_ofdata_to_platdata(const void *blob, int node, |
| 529 | struct dm_i2c_chip *chip); |
| 530 | |
Simon Glass | a8e64c4 | 2015-07-02 18:15:39 -0600 | [diff] [blame] | 531 | /** |
| 532 | * i2c_dump_msgs() - Dump a list of I2C messages |
| 533 | * |
| 534 | * This may be useful for debugging. |
| 535 | * |
| 536 | * @msg: Message list to dump |
| 537 | * @nmsgs: Number of messages |
| 538 | */ |
| 539 | void i2c_dump_msgs(struct i2c_msg *msg, int nmsgs); |
| 540 | |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 541 | #ifndef CONFIG_DM_I2C |
| 542 | |
| 543 | /* |
wdenk | 1f04521 | 2002-03-10 14:37:15 +0000 | [diff] [blame] | 544 | * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING |
| 545 | * |
| 546 | * The implementation MUST NOT use static or global variables if the |
| 547 | * I2C routines are used to read SDRAM configuration information |
| 548 | * because this is done before the memories are initialized. Limited |
| 549 | * use of stack-based variables are OK (the initial stack size is |
| 550 | * limited). |
| 551 | * |
| 552 | * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING |
| 553 | */ |
| 554 | |
| 555 | /* |
| 556 | * Configuration items. |
| 557 | */ |
| 558 | #define I2C_RXTX_LEN 128 /* maximum tx/rx buffer length */ |
| 559 | |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 560 | #if !defined(CONFIG_SYS_I2C_MAX_HOPS) |
| 561 | /* no muxes used bus = i2c adapters */ |
| 562 | #define CONFIG_SYS_I2C_DIRECT_BUS 1 |
| 563 | #define CONFIG_SYS_I2C_MAX_HOPS 0 |
| 564 | #define CONFIG_SYS_NUM_I2C_BUSES ll_entry_count(struct i2c_adapter, i2c) |
Stefan Roese | d07117e | 2007-02-20 10:27:08 +0100 | [diff] [blame] | 565 | #else |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 566 | /* we use i2c muxes */ |
| 567 | #undef CONFIG_SYS_I2C_DIRECT_BUS |
Stefan Roese | d07117e | 2007-02-20 10:27:08 +0100 | [diff] [blame] | 568 | #endif |
| 569 | |
Stefan Roese | 9de4fcb | 2007-03-01 07:03:25 +0100 | [diff] [blame] | 570 | /* define the I2C bus number for RTC and DTT if not already done */ |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 571 | #if !defined(CONFIG_SYS_RTC_BUS_NUM) |
| 572 | #define CONFIG_SYS_RTC_BUS_NUM 0 |
Stefan Roese | 9de4fcb | 2007-03-01 07:03:25 +0100 | [diff] [blame] | 573 | #endif |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 574 | #if !defined(CONFIG_SYS_SPD_BUS_NUM) |
| 575 | #define CONFIG_SYS_SPD_BUS_NUM 0 |
Matthias Fuchs | 66067c3 | 2007-03-08 16:20:32 +0100 | [diff] [blame] | 576 | #endif |
Stefan Roese | 9de4fcb | 2007-03-01 07:03:25 +0100 | [diff] [blame] | 577 | |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 578 | struct i2c_adapter { |
| 579 | void (*init)(struct i2c_adapter *adap, int speed, |
| 580 | int slaveaddr); |
| 581 | int (*probe)(struct i2c_adapter *adap, uint8_t chip); |
| 582 | int (*read)(struct i2c_adapter *adap, uint8_t chip, |
| 583 | uint addr, int alen, uint8_t *buffer, |
| 584 | int len); |
| 585 | int (*write)(struct i2c_adapter *adap, uint8_t chip, |
| 586 | uint addr, int alen, uint8_t *buffer, |
| 587 | int len); |
| 588 | uint (*set_bus_speed)(struct i2c_adapter *adap, |
| 589 | uint speed); |
| 590 | int speed; |
Hannes Petermaier | d588505 | 2014-02-03 21:22:18 +0100 | [diff] [blame] | 591 | int waitdelay; |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 592 | int slaveaddr; |
| 593 | int init_done; |
| 594 | int hwadapnr; |
| 595 | char *name; |
| 596 | }; |
| 597 | |
| 598 | #define U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \ |
| 599 | _set_speed, _speed, _slaveaddr, _hwadapnr, _name) \ |
| 600 | { \ |
| 601 | .init = _init, \ |
| 602 | .probe = _probe, \ |
| 603 | .read = _read, \ |
| 604 | .write = _write, \ |
| 605 | .set_bus_speed = _set_speed, \ |
| 606 | .speed = _speed, \ |
| 607 | .slaveaddr = _slaveaddr, \ |
| 608 | .init_done = 0, \ |
| 609 | .hwadapnr = _hwadapnr, \ |
| 610 | .name = #_name \ |
| 611 | }; |
| 612 | |
| 613 | #define U_BOOT_I2C_ADAP_COMPLETE(_name, _init, _probe, _read, _write, \ |
| 614 | _set_speed, _speed, _slaveaddr, _hwadapnr) \ |
| 615 | ll_entry_declare(struct i2c_adapter, _name, i2c) = \ |
| 616 | U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \ |
| 617 | _set_speed, _speed, _slaveaddr, _hwadapnr, _name); |
| 618 | |
| 619 | struct i2c_adapter *i2c_get_adapter(int index); |
| 620 | |
| 621 | #ifndef CONFIG_SYS_I2C_DIRECT_BUS |
| 622 | struct i2c_mux { |
| 623 | int id; |
| 624 | char name[16]; |
| 625 | }; |
| 626 | |
| 627 | struct i2c_next_hop { |
| 628 | struct i2c_mux mux; |
| 629 | uint8_t chip; |
| 630 | uint8_t channel; |
| 631 | }; |
| 632 | |
| 633 | struct i2c_bus_hose { |
| 634 | int adapter; |
| 635 | struct i2c_next_hop next_hop[CONFIG_SYS_I2C_MAX_HOPS]; |
| 636 | }; |
| 637 | #define I2C_NULL_HOP {{-1, ""}, 0, 0} |
| 638 | extern struct i2c_bus_hose i2c_bus[]; |
| 639 | |
| 640 | #define I2C_ADAPTER(bus) i2c_bus[bus].adapter |
| 641 | #else |
| 642 | #define I2C_ADAPTER(bus) bus |
| 643 | #endif |
| 644 | #define I2C_BUS gd->cur_i2c_bus |
| 645 | |
| 646 | #define I2C_ADAP_NR(bus) i2c_get_adapter(I2C_ADAPTER(bus)) |
| 647 | #define I2C_ADAP I2C_ADAP_NR(gd->cur_i2c_bus) |
| 648 | #define I2C_ADAP_HWNR (I2C_ADAP->hwadapnr) |
| 649 | |
| 650 | #ifndef CONFIG_SYS_I2C_DIRECT_BUS |
| 651 | #define I2C_MUX_PCA9540_ID 1 |
| 652 | #define I2C_MUX_PCA9540 {I2C_MUX_PCA9540_ID, "PCA9540B"} |
| 653 | #define I2C_MUX_PCA9542_ID 2 |
| 654 | #define I2C_MUX_PCA9542 {I2C_MUX_PCA9542_ID, "PCA9542A"} |
| 655 | #define I2C_MUX_PCA9544_ID 3 |
| 656 | #define I2C_MUX_PCA9544 {I2C_MUX_PCA9544_ID, "PCA9544A"} |
| 657 | #define I2C_MUX_PCA9547_ID 4 |
| 658 | #define I2C_MUX_PCA9547 {I2C_MUX_PCA9547_ID, "PCA9547A"} |
Michael Burr | a04a55c | 2013-09-23 22:35:45 +0000 | [diff] [blame] | 659 | #define I2C_MUX_PCA9548_ID 5 |
| 660 | #define I2C_MUX_PCA9548 {I2C_MUX_PCA9548_ID, "PCA9548"} |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 661 | #endif |
wdenk | 6b58f33 | 2003-03-14 20:47:52 +0000 | [diff] [blame] | 662 | |
Heiko Schocher | dc7d22a | 2008-10-15 09:35:26 +0200 | [diff] [blame] | 663 | #ifndef I2C_SOFT_DECLARATIONS |
| 664 | # if defined(CONFIG_MPC8260) |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 665 | # define I2C_SOFT_DECLARATIONS volatile ioport_t *iop = ioport_addr((immap_t *)CONFIG_SYS_IMMR, I2C_PORT); |
Heiko Schocher | dc7d22a | 2008-10-15 09:35:26 +0200 | [diff] [blame] | 666 | # elif defined(CONFIG_8xx) |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 667 | # define I2C_SOFT_DECLARATIONS volatile immap_t *immr = (immap_t *)CONFIG_SYS_IMMR; |
Jens Scharsig | a4db1ca | 2010-02-03 22:46:58 +0100 | [diff] [blame] | 668 | |
| 669 | # elif (defined(CONFIG_AT91RM9200) || \ |
| 670 | defined(CONFIG_AT91SAM9260) || defined(CONFIG_AT91SAM9261) || \ |
Andreas Bießmann | a864979 | 2013-10-30 15:18:18 +0100 | [diff] [blame] | 671 | defined(CONFIG_AT91SAM9263)) |
esw@bus-elektronik.de | 5082bab | 2011-12-20 06:05:30 +0000 | [diff] [blame] | 672 | # define I2C_SOFT_DECLARATIONS at91_pio_t *pio = (at91_pio_t *) ATMEL_BASE_PIOA; |
Heiko Schocher | dc7d22a | 2008-10-15 09:35:26 +0200 | [diff] [blame] | 673 | # else |
| 674 | # define I2C_SOFT_DECLARATIONS |
| 675 | # endif |
| 676 | #endif |
Timur Tabi | 13d598f | 2008-12-03 11:28:30 -0600 | [diff] [blame] | 677 | |
| 678 | #ifdef CONFIG_8xx |
Peter Tyser | 769069e | 2009-04-24 15:34:05 -0500 | [diff] [blame] | 679 | /* Set default value for the I2C bus speed on 8xx. In the |
Timur Tabi | 13d598f | 2008-12-03 11:28:30 -0600 | [diff] [blame] | 680 | * future, we'll define these in all 8xx board config files. |
| 681 | */ |
| 682 | #ifndef CONFIG_SYS_I2C_SPEED |
| 683 | #define CONFIG_SYS_I2C_SPEED 50000 |
| 684 | #endif |
Peter Tyser | 769069e | 2009-04-24 15:34:05 -0500 | [diff] [blame] | 685 | #endif |
Timur Tabi | 13d598f | 2008-12-03 11:28:30 -0600 | [diff] [blame] | 686 | |
Peter Tyser | 769069e | 2009-04-24 15:34:05 -0500 | [diff] [blame] | 687 | /* |
| 688 | * Many boards/controllers/drivers don't support an I2C slave interface so |
| 689 | * provide a default slave address for them for use in common code. A real |
| 690 | * value for CONFIG_SYS_I2C_SLAVE should be defined for any board which does |
| 691 | * support a slave interface. |
| 692 | */ |
Timur Tabi | 13d598f | 2008-12-03 11:28:30 -0600 | [diff] [blame] | 693 | #ifndef CONFIG_SYS_I2C_SLAVE |
Peter Tyser | 769069e | 2009-04-24 15:34:05 -0500 | [diff] [blame] | 694 | #define CONFIG_SYS_I2C_SLAVE 0xfe |
Timur Tabi | 13d598f | 2008-12-03 11:28:30 -0600 | [diff] [blame] | 695 | #endif |
| 696 | |
wdenk | 1f04521 | 2002-03-10 14:37:15 +0000 | [diff] [blame] | 697 | /* |
| 698 | * Initialization, must be called once on start up, may be called |
| 699 | * repeatedly to change the speed and slave addresses. |
| 700 | */ |
Yuan Yao | d40c885 | 2016-06-08 18:24:51 +0800 | [diff] [blame] | 701 | #ifdef CONFIG_SYS_I2C_EARLY_INIT |
| 702 | void i2c_early_init_f(void); |
| 703 | #endif |
wdenk | 1f04521 | 2002-03-10 14:37:15 +0000 | [diff] [blame] | 704 | void i2c_init(int speed, int slaveaddr); |
wdenk | 1f04521 | 2002-03-10 14:37:15 +0000 | [diff] [blame] | 705 | void i2c_init_board(void); |
wdenk | 1f04521 | 2002-03-10 14:37:15 +0000 | [diff] [blame] | 706 | |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 707 | #ifdef CONFIG_SYS_I2C |
| 708 | /* |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 709 | * i2c_get_bus_num: |
| 710 | * |
| 711 | * Returns index of currently active I2C bus. Zero-based. |
| 712 | */ |
| 713 | unsigned int i2c_get_bus_num(void); |
Heiko Schocher | 6ee861b | 2008-10-15 09:39:47 +0200 | [diff] [blame] | 714 | |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 715 | /* |
| 716 | * i2c_set_bus_num: |
| 717 | * |
| 718 | * Change the active I2C bus. Subsequent read/write calls will |
| 719 | * go to this one. |
| 720 | * |
| 721 | * bus - bus index, zero based |
| 722 | * |
| 723 | * Returns: 0 on success, not 0 on failure |
| 724 | * |
| 725 | */ |
| 726 | int i2c_set_bus_num(unsigned int bus); |
Heiko Schocher | 6ee861b | 2008-10-15 09:39:47 +0200 | [diff] [blame] | 727 | |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 728 | /* |
| 729 | * i2c_init_all(): |
| 730 | * |
| 731 | * Initializes all I2C adapters in the system. All i2c_adap structures must |
| 732 | * be initialized beforehead with function pointers and data, including |
| 733 | * speed and slaveaddr. Returns 0 on success, non-0 on failure. |
| 734 | */ |
| 735 | void i2c_init_all(void); |
Heiko Schocher | 6ee861b | 2008-10-15 09:39:47 +0200 | [diff] [blame] | 736 | |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 737 | /* |
| 738 | * Probe the given I2C chip address. Returns 0 if a chip responded, |
| 739 | * not 0 on failure. |
| 740 | */ |
| 741 | int i2c_probe(uint8_t chip); |
| 742 | |
| 743 | /* |
| 744 | * Read/Write interface: |
| 745 | * chip: I2C chip address, range 0..127 |
| 746 | * addr: Memory (register) address within the chip |
| 747 | * alen: Number of bytes to use for addr (typically 1, 2 for larger |
| 748 | * memories, 0 for register type devices with only one |
| 749 | * register) |
| 750 | * buffer: Where to read/write the data |
| 751 | * len: How many bytes to read/write |
| 752 | * |
| 753 | * Returns: 0 on success, not 0 on failure |
| 754 | */ |
| 755 | int i2c_read(uint8_t chip, unsigned int addr, int alen, |
| 756 | uint8_t *buffer, int len); |
| 757 | |
| 758 | int i2c_write(uint8_t chip, unsigned int addr, int alen, |
| 759 | uint8_t *buffer, int len); |
| 760 | |
| 761 | /* |
| 762 | * Utility routines to read/write registers. |
| 763 | */ |
| 764 | uint8_t i2c_reg_read(uint8_t addr, uint8_t reg); |
| 765 | |
| 766 | void i2c_reg_write(uint8_t addr, uint8_t reg, uint8_t val); |
| 767 | |
| 768 | /* |
| 769 | * i2c_set_bus_speed: |
| 770 | * |
| 771 | * Change the speed of the active I2C bus |
| 772 | * |
| 773 | * speed - bus speed in Hz |
| 774 | * |
| 775 | * Returns: new bus speed |
| 776 | * |
| 777 | */ |
| 778 | unsigned int i2c_set_bus_speed(unsigned int speed); |
| 779 | |
| 780 | /* |
| 781 | * i2c_get_bus_speed: |
| 782 | * |
| 783 | * Returns speed of currently active I2C bus in Hz |
| 784 | */ |
| 785 | |
| 786 | unsigned int i2c_get_bus_speed(void); |
| 787 | |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 788 | #else |
Heiko Schocher | 6ee861b | 2008-10-15 09:39:47 +0200 | [diff] [blame] | 789 | |
wdenk | 1f04521 | 2002-03-10 14:37:15 +0000 | [diff] [blame] | 790 | /* |
| 791 | * Probe the given I2C chip address. Returns 0 if a chip responded, |
| 792 | * not 0 on failure. |
| 793 | */ |
| 794 | int i2c_probe(uchar chip); |
| 795 | |
| 796 | /* |
| 797 | * Read/Write interface: |
| 798 | * chip: I2C chip address, range 0..127 |
| 799 | * addr: Memory (register) address within the chip |
| 800 | * alen: Number of bytes to use for addr (typically 1, 2 for larger |
| 801 | * memories, 0 for register type devices with only one |
| 802 | * register) |
| 803 | * buffer: Where to read/write the data |
| 804 | * len: How many bytes to read/write |
| 805 | * |
| 806 | * Returns: 0 on success, not 0 on failure |
| 807 | */ |
| 808 | int i2c_read(uchar chip, uint addr, int alen, uchar *buffer, int len); |
| 809 | int i2c_write(uchar chip, uint addr, int alen, uchar *buffer, int len); |
| 810 | |
| 811 | /* |
| 812 | * Utility routines to read/write registers. |
| 813 | */ |
Timur Tabi | 13d598f | 2008-12-03 11:28:30 -0600 | [diff] [blame] | 814 | static inline u8 i2c_reg_read(u8 addr, u8 reg) |
| 815 | { |
| 816 | u8 buf; |
| 817 | |
| 818 | #ifdef CONFIG_8xx |
| 819 | /* MPC8xx needs this. Maybe one day we can get rid of it. */ |
| 820 | i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE); |
| 821 | #endif |
| 822 | |
| 823 | #ifdef DEBUG |
| 824 | printf("%s: addr=0x%02x, reg=0x%02x\n", __func__, addr, reg); |
| 825 | #endif |
| 826 | |
Timur Tabi | 13d598f | 2008-12-03 11:28:30 -0600 | [diff] [blame] | 827 | i2c_read(addr, reg, 1, &buf, 1); |
Timur Tabi | 13d598f | 2008-12-03 11:28:30 -0600 | [diff] [blame] | 828 | |
| 829 | return buf; |
| 830 | } |
| 831 | |
| 832 | static inline void i2c_reg_write(u8 addr, u8 reg, u8 val) |
| 833 | { |
| 834 | #ifdef CONFIG_8xx |
| 835 | /* MPC8xx needs this. Maybe one day we can get rid of it. */ |
| 836 | i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE); |
| 837 | #endif |
| 838 | |
| 839 | #ifdef DEBUG |
| 840 | printf("%s: addr=0x%02x, reg=0x%02x, val=0x%02x\n", |
| 841 | __func__, addr, reg, val); |
| 842 | #endif |
| 843 | |
Timur Tabi | 13d598f | 2008-12-03 11:28:30 -0600 | [diff] [blame] | 844 | i2c_write(addr, reg, 1, &val, 1); |
Timur Tabi | 13d598f | 2008-12-03 11:28:30 -0600 | [diff] [blame] | 845 | } |
wdenk | 1f04521 | 2002-03-10 14:37:15 +0000 | [diff] [blame] | 846 | |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 847 | /* |
| 848 | * Functions for setting the current I2C bus and its speed |
| 849 | */ |
| 850 | |
| 851 | /* |
| 852 | * i2c_set_bus_num: |
| 853 | * |
| 854 | * Change the active I2C bus. Subsequent read/write calls will |
| 855 | * go to this one. |
| 856 | * |
Wolfgang Denk | a1be476 | 2008-05-20 16:00:29 +0200 | [diff] [blame] | 857 | * bus - bus index, zero based |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 858 | * |
Wolfgang Denk | a1be476 | 2008-05-20 16:00:29 +0200 | [diff] [blame] | 859 | * Returns: 0 on success, not 0 on failure |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 860 | * |
| 861 | */ |
Timur Tabi | c0b114a | 2006-10-31 21:23:16 -0600 | [diff] [blame] | 862 | int i2c_set_bus_num(unsigned int bus); |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 863 | |
| 864 | /* |
| 865 | * i2c_get_bus_num: |
| 866 | * |
| 867 | * Returns index of currently active I2C bus. Zero-based. |
| 868 | */ |
| 869 | |
Timur Tabi | c0b114a | 2006-10-31 21:23:16 -0600 | [diff] [blame] | 870 | unsigned int i2c_get_bus_num(void); |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 871 | |
| 872 | /* |
| 873 | * i2c_set_bus_speed: |
| 874 | * |
| 875 | * Change the speed of the active I2C bus |
| 876 | * |
Wolfgang Denk | a1be476 | 2008-05-20 16:00:29 +0200 | [diff] [blame] | 877 | * speed - bus speed in Hz |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 878 | * |
Wolfgang Denk | a1be476 | 2008-05-20 16:00:29 +0200 | [diff] [blame] | 879 | * Returns: 0 on success, not 0 on failure |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 880 | * |
| 881 | */ |
Timur Tabi | c0b114a | 2006-10-31 21:23:16 -0600 | [diff] [blame] | 882 | int i2c_set_bus_speed(unsigned int); |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 883 | |
| 884 | /* |
| 885 | * i2c_get_bus_speed: |
| 886 | * |
| 887 | * Returns speed of currently active I2C bus in Hz |
| 888 | */ |
| 889 | |
Timur Tabi | c0b114a | 2006-10-31 21:23:16 -0600 | [diff] [blame] | 890 | unsigned int i2c_get_bus_speed(void); |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 891 | #endif /* CONFIG_SYS_I2C */ |
| 892 | |
| 893 | /* |
| 894 | * only for backwardcompatibility, should go away if we switched |
| 895 | * completely to new multibus support. |
| 896 | */ |
| 897 | #if defined(CONFIG_SYS_I2C) || defined(CONFIG_I2C_MULTI_BUS) |
| 898 | # if !defined(CONFIG_SYS_MAX_I2C_BUS) |
| 899 | # define CONFIG_SYS_MAX_I2C_BUS 2 |
| 900 | # endif |
Łukasz Majewski | 1a6a2a9 | 2013-08-16 15:31:45 +0200 | [diff] [blame] | 901 | # define I2C_MULTI_BUS 1 |
Heiko Schocher | e7d9c4f | 2012-01-16 21:12:23 +0000 | [diff] [blame] | 902 | #else |
| 903 | # define CONFIG_SYS_MAX_I2C_BUS 1 |
| 904 | # define I2C_MULTI_BUS 0 |
| 905 | #endif |
Ben Warren | 4565715 | 2006-09-07 16:50:54 -0400 | [diff] [blame] | 906 | |
Marek Vasut | 513b820 | 2011-10-25 11:40:57 +0200 | [diff] [blame] | 907 | /* NOTE: These two functions MUST be always_inline to avoid code growth! */ |
| 908 | static inline unsigned int I2C_GET_BUS(void) __attribute__((always_inline)); |
| 909 | static inline unsigned int I2C_GET_BUS(void) |
| 910 | { |
| 911 | return I2C_MULTI_BUS ? i2c_get_bus_num() : 0; |
| 912 | } |
| 913 | |
| 914 | static inline void I2C_SET_BUS(unsigned int bus) __attribute__((always_inline)); |
| 915 | static inline void I2C_SET_BUS(unsigned int bus) |
| 916 | { |
| 917 | if (I2C_MULTI_BUS) |
| 918 | i2c_set_bus_num(bus); |
| 919 | } |
| 920 | |
Łukasz Majewski | b2d7652 | 2012-09-04 23:15:20 +0000 | [diff] [blame] | 921 | /* Multi I2C definitions */ |
| 922 | enum { |
| 923 | I2C_0, I2C_1, I2C_2, I2C_3, I2C_4, I2C_5, I2C_6, I2C_7, |
| 924 | I2C_8, I2C_9, I2C_10, |
| 925 | }; |
| 926 | |
Rajeshwari Shinde | 53cfac5 | 2012-12-26 20:03:12 +0000 | [diff] [blame] | 927 | /** |
| 928 | * Get FDT values for i2c bus. |
| 929 | * |
| 930 | * @param blob Device tree blbo |
| 931 | * @return the number of I2C bus |
| 932 | */ |
| 933 | void board_i2c_init(const void *blob); |
| 934 | |
| 935 | /** |
| 936 | * Find the I2C bus number by given a FDT I2C node. |
| 937 | * |
| 938 | * @param blob Device tree blbo |
| 939 | * @param node FDT I2C node to find |
| 940 | * @return the number of I2C bus (zero based), or -1 on error |
| 941 | */ |
| 942 | int i2c_get_bus_num_fdt(int node); |
| 943 | |
| 944 | /** |
| 945 | * Reset the I2C bus represented by the given a FDT I2C node. |
| 946 | * |
| 947 | * @param blob Device tree blbo |
| 948 | * @param node FDT I2C node to find |
| 949 | * @return 0 if port was reset, -1 if not found |
| 950 | */ |
| 951 | int i2c_reset_port_fdt(const void *blob, int node); |
Simon Glass | c7a5890 | 2014-12-10 08:55:47 -0700 | [diff] [blame] | 952 | |
| 953 | #endif /* !CONFIG_DM_I2C */ |
| 954 | |
wdenk | 1f04521 | 2002-03-10 14:37:15 +0000 | [diff] [blame] | 955 | #endif /* _I2C_H_ */ |