1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2014 Google, Inc
11 #include <dm/device-internal.h>
13 #include <dm/pinctrl.h>
18 #define I2C_MAX_OFFSET_LEN 4
26 /* Useful debugging function */
27 void i2c_dump_msgs(struct i2c_msg *msg, int nmsgs)
31 for (i = 0; i < nmsgs; i++) {
32 struct i2c_msg *m = &msg[i];
34 printf(" %s %x len=%x", m->flags & I2C_M_RD ? "R" : "W",
36 if (!(m->flags & I2C_M_RD))
37 printf(": %x", m->buf[0]);
43 * i2c_setup_offset() - Set up a new message with a chip offset
46 * @offset: Byte offset within chip
47 * @offset_buf: Place to put byte offset
48 * @msg: Message buffer
49 * @return 0 if OK, -EADDRNOTAVAIL if the offset length is 0. In that case the
50 * message is still set up but will not contain an offset.
52 static int i2c_setup_offset(struct dm_i2c_chip *chip, uint offset,
53 uint8_t offset_buf[], struct i2c_msg *msg)
57 msg->addr = chip->chip_addr;
58 msg->flags = chip->flags & DM_I2C_CHIP_10BIT ? I2C_M_TEN : 0;
59 msg->len = chip->offset_len;
60 msg->buf = offset_buf;
61 if (!chip->offset_len)
62 return -EADDRNOTAVAIL;
63 assert(chip->offset_len <= I2C_MAX_OFFSET_LEN);
64 offset_len = chip->offset_len;
66 *offset_buf++ = offset >> (8 * offset_len);
71 static int i2c_read_bytewise(struct udevice *dev, uint offset,
72 uint8_t *buffer, int len)
74 struct dm_i2c_chip *chip = dev_get_parent_platdata(dev);
75 struct udevice *bus = dev_get_parent(dev);
76 struct dm_i2c_ops *ops = i2c_get_ops(bus);
77 struct i2c_msg msg[2], *ptr;
78 uint8_t offset_buf[I2C_MAX_OFFSET_LEN];
82 for (i = 0; i < len; i++) {
83 if (i2c_setup_offset(chip, offset + i, offset_buf, msg))
86 ptr->addr = chip->chip_addr;
87 ptr->flags = msg->flags | I2C_M_RD;
89 ptr->buf = &buffer[i];
92 ret = ops->xfer(bus, msg, ptr - msg);
100 static int i2c_write_bytewise(struct udevice *dev, uint offset,
101 const uint8_t *buffer, int len)
103 struct dm_i2c_chip *chip = dev_get_parent_platdata(dev);
104 struct udevice *bus = dev_get_parent(dev);
105 struct dm_i2c_ops *ops = i2c_get_ops(bus);
106 struct i2c_msg msg[1];
107 uint8_t buf[I2C_MAX_OFFSET_LEN + 1];
111 for (i = 0; i < len; i++) {
112 if (i2c_setup_offset(chip, offset + i, buf, msg))
114 buf[msg->len++] = buffer[i];
116 ret = ops->xfer(bus, msg, 1);
124 int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len)
126 struct dm_i2c_chip *chip = dev_get_parent_platdata(dev);
127 struct udevice *bus = dev_get_parent(dev);
128 struct dm_i2c_ops *ops = i2c_get_ops(bus);
129 struct i2c_msg msg[2], *ptr;
130 uint8_t offset_buf[I2C_MAX_OFFSET_LEN];
135 if (chip->flags & DM_I2C_CHIP_RD_ADDRESS)
136 return i2c_read_bytewise(dev, offset, buffer, len);
138 if (!i2c_setup_offset(chip, offset, offset_buf, ptr))
142 ptr->addr = chip->chip_addr;
143 ptr->flags = chip->flags & DM_I2C_CHIP_10BIT ? I2C_M_TEN : 0;
144 ptr->flags |= I2C_M_RD;
149 msg_count = ptr - msg;
151 return ops->xfer(bus, msg, msg_count);
154 int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer,
157 struct dm_i2c_chip *chip = dev_get_parent_platdata(dev);
158 struct udevice *bus = dev_get_parent(dev);
159 struct dm_i2c_ops *ops = i2c_get_ops(bus);
160 struct i2c_msg msg[1];
165 if (chip->flags & DM_I2C_CHIP_WR_ADDRESS)
166 return i2c_write_bytewise(dev, offset, buffer, len);
168 * The simple approach would be to send two messages here: one to
169 * set the offset and one to write the bytes. However some drivers
170 * will not be expecting this, and some chips won't like how the
171 * driver presents this on the I2C bus.
173 * The API does not support separate offset and data. We could extend
174 * it with a flag indicating that there is data in the next message
175 * that needs to be processed in the same transaction. We could
176 * instead add an additional buffer to each message. For now, handle
177 * this in the uclass since it isn't clear what the impact on drivers
178 * would be with this extra complication. Unfortunately this means
179 * copying the message.
181 * Use the stack for small messages, malloc() for larger ones. We
182 * need to allow space for the offset (up to 4 bytes) and the message
186 uint8_t buf[I2C_MAX_OFFSET_LEN + len];
188 i2c_setup_offset(chip, offset, buf, msg);
190 memcpy(buf + chip->offset_len, buffer, len);
192 return ops->xfer(bus, msg, 1);
197 buf = malloc(I2C_MAX_OFFSET_LEN + len);
200 i2c_setup_offset(chip, offset, buf, msg);
202 memcpy(buf + chip->offset_len, buffer, len);
204 ret = ops->xfer(bus, msg, 1);
210 int dm_i2c_xfer(struct udevice *dev, struct i2c_msg *msg, int nmsgs)
212 struct udevice *bus = dev_get_parent(dev);
213 struct dm_i2c_ops *ops = i2c_get_ops(bus);
218 return ops->xfer(bus, msg, nmsgs);
221 int dm_i2c_reg_read(struct udevice *dev, uint offset)
226 ret = dm_i2c_read(dev, offset, &val, 1);
233 int dm_i2c_reg_write(struct udevice *dev, uint offset, uint value)
237 return dm_i2c_write(dev, offset, &val, 1);
241 * i2c_probe_chip() - probe for a chip on a bus
244 * @chip_addr: Chip address to probe
245 * @flags: Flags for the chip
246 * @return 0 if found, -ENOSYS if the driver is invalid, -EREMOTEIO if the chip
247 * does not respond to probe
249 static int i2c_probe_chip(struct udevice *bus, uint chip_addr,
250 enum dm_i2c_chip_flags chip_flags)
252 struct dm_i2c_ops *ops = i2c_get_ops(bus);
253 struct i2c_msg msg[1];
256 if (ops->probe_chip) {
257 ret = ops->probe_chip(bus, chip_addr, chip_flags);
258 if (!ret || ret != -ENOSYS)
265 /* Probe with a zero-length message */
266 msg->addr = chip_addr;
267 msg->flags = chip_flags & DM_I2C_CHIP_10BIT ? I2C_M_TEN : 0;
271 return ops->xfer(bus, msg, 1);
274 static int i2c_bind_driver(struct udevice *bus, uint chip_addr, uint offset_len,
275 struct udevice **devp)
277 struct dm_i2c_chip *chip;
282 snprintf(name, sizeof(name), "generic_%x", chip_addr);
286 ret = device_bind_driver(bus, "i2c_generic_chip_drv", str, &dev);
287 debug("%s: device_bind_driver: ret=%d\n", __func__, ret);
291 /* Tell the device what we know about it */
292 chip = dev_get_parent_platdata(dev);
293 chip->chip_addr = chip_addr;
294 chip->offset_len = offset_len;
295 ret = device_probe(dev);
296 debug("%s: device_probe: ret=%d\n", __func__, ret);
305 * If the device failed to probe, unbind it. There is nothing there
306 * on the bus so we don't want to leave it lying around
314 int i2c_get_chip(struct udevice *bus, uint chip_addr, uint offset_len,
315 struct udevice **devp)
319 debug("%s: Searching bus '%s' for address %02x: ", __func__,
320 bus->name, chip_addr);
321 for (device_find_first_child(bus, &dev); dev;
322 device_find_next_child(&dev)) {
323 struct dm_i2c_chip *chip = dev_get_parent_platdata(dev);
326 if (chip->chip_addr == chip_addr) {
327 ret = device_probe(dev);
328 debug("found, ret=%d\n", ret);
335 debug("not found\n");
336 return i2c_bind_driver(bus, chip_addr, offset_len, devp);
339 int i2c_get_chip_for_busnum(int busnum, int chip_addr, uint offset_len,
340 struct udevice **devp)
345 ret = uclass_get_device_by_seq(UCLASS_I2C, busnum, &bus);
347 debug("Cannot find I2C bus %d\n", busnum);
351 /* detect the presence of the chip on the bus */
352 ret = i2c_probe_chip(bus, chip_addr, 0);
353 debug("%s: bus='%s', address %02x, ret=%d\n", __func__, bus->name,
356 debug("Cannot detect I2C chip %02x on bus %d\n", chip_addr,
361 ret = i2c_get_chip(bus, chip_addr, offset_len, devp);
363 debug("Cannot find I2C chip %02x on bus %d\n", chip_addr,
371 int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags,
372 struct udevice **devp)
378 /* First probe that chip */
379 ret = i2c_probe_chip(bus, chip_addr, chip_flags);
380 debug("%s: bus='%s', address %02x, ret=%d\n", __func__, bus->name,
385 /* The chip was found, see if we have a driver, and probe it */
386 ret = i2c_get_chip(bus, chip_addr, 1, devp);
387 debug("%s: i2c_get_chip: ret=%d\n", __func__, ret);
392 int dm_i2c_set_bus_speed(struct udevice *bus, unsigned int speed)
394 struct dm_i2c_ops *ops = i2c_get_ops(bus);
395 struct dm_i2c_bus *i2c = dev_get_uclass_priv(bus);
399 * If we have a method, call it. If not then the driver probably wants
400 * to deal with speed changes on the next transfer. It can easily read
401 * the current speed from this uclass
403 if (ops->set_bus_speed) {
404 ret = ops->set_bus_speed(bus, speed);
408 i2c->speed_hz = speed;
413 int dm_i2c_get_bus_speed(struct udevice *bus)
415 struct dm_i2c_ops *ops = i2c_get_ops(bus);
416 struct dm_i2c_bus *i2c = dev_get_uclass_priv(bus);
418 if (!ops->get_bus_speed)
419 return i2c->speed_hz;
421 return ops->get_bus_speed(bus);
424 int i2c_set_chip_flags(struct udevice *dev, uint flags)
426 struct udevice *bus = dev->parent;
427 struct dm_i2c_chip *chip = dev_get_parent_platdata(dev);
428 struct dm_i2c_ops *ops = i2c_get_ops(bus);
431 if (ops->set_flags) {
432 ret = ops->set_flags(dev, flags);
441 int i2c_get_chip_flags(struct udevice *dev, uint *flagsp)
443 struct dm_i2c_chip *chip = dev_get_parent_platdata(dev);
445 *flagsp = chip->flags;
450 int i2c_set_chip_offset_len(struct udevice *dev, uint offset_len)
452 struct dm_i2c_chip *chip = dev_get_parent_platdata(dev);
454 if (offset_len > I2C_MAX_OFFSET_LEN)
456 chip->offset_len = offset_len;
461 int i2c_get_chip_offset_len(struct udevice *dev)
463 struct dm_i2c_chip *chip = dev_get_parent_platdata(dev);
465 return chip->offset_len;
468 #ifdef CONFIG_DM_GPIO
469 static void i2c_gpio_set_pin(struct gpio_desc *pin, int bit)
472 dm_gpio_set_dir_flags(pin, GPIOD_IS_IN);
474 dm_gpio_set_dir_flags(pin, GPIOD_IS_OUT |
476 GPIOD_IS_OUT_ACTIVE);
479 static int i2c_gpio_get_pin(struct gpio_desc *pin)
481 return dm_gpio_get_value(pin);
484 static int i2c_deblock_gpio_loop(struct gpio_desc *sda_pin,
485 struct gpio_desc *scl_pin)
490 i2c_gpio_set_pin(sda_pin, 1);
491 i2c_gpio_set_pin(scl_pin, 1);
494 /* Toggle SCL until slave release SDA */
495 while (counter-- >= 0) {
496 i2c_gpio_set_pin(scl_pin, 1);
498 i2c_gpio_set_pin(scl_pin, 0);
500 if (i2c_gpio_get_pin(sda_pin))
504 /* Then, send I2C stop */
505 i2c_gpio_set_pin(sda_pin, 0);
508 i2c_gpio_set_pin(scl_pin, 1);
511 i2c_gpio_set_pin(sda_pin, 1);
514 if (!i2c_gpio_get_pin(sda_pin) || !i2c_gpio_get_pin(scl_pin))
520 static int i2c_deblock_gpio(struct udevice *bus)
522 struct gpio_desc gpios[PIN_COUNT];
525 ret = gpio_request_list_by_name(bus, "gpios", gpios,
526 ARRAY_SIZE(gpios), GPIOD_IS_IN);
527 if (ret != ARRAY_SIZE(gpios)) {
528 debug("%s: I2C Node '%s' has no 'gpios' property %s\n",
529 __func__, dev_read_name(bus), bus->name);
531 gpio_free_list(bus, gpios, ret);
537 ret = pinctrl_select_state(bus, "gpio");
539 debug("%s: I2C Node '%s' has no 'gpio' pinctrl state. %s\n",
540 __func__, dev_read_name(bus), bus->name);
544 ret0 = i2c_deblock_gpio_loop(&gpios[PIN_SDA], &gpios[PIN_SCL]);
546 ret = pinctrl_select_state(bus, "default");
548 debug("%s: I2C Node '%s' has no 'default' pinctrl state. %s\n",
549 __func__, dev_read_name(bus), bus->name);
552 ret = !ret ? ret0 : ret;
555 gpio_free_list(bus, gpios, ARRAY_SIZE(gpios));
560 static int i2c_deblock_gpio(struct udevice *bus)
564 #endif // CONFIG_DM_GPIO
566 int i2c_deblock(struct udevice *bus)
568 struct dm_i2c_ops *ops = i2c_get_ops(bus);
571 return i2c_deblock_gpio(bus);
573 return ops->deblock(bus);
576 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
577 int i2c_chip_ofdata_to_platdata(struct udevice *dev, struct dm_i2c_chip *chip)
581 chip->offset_len = dev_read_u32_default(dev, "u-boot,i2c-offset-len",
584 addr = dev_read_u32_default(dev, "reg", -1);
586 debug("%s: I2C Node '%s' has no 'reg' property %s\n", __func__,
587 dev_read_name(dev), dev->name);
590 chip->chip_addr = addr;
596 static int i2c_pre_probe(struct udevice *dev)
598 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
599 struct dm_i2c_bus *i2c = dev_get_uclass_priv(dev);
600 unsigned int max = 0;
604 i2c->max_transaction_bytes = 0;
605 dev_for_each_subnode(node, dev) {
606 ret = ofnode_read_u32(node,
607 "u-boot,i2c-transaction-bytes",
609 if (!ret && max > i2c->max_transaction_bytes)
610 i2c->max_transaction_bytes = max;
613 debug("%s: I2C bus: %s max transaction bytes: %d\n", __func__,
614 dev->name, i2c->max_transaction_bytes);
619 static int i2c_post_probe(struct udevice *dev)
621 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
622 struct dm_i2c_bus *i2c = dev_get_uclass_priv(dev);
624 i2c->speed_hz = dev_read_u32_default(dev, "clock-frequency", 100000);
626 return dm_i2c_set_bus_speed(dev, i2c->speed_hz);
632 static int i2c_child_post_bind(struct udevice *dev)
634 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
635 struct dm_i2c_chip *plat = dev_get_parent_platdata(dev);
637 if (!dev_of_valid(dev))
639 return i2c_chip_ofdata_to_platdata(dev, plat);
649 static int i2c_post_bind(struct udevice *dev)
651 struct uclass *class = dev->uclass;
652 struct i2c_priv *priv = class->priv;
659 debug("%s: %s, req_seq=%d\n", __func__, dev->name, dev->req_seq);
661 /* if there is no alias ID, use the first free */
662 if (dev->req_seq == -1)
663 dev->req_seq = ++priv->max_id;
665 debug("%s: %s, new req_seq=%d\n", __func__, dev->name, dev->req_seq);
667 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
668 ret = dm_scan_fdt_dev(dev);
673 int i2c_uclass_init(struct uclass *class)
675 struct i2c_priv *priv = class->priv;
681 /* Get the last allocated alias. */
682 #if CONFIG_IS_ENABLED(OF_CONTROL)
683 priv->max_id = dev_read_alias_highest_id("i2c");
688 debug("%s: highest alias id is %d\n", __func__, priv->max_id);
693 UCLASS_DRIVER(i2c) = {
696 .flags = DM_UC_FLAG_SEQ_ALIAS,
697 .post_bind = i2c_post_bind,
698 .init = i2c_uclass_init,
699 .priv_auto_alloc_size = sizeof(struct i2c_priv),
700 .pre_probe = i2c_pre_probe,
701 .post_probe = i2c_post_probe,
702 .per_device_auto_alloc_size = sizeof(struct dm_i2c_bus),
703 .per_child_platdata_auto_alloc_size = sizeof(struct dm_i2c_chip),
704 .child_post_bind = i2c_child_post_bind,
707 UCLASS_DRIVER(i2c_generic) = {
708 .id = UCLASS_I2C_GENERIC,
709 .name = "i2c_generic",
712 U_BOOT_DRIVER(i2c_generic_chip_drv) = {
713 .name = "i2c_generic_chip_drv",
714 .id = UCLASS_I2C_GENERIC,