1 // SPDX-License-Identifier: GPL-2.0+
4 * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
6 * (C) Copyright 2000 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
7 * Marius Groeger <mgroeger@sysgo.de>
9 * (C) Copyright 2003 Pengutronix e.K.
10 * Robert Schwebel <r.schwebel@pengutronix.de>
12 * (C) Copyright 2011 Marvell Inc.
13 * Lei Wen <leiwen@marvell.com>
15 * Back ported to the 8xx platform (from the 8260 platform) by
16 * Murray.Jensen@cmst.csiro.au, 27-Jan-01.
24 #include <linux/delay.h>
27 /* All transfers are described by this data structure */
35 #ifdef CONFIG_ARMADA_3700
36 /* Armada 3700 has no padding between the registers */
59 * Dummy implementation that can be overwritten by a board
62 __weak void i2c_clk_enable(void)
67 * i2c_reset: - reset the host controller
70 static void i2c_reset(struct mv_i2c *base)
74 /* Save bus mode (standard or fast speed) for later use */
75 icr_mode = readl(&base->icr) & ICR_MODE_MASK;
76 writel(readl(&base->icr) & ~ICR_IUE, &base->icr); /* disable unit */
77 writel(readl(&base->icr) | ICR_UR, &base->icr); /* reset the unit */
79 writel(readl(&base->icr) & ~ICR_IUE, &base->icr); /* disable unit */
83 writel(CONFIG_SYS_I2C_SLAVE, &base->isar); /* set our slave address */
84 /* set control reg values */
85 writel(I2C_ICR_INIT | icr_mode, &base->icr);
86 writel(I2C_ISR_INIT, &base->isr); /* set clear interrupt bits */
87 writel(readl(&base->icr) | ICR_IUE, &base->icr); /* enable unit */
92 * i2c_isr_set_cleared: - wait until certain bits of the I2C status register
95 * @return: 1 in case of success, 0 means timeout (no match within 10 ms).
97 static int i2c_isr_set_cleared(struct mv_i2c *base, unsigned long set_mask,
98 unsigned long cleared_mask)
100 int timeout = 1000, isr;
103 isr = readl(&base->isr);
107 } while (((isr & set_mask) != set_mask)
108 || ((isr & cleared_mask) != 0));
114 * i2c_transfer: - Transfer one byte over the i2c bus
116 * This function can tranfer a byte over the i2c bus in both directions.
117 * It is used by the public API functions.
119 * @return: 0: transfer successful
120 * -1: message is empty
121 * -2: transmit timeout
123 * -4: receive timeout
124 * -5: illegal parameters
125 * -6: bus is busy and couldn't be aquired
127 static int i2c_transfer(struct mv_i2c *base, struct mv_i2c_msg *msg)
132 goto transfer_error_msg_empty;
134 switch (msg->direction) {
136 /* check if bus is not busy */
137 if (!i2c_isr_set_cleared(base, 0, ISR_IBB))
138 goto transfer_error_bus_busy;
140 /* start transmission */
141 writel(readl(&base->icr) & ~ICR_START, &base->icr);
142 writel(readl(&base->icr) & ~ICR_STOP, &base->icr);
143 writel(msg->data, &base->idbr);
144 if (msg->condition == I2C_COND_START)
145 writel(readl(&base->icr) | ICR_START, &base->icr);
146 if (msg->condition == I2C_COND_STOP)
147 writel(readl(&base->icr) | ICR_STOP, &base->icr);
148 if (msg->acknack == I2C_ACKNAK_SENDNAK)
149 writel(readl(&base->icr) | ICR_ACKNAK, &base->icr);
150 if (msg->acknack == I2C_ACKNAK_SENDACK)
151 writel(readl(&base->icr) & ~ICR_ACKNAK, &base->icr);
152 writel(readl(&base->icr) & ~ICR_ALDIE, &base->icr);
153 writel(readl(&base->icr) | ICR_TB, &base->icr);
155 /* transmit register empty? */
156 if (!i2c_isr_set_cleared(base, ISR_ITE, 0))
157 goto transfer_error_transmit_timeout;
159 /* clear 'transmit empty' state */
160 writel(readl(&base->isr) | ISR_ITE, &base->isr);
162 /* wait for ACK from slave */
163 if (msg->acknack == I2C_ACKNAK_WAITACK)
164 if (!i2c_isr_set_cleared(base, 0, ISR_ACKNAK))
165 goto transfer_error_ack_missing;
170 /* check if bus is not busy */
171 if (!i2c_isr_set_cleared(base, 0, ISR_IBB))
172 goto transfer_error_bus_busy;
175 writel(readl(&base->icr) & ~ICR_START, &base->icr);
176 writel(readl(&base->icr) & ~ICR_STOP, &base->icr);
177 if (msg->condition == I2C_COND_START)
178 writel(readl(&base->icr) | ICR_START, &base->icr);
179 if (msg->condition == I2C_COND_STOP)
180 writel(readl(&base->icr) | ICR_STOP, &base->icr);
181 if (msg->acknack == I2C_ACKNAK_SENDNAK)
182 writel(readl(&base->icr) | ICR_ACKNAK, &base->icr);
183 if (msg->acknack == I2C_ACKNAK_SENDACK)
184 writel(readl(&base->icr) & ~ICR_ACKNAK, &base->icr);
185 writel(readl(&base->icr) & ~ICR_ALDIE, &base->icr);
186 writel(readl(&base->icr) | ICR_TB, &base->icr);
188 /* receive register full? */
189 if (!i2c_isr_set_cleared(base, ISR_IRF, 0))
190 goto transfer_error_receive_timeout;
192 msg->data = readl(&base->idbr);
194 /* clear 'receive empty' state */
195 writel(readl(&base->isr) | ISR_IRF, &base->isr);
198 goto transfer_error_illegal_param;
203 transfer_error_msg_empty:
204 debug("i2c_transfer: error: 'msg' is empty\n");
206 goto i2c_transfer_finish;
208 transfer_error_transmit_timeout:
209 debug("i2c_transfer: error: transmit timeout\n");
211 goto i2c_transfer_finish;
213 transfer_error_ack_missing:
214 debug("i2c_transfer: error: ACK missing\n");
216 goto i2c_transfer_finish;
218 transfer_error_receive_timeout:
219 debug("i2c_transfer: error: receive timeout\n");
221 goto i2c_transfer_finish;
223 transfer_error_illegal_param:
224 debug("i2c_transfer: error: illegal parameters\n");
226 goto i2c_transfer_finish;
228 transfer_error_bus_busy:
229 debug("i2c_transfer: error: bus is busy\n");
231 goto i2c_transfer_finish;
234 debug("i2c_transfer: ISR: 0x%04x\n", readl(&base->isr));
239 static int __i2c_read(struct mv_i2c *base, uchar chip, u8 *addr, int alen,
240 uchar *buffer, int len)
242 struct mv_i2c_msg msg;
244 debug("i2c_read(chip=0x%02x, addr=0x%02x, alen=0x%02x, "
245 "len=0x%02x)\n", chip, *addr, alen, len);
248 printf("reading zero byte is invalid\n");
254 /* dummy chip address write */
255 debug("i2c_read: dummy chip address write\n");
256 msg.condition = I2C_COND_START;
257 msg.acknack = I2C_ACKNAK_WAITACK;
258 msg.direction = I2C_WRITE;
259 msg.data = (chip << 1);
261 if (i2c_transfer(base, &msg))
265 * send memory address bytes;
266 * alen defines how much bytes we have to send.
268 while (--alen >= 0) {
269 debug("i2c_read: send address byte %02x (alen=%d)\n",
271 msg.condition = I2C_COND_NORMAL;
272 msg.acknack = I2C_ACKNAK_WAITACK;
273 msg.direction = I2C_WRITE;
274 msg.data = addr[alen];
275 if (i2c_transfer(base, &msg))
279 /* start read sequence */
280 debug("i2c_read: start read sequence\n");
281 msg.condition = I2C_COND_START;
282 msg.acknack = I2C_ACKNAK_WAITACK;
283 msg.direction = I2C_WRITE;
284 msg.data = (chip << 1);
286 if (i2c_transfer(base, &msg))
289 /* read bytes; send NACK at last byte */
292 msg.condition = I2C_COND_STOP;
293 msg.acknack = I2C_ACKNAK_SENDNAK;
295 msg.condition = I2C_COND_NORMAL;
296 msg.acknack = I2C_ACKNAK_SENDACK;
299 msg.direction = I2C_READ;
301 if (i2c_transfer(base, &msg))
305 debug("i2c_read: reading byte (%p)=0x%02x\n",
315 static int __i2c_write(struct mv_i2c *base, uchar chip, u8 *addr, int alen,
316 uchar *buffer, int len)
318 struct mv_i2c_msg msg;
320 debug("i2c_write(chip=0x%02x, addr=0x%02x, alen=0x%02x, "
321 "len=0x%02x)\n", chip, *addr, alen, len);
325 /* chip address write */
326 debug("i2c_write: chip address write\n");
327 msg.condition = I2C_COND_START;
328 msg.acknack = I2C_ACKNAK_WAITACK;
329 msg.direction = I2C_WRITE;
330 msg.data = (chip << 1);
332 if (i2c_transfer(base, &msg))
336 * send memory address bytes;
337 * alen defines how much bytes we have to send.
339 while (--alen >= 0) {
340 debug("i2c_read: send address byte %02x (alen=%d)\n",
342 msg.condition = I2C_COND_NORMAL;
343 msg.acknack = I2C_ACKNAK_WAITACK;
344 msg.direction = I2C_WRITE;
345 msg.data = addr[alen];
346 if (i2c_transfer(base, &msg))
350 /* write bytes; send NACK at last byte */
352 debug("i2c_write: writing byte (%p)=0x%02x\n",
356 msg.condition = I2C_COND_STOP;
358 msg.condition = I2C_COND_NORMAL;
360 msg.acknack = I2C_ACKNAK_WAITACK;
361 msg.direction = I2C_WRITE;
362 msg.data = *(buffer++);
364 if (i2c_transfer(base, &msg))
373 #ifndef CONFIG_DM_I2C
375 static struct mv_i2c *base_glob;
377 static void i2c_board_init(struct mv_i2c *base)
379 #ifdef CONFIG_SYS_I2C_INIT_BOARD
382 * call board specific i2c bus reset routine before accessing the
383 * environment, which might be in a chip on that bus. For details
384 * about this problem see doc/I2C_Edge_Conditions.
386 * disable I2C controller first, otherwhise it thinks we want to
387 * talk to the slave port...
389 icr = readl(&base->icr);
390 writel(readl(&base->icr) & ~(ICR_SCLE | ICR_IUE), &base->icr);
394 writel(icr, &base->icr);
398 #ifdef CONFIG_I2C_MULTI_BUS
399 static unsigned long i2c_regs[CONFIG_MV_I2C_NUM] = CONFIG_MV_I2C_REG;
400 static unsigned int bus_initialized[CONFIG_MV_I2C_NUM];
401 static unsigned int current_bus;
403 int i2c_set_bus_num(unsigned int bus)
405 if ((bus < 0) || (bus >= CONFIG_MV_I2C_NUM)) {
406 printf("Bad bus: %d\n", bus);
410 base_glob = (struct mv_i2c *)i2c_regs[bus];
413 if (!bus_initialized[current_bus]) {
414 i2c_board_init(base_glob);
415 bus_initialized[current_bus] = 1;
421 unsigned int i2c_get_bus_num(void)
428 void i2c_init(int speed, int slaveaddr)
432 #ifdef CONFIG_I2C_MULTI_BUS
434 base_glob = (struct mv_i2c *)i2c_regs[current_bus];
436 base_glob = (struct mv_i2c *)CONFIG_MV_I2C_REG;
439 if (speed > I2C_SPEED_STANDARD_RATE)
443 clrsetbits_le32(&base_glob->icr, ICR_MODE_MASK, val);
445 i2c_board_init(base_glob);
448 static int __i2c_probe_chip(struct mv_i2c *base, uchar chip)
450 struct mv_i2c_msg msg;
454 msg.condition = I2C_COND_START;
455 msg.acknack = I2C_ACKNAK_WAITACK;
456 msg.direction = I2C_WRITE;
457 msg.data = (chip << 1) + 1;
458 if (i2c_transfer(base, &msg))
461 msg.condition = I2C_COND_STOP;
462 msg.acknack = I2C_ACKNAK_SENDNAK;
463 msg.direction = I2C_READ;
465 if (i2c_transfer(base, &msg))
472 * i2c_probe: - Test if a chip answers for a given i2c address
474 * @chip: address of the chip which is searched for
475 * @return: 0 if a chip was found, -1 otherwhise
477 int i2c_probe(uchar chip)
479 return __i2c_probe_chip(base_glob, chip);
483 * i2c_read: - Read multiple bytes from an i2c device
485 * The higher level routines take into account that this function is only
486 * called with len < page length of the device (see configuration file)
488 * @chip: address of the chip which is to be read
489 * @addr: i2c data address within the chip
490 * @alen: length of the i2c data address (1..2 bytes)
491 * @buffer: where to write the data
492 * @len: how much byte do we want to read
493 * @return: 0 in case of success
495 int i2c_read(uchar chip, uint addr, int alen, uchar *buffer, int len)
499 addr_bytes[0] = (addr >> 0) & 0xFF;
500 addr_bytes[1] = (addr >> 8) & 0xFF;
501 addr_bytes[2] = (addr >> 16) & 0xFF;
502 addr_bytes[3] = (addr >> 24) & 0xFF;
504 return __i2c_read(base_glob, chip, addr_bytes, alen, buffer, len);
508 * i2c_write: - Write multiple bytes to an i2c device
510 * The higher level routines take into account that this function is only
511 * called with len < page length of the device (see configuration file)
513 * @chip: address of the chip which is to be written
514 * @addr: i2c data address within the chip
515 * @alen: length of the i2c data address (1..2 bytes)
516 * @buffer: where to find the data to be written
517 * @len: how much byte do we want to read
518 * @return: 0 in case of success
520 int i2c_write(uchar chip, uint addr, int alen, uchar *buffer, int len)
524 addr_bytes[0] = (addr >> 0) & 0xFF;
525 addr_bytes[1] = (addr >> 8) & 0xFF;
526 addr_bytes[2] = (addr >> 16) & 0xFF;
527 addr_bytes[3] = (addr >> 24) & 0xFF;
529 return __i2c_write(base_glob, chip, addr_bytes, alen, buffer, len);
532 #else /* CONFIG_DM_I2C */
538 static int mv_i2c_xfer(struct udevice *bus, struct i2c_msg *msg, int nmsgs)
540 struct mv_i2c_priv *i2c = dev_get_priv(bus);
541 struct i2c_msg *dmsg, *omsg, dummy;
543 memset(&dummy, 0, sizeof(struct i2c_msg));
546 * We expect either two messages (one with an offset and one with the
547 * actual data) or one message (just data or offset/data combined)
549 if (nmsgs > 2 || nmsgs == 0) {
550 debug("%s: Only one or two messages are supported.", __func__);
554 omsg = nmsgs == 1 ? &dummy : msg;
555 dmsg = nmsgs == 1 ? msg : msg + 1;
557 if (dmsg->flags & I2C_M_RD)
558 return __i2c_read(i2c->base, dmsg->addr, omsg->buf,
559 omsg->len, dmsg->buf, dmsg->len);
561 return __i2c_write(i2c->base, dmsg->addr, omsg->buf,
562 omsg->len, dmsg->buf, dmsg->len);
565 static int mv_i2c_set_bus_speed(struct udevice *bus, unsigned int speed)
567 struct mv_i2c_priv *priv = dev_get_priv(bus);
570 if (speed > I2C_SPEED_STANDARD_RATE)
574 clrsetbits_le32(&priv->base->icr, ICR_MODE_MASK, val);
579 static int mv_i2c_probe(struct udevice *bus)
581 struct mv_i2c_priv *priv = dev_get_priv(bus);
583 priv->base = dev_read_addr_ptr(bus);
588 static const struct dm_i2c_ops mv_i2c_ops = {
590 .set_bus_speed = mv_i2c_set_bus_speed,
593 static const struct udevice_id mv_i2c_ids[] = {
594 { .compatible = "marvell,armada-3700-i2c" },
598 U_BOOT_DRIVER(i2c_mv) = {
601 .of_match = mv_i2c_ids,
602 .probe = mv_i2c_probe,
603 .priv_auto = sizeof(struct mv_i2c_priv),
606 #endif /* CONFIG_DM_I2C */