blob: c1fc290bd253e8d87ba1e01a4c0b74e7a7eebeae [file] [log] [blame]
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +02001/*
2 * (C) Copyright 2015, Samsung Electronics
3 * Przemyslaw Marczak <p.marczak@samsung.com>
4 *
5 * This file is based on: drivers/i2c/soft-i2c.c,
6 * with added driver-model support and code cleanup.
7 */
8#include <common.h>
9#include <errno.h>
10#include <dm.h>
11#include <i2c.h>
Simon Glass0f2af882020-05-10 11:40:05 -060012#include <log.h>
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020013#include <asm/gpio.h>
Simon Glassdbd79542020-05-10 11:40:11 -060014#include <linux/delay.h>
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020015
16#define DEFAULT_UDELAY 5
17#define RETRIES 0
18#define I2C_ACK 0
19#define I2C_NOACK 1
20
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020021enum {
22 PIN_SDA = 0,
23 PIN_SCL,
24 PIN_COUNT,
25};
26
27struct i2c_gpio_bus {
28 /**
29 * udelay - delay [us] between GPIO toggle operations,
30 * which is 1/4 of I2C speed clock period.
31 */
32 int udelay;
33 /* sda, scl */
34 struct gpio_desc gpios[PIN_COUNT];
Michael Auchter5f6b1852020-02-07 10:55:31 -060035
36 int (*get_sda)(struct i2c_gpio_bus *bus);
37 void (*set_sda)(struct i2c_gpio_bus *bus, int bit);
38 void (*set_scl)(struct i2c_gpio_bus *bus, int bit);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020039};
40
Michael Auchter5f6b1852020-02-07 10:55:31 -060041static int i2c_gpio_sda_get(struct i2c_gpio_bus *bus)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020042{
Michael Auchter5f6b1852020-02-07 10:55:31 -060043 struct gpio_desc *sda = &bus->gpios[PIN_SDA];
44
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020045 return dm_gpio_get_value(sda);
46}
47
Michael Auchter5f6b1852020-02-07 10:55:31 -060048static void i2c_gpio_sda_set(struct i2c_gpio_bus *bus, int bit)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020049{
Michael Auchter5f6b1852020-02-07 10:55:31 -060050 struct gpio_desc *sda = &bus->gpios[PIN_SDA];
Simon Glassd20d4b72021-03-23 14:52:06 +130051 ulong flags;
Michael Auchter5f6b1852020-02-07 10:55:31 -060052
Axel Lin05474832015-04-26 11:05:38 +080053 if (bit)
Simon Glassd20d4b72021-03-23 14:52:06 +130054 flags = GPIOD_IS_IN;
Axel Lin05474832015-04-26 11:05:38 +080055 else
Simon Glassd20d4b72021-03-23 14:52:06 +130056 flags = GPIOD_IS_OUT;
57 dm_gpio_clrset_flags(sda, GPIOD_MASK_DIR, flags);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020058}
59
Michael Auchter5f6b1852020-02-07 10:55:31 -060060static void i2c_gpio_scl_set(struct i2c_gpio_bus *bus, int bit)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020061{
Michael Auchter5f6b1852020-02-07 10:55:31 -060062 struct gpio_desc *scl = &bus->gpios[PIN_SCL];
Heiko Schocher48f39d82020-03-16 07:55:06 +010063 int count = 0;
64
65 if (bit) {
Simon Glassd20d4b72021-03-23 14:52:06 +130066 dm_gpio_clrset_flags(scl, GPIOD_MASK_DIR, GPIOD_IS_IN);
Heiko Schocher48f39d82020-03-16 07:55:06 +010067 while (!dm_gpio_get_value(scl) && count++ < 100000)
68 udelay(1);
69
70 if (!dm_gpio_get_value(scl))
71 pr_err("timeout waiting on slave to release scl\n");
72 } else {
Simon Glassd20d4b72021-03-23 14:52:06 +130073 dm_gpio_clrset_flags(scl, GPIOD_MASK_DIR, GPIOD_IS_OUT);
Heiko Schocher48f39d82020-03-16 07:55:06 +010074 }
75}
76
77/* variant for output only gpios which cannot support clock stretching */
78static void i2c_gpio_scl_set_output_only(struct i2c_gpio_bus *bus, int bit)
79{
80 struct gpio_desc *scl = &bus->gpios[PIN_SCL];
Simon Glassd20d4b72021-03-23 14:52:06 +130081 ulong flags = GPIOD_IS_OUT;
Axel Lin05474832015-04-26 11:05:38 +080082
83 if (bit)
Simon Glassd20d4b72021-03-23 14:52:06 +130084 flags |= GPIOD_IS_OUT_ACTIVE;
85 dm_gpio_clrset_flags(scl, GPIOD_MASK_DIR, flags);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020086}
87
Michael Auchter5f6b1852020-02-07 10:55:31 -060088static void i2c_gpio_write_bit(struct i2c_gpio_bus *bus, int delay, uchar bit)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020089{
Michael Auchter5f6b1852020-02-07 10:55:31 -060090 bus->set_scl(bus, 0);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020091 udelay(delay);
Michael Auchter5f6b1852020-02-07 10:55:31 -060092 bus->set_sda(bus, bit);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020093 udelay(delay);
Michael Auchter5f6b1852020-02-07 10:55:31 -060094 bus->set_scl(bus, 1);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020095 udelay(2 * delay);
96}
97
Michael Auchter5f6b1852020-02-07 10:55:31 -060098static int i2c_gpio_read_bit(struct i2c_gpio_bus *bus, int delay)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +020099{
100 int value;
101
Michael Auchter5f6b1852020-02-07 10:55:31 -0600102 bus->set_scl(bus, 1);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200103 udelay(delay);
Michael Auchter5f6b1852020-02-07 10:55:31 -0600104 value = bus->get_sda(bus);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200105 udelay(delay);
Michael Auchter5f6b1852020-02-07 10:55:31 -0600106 bus->set_scl(bus, 0);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200107 udelay(2 * delay);
108
109 return value;
110}
111
112/* START: High -> Low on SDA while SCL is High */
Michael Auchter5f6b1852020-02-07 10:55:31 -0600113static void i2c_gpio_send_start(struct i2c_gpio_bus *bus, int delay)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200114{
115 udelay(delay);
Michael Auchter5f6b1852020-02-07 10:55:31 -0600116 bus->set_sda(bus, 1);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200117 udelay(delay);
Michael Auchter5f6b1852020-02-07 10:55:31 -0600118 bus->set_scl(bus, 1);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200119 udelay(delay);
Michael Auchter5f6b1852020-02-07 10:55:31 -0600120 bus->set_sda(bus, 0);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200121 udelay(delay);
122}
123
124/* STOP: Low -> High on SDA while SCL is High */
Michael Auchter5f6b1852020-02-07 10:55:31 -0600125static void i2c_gpio_send_stop(struct i2c_gpio_bus *bus, int delay)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200126{
Michael Auchter5f6b1852020-02-07 10:55:31 -0600127 bus->set_scl(bus, 0);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200128 udelay(delay);
Michael Auchter5f6b1852020-02-07 10:55:31 -0600129 bus->set_sda(bus, 0);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200130 udelay(delay);
Michael Auchter5f6b1852020-02-07 10:55:31 -0600131 bus->set_scl(bus, 1);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200132 udelay(delay);
Michael Auchter5f6b1852020-02-07 10:55:31 -0600133 bus->set_sda(bus, 1);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200134 udelay(delay);
135}
136
137/* ack should be I2C_ACK or I2C_NOACK */
Michael Auchter5f6b1852020-02-07 10:55:31 -0600138static void i2c_gpio_send_ack(struct i2c_gpio_bus *bus, int delay, int ack)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200139{
Michael Auchter5f6b1852020-02-07 10:55:31 -0600140 i2c_gpio_write_bit(bus, delay, ack);
141 bus->set_scl(bus, 0);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200142 udelay(delay);
143}
144
145/**
146 * Send a reset sequence consisting of 9 clocks with the data signal high
147 * to clock any confused device back into an idle state. Also send a
148 * <stop> at the end of the sequence for belts & suspenders.
149 */
Michael Auchter5f6b1852020-02-07 10:55:31 -0600150static void i2c_gpio_send_reset(struct i2c_gpio_bus *bus, int delay)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200151{
152 int j;
153
154 for (j = 0; j < 9; j++)
Michael Auchter5f6b1852020-02-07 10:55:31 -0600155 i2c_gpio_write_bit(bus, delay, 1);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200156
Michael Auchter5f6b1852020-02-07 10:55:31 -0600157 i2c_gpio_send_stop(bus, delay);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200158}
159
160/* Set sda high with low clock, before reading slave data */
Michael Auchter5f6b1852020-02-07 10:55:31 -0600161static void i2c_gpio_sda_high(struct i2c_gpio_bus *bus, int delay)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200162{
Michael Auchter5f6b1852020-02-07 10:55:31 -0600163 bus->set_scl(bus, 0);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200164 udelay(delay);
Michael Auchter5f6b1852020-02-07 10:55:31 -0600165 bus->set_sda(bus, 1);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200166 udelay(delay);
167}
168
169/* Send 8 bits and look for an acknowledgement */
Michael Auchter5f6b1852020-02-07 10:55:31 -0600170static int i2c_gpio_write_byte(struct i2c_gpio_bus *bus, int delay, uchar data)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200171{
172 int j;
173 int nack;
174
175 for (j = 0; j < 8; j++) {
Michael Auchter5f6b1852020-02-07 10:55:31 -0600176 i2c_gpio_write_bit(bus, delay, data & 0x80);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200177 data <<= 1;
178 }
179
180 udelay(delay);
181
182 /* Look for an <ACK>(negative logic) and return it */
Michael Auchter5f6b1852020-02-07 10:55:31 -0600183 i2c_gpio_sda_high(bus, delay);
184 nack = i2c_gpio_read_bit(bus, delay);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200185
186 return nack; /* not a nack is an ack */
187}
188
189/**
190 * if ack == I2C_ACK, ACK the byte so can continue reading, else
191 * send I2C_NOACK to end the read.
192 */
Michael Auchter5f6b1852020-02-07 10:55:31 -0600193static uchar i2c_gpio_read_byte(struct i2c_gpio_bus *bus, int delay, int ack)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200194{
195 int data;
196 int j;
197
Michael Auchter5f6b1852020-02-07 10:55:31 -0600198 i2c_gpio_sda_high(bus, delay);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200199 data = 0;
200 for (j = 0; j < 8; j++) {
201 data <<= 1;
Michael Auchter5f6b1852020-02-07 10:55:31 -0600202 data |= i2c_gpio_read_bit(bus, delay);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200203 }
Michael Auchter5f6b1852020-02-07 10:55:31 -0600204 i2c_gpio_send_ack(bus, delay, ack);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200205
206 return data;
207}
208
209/* send start and the slave chip address */
Michael Auchter5f6b1852020-02-07 10:55:31 -0600210int i2c_send_slave_addr(struct i2c_gpio_bus *bus, int delay, uchar chip)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200211{
Michael Auchter5f6b1852020-02-07 10:55:31 -0600212 i2c_gpio_send_start(bus, delay);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200213
Michael Auchter5f6b1852020-02-07 10:55:31 -0600214 if (i2c_gpio_write_byte(bus, delay, chip)) {
215 i2c_gpio_send_stop(bus, delay);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200216 return -EIO;
217 }
218
219 return 0;
220}
221
222static int i2c_gpio_write_data(struct i2c_gpio_bus *bus, uchar chip,
223 uchar *buffer, int len,
224 bool end_with_repeated_start)
225{
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200226 unsigned int delay = bus->udelay;
227 int failures = 0;
228
229 debug("%s: chip %x buffer %p len %d\n", __func__, chip, buffer, len);
230
Michael Auchter5f6b1852020-02-07 10:55:31 -0600231 if (i2c_send_slave_addr(bus, delay, chip << 1)) {
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200232 debug("i2c_write, no chip responded %02X\n", chip);
233 return -EIO;
234 }
235
236 while (len-- > 0) {
Michael Auchter5f6b1852020-02-07 10:55:31 -0600237 if (i2c_gpio_write_byte(bus, delay, *buffer++))
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200238 failures++;
239 }
240
241 if (!end_with_repeated_start) {
Michael Auchter5f6b1852020-02-07 10:55:31 -0600242 i2c_gpio_send_stop(bus, delay);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200243 return failures;
244 }
245
Michael Auchter5f6b1852020-02-07 10:55:31 -0600246 if (i2c_send_slave_addr(bus, delay, (chip << 1) | 0x1)) {
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200247 debug("i2c_write, no chip responded %02X\n", chip);
248 return -EIO;
249 }
250
251 return failures;
252}
253
254static int i2c_gpio_read_data(struct i2c_gpio_bus *bus, uchar chip,
255 uchar *buffer, int len)
256{
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200257 unsigned int delay = bus->udelay;
258
259 debug("%s: chip %x buffer: %p len %d\n", __func__, chip, buffer, len);
260
261 while (len-- > 0)
Michael Auchter5f6b1852020-02-07 10:55:31 -0600262 *buffer++ = i2c_gpio_read_byte(bus, delay, len == 0);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200263
Michael Auchter5f6b1852020-02-07 10:55:31 -0600264 i2c_gpio_send_stop(bus, delay);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200265
266 return 0;
267}
268
269static int i2c_gpio_xfer(struct udevice *dev, struct i2c_msg *msg, int nmsgs)
270{
271 struct i2c_gpio_bus *bus = dev_get_priv(dev);
272 int ret;
273
274 for (; nmsgs > 0; nmsgs--, msg++) {
275 bool next_is_read = nmsgs > 1 && (msg[1].flags & I2C_M_RD);
276
277 if (msg->flags & I2C_M_RD) {
278 ret = i2c_gpio_read_data(bus, msg->addr, msg->buf,
279 msg->len);
280 } else {
281 ret = i2c_gpio_write_data(bus, msg->addr, msg->buf,
282 msg->len, next_is_read);
283 }
284
285 if (ret)
286 return -EREMOTEIO;
287 }
288
289 return 0;
290}
291
292static int i2c_gpio_probe(struct udevice *dev, uint chip, uint chip_flags)
293{
294 struct i2c_gpio_bus *bus = dev_get_priv(dev);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200295 unsigned int delay = bus->udelay;
296 int ret;
297
Michael Auchter5f6b1852020-02-07 10:55:31 -0600298 i2c_gpio_send_start(bus, delay);
299 ret = i2c_gpio_write_byte(bus, delay, (chip << 1) | 0);
300 i2c_gpio_send_stop(bus, delay);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200301
302 debug("%s: bus: %d (%s) chip: %x flags: %x ret: %d\n",
Simon Glass75e534b2020-12-16 21:20:07 -0700303 __func__, dev_seq(dev), dev->name, chip, chip_flags, ret);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200304
305 return ret;
306}
307
308static int i2c_gpio_set_bus_speed(struct udevice *dev, unsigned int speed_hz)
309{
310 struct i2c_gpio_bus *bus = dev_get_priv(dev);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200311
312 bus->udelay = 1000000 / (speed_hz << 2);
313
Michael Auchter5f6b1852020-02-07 10:55:31 -0600314 i2c_gpio_send_reset(bus, bus->udelay);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200315
316 return 0;
317}
318
Marek Vasut9f52cc42020-02-07 16:57:52 +0100319static int i2c_gpio_drv_probe(struct udevice *dev)
320{
321 if (dev_read_bool(dev, "i2c-gpio,deblock")) {
322 /* @200kHz 9 clocks = 44us, 62us is ok */
323 const unsigned int DELAY_ABORT_SEQ = 62;
324 struct i2c_gpio_bus *bus = dev_get_priv(dev);
325
326 return i2c_deblock_gpio_loop(&bus->gpios[PIN_SDA],
327 &bus->gpios[PIN_SCL],
328 16, 5, DELAY_ABORT_SEQ);
329 }
330
331 return 0;
332}
333
Simon Glassaad29ae2020-12-03 16:55:21 -0700334static int i2c_gpio_of_to_plat(struct udevice *dev)
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200335{
336 struct i2c_gpio_bus *bus = dev_get_priv(dev);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200337 int ret;
338
Samuel Hollandb66238b2021-08-21 19:25:43 -0500339 /* "gpios" is deprecated and replaced by "sda-gpios" + "scl-gpios". */
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200340 ret = gpio_request_list_by_name(dev, "gpios", bus->gpios,
341 ARRAY_SIZE(bus->gpios), 0);
Chris Packhamd3447b52023-07-26 11:13:08 +1200342 if (ret == 0) {
Samuel Hollandb66238b2021-08-21 19:25:43 -0500343 ret = gpio_request_by_name(dev, "sda-gpios", 0,
344 &bus->gpios[PIN_SDA], 0);
345 if (ret < 0)
346 goto error;
347 ret = gpio_request_by_name(dev, "scl-gpios", 0,
348 &bus->gpios[PIN_SCL], 0);
349 }
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200350 if (ret < 0)
351 goto error;
352
Patrick Delaunay008573b2020-09-10 18:25:09 +0200353 bus->udelay = dev_read_u32_default(dev, "i2c-gpio,delay-us",
354 DEFAULT_UDELAY);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200355
Michael Auchter5f6b1852020-02-07 10:55:31 -0600356 bus->get_sda = i2c_gpio_sda_get;
357 bus->set_sda = i2c_gpio_sda_set;
Patrick Delaunay008573b2020-09-10 18:25:09 +0200358 if (dev_read_bool(dev, "i2c-gpio,scl-output-only"))
Heiko Schocher48f39d82020-03-16 07:55:06 +0100359 bus->set_scl = i2c_gpio_scl_set_output_only;
360 else
361 bus->set_scl = i2c_gpio_scl_set;
Michael Auchter5f6b1852020-02-07 10:55:31 -0600362
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200363 return 0;
364error:
Sergei Antonov2ff09752022-10-20 17:28:14 +0300365 pr_err("Can't get %s gpios! Error: %d\n", dev->name, ret);
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200366 return ret;
367}
368
369static const struct dm_i2c_ops i2c_gpio_ops = {
370 .xfer = i2c_gpio_xfer,
371 .probe_chip = i2c_gpio_probe,
372 .set_bus_speed = i2c_gpio_set_bus_speed,
373};
374
375static const struct udevice_id i2c_gpio_ids[] = {
376 { .compatible = "i2c-gpio" },
377 { }
378};
379
380U_BOOT_DRIVER(i2c_gpio) = {
381 .name = "i2c-gpio",
382 .id = UCLASS_I2C,
383 .of_match = i2c_gpio_ids,
Marek Vasut9f52cc42020-02-07 16:57:52 +0100384 .probe = i2c_gpio_drv_probe,
Simon Glassaad29ae2020-12-03 16:55:21 -0700385 .of_to_plat = i2c_gpio_of_to_plat,
Simon Glass8a2b47f2020-12-03 16:55:17 -0700386 .priv_auto = sizeof(struct i2c_gpio_bus),
Przemyslaw Marczakd3aa7e12015-03-31 18:57:18 +0200387 .ops = &i2c_gpio_ops,
388};