SPDX: Convert all of our single license tags to Linux Kernel style
[oweals/u-boot.git] / drivers / i2c / mvtwsi.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Driver for the TWSI (i2c) controller found on the Marvell
4  * orion5x and kirkwood SoC families.
5  *
6  * Author: Albert Aribaud <albert.u.boot@aribaud.net>
7  * Copyright (c) 2010 Albert Aribaud.
8  */
9
10 #include <common.h>
11 #include <i2c.h>
12 #include <linux/errno.h>
13 #include <asm/io.h>
14 #include <linux/compat.h>
15 #ifdef CONFIG_DM_I2C
16 #include <dm.h>
17 #endif
18
19 DECLARE_GLOBAL_DATA_PTR;
20
21 /*
22  * Include a file that will provide CONFIG_I2C_MVTWSI_BASE*, and possibly other
23  * settings
24  */
25
26 #ifndef CONFIG_DM_I2C
27 #if defined(CONFIG_ORION5X)
28 #include <asm/arch/orion5x.h>
29 #elif (defined(CONFIG_KIRKWOOD) || defined(CONFIG_ARCH_MVEBU))
30 #include <asm/arch/soc.h>
31 #elif defined(CONFIG_ARCH_SUNXI)
32 #include <asm/arch/i2c.h>
33 #else
34 #error Driver mvtwsi not supported by SoC or board
35 #endif
36 #endif /* CONFIG_DM_I2C */
37
38 /*
39  * On SUNXI, we get CONFIG_SYS_TCLK from this include, so we want to
40  * always have it.
41  */
42 #if defined(CONFIG_DM_I2C) && defined(CONFIG_ARCH_SUNXI)
43 #include <asm/arch/i2c.h>
44 #endif
45
46 /*
47  * TWSI register structure
48  */
49
50 #ifdef CONFIG_ARCH_SUNXI
51
52 struct  mvtwsi_registers {
53         u32 slave_address;
54         u32 xtnd_slave_addr;
55         u32 data;
56         u32 control;
57         u32 status;
58         u32 baudrate;
59         u32 soft_reset;
60 };
61
62 #else
63
64 struct  mvtwsi_registers {
65         u32 slave_address;
66         u32 data;
67         u32 control;
68         union {
69                 u32 status;     /* When reading */
70                 u32 baudrate;   /* When writing */
71         };
72         u32 xtnd_slave_addr;
73         u32 reserved[2];
74         u32 soft_reset;
75 };
76
77 #endif
78
79 #ifdef CONFIG_DM_I2C
80 struct mvtwsi_i2c_dev {
81         /* TWSI Register base for the device */
82         struct mvtwsi_registers *base;
83         /* Number of the device (determined from cell-index property) */
84         int index;
85         /* The I2C slave address for the device */
86         u8 slaveadd;
87         /* The configured I2C speed in Hz */
88         uint speed;
89         /* The current length of a clock period (depending on speed) */
90         uint tick;
91 };
92 #endif /* CONFIG_DM_I2C */
93
94 /*
95  * enum mvtwsi_ctrl_register_fields - Bit masks for flags in the control
96  * register
97  */
98 enum mvtwsi_ctrl_register_fields {
99         /* Acknowledge bit */
100         MVTWSI_CONTROL_ACK      = 0x00000004,
101         /* Interrupt flag */
102         MVTWSI_CONTROL_IFLG     = 0x00000008,
103         /* Stop bit */
104         MVTWSI_CONTROL_STOP     = 0x00000010,
105         /* Start bit */
106         MVTWSI_CONTROL_START    = 0x00000020,
107         /* I2C enable */
108         MVTWSI_CONTROL_TWSIEN   = 0x00000040,
109         /* Interrupt enable */
110         MVTWSI_CONTROL_INTEN    = 0x00000080,
111 };
112
113 /*
114  * On sun6i and newer, IFLG is a write-clear bit, which is cleared by writing 1;
115  * on other platforms, it is a normal r/w bit, which is cleared by writing 0.
116  */
117
118 #ifdef CONFIG_SUNXI_GEN_SUN6I
119 #define MVTWSI_CONTROL_CLEAR_IFLG       0x00000008
120 #else
121 #define MVTWSI_CONTROL_CLEAR_IFLG       0x00000000
122 #endif
123
124 /*
125  * enum mvstwsi_status_values - Possible values of I2C controller's status
126  * register
127  *
128  * Only those statuses expected in normal master operation on
129  * non-10-bit-address devices are specified.
130  *
131  * Every status that's unexpected during normal operation (bus errors,
132  * arbitration losses, missing ACKs...) is passed back to the caller as an error
133  * code.
134  */
135 enum mvstwsi_status_values {
136         /* START condition transmitted */
137         MVTWSI_STATUS_START             = 0x08,
138         /* Repeated START condition transmitted */
139         MVTWSI_STATUS_REPEATED_START    = 0x10,
140         /* Address + write bit transmitted, ACK received */
141         MVTWSI_STATUS_ADDR_W_ACK        = 0x18,
142         /* Data transmitted, ACK received */
143         MVTWSI_STATUS_DATA_W_ACK        = 0x28,
144         /* Address + read bit transmitted, ACK received */
145         MVTWSI_STATUS_ADDR_R_ACK        = 0x40,
146         /* Address + read bit transmitted, ACK not received */
147         MVTWSI_STATUS_ADDR_R_NAK        = 0x48,
148         /* Data received, ACK transmitted */
149         MVTWSI_STATUS_DATA_R_ACK        = 0x50,
150         /* Data received, ACK not transmitted */
151         MVTWSI_STATUS_DATA_R_NAK        = 0x58,
152         /* No relevant status */
153         MVTWSI_STATUS_IDLE              = 0xF8,
154 };
155
156 /*
157  * enum mvstwsi_ack_flags - Determine whether a read byte should be
158  * acknowledged or not.
159  */
160 enum mvtwsi_ack_flags {
161         /* Send NAK after received byte */
162         MVTWSI_READ_NAK = 0,
163         /* Send ACK after received byte */
164         MVTWSI_READ_ACK = 1,
165 };
166
167 /*
168  * calc_tick() - Calculate the duration of a clock cycle from the I2C speed
169  *
170  * @speed:      The speed in Hz to calculate the clock cycle duration for.
171  * @return The duration of a clock cycle in ns.
172  */
173 inline uint calc_tick(uint speed)
174 {
175         /* One tick = the duration of a period at the specified speed in ns (we
176          * add 100 ns to be on the safe side) */
177         return (1000000000u / speed) + 100;
178 }
179
180 #ifndef CONFIG_DM_I2C
181
182 /*
183  * twsi_get_base() - Get controller register base for specified adapter
184  *
185  * @adap:       Adapter to get the register base for.
186  * @return Register base for the specified adapter.
187  */
188 static struct mvtwsi_registers *twsi_get_base(struct i2c_adapter *adap)
189 {
190         switch (adap->hwadapnr) {
191 #ifdef CONFIG_I2C_MVTWSI_BASE0
192         case 0:
193                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE0;
194 #endif
195 #ifdef CONFIG_I2C_MVTWSI_BASE1
196         case 1:
197                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE1;
198 #endif
199 #ifdef CONFIG_I2C_MVTWSI_BASE2
200         case 2:
201                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE2;
202 #endif
203 #ifdef CONFIG_I2C_MVTWSI_BASE3
204         case 3:
205                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE3;
206 #endif
207 #ifdef CONFIG_I2C_MVTWSI_BASE4
208         case 4:
209                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE4;
210 #endif
211 #ifdef CONFIG_I2C_MVTWSI_BASE5
212         case 5:
213                 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE5;
214 #endif
215         default:
216                 printf("Missing mvtwsi controller %d base\n", adap->hwadapnr);
217                 break;
218         }
219
220         return NULL;
221 }
222 #endif
223
224 /*
225  * enum mvtwsi_error_class - types of I2C errors
226  */
227 enum mvtwsi_error_class {
228         /* The controller returned a different status than expected */
229         MVTWSI_ERROR_WRONG_STATUS       = 0x01,
230         /* The controller timed out */
231         MVTWSI_ERROR_TIMEOUT            = 0x02,
232 };
233
234 /*
235  * mvtwsi_error() - Build I2C return code from error information
236  *
237  * For debugging purposes, this function packs some information of an occurred
238  * error into a return code. These error codes are returned from I2C API
239  * functions (i2c_{read,write}, dm_i2c_{read,write}, etc.).
240  *
241  * @ec:         The error class of the error (enum mvtwsi_error_class).
242  * @lc:         The last value of the control register.
243  * @ls:         The last value of the status register.
244  * @es:         The expected value of the status register.
245  * @return The generated error code.
246  */
247 inline uint mvtwsi_error(uint ec, uint lc, uint ls, uint es)
248 {
249         return ((ec << 24) & 0xFF000000)
250                | ((lc << 16) & 0x00FF0000)
251                | ((ls << 8) & 0x0000FF00)
252                | (es & 0xFF);
253 }
254
255 /*
256  * twsi_wait() - Wait for I2C bus interrupt flag and check status, or time out.
257  *
258  * @return Zero if status is as expected, or a non-zero code if either a time
259  *         out occurred, or the status was not the expected one.
260  */
261 static int twsi_wait(struct mvtwsi_registers *twsi, int expected_status,
262                      uint tick)
263 {
264         int control, status;
265         int timeout = 1000;
266
267         do {
268                 control = readl(&twsi->control);
269                 if (control & MVTWSI_CONTROL_IFLG) {
270                         status = readl(&twsi->status);
271                         if (status == expected_status)
272                                 return 0;
273                         else
274                                 return mvtwsi_error(
275                                         MVTWSI_ERROR_WRONG_STATUS,
276                                         control, status, expected_status);
277                 }
278                 ndelay(tick); /* One clock cycle */
279         } while (timeout--);
280         status = readl(&twsi->status);
281         return mvtwsi_error(MVTWSI_ERROR_TIMEOUT, control, status,
282                             expected_status);
283 }
284
285 /*
286  * twsi_start() - Assert a START condition on the bus.
287  *
288  * This function is used in both single I2C transactions and inside
289  * back-to-back transactions (repeated starts).
290  *
291  * @twsi:               The MVTWSI register structure to use.
292  * @expected_status:    The I2C bus status expected to be asserted after the
293  *                      operation completion.
294  * @tick:               The duration of a clock cycle at the current I2C speed.
295  * @return Zero if status is as expected, or a non-zero code if either a time
296  *         out occurred or the status was not the expected one.
297  */
298 static int twsi_start(struct mvtwsi_registers *twsi, int expected_status,
299                       uint tick)
300 {
301         /* Assert START */
302         writel(MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_START |
303                MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
304         /* Wait for controller to process START */
305         return twsi_wait(twsi, expected_status, tick);
306 }
307
308 /*
309  * twsi_send() - Send a byte on the I2C bus.
310  *
311  * The byte may be part of an address byte or data.
312  *
313  * @twsi:               The MVTWSI register structure to use.
314  * @byte:               The byte to send.
315  * @expected_status:    The I2C bus status expected to be asserted after the
316  *                      operation completion.
317  * @tick:               The duration of a clock cycle at the current I2C speed.
318  * @return Zero if status is as expected, or a non-zero code if either a time
319  *         out occurred or the status was not the expected one.
320  */
321 static int twsi_send(struct mvtwsi_registers *twsi, u8 byte,
322                      int expected_status, uint tick)
323 {
324         /* Write byte to data register for sending */
325         writel(byte, &twsi->data);
326         /* Clear any pending interrupt -- that will cause sending */
327         writel(MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_CLEAR_IFLG,
328                &twsi->control);
329         /* Wait for controller to receive byte, and check ACK */
330         return twsi_wait(twsi, expected_status, tick);
331 }
332
333 /*
334  * twsi_recv() - Receive a byte on the I2C bus.
335  *
336  * The static variable mvtwsi_control_flags controls whether we ack or nak.
337  *
338  * @twsi:               The MVTWSI register structure to use.
339  * @byte:               The byte to send.
340  * @ack_flag:           Flag that determines whether the received byte should
341  *                      be acknowledged by the controller or not (sent ACK/NAK).
342  * @tick:               The duration of a clock cycle at the current I2C speed.
343  * @return Zero if status is as expected, or a non-zero code if either a time
344  *         out occurred or the status was not the expected one.
345  */
346 static int twsi_recv(struct mvtwsi_registers *twsi, u8 *byte, int ack_flag,
347                      uint tick)
348 {
349         int expected_status, status, control;
350
351         /* Compute expected status based on passed ACK flag */
352         expected_status = ack_flag ? MVTWSI_STATUS_DATA_R_ACK :
353                           MVTWSI_STATUS_DATA_R_NAK;
354         /* Acknowledge *previous state*, and launch receive */
355         control = MVTWSI_CONTROL_TWSIEN;
356         control |= ack_flag == MVTWSI_READ_ACK ? MVTWSI_CONTROL_ACK : 0;
357         writel(control | MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
358         /* Wait for controller to receive byte, and assert ACK or NAK */
359         status = twsi_wait(twsi, expected_status, tick);
360         /* If we did receive the expected byte, store it */
361         if (status == 0)
362                 *byte = readl(&twsi->data);
363         return status;
364 }
365
366 /*
367  * twsi_stop() - Assert a STOP condition on the bus.
368  *
369  * This function is also used to force the bus back to idle state (SDA =
370  * SCL = 1).
371  *
372  * @twsi:       The MVTWSI register structure to use.
373  * @tick:       The duration of a clock cycle at the current I2C speed.
374  * @return Zero if the operation succeeded, or a non-zero code if a time out
375  *         occurred.
376  */
377 static int twsi_stop(struct mvtwsi_registers *twsi, uint tick)
378 {
379         int control, stop_status;
380         int status = 0;
381         int timeout = 1000;
382
383         /* Assert STOP */
384         control = MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_STOP;
385         writel(control | MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
386         /* Wait for IDLE; IFLG won't rise, so we can't use twsi_wait() */
387         do {
388                 stop_status = readl(&twsi->status);
389                 if (stop_status == MVTWSI_STATUS_IDLE)
390                         break;
391                 ndelay(tick); /* One clock cycle */
392         } while (timeout--);
393         control = readl(&twsi->control);
394         if (stop_status != MVTWSI_STATUS_IDLE)
395                 status = mvtwsi_error(MVTWSI_ERROR_TIMEOUT,
396                                       control, status, MVTWSI_STATUS_IDLE);
397         return status;
398 }
399
400 /*
401  * twsi_calc_freq() - Compute I2C frequency depending on m and n parameters.
402  *
403  * @n:          Parameter 'n' for the frequency calculation algorithm.
404  * @m:          Parameter 'm' for the frequency calculation algorithm.
405  * @return The I2C frequency corresponding to the passed m and n parameters.
406  */
407 static uint twsi_calc_freq(const int n, const int m)
408 {
409 #ifdef CONFIG_ARCH_SUNXI
410         return CONFIG_SYS_TCLK / (10 * (m + 1) * (1 << n));
411 #else
412         return CONFIG_SYS_TCLK / (10 * (m + 1) * (2 << n));
413 #endif
414 }
415
416 /*
417  * twsi_reset() - Reset the I2C controller.
418  *
419  * Resetting the controller also resets the baud rate and slave address, hence
420  * they must be re-established after the reset.
421  *
422  * @twsi:       The MVTWSI register structure to use.
423  */
424 static void twsi_reset(struct mvtwsi_registers *twsi)
425 {
426         /* Reset controller */
427         writel(0, &twsi->soft_reset);
428         /* Wait 2 ms -- this is what the Marvell LSP does */
429         udelay(20000);
430 }
431
432 /*
433  * __twsi_i2c_set_bus_speed() - Set the speed of the I2C controller.
434  *
435  * This function sets baud rate to the highest possible value that does not
436  * exceed the requested rate.
437  *
438  * @twsi:               The MVTWSI register structure to use.
439  * @requested_speed:    The desired frequency the controller should run at
440  *                      in Hz.
441  * @return The actual frequency the controller was configured to.
442  */
443 static uint __twsi_i2c_set_bus_speed(struct mvtwsi_registers *twsi,
444                                      uint requested_speed)
445 {
446         uint tmp_speed, highest_speed, n, m;
447         uint baud = 0x44; /* Baud rate after controller reset */
448
449         highest_speed = 0;
450         /* Successively try m, n combinations, and use the combination
451          * resulting in the largest speed that's not above the requested
452          * speed */
453         for (n = 0; n < 8; n++) {
454                 for (m = 0; m < 16; m++) {
455                         tmp_speed = twsi_calc_freq(n, m);
456                         if ((tmp_speed <= requested_speed) &&
457                             (tmp_speed > highest_speed)) {
458                                 highest_speed = tmp_speed;
459                                 baud = (m << 3) | n;
460                         }
461                 }
462         }
463         writel(baud, &twsi->baudrate);
464
465         /* Wait for controller for one tick */
466 #ifdef CONFIG_DM_I2C
467         ndelay(calc_tick(highest_speed));
468 #else
469         ndelay(10000);
470 #endif
471         return highest_speed;
472 }
473
474 /*
475  * __twsi_i2c_init() - Initialize the I2C controller.
476  *
477  * @twsi:               The MVTWSI register structure to use.
478  * @speed:              The initial frequency the controller should run at
479  *                      in Hz.
480  * @slaveadd:           The I2C address to be set for the I2C master.
481  * @actual_speed:       A output parameter that receives the actual frequency
482  *                      in Hz the controller was set to by the function.
483  * @return Zero if the operation succeeded, or a non-zero code if a time out
484  *         occurred.
485  */
486 static void __twsi_i2c_init(struct mvtwsi_registers *twsi, int speed,
487                             int slaveadd, uint *actual_speed)
488 {
489         uint tmp_speed;
490
491         /* Reset controller */
492         twsi_reset(twsi);
493         /* Set speed */
494         tmp_speed = __twsi_i2c_set_bus_speed(twsi, speed);
495         if (actual_speed)
496                 *actual_speed = tmp_speed;
497         /* Set slave address; even though we don't use it */
498         writel(slaveadd, &twsi->slave_address);
499         writel(0, &twsi->xtnd_slave_addr);
500         /* Assert STOP, but don't care for the result */
501 #ifdef CONFIG_DM_I2C
502         (void) twsi_stop(twsi, calc_tick(*actual_speed));
503 #else
504         (void) twsi_stop(twsi, 10000);
505 #endif
506 }
507
508 /*
509  * i2c_begin() - Start a I2C transaction.
510  *
511  * Begin a I2C transaction with a given expected start status and chip address.
512  * A START is asserted, and the address byte is sent to the I2C controller. The
513  * expected address status will be derived from the direction bit (bit 0) of
514  * the address byte.
515  *
516  * @twsi:                       The MVTWSI register structure to use.
517  * @expected_start_status:      The I2C status the controller is expected to
518  *                              assert after the address byte was sent.
519  * @addr:                       The address byte to be sent.
520  * @tick:                       The duration of a clock cycle at the current
521  *                              I2C speed.
522  * @return Zero if the operation succeeded, or a non-zero code if a time out or
523  *         unexpected I2C status occurred.
524  */
525 static int i2c_begin(struct mvtwsi_registers *twsi, int expected_start_status,
526                      u8 addr, uint tick)
527 {
528         int status, expected_addr_status;
529
530         /* Compute the expected address status from the direction bit in
531          * the address byte */
532         if (addr & 1) /* Reading */
533                 expected_addr_status = MVTWSI_STATUS_ADDR_R_ACK;
534         else /* Writing */
535                 expected_addr_status = MVTWSI_STATUS_ADDR_W_ACK;
536         /* Assert START */
537         status = twsi_start(twsi, expected_start_status, tick);
538         /* Send out the address if the start went well */
539         if (status == 0)
540                 status = twsi_send(twsi, addr, expected_addr_status, tick);
541         /* Return 0, or the status of the first failure */
542         return status;
543 }
544
545 /*
546  * __twsi_i2c_probe_chip() - Probe the given I2C chip address.
547  *
548  * This function begins a I2C read transaction, does a dummy read and NAKs; if
549  * the procedure succeeds, the chip is considered to be present.
550  *
551  * @twsi:       The MVTWSI register structure to use.
552  * @chip:       The chip address to probe.
553  * @tick:       The duration of a clock cycle at the current I2C speed.
554  * @return Zero if the operation succeeded, or a non-zero code if a time out or
555  *         unexpected I2C status occurred.
556  */
557 static int __twsi_i2c_probe_chip(struct mvtwsi_registers *twsi, uchar chip,
558                                  uint tick)
559 {
560         u8 dummy_byte;
561         int status;
562
563         /* Begin i2c read */
564         status = i2c_begin(twsi, MVTWSI_STATUS_START, (chip << 1) | 1, tick);
565         /* Dummy read was accepted: receive byte, but NAK it. */
566         if (status == 0)
567                 status = twsi_recv(twsi, &dummy_byte, MVTWSI_READ_NAK, tick);
568         /* Stop transaction */
569         twsi_stop(twsi, tick);
570         /* Return 0, or the status of the first failure */
571         return status;
572 }
573
574 /*
575  * __twsi_i2c_read() - Read data from a I2C chip.
576  *
577  * This function begins a I2C write transaction, and transmits the address
578  * bytes; then begins a I2C read transaction, and receives the data bytes.
579  *
580  * NOTE: Some devices want a stop right before the second start, while some
581  * will choke if it is there. Since deciding this is not yet supported in
582  * higher level APIs, we need to make a decision here, and for the moment that
583  * will be a repeated start without a preceding stop.
584  *
585  * @twsi:       The MVTWSI register structure to use.
586  * @chip:       The chip address to read from.
587  * @addr:       The address bytes to send.
588  * @alen:       The length of the address bytes in bytes.
589  * @data:       The buffer to receive the data read from the chip (has to have
590  *              a size of at least 'length' bytes).
591  * @length:     The amount of data to be read from the chip in bytes.
592  * @tick:       The duration of a clock cycle at the current I2C speed.
593  * @return Zero if the operation succeeded, or a non-zero code if a time out or
594  *         unexpected I2C status occurred.
595  */
596 static int __twsi_i2c_read(struct mvtwsi_registers *twsi, uchar chip,
597                            u8 *addr, int alen, uchar *data, int length,
598                            uint tick)
599 {
600         int status = 0;
601         int stop_status;
602         int expected_start = MVTWSI_STATUS_START;
603
604         if (alen > 0) {
605                 /* Begin i2c write to send the address bytes */
606                 status = i2c_begin(twsi, expected_start, (chip << 1), tick);
607                 /* Send address bytes */
608                 while ((status == 0) && alen--)
609                         status = twsi_send(twsi, addr[alen],
610                                            MVTWSI_STATUS_DATA_W_ACK, tick);
611                 /* Send repeated STARTs after the initial START */
612                 expected_start = MVTWSI_STATUS_REPEATED_START;
613         }
614         /* Begin i2c read to receive data bytes */
615         if (status == 0)
616                 status = i2c_begin(twsi, expected_start, (chip << 1) | 1, tick);
617         /* Receive actual data bytes; set NAK if we if we have nothing more to
618          * read */
619         while ((status == 0) && length--)
620                 status = twsi_recv(twsi, data++,
621                                    length > 0 ?
622                                    MVTWSI_READ_ACK : MVTWSI_READ_NAK, tick);
623         /* Stop transaction */
624         stop_status = twsi_stop(twsi, tick);
625         /* Return 0, or the status of the first failure */
626         return status != 0 ? status : stop_status;
627 }
628
629 /*
630  * __twsi_i2c_write() - Send data to a I2C chip.
631  *
632  * This function begins a I2C write transaction, and transmits the address
633  * bytes; then begins a new I2C write transaction, and sends the data bytes.
634  *
635  * @twsi:       The MVTWSI register structure to use.
636  * @chip:       The chip address to read from.
637  * @addr:       The address bytes to send.
638  * @alen:       The length of the address bytes in bytes.
639  * @data:       The buffer containing the data to be sent to the chip.
640  * @length:     The length of data to be sent to the chip in bytes.
641  * @tick:       The duration of a clock cycle at the current I2C speed.
642  * @return Zero if the operation succeeded, or a non-zero code if a time out or
643  *         unexpected I2C status occurred.
644  */
645 static int __twsi_i2c_write(struct mvtwsi_registers *twsi, uchar chip,
646                             u8 *addr, int alen, uchar *data, int length,
647                             uint tick)
648 {
649         int status, stop_status;
650
651         /* Begin i2c write to send first the address bytes, then the
652          * data bytes */
653         status = i2c_begin(twsi, MVTWSI_STATUS_START, (chip << 1), tick);
654         /* Send address bytes */
655         while ((status == 0) && (alen-- > 0))
656                 status = twsi_send(twsi, addr[alen], MVTWSI_STATUS_DATA_W_ACK,
657                                    tick);
658         /* Send data bytes */
659         while ((status == 0) && (length-- > 0))
660                 status = twsi_send(twsi, *(data++), MVTWSI_STATUS_DATA_W_ACK,
661                                    tick);
662         /* Stop transaction */
663         stop_status = twsi_stop(twsi, tick);
664         /* Return 0, or the status of the first failure */
665         return status != 0 ? status : stop_status;
666 }
667
668 #ifndef CONFIG_DM_I2C
669 static void twsi_i2c_init(struct i2c_adapter *adap, int speed,
670                           int slaveadd)
671 {
672         struct mvtwsi_registers *twsi = twsi_get_base(adap);
673         __twsi_i2c_init(twsi, speed, slaveadd, NULL);
674 }
675
676 static uint twsi_i2c_set_bus_speed(struct i2c_adapter *adap,
677                                    uint requested_speed)
678 {
679         struct mvtwsi_registers *twsi = twsi_get_base(adap);
680         __twsi_i2c_set_bus_speed(twsi, requested_speed);
681         return 0;
682 }
683
684 static int twsi_i2c_probe(struct i2c_adapter *adap, uchar chip)
685 {
686         struct mvtwsi_registers *twsi = twsi_get_base(adap);
687         return __twsi_i2c_probe_chip(twsi, chip, 10000);
688 }
689
690 static int twsi_i2c_read(struct i2c_adapter *adap, uchar chip, uint addr,
691                          int alen, uchar *data, int length)
692 {
693         struct mvtwsi_registers *twsi = twsi_get_base(adap);
694         u8 addr_bytes[4];
695
696         addr_bytes[0] = (addr >> 0) & 0xFF;
697         addr_bytes[1] = (addr >> 8) & 0xFF;
698         addr_bytes[2] = (addr >> 16) & 0xFF;
699         addr_bytes[3] = (addr >> 24) & 0xFF;
700
701         return __twsi_i2c_read(twsi, chip, addr_bytes, alen, data, length,
702                                10000);
703 }
704
705 static int twsi_i2c_write(struct i2c_adapter *adap, uchar chip, uint addr,
706                           int alen, uchar *data, int length)
707 {
708         struct mvtwsi_registers *twsi = twsi_get_base(adap);
709         u8 addr_bytes[4];
710
711         addr_bytes[0] = (addr >> 0) & 0xFF;
712         addr_bytes[1] = (addr >> 8) & 0xFF;
713         addr_bytes[2] = (addr >> 16) & 0xFF;
714         addr_bytes[3] = (addr >> 24) & 0xFF;
715
716         return __twsi_i2c_write(twsi, chip, addr_bytes, alen, data, length,
717                                 10000);
718 }
719
720 #ifdef CONFIG_I2C_MVTWSI_BASE0
721 U_BOOT_I2C_ADAP_COMPLETE(twsi0, twsi_i2c_init, twsi_i2c_probe,
722                          twsi_i2c_read, twsi_i2c_write,
723                          twsi_i2c_set_bus_speed,
724                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 0)
725 #endif
726 #ifdef CONFIG_I2C_MVTWSI_BASE1
727 U_BOOT_I2C_ADAP_COMPLETE(twsi1, twsi_i2c_init, twsi_i2c_probe,
728                          twsi_i2c_read, twsi_i2c_write,
729                          twsi_i2c_set_bus_speed,
730                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 1)
731
732 #endif
733 #ifdef CONFIG_I2C_MVTWSI_BASE2
734 U_BOOT_I2C_ADAP_COMPLETE(twsi2, twsi_i2c_init, twsi_i2c_probe,
735                          twsi_i2c_read, twsi_i2c_write,
736                          twsi_i2c_set_bus_speed,
737                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 2)
738
739 #endif
740 #ifdef CONFIG_I2C_MVTWSI_BASE3
741 U_BOOT_I2C_ADAP_COMPLETE(twsi3, twsi_i2c_init, twsi_i2c_probe,
742                          twsi_i2c_read, twsi_i2c_write,
743                          twsi_i2c_set_bus_speed,
744                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 3)
745
746 #endif
747 #ifdef CONFIG_I2C_MVTWSI_BASE4
748 U_BOOT_I2C_ADAP_COMPLETE(twsi4, twsi_i2c_init, twsi_i2c_probe,
749                          twsi_i2c_read, twsi_i2c_write,
750                          twsi_i2c_set_bus_speed,
751                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 4)
752
753 #endif
754 #ifdef CONFIG_I2C_MVTWSI_BASE5
755 U_BOOT_I2C_ADAP_COMPLETE(twsi5, twsi_i2c_init, twsi_i2c_probe,
756                          twsi_i2c_read, twsi_i2c_write,
757                          twsi_i2c_set_bus_speed,
758                          CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 5)
759
760 #endif
761 #else /* CONFIG_DM_I2C */
762
763 static int mvtwsi_i2c_probe_chip(struct udevice *bus, u32 chip_addr,
764                                  u32 chip_flags)
765 {
766         struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
767         return __twsi_i2c_probe_chip(dev->base, chip_addr, dev->tick);
768 }
769
770 static int mvtwsi_i2c_set_bus_speed(struct udevice *bus, uint speed)
771 {
772         struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
773
774         dev->speed = __twsi_i2c_set_bus_speed(dev->base, speed);
775         dev->tick = calc_tick(dev->speed);
776
777         return 0;
778 }
779
780 static int mvtwsi_i2c_ofdata_to_platdata(struct udevice *bus)
781 {
782         struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
783
784         dev->base = devfdt_get_addr_ptr(bus);
785
786         if (!dev->base)
787                 return -ENOMEM;
788
789         dev->index = fdtdec_get_int(gd->fdt_blob, dev_of_offset(bus),
790                                     "cell-index", -1);
791         dev->slaveadd = fdtdec_get_int(gd->fdt_blob, dev_of_offset(bus),
792                                        "u-boot,i2c-slave-addr", 0x0);
793         dev->speed = fdtdec_get_int(gd->fdt_blob, dev_of_offset(bus),
794                                     "clock-frequency", 100000);
795         return 0;
796 }
797
798 static int mvtwsi_i2c_probe(struct udevice *bus)
799 {
800         struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
801         uint actual_speed;
802
803         __twsi_i2c_init(dev->base, dev->speed, dev->slaveadd, &actual_speed);
804         dev->speed = actual_speed;
805         dev->tick = calc_tick(dev->speed);
806         return 0;
807 }
808
809 static int mvtwsi_i2c_xfer(struct udevice *bus, struct i2c_msg *msg, int nmsgs)
810 {
811         struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
812         struct i2c_msg *dmsg, *omsg, dummy;
813
814         memset(&dummy, 0, sizeof(struct i2c_msg));
815
816         /* We expect either two messages (one with an offset and one with the
817          * actual data) or one message (just data or offset/data combined) */
818         if (nmsgs > 2 || nmsgs == 0) {
819                 debug("%s: Only one or two messages are supported.", __func__);
820                 return -1;
821         }
822
823         omsg = nmsgs == 1 ? &dummy : msg;
824         dmsg = nmsgs == 1 ? msg : msg + 1;
825
826         if (dmsg->flags & I2C_M_RD)
827                 return __twsi_i2c_read(dev->base, dmsg->addr, omsg->buf,
828                                        omsg->len, dmsg->buf, dmsg->len,
829                                        dev->tick);
830         else
831                 return __twsi_i2c_write(dev->base, dmsg->addr, omsg->buf,
832                                         omsg->len, dmsg->buf, dmsg->len,
833                                         dev->tick);
834 }
835
836 static const struct dm_i2c_ops mvtwsi_i2c_ops = {
837         .xfer           = mvtwsi_i2c_xfer,
838         .probe_chip     = mvtwsi_i2c_probe_chip,
839         .set_bus_speed  = mvtwsi_i2c_set_bus_speed,
840 };
841
842 static const struct udevice_id mvtwsi_i2c_ids[] = {
843         { .compatible = "marvell,mv64xxx-i2c", },
844         { .compatible = "marvell,mv78230-i2c", },
845         { .compatible = "allwinner,sun6i-a31-i2c", },
846         { /* sentinel */ }
847 };
848
849 U_BOOT_DRIVER(i2c_mvtwsi) = {
850         .name = "i2c_mvtwsi",
851         .id = UCLASS_I2C,
852         .of_match = mvtwsi_i2c_ids,
853         .probe = mvtwsi_i2c_probe,
854         .ofdata_to_platdata = mvtwsi_i2c_ofdata_to_platdata,
855         .priv_auto_alloc_size = sizeof(struct mvtwsi_i2c_dev),
856         .ops = &mvtwsi_i2c_ops,
857 };
858 #endif /* CONFIG_DM_I2C */