blob: 8552fba7b6c6c120065048eb779effbb6f0229f6 [file] [log] [blame]
Heiko Schocher4ce5a722009-07-20 09:59:37 +02001/*
Albert Aribaud306563a2010-08-27 18:26:05 +02002 * Driver for the TWSI (i2c) controller found on the Marvell
3 * orion5x and kirkwood SoC families.
Heiko Schocher4ce5a722009-07-20 09:59:37 +02004 *
Albert ARIBAUD57b4bce2011-04-22 19:41:02 +02005 * Author: Albert Aribaud <albert.u.boot@aribaud.net>
Albert Aribaud306563a2010-08-27 18:26:05 +02006 * Copyright (c) 2010 Albert Aribaud.
Heiko Schocher4ce5a722009-07-20 09:59:37 +02007 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02008 * SPDX-License-Identifier: GPL-2.0+
Heiko Schocher4ce5a722009-07-20 09:59:37 +02009 */
Albert Aribaud306563a2010-08-27 18:26:05 +020010
Heiko Schocher4ce5a722009-07-20 09:59:37 +020011#include <common.h>
12#include <i2c.h>
Heiko Schocher4ce5a722009-07-20 09:59:37 +020013#include <asm/errno.h>
14#include <asm/io.h>
mario.six@gdsys.cc14a6ff22016-07-21 11:57:10 +020015#ifdef CONFIG_DM_I2C
16#include <dm.h>
17#endif
18
19DECLARE_GLOBAL_DATA_PTR;
Heiko Schocher4ce5a722009-07-20 09:59:37 +020020
Heiko Schocher4ce5a722009-07-20 09:59:37 +020021/*
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +020022 * Include a file that will provide CONFIG_I2C_MVTWSI_BASE*, and possibly other
23 * settings
Heiko Schocher4ce5a722009-07-20 09:59:37 +020024 */
25
mario.six@gdsys.cc14a6ff22016-07-21 11:57:10 +020026#ifndef CONFIG_DM_I2C
Albert Aribaud306563a2010-08-27 18:26:05 +020027#if defined(CONFIG_ORION5X)
28#include <asm/arch/orion5x.h>
Stefan Roese81e33f42015-12-21 13:56:33 +010029#elif (defined(CONFIG_KIRKWOOD) || defined(CONFIG_ARCH_MVEBU))
Stefan Roese3dc23f72014-10-22 12:13:06 +020030#include <asm/arch/soc.h>
Hans de Goede66203772014-06-13 22:55:49 +020031#elif defined(CONFIG_SUNXI)
32#include <asm/arch/i2c.h>
Albert Aribaud306563a2010-08-27 18:26:05 +020033#else
34#error Driver mvtwsi not supported by SoC or board
35#endif
mario.six@gdsys.cc14a6ff22016-07-21 11:57:10 +020036#endif /* CONFIG_DM_I2C */
Albert Aribaud306563a2010-08-27 18:26:05 +020037
38/*
39 * TWSI register structure
40 */
41
Hans de Goede66203772014-06-13 22:55:49 +020042#ifdef CONFIG_SUNXI
43
44struct mvtwsi_registers {
45 u32 slave_address;
46 u32 xtnd_slave_addr;
47 u32 data;
48 u32 control;
49 u32 status;
50 u32 baudrate;
51 u32 soft_reset;
52};
53
54#else
55
Albert Aribaud306563a2010-08-27 18:26:05 +020056struct mvtwsi_registers {
57 u32 slave_address;
58 u32 data;
59 u32 control;
60 union {
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +020061 u32 status; /* When reading */
62 u32 baudrate; /* When writing */
Albert Aribaud306563a2010-08-27 18:26:05 +020063 };
64 u32 xtnd_slave_addr;
65 u32 reserved[2];
66 u32 soft_reset;
67};
68
Hans de Goede66203772014-06-13 22:55:49 +020069#endif
70
mario.six@gdsys.cc14a6ff22016-07-21 11:57:10 +020071#ifdef CONFIG_DM_I2C
72struct mvtwsi_i2c_dev {
73 /* TWSI Register base for the device */
74 struct mvtwsi_registers *base;
75 /* Number of the device (determined from cell-index property) */
76 int index;
77 /* The I2C slave address for the device */
78 u8 slaveadd;
79 /* The configured I2C speed in Hz */
80 uint speed;
81};
82#endif /* CONFIG_DM_I2C */
83
Albert Aribaud306563a2010-08-27 18:26:05 +020084/*
mario.six@gdsys.ccdfc39582016-07-21 11:57:02 +020085 * enum mvtwsi_ctrl_register_fields - Bit masks for flags in the control
86 * register
Albert Aribaud306563a2010-08-27 18:26:05 +020087 */
mario.six@gdsys.ccdfc39582016-07-21 11:57:02 +020088enum mvtwsi_ctrl_register_fields {
89 /* Acknowledge bit */
90 MVTWSI_CONTROL_ACK = 0x00000004,
91 /* Interrupt flag */
92 MVTWSI_CONTROL_IFLG = 0x00000008,
93 /* Stop bit */
94 MVTWSI_CONTROL_STOP = 0x00000010,
95 /* Start bit */
96 MVTWSI_CONTROL_START = 0x00000020,
97 /* I2C enable */
98 MVTWSI_CONTROL_TWSIEN = 0x00000040,
99 /* Interrupt enable */
100 MVTWSI_CONTROL_INTEN = 0x00000080,
101};
Albert Aribaud306563a2010-08-27 18:26:05 +0200102
103/*
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200104 * On sun6i and newer, IFLG is a write-clear bit, which is cleared by writing 1;
105 * on other platforms, it is a normal r/w bit, which is cleared by writing 0.
Hans de Goede904dfbf2016-01-14 14:06:25 +0100106 */
107
108#ifdef CONFIG_SUNXI_GEN_SUN6I
109#define MVTWSI_CONTROL_CLEAR_IFLG 0x00000008
110#else
111#define MVTWSI_CONTROL_CLEAR_IFLG 0x00000000
112#endif
113
114/*
mario.six@gdsys.ccdfc39582016-07-21 11:57:02 +0200115 * enum mvstwsi_status_values - Possible values of I2C controller's status
116 * register
117 *
118 * Only those statuses expected in normal master operation on
119 * non-10-bit-address devices are specified.
120 *
121 * Every status that's unexpected during normal operation (bus errors,
122 * arbitration losses, missing ACKs...) is passed back to the caller as an error
Albert Aribaud306563a2010-08-27 18:26:05 +0200123 * code.
124 */
mario.six@gdsys.ccdfc39582016-07-21 11:57:02 +0200125enum mvstwsi_status_values {
126 /* START condition transmitted */
127 MVTWSI_STATUS_START = 0x08,
128 /* Repeated START condition transmitted */
129 MVTWSI_STATUS_REPEATED_START = 0x10,
130 /* Address + write bit transmitted, ACK received */
131 MVTWSI_STATUS_ADDR_W_ACK = 0x18,
132 /* Data transmitted, ACK received */
133 MVTWSI_STATUS_DATA_W_ACK = 0x28,
134 /* Address + read bit transmitted, ACK received */
135 MVTWSI_STATUS_ADDR_R_ACK = 0x40,
136 /* Address + read bit transmitted, ACK not received */
137 MVTWSI_STATUS_ADDR_R_NAK = 0x48,
138 /* Data received, ACK transmitted */
139 MVTWSI_STATUS_DATA_R_ACK = 0x50,
140 /* Data received, ACK not transmitted */
141 MVTWSI_STATUS_DATA_R_NAK = 0x58,
142 /* No relevant status */
143 MVTWSI_STATUS_IDLE = 0xF8,
144};
Albert Aribaud306563a2010-08-27 18:26:05 +0200145
146/*
mario.six@gdsys.cc670514f2016-07-21 11:57:04 +0200147 * enum mvstwsi_ack_flags - Determine whether a read byte should be
148 * acknowledged or not.
149 */
150enum mvtwsi_ack_flags {
151 /* Send NAK after received byte */
152 MVTWSI_READ_NAK = 0,
153 /* Send ACK after received byte */
154 MVTWSI_READ_ACK = 1,
155};
156
mario.six@gdsys.cc14a6ff22016-07-21 11:57:10 +0200157#ifndef CONFIG_DM_I2C
mario.six@gdsys.cc670514f2016-07-21 11:57:04 +0200158/*
Paul Kocialkowskidd822422015-04-10 23:09:51 +0200159 * MVTWSI controller base
Albert Aribaud306563a2010-08-27 18:26:05 +0200160 */
161
Paul Kocialkowskidd822422015-04-10 23:09:51 +0200162static struct mvtwsi_registers *twsi_get_base(struct i2c_adapter *adap)
163{
164 switch (adap->hwadapnr) {
165#ifdef CONFIG_I2C_MVTWSI_BASE0
166 case 0:
mario.six@gdsys.cc9ec43b02016-07-21 11:57:01 +0200167 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE0;
Paul Kocialkowskidd822422015-04-10 23:09:51 +0200168#endif
169#ifdef CONFIG_I2C_MVTWSI_BASE1
170 case 1:
mario.six@gdsys.cc9ec43b02016-07-21 11:57:01 +0200171 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE1;
Paul Kocialkowskidd822422015-04-10 23:09:51 +0200172#endif
173#ifdef CONFIG_I2C_MVTWSI_BASE2
174 case 2:
mario.six@gdsys.cc9ec43b02016-07-21 11:57:01 +0200175 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE2;
Paul Kocialkowskidd822422015-04-10 23:09:51 +0200176#endif
177#ifdef CONFIG_I2C_MVTWSI_BASE3
178 case 3:
mario.six@gdsys.cc9ec43b02016-07-21 11:57:01 +0200179 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE3;
Paul Kocialkowskidd822422015-04-10 23:09:51 +0200180#endif
181#ifdef CONFIG_I2C_MVTWSI_BASE4
182 case 4:
mario.six@gdsys.cc9ec43b02016-07-21 11:57:01 +0200183 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE4;
Paul Kocialkowskidd822422015-04-10 23:09:51 +0200184#endif
Jelle van der Waa9d082682016-01-14 14:06:26 +0100185#ifdef CONFIG_I2C_MVTWSI_BASE5
186 case 5:
mario.six@gdsys.cc9ec43b02016-07-21 11:57:01 +0200187 return (struct mvtwsi_registers *)CONFIG_I2C_MVTWSI_BASE5;
Jelle van der Waa9d082682016-01-14 14:06:26 +0100188#endif
Paul Kocialkowskidd822422015-04-10 23:09:51 +0200189 default:
190 printf("Missing mvtwsi controller %d base\n", adap->hwadapnr);
191 break;
192 }
193
194 return NULL;
195}
mario.six@gdsys.cc14a6ff22016-07-21 11:57:10 +0200196#endif
Albert Aribaud306563a2010-08-27 18:26:05 +0200197
198/*
mario.six@gdsys.ccdfc39582016-07-21 11:57:02 +0200199 * enum mvtwsi_error_class - types of I2C errors
Albert Aribaud306563a2010-08-27 18:26:05 +0200200 */
mario.six@gdsys.ccdfc39582016-07-21 11:57:02 +0200201enum mvtwsi_error_class {
202 /* The controller returned a different status than expected */
203 MVTWSI_ERROR_WRONG_STATUS = 0x01,
204 /* The controller timed out */
205 MVTWSI_ERROR_TIMEOUT = 0x02,
206};
Albert Aribaud306563a2010-08-27 18:26:05 +0200207
mario.six@gdsys.ccdfc39582016-07-21 11:57:02 +0200208/*
209 * mvtwsi_error() - Build I2C return code from error information
210 *
211 * For debugging purposes, this function packs some information of an occurred
212 * error into a return code. These error codes are returned from I2C API
213 * functions (i2c_{read,write}, dm_i2c_{read,write}, etc.).
214 *
215 * @ec: The error class of the error (enum mvtwsi_error_class).
216 * @lc: The last value of the control register.
217 * @ls: The last value of the status register.
218 * @es: The expected value of the status register.
219 * @return The generated error code.
220 */
221inline uint mvtwsi_error(uint ec, uint lc, uint ls, uint es)
222{
223 return ((ec << 24) & 0xFF000000)
224 | ((lc << 16) & 0x00FF0000)
225 | ((ls << 8) & 0x0000FF00)
226 | (es & 0xFF);
227}
Albert Aribaud306563a2010-08-27 18:26:05 +0200228
229/*
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200230 * Wait for IFLG to raise, or return 'timeout.' Then, if the status is as
231 * expected, return 0 (ok) or 'wrong status' otherwise.
Albert Aribaud306563a2010-08-27 18:26:05 +0200232 */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200233static int twsi_wait(struct mvtwsi_registers *twsi, int expected_status)
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200234{
Albert Aribaud306563a2010-08-27 18:26:05 +0200235 int control, status;
236 int timeout = 1000;
237
238 do {
239 control = readl(&twsi->control);
240 if (control & MVTWSI_CONTROL_IFLG) {
241 status = readl(&twsi->status);
242 if (status == expected_status)
243 return 0;
244 else
mario.six@gdsys.ccdfc39582016-07-21 11:57:02 +0200245 return mvtwsi_error(
Albert Aribaud306563a2010-08-27 18:26:05 +0200246 MVTWSI_ERROR_WRONG_STATUS,
247 control, status, expected_status);
248 }
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200249 udelay(10); /* One clock cycle at 100 kHz */
Albert Aribaud306563a2010-08-27 18:26:05 +0200250 } while (timeout--);
251 status = readl(&twsi->status);
mario.six@gdsys.ccdfc39582016-07-21 11:57:02 +0200252 return mvtwsi_error(MVTWSI_ERROR_TIMEOUT, control, status,
253 expected_status);
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200254}
255
Albert Aribaud306563a2010-08-27 18:26:05 +0200256/*
Albert Aribaud306563a2010-08-27 18:26:05 +0200257 * Assert the START condition, either in a single I2C transaction
258 * or inside back-to-back ones (repeated starts).
259 */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200260static int twsi_start(struct mvtwsi_registers *twsi, int expected_status)
Albert Aribaud306563a2010-08-27 18:26:05 +0200261{
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200262 /* Assert START */
mario.six@gdsys.cc670514f2016-07-21 11:57:04 +0200263 writel(MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_START |
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200264 MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
265 /* Wait for controller to process START */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200266 return twsi_wait(twsi, expected_status);
Albert Aribaud306563a2010-08-27 18:26:05 +0200267}
268
269/*
270 * Send a byte (i2c address or data).
271 */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200272static int twsi_send(struct mvtwsi_registers *twsi, u8 byte,
273 int expected_status)
Albert Aribaud306563a2010-08-27 18:26:05 +0200274{
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200275 /* Write byte to data register for sending */
Albert Aribaud306563a2010-08-27 18:26:05 +0200276 writel(byte, &twsi->data);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200277 /* Clear any pending interrupt -- that will cause sending */
mario.six@gdsys.cc670514f2016-07-21 11:57:04 +0200278 writel(MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_CLEAR_IFLG,
279 &twsi->control);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200280 /* Wait for controller to receive byte, and check ACK */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200281 return twsi_wait(twsi, expected_status);
Albert Aribaud306563a2010-08-27 18:26:05 +0200282}
283
284/*
285 * Receive a byte.
Albert Aribaud306563a2010-08-27 18:26:05 +0200286 */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200287static int twsi_recv(struct mvtwsi_registers *twsi, u8 *byte, int ack_flag)
Albert Aribaud306563a2010-08-27 18:26:05 +0200288{
mario.six@gdsys.cc670514f2016-07-21 11:57:04 +0200289 int expected_status, status, control;
Albert Aribaud306563a2010-08-27 18:26:05 +0200290
mario.six@gdsys.cc670514f2016-07-21 11:57:04 +0200291 /* Compute expected status based on passed ACK flag */
292 expected_status = ack_flag ? MVTWSI_STATUS_DATA_R_ACK :
293 MVTWSI_STATUS_DATA_R_NAK;
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200294 /* Acknowledge *previous state*, and launch receive */
mario.six@gdsys.cc670514f2016-07-21 11:57:04 +0200295 control = MVTWSI_CONTROL_TWSIEN;
296 control |= ack_flag == MVTWSI_READ_ACK ? MVTWSI_CONTROL_ACK : 0;
297 writel(control | MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200298 /* Wait for controller to receive byte, and assert ACK or NAK */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200299 status = twsi_wait(twsi, expected_status);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200300 /* If we did receive the expected byte, store it */
Albert Aribaud306563a2010-08-27 18:26:05 +0200301 if (status == 0)
302 *byte = readl(&twsi->data);
Albert Aribaud306563a2010-08-27 18:26:05 +0200303 return status;
304}
305
306/*
307 * Assert the STOP condition.
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200308 * This is also used to force the bus back to idle (SDA = SCL = 1).
Albert Aribaud306563a2010-08-27 18:26:05 +0200309 */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200310static int twsi_stop(struct mvtwsi_registers *twsi)
Albert Aribaud306563a2010-08-27 18:26:05 +0200311{
312 int control, stop_status;
mario.six@gdsys.cc059fce92016-07-21 11:57:05 +0200313 int status = 0;
Albert Aribaud306563a2010-08-27 18:26:05 +0200314 int timeout = 1000;
315
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200316 /* Assert STOP */
Albert Aribaud306563a2010-08-27 18:26:05 +0200317 control = MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_STOP;
Hans de Goede904dfbf2016-01-14 14:06:25 +0100318 writel(control | MVTWSI_CONTROL_CLEAR_IFLG, &twsi->control);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200319 /* Wait for IDLE; IFLG won't rise, so we can't use twsi_wait() */
Albert Aribaud306563a2010-08-27 18:26:05 +0200320 do {
321 stop_status = readl(&twsi->status);
322 if (stop_status == MVTWSI_STATUS_IDLE)
323 break;
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200324 udelay(10); /* One clock cycle at 100 kHz */
Albert Aribaud306563a2010-08-27 18:26:05 +0200325 } while (timeout--);
326 control = readl(&twsi->control);
327 if (stop_status != MVTWSI_STATUS_IDLE)
mario.six@gdsys.cc059fce92016-07-21 11:57:05 +0200328 status = mvtwsi_error(MVTWSI_ERROR_TIMEOUT,
329 control, status, MVTWSI_STATUS_IDLE);
Albert Aribaud306563a2010-08-27 18:26:05 +0200330 return status;
331}
332
mario.six@gdsys.cce0758282016-07-21 11:57:06 +0200333static uint twsi_calc_freq(const int n, const int m)
Stefan Roesef582a152015-03-18 09:30:54 +0100334{
335#ifdef CONFIG_SUNXI
336 return CONFIG_SYS_TCLK / (10 * (m + 1) * (1 << n));
337#else
338 return CONFIG_SYS_TCLK / (10 * (m + 1) * (2 << n));
339#endif
340}
Albert Aribaud306563a2010-08-27 18:26:05 +0200341
342/*
Albert Aribaud306563a2010-08-27 18:26:05 +0200343 * Reset controller.
Albert Aribaud306563a2010-08-27 18:26:05 +0200344 * Controller reset also resets the baud rate and slave address, so
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200345 * they must be re-established afterwards.
Albert Aribaud306563a2010-08-27 18:26:05 +0200346 */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200347static void twsi_reset(struct mvtwsi_registers *twsi)
Albert Aribaud306563a2010-08-27 18:26:05 +0200348{
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200349 /* Reset controller */
Albert Aribaud306563a2010-08-27 18:26:05 +0200350 writel(0, &twsi->soft_reset);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200351 /* Wait 2 ms -- this is what the Marvell LSP does */
Albert Aribaud306563a2010-08-27 18:26:05 +0200352 udelay(20000);
Albert Aribaud306563a2010-08-27 18:26:05 +0200353}
354
355/*
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200356 * Sets baud to the highest possible value not exceeding the requested one.
Albert Aribaud306563a2010-08-27 18:26:05 +0200357 */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200358static uint __twsi_i2c_set_bus_speed(struct mvtwsi_registers *twsi,
mario.six@gdsys.cc61bc02b2016-07-21 11:57:07 +0200359 uint requested_speed)
Albert Aribaud306563a2010-08-27 18:26:05 +0200360{
mario.six@gdsys.cce0758282016-07-21 11:57:06 +0200361 uint tmp_speed, highest_speed, n, m;
362 uint baud = 0x44; /* Baud rate after controller reset */
Albert Aribaud306563a2010-08-27 18:26:05 +0200363
Albert Aribaud306563a2010-08-27 18:26:05 +0200364 highest_speed = 0;
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200365 /* Successively try m, n combinations, and use the combination
366 * resulting in the largest speed that's not above the requested
367 * speed */
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200368 for (n = 0; n < 8; n++) {
369 for (m = 0; m < 16; m++) {
Stefan Roesef582a152015-03-18 09:30:54 +0100370 tmp_speed = twsi_calc_freq(n, m);
mario.six@gdsys.cc9ec43b02016-07-21 11:57:01 +0200371 if ((tmp_speed <= requested_speed) &&
372 (tmp_speed > highest_speed)) {
Albert Aribaud306563a2010-08-27 18:26:05 +0200373 highest_speed = tmp_speed;
374 baud = (m << 3) | n;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200375 }
376 }
377 }
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200378 writel(baud, &twsi->baudrate);
379 return 0;
380}
381
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200382static void __twsi_i2c_init(struct mvtwsi_registers *twsi, int speed,
mario.six@gdsys.cc14a6ff22016-07-21 11:57:10 +0200383 int slaveadd)
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200384{
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200385 /* Reset controller */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200386 twsi_reset(twsi);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200387 /* Set speed */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200388 __twsi_i2c_set_bus_speed(twsi, speed);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200389 /* Set slave address; even though we don't use it */
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200390 writel(slaveadd, &twsi->slave_address);
391 writel(0, &twsi->xtnd_slave_addr);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200392 /* Assert STOP, but don't care for the result */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200393 (void) twsi_stop(twsi);
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200394}
395
Albert Aribaud306563a2010-08-27 18:26:05 +0200396/*
397 * Begin I2C transaction with expected start status, at given address.
Albert Aribaud306563a2010-08-27 18:26:05 +0200398 * Expected address status will derive from direction bit (bit 0) in addr.
399 */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200400static int i2c_begin(struct mvtwsi_registers *twsi, int expected_start_status,
mario.six@gdsys.cc670514f2016-07-21 11:57:04 +0200401 u8 addr)
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200402{
Albert Aribaud306563a2010-08-27 18:26:05 +0200403 int status, expected_addr_status;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200404
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200405 /* Compute the expected address status from the direction bit in
406 * the address byte */
407 if (addr & 1) /* Reading */
Albert Aribaud306563a2010-08-27 18:26:05 +0200408 expected_addr_status = MVTWSI_STATUS_ADDR_R_ACK;
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200409 else /* Writing */
Albert Aribaud306563a2010-08-27 18:26:05 +0200410 expected_addr_status = MVTWSI_STATUS_ADDR_W_ACK;
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200411 /* Assert START */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200412 status = twsi_start(twsi, expected_start_status);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200413 /* Send out the address if the start went well */
Albert Aribaud306563a2010-08-27 18:26:05 +0200414 if (status == 0)
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200415 status = twsi_send(twsi, addr, expected_addr_status);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200416 /* Return 0, or the status of the first failure */
Albert Aribaud306563a2010-08-27 18:26:05 +0200417 return status;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200418}
419
Albert Aribaud306563a2010-08-27 18:26:05 +0200420/*
Albert Aribaud306563a2010-08-27 18:26:05 +0200421 * Begin read, nak data byte, end.
422 */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200423static int __twsi_i2c_probe_chip(struct mvtwsi_registers *twsi, uchar chip)
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200424{
Albert Aribaud306563a2010-08-27 18:26:05 +0200425 u8 dummy_byte;
426 int status;
427
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200428 /* Begin i2c read */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200429 status = i2c_begin(twsi, MVTWSI_STATUS_START, (chip << 1) | 1);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200430 /* Dummy read was accepted: receive byte, but NAK it. */
Albert Aribaud306563a2010-08-27 18:26:05 +0200431 if (status == 0)
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200432 status = twsi_recv(twsi, &dummy_byte, MVTWSI_READ_NAK);
Albert Aribaud306563a2010-08-27 18:26:05 +0200433 /* Stop transaction */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200434 twsi_stop(twsi);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200435 /* Return 0, or the status of the first failure */
Albert Aribaud306563a2010-08-27 18:26:05 +0200436 return status;
437}
438
439/*
Albert Aribaud306563a2010-08-27 18:26:05 +0200440 * Begin write, send address byte(s), begin read, receive data bytes, end.
441 *
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200442 * NOTE: Some devices want a stop right before the second start, while some
443 * will choke if it is there. Since deciding this is not yet supported in
444 * higher level APIs, we need to make a decision here, and for the moment that
445 * will be a repeated start without a preceding stop.
Albert Aribaud306563a2010-08-27 18:26:05 +0200446 */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200447static int __twsi_i2c_read(struct mvtwsi_registers *twsi, uchar chip,
mario.six@gdsys.ccf8a10ed2016-07-21 11:57:09 +0200448 u8 *addr, int alen, uchar *data, int length)
Albert Aribaud306563a2010-08-27 18:26:05 +0200449{
mario.six@gdsys.cc059fce92016-07-21 11:57:05 +0200450 int status = 0;
451 int stop_status;
mario.six@gdsys.cc24f9c6b2016-07-21 11:57:11 +0200452 int expected_start = MVTWSI_STATUS_START;
Albert Aribaud306563a2010-08-27 18:26:05 +0200453
mario.six@gdsys.cc24f9c6b2016-07-21 11:57:11 +0200454 if (alen > 0) {
455 /* Begin i2c write to send the address bytes */
456 status = i2c_begin(twsi, expected_start, (chip << 1));
457 /* Send address bytes */
458 while ((status == 0) && alen--)
459 status = twsi_send(twsi, *(addr++),
460 MVTWSI_STATUS_DATA_W_ACK);
461 /* Send repeated STARTs after the initial START */
462 expected_start = MVTWSI_STATUS_REPEATED_START;
463 }
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200464 /* Begin i2c read to receive data bytes */
Albert Aribaud306563a2010-08-27 18:26:05 +0200465 if (status == 0)
mario.six@gdsys.cc24f9c6b2016-07-21 11:57:11 +0200466 status = i2c_begin(twsi, expected_start, (chip << 1) | 1);
mario.six@gdsys.cc670514f2016-07-21 11:57:04 +0200467 /* Receive actual data bytes; set NAK if we if we have nothing more to
468 * read */
469 while ((status == 0) && length--)
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200470 status = twsi_recv(twsi, data++,
mario.six@gdsys.cc670514f2016-07-21 11:57:04 +0200471 length > 0 ?
472 MVTWSI_READ_ACK : MVTWSI_READ_NAK);
Albert Aribaud306563a2010-08-27 18:26:05 +0200473 /* Stop transaction */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200474 stop_status = twsi_stop(twsi);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200475 /* Return 0, or the status of the first failure */
mario.six@gdsys.cc059fce92016-07-21 11:57:05 +0200476 return status != 0 ? status : stop_status;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200477}
478
Albert Aribaud306563a2010-08-27 18:26:05 +0200479/*
Albert Aribaud306563a2010-08-27 18:26:05 +0200480 * Begin write, send address byte(s), send data bytes, end.
481 */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200482static int __twsi_i2c_write(struct mvtwsi_registers *twsi, uchar chip,
mario.six@gdsys.ccf8a10ed2016-07-21 11:57:09 +0200483 u8 *addr, int alen, uchar *data, int length)
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200484{
mario.six@gdsys.cc059fce92016-07-21 11:57:05 +0200485 int status, stop_status;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200486
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200487 /* Begin i2c write to send first the address bytes, then the
488 * data bytes */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200489 status = i2c_begin(twsi, MVTWSI_STATUS_START, (chip << 1));
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200490 /* Send address bytes */
mario.six@gdsys.ccf8a10ed2016-07-21 11:57:09 +0200491 while ((status == 0) && (alen-- > 0))
492 status = twsi_send(twsi, *(addr++), MVTWSI_STATUS_DATA_W_ACK);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200493 /* Send data bytes */
Albert Aribaud306563a2010-08-27 18:26:05 +0200494 while ((status == 0) && (length-- > 0))
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200495 status = twsi_send(twsi, *(data++), MVTWSI_STATUS_DATA_W_ACK);
Albert Aribaud306563a2010-08-27 18:26:05 +0200496 /* Stop transaction */
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200497 stop_status = twsi_stop(twsi);
mario.six@gdsys.cc49c801b2016-07-21 11:57:03 +0200498 /* Return 0, or the status of the first failure */
mario.six@gdsys.cc059fce92016-07-21 11:57:05 +0200499 return status != 0 ? status : stop_status;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200500}
501
mario.six@gdsys.cc14a6ff22016-07-21 11:57:10 +0200502#ifndef CONFIG_DM_I2C
mario.six@gdsys.cc61bc02b2016-07-21 11:57:07 +0200503static void twsi_i2c_init(struct i2c_adapter *adap, int speed,
504 int slaveadd)
505{
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200506 struct mvtwsi_registers *twsi = twsi_get_base(adap);
507 __twsi_i2c_init(twsi, speed, slaveadd);
mario.six@gdsys.cc61bc02b2016-07-21 11:57:07 +0200508}
509
510static uint twsi_i2c_set_bus_speed(struct i2c_adapter *adap,
511 uint requested_speed)
512{
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200513 struct mvtwsi_registers *twsi = twsi_get_base(adap);
514 return __twsi_i2c_set_bus_speed(twsi, requested_speed);
mario.six@gdsys.cc61bc02b2016-07-21 11:57:07 +0200515}
516
517static int twsi_i2c_probe(struct i2c_adapter *adap, uchar chip)
518{
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200519 struct mvtwsi_registers *twsi = twsi_get_base(adap);
520 return __twsi_i2c_probe_chip(twsi, chip);
mario.six@gdsys.cc61bc02b2016-07-21 11:57:07 +0200521}
522
523static int twsi_i2c_read(struct i2c_adapter *adap, uchar chip, uint addr,
524 int alen, uchar *data, int length)
525{
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200526 struct mvtwsi_registers *twsi = twsi_get_base(adap);
mario.six@gdsys.ccf8a10ed2016-07-21 11:57:09 +0200527 u8 addr_bytes[4];
528
529 addr_bytes[0] = (addr >> 0) & 0xFF;
530 addr_bytes[1] = (addr >> 8) & 0xFF;
531 addr_bytes[2] = (addr >> 16) & 0xFF;
532 addr_bytes[3] = (addr >> 24) & 0xFF;
533
534 return __twsi_i2c_read(twsi, chip, addr_bytes, alen, data, length);
mario.six@gdsys.cc61bc02b2016-07-21 11:57:07 +0200535}
536
537static int twsi_i2c_write(struct i2c_adapter *adap, uchar chip, uint addr,
538 int alen, uchar *data, int length)
539{
mario.six@gdsys.cc3c4db632016-07-21 11:57:08 +0200540 struct mvtwsi_registers *twsi = twsi_get_base(adap);
mario.six@gdsys.ccf8a10ed2016-07-21 11:57:09 +0200541 u8 addr_bytes[4];
542
543 addr_bytes[0] = (addr >> 0) & 0xFF;
544 addr_bytes[1] = (addr >> 8) & 0xFF;
545 addr_bytes[2] = (addr >> 16) & 0xFF;
546 addr_bytes[3] = (addr >> 24) & 0xFF;
547
548 return __twsi_i2c_write(twsi, chip, addr_bytes, alen, data, length);
mario.six@gdsys.cc61bc02b2016-07-21 11:57:07 +0200549}
550
Paul Kocialkowskidd822422015-04-10 23:09:51 +0200551#ifdef CONFIG_I2C_MVTWSI_BASE0
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200552U_BOOT_I2C_ADAP_COMPLETE(twsi0, twsi_i2c_init, twsi_i2c_probe,
553 twsi_i2c_read, twsi_i2c_write,
554 twsi_i2c_set_bus_speed,
555 CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 0)
Paul Kocialkowskidd822422015-04-10 23:09:51 +0200556#endif
557#ifdef CONFIG_I2C_MVTWSI_BASE1
558U_BOOT_I2C_ADAP_COMPLETE(twsi1, twsi_i2c_init, twsi_i2c_probe,
559 twsi_i2c_read, twsi_i2c_write,
560 twsi_i2c_set_bus_speed,
561 CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 1)
562
563#endif
564#ifdef CONFIG_I2C_MVTWSI_BASE2
565U_BOOT_I2C_ADAP_COMPLETE(twsi2, twsi_i2c_init, twsi_i2c_probe,
566 twsi_i2c_read, twsi_i2c_write,
567 twsi_i2c_set_bus_speed,
568 CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 2)
569
570#endif
571#ifdef CONFIG_I2C_MVTWSI_BASE3
572U_BOOT_I2C_ADAP_COMPLETE(twsi3, twsi_i2c_init, twsi_i2c_probe,
573 twsi_i2c_read, twsi_i2c_write,
574 twsi_i2c_set_bus_speed,
575 CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 3)
576
577#endif
578#ifdef CONFIG_I2C_MVTWSI_BASE4
579U_BOOT_I2C_ADAP_COMPLETE(twsi4, twsi_i2c_init, twsi_i2c_probe,
580 twsi_i2c_read, twsi_i2c_write,
581 twsi_i2c_set_bus_speed,
582 CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 4)
583
584#endif
Jelle van der Waa9d082682016-01-14 14:06:26 +0100585#ifdef CONFIG_I2C_MVTWSI_BASE5
586U_BOOT_I2C_ADAP_COMPLETE(twsi5, twsi_i2c_init, twsi_i2c_probe,
587 twsi_i2c_read, twsi_i2c_write,
588 twsi_i2c_set_bus_speed,
589 CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 5)
590
591#endif
mario.six@gdsys.cc14a6ff22016-07-21 11:57:10 +0200592#else /* CONFIG_DM_I2C */
593
594static int mvtwsi_i2c_probe_chip(struct udevice *bus, u32 chip_addr,
595 u32 chip_flags)
596{
597 struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
598 return __twsi_i2c_probe_chip(dev->base, chip_addr);
599}
600
601static int mvtwsi_i2c_set_bus_speed(struct udevice *bus, uint speed)
602{
603 struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
604 return __twsi_i2c_set_bus_speed(dev->base, speed);
605}
606
607static int mvtwsi_i2c_ofdata_to_platdata(struct udevice *bus)
608{
609 struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
610
611 dev->base = dev_get_addr_ptr(bus);
612
613 if (!dev->base)
614 return -ENOMEM;
615
616 dev->index = fdtdec_get_int(gd->fdt_blob, bus->of_offset,
617 "cell-index", -1);
618 dev->slaveadd = fdtdec_get_int(gd->fdt_blob, bus->of_offset,
619 "u-boot,i2c-slave-addr", 0x0);
620 dev->speed = fdtdec_get_int(gd->fdt_blob, bus->of_offset,
621 "clock-frequency", 100000);
622 return 0;
623}
624
625static int mvtwsi_i2c_probe(struct udevice *bus)
626{
627 struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
628 __twsi_i2c_init(dev->base, dev->speed, dev->slaveadd);
629 return 0;
630}
631
632static int mvtwsi_i2c_xfer(struct udevice *bus, struct i2c_msg *msg, int nmsgs)
633{
634 struct mvtwsi_i2c_dev *dev = dev_get_priv(bus);
635 struct i2c_msg *dmsg, *omsg, dummy;
636
637 memset(&dummy, 0, sizeof(struct i2c_msg));
638
639 /* We expect either two messages (one with an offset and one with the
640 * actual data) or one message (just data or offset/data combined) */
641 if (nmsgs > 2 || nmsgs == 0) {
642 debug("%s: Only one or two messages are supported.", __func__);
643 return -1;
644 }
645
646 omsg = nmsgs == 1 ? &dummy : msg;
647 dmsg = nmsgs == 1 ? msg : msg + 1;
648
649 if (dmsg->flags & I2C_M_RD)
650 return __twsi_i2c_read(dev->base, dmsg->addr, omsg->buf,
651 omsg->len, dmsg->buf, dmsg->len);
652 else
653 return __twsi_i2c_write(dev->base, dmsg->addr, omsg->buf,
654 omsg->len, dmsg->buf, dmsg->len);
655}
656
657static const struct dm_i2c_ops mvtwsi_i2c_ops = {
658 .xfer = mvtwsi_i2c_xfer,
659 .probe_chip = mvtwsi_i2c_probe_chip,
660 .set_bus_speed = mvtwsi_i2c_set_bus_speed,
661};
662
663static const struct udevice_id mvtwsi_i2c_ids[] = {
664 { .compatible = "marvell,mv64xxx-i2c", },
665 { /* sentinel */ }
666};
667
668U_BOOT_DRIVER(i2c_mvtwsi) = {
669 .name = "i2c_mvtwsi",
670 .id = UCLASS_I2C,
671 .of_match = mvtwsi_i2c_ids,
672 .probe = mvtwsi_i2c_probe,
673 .ofdata_to_platdata = mvtwsi_i2c_ofdata_to_platdata,
674 .priv_auto_alloc_size = sizeof(struct mvtwsi_i2c_dev),
675 .ops = &mvtwsi_i2c_ops,
676};
677#endif /* CONFIG_DM_I2C */