1 /* 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 * 6 * (C) Copyright 2001 7 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com. 8 * 9 * SPDX-License-Identifier: GPL-2.0+ 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 /* 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 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 34 struct udevice; 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 * 41 * To obtain this structure, use dev_get_parent_platdata(dev) where dev is 42 * the chip to examine. 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; 57 bool test_mode; 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 dev_get_uclass_priv(bus) where bus is the 69 * I2C bus udevice. 70 * 71 * @speed_hz: Bus speed in hertz (typically 100000) 72 */ 73 struct dm_i2c_bus { 74 int speed_hz; 75 }; 76 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 120 /** 121 * dm_i2c_read() - read bytes from an I2C chip 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 */ 137 int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len); 138 139 /** 140 * dm_i2c_write() - write bytes to an I2C chip 141 * 142 * See notes for dm_i2c_read() above. 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 */ 151 int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer, 152 int len); 153 154 /** 155 * dm_i2c_probe() - probe a particular chip address 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 */ 167 int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags, 168 struct udevice **devp); 169 170 /** 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 * 175 * @dev: Device to use for transfer 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 * 186 * @dev: Device to use for transfer 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 /** 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 /** 207 * dm_i2c_set_bus_speed() - set the speed of a bus 208 * 209 * @bus: Bus to adjust 210 * @speed: Requested speed in Hz 211 * @return 0 if OK, -EINVAL for invalid values 212 */ 213 int dm_i2c_set_bus_speed(struct udevice *bus, unsigned int speed); 214 215 /** 216 * dm_i2c_get_bus_speed() - get the speed of a bus 217 * 218 * @bus: Bus to check 219 * @return speed of selected I2C bus in Hz, -ve on error 220 */ 221 int dm_i2c_get_bus_speed(struct udevice *bus); 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 */ 254 int i2c_set_chip_offset_len(struct udevice *dev, uint offset_len); 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 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 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 /** 314 * i2c_set_bus_num() - Compatibility function for driver model 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 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 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 351 #endif 352 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 393 * dev_get_uclass_priv(bus)->speed_hz 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 407 * normally be expected to return dev_get_uclass_priv(bus)->speed_hz. 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 /** 448 * i2c_get_chip() - get a device to use to access a chip on a bus 449 * 450 * This returns the device for the given chip address. The device can then 451 * be used with calls to i2c_read(), i2c_write(), i2c_probe(), etc. 452 * 453 * @bus: Bus to examine 454 * @chip_addr: Chip address for the new device 455 * @offset_len: Length of a register offset in bytes (normally 1) 456 * @devp: Returns pointer to new device if found or -ENODEV if not 457 * found 458 */ 459 int i2c_get_chip(struct udevice *bus, uint chip_addr, uint offset_len, 460 struct udevice **devp); 461 462 /** 463 * i2c_get_chip() - get a device to use to access a chip on a bus number 464 * 465 * This returns the device for the given chip address on a particular bus 466 * number. 467 * 468 * @busnum: Bus number to examine 469 * @chip_addr: Chip address for the new device 470 * @offset_len: Length of a register offset in bytes (normally 1) 471 * @devp: Returns pointer to new device if found or -ENODEV if not 472 * found 473 */ 474 int i2c_get_chip_for_busnum(int busnum, int chip_addr, uint offset_len, 475 struct udevice **devp); 476 477 /** 478 * i2c_chip_ofdata_to_platdata() - Decode standard I2C platform data 479 * 480 * This decodes the chip address from a device tree node and puts it into 481 * its dm_i2c_chip structure. This should be called in your driver's 482 * ofdata_to_platdata() method. 483 * 484 * @blob: Device tree blob 485 * @node: Node offset to read from 486 * @spi: Place to put the decoded information 487 */ 488 int i2c_chip_ofdata_to_platdata(const void *blob, int node, 489 struct dm_i2c_chip *chip); 490 491 /** 492 * i2c_dump_msgs() - Dump a list of I2C messages 493 * 494 * This may be useful for debugging. 495 * 496 * @msg: Message list to dump 497 * @nmsgs: Number of messages 498 */ 499 void i2c_dump_msgs(struct i2c_msg *msg, int nmsgs); 500 501 #ifndef CONFIG_DM_I2C 502 503 /* 504 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING 505 * 506 * The implementation MUST NOT use static or global variables if the 507 * I2C routines are used to read SDRAM configuration information 508 * because this is done before the memories are initialized. Limited 509 * use of stack-based variables are OK (the initial stack size is 510 * limited). 511 * 512 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING 513 */ 514 515 /* 516 * Configuration items. 517 */ 518 #define I2C_RXTX_LEN 128 /* maximum tx/rx buffer length */ 519 520 #if !defined(CONFIG_SYS_I2C_MAX_HOPS) 521 /* no muxes used bus = i2c adapters */ 522 #define CONFIG_SYS_I2C_DIRECT_BUS 1 523 #define CONFIG_SYS_I2C_MAX_HOPS 0 524 #define CONFIG_SYS_NUM_I2C_BUSES ll_entry_count(struct i2c_adapter, i2c) 525 #else 526 /* we use i2c muxes */ 527 #undef CONFIG_SYS_I2C_DIRECT_BUS 528 #endif 529 530 /* define the I2C bus number for RTC and DTT if not already done */ 531 #if !defined(CONFIG_SYS_RTC_BUS_NUM) 532 #define CONFIG_SYS_RTC_BUS_NUM 0 533 #endif 534 #if !defined(CONFIG_SYS_DTT_BUS_NUM) 535 #define CONFIG_SYS_DTT_BUS_NUM 0 536 #endif 537 #if !defined(CONFIG_SYS_SPD_BUS_NUM) 538 #define CONFIG_SYS_SPD_BUS_NUM 0 539 #endif 540 541 struct i2c_adapter { 542 void (*init)(struct i2c_adapter *adap, int speed, 543 int slaveaddr); 544 int (*probe)(struct i2c_adapter *adap, uint8_t chip); 545 int (*read)(struct i2c_adapter *adap, uint8_t chip, 546 uint addr, int alen, uint8_t *buffer, 547 int len); 548 int (*write)(struct i2c_adapter *adap, uint8_t chip, 549 uint addr, int alen, uint8_t *buffer, 550 int len); 551 uint (*set_bus_speed)(struct i2c_adapter *adap, 552 uint speed); 553 int speed; 554 int waitdelay; 555 int slaveaddr; 556 int init_done; 557 int hwadapnr; 558 char *name; 559 }; 560 561 #define U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \ 562 _set_speed, _speed, _slaveaddr, _hwadapnr, _name) \ 563 { \ 564 .init = _init, \ 565 .probe = _probe, \ 566 .read = _read, \ 567 .write = _write, \ 568 .set_bus_speed = _set_speed, \ 569 .speed = _speed, \ 570 .slaveaddr = _slaveaddr, \ 571 .init_done = 0, \ 572 .hwadapnr = _hwadapnr, \ 573 .name = #_name \ 574 }; 575 576 #define U_BOOT_I2C_ADAP_COMPLETE(_name, _init, _probe, _read, _write, \ 577 _set_speed, _speed, _slaveaddr, _hwadapnr) \ 578 ll_entry_declare(struct i2c_adapter, _name, i2c) = \ 579 U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \ 580 _set_speed, _speed, _slaveaddr, _hwadapnr, _name); 581 582 struct i2c_adapter *i2c_get_adapter(int index); 583 584 #ifndef CONFIG_SYS_I2C_DIRECT_BUS 585 struct i2c_mux { 586 int id; 587 char name[16]; 588 }; 589 590 struct i2c_next_hop { 591 struct i2c_mux mux; 592 uint8_t chip; 593 uint8_t channel; 594 }; 595 596 struct i2c_bus_hose { 597 int adapter; 598 struct i2c_next_hop next_hop[CONFIG_SYS_I2C_MAX_HOPS]; 599 }; 600 #define I2C_NULL_HOP {{-1, ""}, 0, 0} 601 extern struct i2c_bus_hose i2c_bus[]; 602 603 #define I2C_ADAPTER(bus) i2c_bus[bus].adapter 604 #else 605 #define I2C_ADAPTER(bus) bus 606 #endif 607 #define I2C_BUS gd->cur_i2c_bus 608 609 #define I2C_ADAP_NR(bus) i2c_get_adapter(I2C_ADAPTER(bus)) 610 #define I2C_ADAP I2C_ADAP_NR(gd->cur_i2c_bus) 611 #define I2C_ADAP_HWNR (I2C_ADAP->hwadapnr) 612 613 #ifndef CONFIG_SYS_I2C_DIRECT_BUS 614 #define I2C_MUX_PCA9540_ID 1 615 #define I2C_MUX_PCA9540 {I2C_MUX_PCA9540_ID, "PCA9540B"} 616 #define I2C_MUX_PCA9542_ID 2 617 #define I2C_MUX_PCA9542 {I2C_MUX_PCA9542_ID, "PCA9542A"} 618 #define I2C_MUX_PCA9544_ID 3 619 #define I2C_MUX_PCA9544 {I2C_MUX_PCA9544_ID, "PCA9544A"} 620 #define I2C_MUX_PCA9547_ID 4 621 #define I2C_MUX_PCA9547 {I2C_MUX_PCA9547_ID, "PCA9547A"} 622 #define I2C_MUX_PCA9548_ID 5 623 #define I2C_MUX_PCA9548 {I2C_MUX_PCA9548_ID, "PCA9548"} 624 #endif 625 626 #ifndef I2C_SOFT_DECLARATIONS 627 # if defined(CONFIG_MPC8260) 628 # define I2C_SOFT_DECLARATIONS volatile ioport_t *iop = ioport_addr((immap_t *)CONFIG_SYS_IMMR, I2C_PORT); 629 # elif defined(CONFIG_8xx) 630 # define I2C_SOFT_DECLARATIONS volatile immap_t *immr = (immap_t *)CONFIG_SYS_IMMR; 631 632 # elif (defined(CONFIG_AT91RM9200) || \ 633 defined(CONFIG_AT91SAM9260) || defined(CONFIG_AT91SAM9261) || \ 634 defined(CONFIG_AT91SAM9263)) 635 # define I2C_SOFT_DECLARATIONS at91_pio_t *pio = (at91_pio_t *) ATMEL_BASE_PIOA; 636 # else 637 # define I2C_SOFT_DECLARATIONS 638 # endif 639 #endif 640 641 #ifdef CONFIG_8xx 642 /* Set default value for the I2C bus speed on 8xx. In the 643 * future, we'll define these in all 8xx board config files. 644 */ 645 #ifndef CONFIG_SYS_I2C_SPEED 646 #define CONFIG_SYS_I2C_SPEED 50000 647 #endif 648 #endif 649 650 /* 651 * Many boards/controllers/drivers don't support an I2C slave interface so 652 * provide a default slave address for them for use in common code. A real 653 * value for CONFIG_SYS_I2C_SLAVE should be defined for any board which does 654 * support a slave interface. 655 */ 656 #ifndef CONFIG_SYS_I2C_SLAVE 657 #define CONFIG_SYS_I2C_SLAVE 0xfe 658 #endif 659 660 /* 661 * Initialization, must be called once on start up, may be called 662 * repeatedly to change the speed and slave addresses. 663 */ 664 void i2c_init(int speed, int slaveaddr); 665 void i2c_init_board(void); 666 #ifdef CONFIG_SYS_I2C_BOARD_LATE_INIT 667 void i2c_board_late_init(void); 668 #endif 669 670 #ifdef CONFIG_SYS_I2C 671 /* 672 * i2c_get_bus_num: 673 * 674 * Returns index of currently active I2C bus. Zero-based. 675 */ 676 unsigned int i2c_get_bus_num(void); 677 678 /* 679 * i2c_set_bus_num: 680 * 681 * Change the active I2C bus. Subsequent read/write calls will 682 * go to this one. 683 * 684 * bus - bus index, zero based 685 * 686 * Returns: 0 on success, not 0 on failure 687 * 688 */ 689 int i2c_set_bus_num(unsigned int bus); 690 691 /* 692 * i2c_init_all(): 693 * 694 * Initializes all I2C adapters in the system. All i2c_adap structures must 695 * be initialized beforehead with function pointers and data, including 696 * speed and slaveaddr. Returns 0 on success, non-0 on failure. 697 */ 698 void i2c_init_all(void); 699 700 /* 701 * Probe the given I2C chip address. Returns 0 if a chip responded, 702 * not 0 on failure. 703 */ 704 int i2c_probe(uint8_t chip); 705 706 /* 707 * Read/Write interface: 708 * chip: I2C chip address, range 0..127 709 * addr: Memory (register) address within the chip 710 * alen: Number of bytes to use for addr (typically 1, 2 for larger 711 * memories, 0 for register type devices with only one 712 * register) 713 * buffer: Where to read/write the data 714 * len: How many bytes to read/write 715 * 716 * Returns: 0 on success, not 0 on failure 717 */ 718 int i2c_read(uint8_t chip, unsigned int addr, int alen, 719 uint8_t *buffer, int len); 720 721 int i2c_write(uint8_t chip, unsigned int addr, int alen, 722 uint8_t *buffer, int len); 723 724 /* 725 * Utility routines to read/write registers. 726 */ 727 uint8_t i2c_reg_read(uint8_t addr, uint8_t reg); 728 729 void i2c_reg_write(uint8_t addr, uint8_t reg, uint8_t val); 730 731 /* 732 * i2c_set_bus_speed: 733 * 734 * Change the speed of the active I2C bus 735 * 736 * speed - bus speed in Hz 737 * 738 * Returns: new bus speed 739 * 740 */ 741 unsigned int i2c_set_bus_speed(unsigned int speed); 742 743 /* 744 * i2c_get_bus_speed: 745 * 746 * Returns speed of currently active I2C bus in Hz 747 */ 748 749 unsigned int i2c_get_bus_speed(void); 750 751 /* 752 * i2c_reloc_fixup: 753 * 754 * Adjusts I2C pointers after U-Boot is relocated to DRAM 755 */ 756 void i2c_reloc_fixup(void); 757 #if defined(CONFIG_SYS_I2C_SOFT) 758 void i2c_soft_init(void); 759 void i2c_soft_active(void); 760 void i2c_soft_tristate(void); 761 int i2c_soft_read(void); 762 void i2c_soft_sda(int bit); 763 void i2c_soft_scl(int bit); 764 void i2c_soft_delay(void); 765 #endif 766 #else 767 768 /* 769 * Probe the given I2C chip address. Returns 0 if a chip responded, 770 * not 0 on failure. 771 */ 772 int i2c_probe(uchar chip); 773 774 /* 775 * Read/Write interface: 776 * chip: I2C chip address, range 0..127 777 * addr: Memory (register) address within the chip 778 * alen: Number of bytes to use for addr (typically 1, 2 for larger 779 * memories, 0 for register type devices with only one 780 * register) 781 * buffer: Where to read/write the data 782 * len: How many bytes to read/write 783 * 784 * Returns: 0 on success, not 0 on failure 785 */ 786 int i2c_read(uchar chip, uint addr, int alen, uchar *buffer, int len); 787 int i2c_write(uchar chip, uint addr, int alen, uchar *buffer, int len); 788 789 /* 790 * Utility routines to read/write registers. 791 */ 792 static inline u8 i2c_reg_read(u8 addr, u8 reg) 793 { 794 u8 buf; 795 796 #ifdef CONFIG_8xx 797 /* MPC8xx needs this. Maybe one day we can get rid of it. */ 798 i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE); 799 #endif 800 801 #ifdef DEBUG 802 printf("%s: addr=0x%02x, reg=0x%02x\n", __func__, addr, reg); 803 #endif 804 805 i2c_read(addr, reg, 1, &buf, 1); 806 807 return buf; 808 } 809 810 static inline void i2c_reg_write(u8 addr, u8 reg, u8 val) 811 { 812 #ifdef CONFIG_8xx 813 /* MPC8xx needs this. Maybe one day we can get rid of it. */ 814 i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE); 815 #endif 816 817 #ifdef DEBUG 818 printf("%s: addr=0x%02x, reg=0x%02x, val=0x%02x\n", 819 __func__, addr, reg, val); 820 #endif 821 822 i2c_write(addr, reg, 1, &val, 1); 823 } 824 825 /* 826 * Functions for setting the current I2C bus and its speed 827 */ 828 829 /* 830 * i2c_set_bus_num: 831 * 832 * Change the active I2C bus. Subsequent read/write calls will 833 * go to this one. 834 * 835 * bus - bus index, zero based 836 * 837 * Returns: 0 on success, not 0 on failure 838 * 839 */ 840 int i2c_set_bus_num(unsigned int bus); 841 842 /* 843 * i2c_get_bus_num: 844 * 845 * Returns index of currently active I2C bus. Zero-based. 846 */ 847 848 unsigned int i2c_get_bus_num(void); 849 850 /* 851 * i2c_set_bus_speed: 852 * 853 * Change the speed of the active I2C bus 854 * 855 * speed - bus speed in Hz 856 * 857 * Returns: 0 on success, not 0 on failure 858 * 859 */ 860 int i2c_set_bus_speed(unsigned int); 861 862 /* 863 * i2c_get_bus_speed: 864 * 865 * Returns speed of currently active I2C bus in Hz 866 */ 867 868 unsigned int i2c_get_bus_speed(void); 869 #endif /* CONFIG_SYS_I2C */ 870 871 /* 872 * only for backwardcompatibility, should go away if we switched 873 * completely to new multibus support. 874 */ 875 #if defined(CONFIG_SYS_I2C) || defined(CONFIG_I2C_MULTI_BUS) 876 # if !defined(CONFIG_SYS_MAX_I2C_BUS) 877 # define CONFIG_SYS_MAX_I2C_BUS 2 878 # endif 879 # define I2C_MULTI_BUS 1 880 #else 881 # define CONFIG_SYS_MAX_I2C_BUS 1 882 # define I2C_MULTI_BUS 0 883 #endif 884 885 /* NOTE: These two functions MUST be always_inline to avoid code growth! */ 886 static inline unsigned int I2C_GET_BUS(void) __attribute__((always_inline)); 887 static inline unsigned int I2C_GET_BUS(void) 888 { 889 return I2C_MULTI_BUS ? i2c_get_bus_num() : 0; 890 } 891 892 static inline void I2C_SET_BUS(unsigned int bus) __attribute__((always_inline)); 893 static inline void I2C_SET_BUS(unsigned int bus) 894 { 895 if (I2C_MULTI_BUS) 896 i2c_set_bus_num(bus); 897 } 898 899 /* Multi I2C definitions */ 900 enum { 901 I2C_0, I2C_1, I2C_2, I2C_3, I2C_4, I2C_5, I2C_6, I2C_7, 902 I2C_8, I2C_9, I2C_10, 903 }; 904 905 /* Multi I2C busses handling */ 906 #ifdef CONFIG_SOFT_I2C_MULTI_BUS 907 extern int get_multi_scl_pin(void); 908 extern int get_multi_sda_pin(void); 909 extern int multi_i2c_init(void); 910 #endif 911 912 /** 913 * Get FDT values for i2c bus. 914 * 915 * @param blob Device tree blbo 916 * @return the number of I2C bus 917 */ 918 void board_i2c_init(const void *blob); 919 920 /** 921 * Find the I2C bus number by given a FDT I2C node. 922 * 923 * @param blob Device tree blbo 924 * @param node FDT I2C node to find 925 * @return the number of I2C bus (zero based), or -1 on error 926 */ 927 int i2c_get_bus_num_fdt(int node); 928 929 /** 930 * Reset the I2C bus represented by the given a FDT I2C node. 931 * 932 * @param blob Device tree blbo 933 * @param node FDT I2C node to find 934 * @return 0 if port was reset, -1 if not found 935 */ 936 int i2c_reset_port_fdt(const void *blob, int node); 937 938 #endif /* !CONFIG_DM_I2C */ 939 940 #endif /* _I2C_H_ */ 941