blob: 6f6edd5e519547a8f201facab1da48d2a9fa07d6 [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>
15
Heiko Schocher4ce5a722009-07-20 09:59:37 +020016/*
Albert Aribaud306563a2010-08-27 18:26:05 +020017 * include a file that will provide CONFIG_I2C_MVTWSI_BASE
18 * and possibly other settings
Heiko Schocher4ce5a722009-07-20 09:59:37 +020019 */
20
Albert Aribaud306563a2010-08-27 18:26:05 +020021#if defined(CONFIG_ORION5X)
22#include <asm/arch/orion5x.h>
Stefan Roese6d5fe562014-10-22 12:13:16 +020023#elif (defined(CONFIG_KIRKWOOD) || defined(CONFIG_ARMADA_XP))
Stefan Roese3dc23f72014-10-22 12:13:06 +020024#include <asm/arch/soc.h>
Hans de Goede66203772014-06-13 22:55:49 +020025#elif defined(CONFIG_SUNXI)
26#include <asm/arch/i2c.h>
Albert Aribaud306563a2010-08-27 18:26:05 +020027#else
28#error Driver mvtwsi not supported by SoC or board
29#endif
30
31/*
32 * TWSI register structure
33 */
34
Hans de Goede66203772014-06-13 22:55:49 +020035#ifdef CONFIG_SUNXI
36
37struct mvtwsi_registers {
38 u32 slave_address;
39 u32 xtnd_slave_addr;
40 u32 data;
41 u32 control;
42 u32 status;
43 u32 baudrate;
44 u32 soft_reset;
45};
46
47#else
48
Albert Aribaud306563a2010-08-27 18:26:05 +020049struct mvtwsi_registers {
50 u32 slave_address;
51 u32 data;
52 u32 control;
53 union {
54 u32 status; /* when reading */
55 u32 baudrate; /* when writing */
56 };
57 u32 xtnd_slave_addr;
58 u32 reserved[2];
59 u32 soft_reset;
60};
61
Hans de Goede66203772014-06-13 22:55:49 +020062#endif
63
Albert Aribaud306563a2010-08-27 18:26:05 +020064/*
65 * Control register fields
66 */
67
68#define MVTWSI_CONTROL_ACK 0x00000004
69#define MVTWSI_CONTROL_IFLG 0x00000008
70#define MVTWSI_CONTROL_STOP 0x00000010
71#define MVTWSI_CONTROL_START 0x00000020
72#define MVTWSI_CONTROL_TWSIEN 0x00000040
73#define MVTWSI_CONTROL_INTEN 0x00000080
74
75/*
76 * Status register values -- only those expected in normal master
77 * operation on non-10-bit-address devices; whatever status we don't
78 * expect in nominal conditions (bus errors, arbitration losses,
79 * missing ACKs...) we just pass back to the caller as an error
80 * code.
81 */
82
83#define MVTWSI_STATUS_START 0x08
84#define MVTWSI_STATUS_REPEATED_START 0x10
85#define MVTWSI_STATUS_ADDR_W_ACK 0x18
86#define MVTWSI_STATUS_DATA_W_ACK 0x28
87#define MVTWSI_STATUS_ADDR_R_ACK 0x40
88#define MVTWSI_STATUS_ADDR_R_NAK 0x48
89#define MVTWSI_STATUS_DATA_R_ACK 0x50
90#define MVTWSI_STATUS_DATA_R_NAK 0x58
91#define MVTWSI_STATUS_IDLE 0xF8
92
93/*
94 * The single instance of the controller we'll be dealing with
95 */
96
97static struct mvtwsi_registers *twsi =
98 (struct mvtwsi_registers *) CONFIG_I2C_MVTWSI_BASE;
99
100/*
101 * Returned statuses are 0 for success and nonzero otherwise.
102 * Currently, cmd_i2c and cmd_eeprom do not interpret an error status.
103 * Thus to ease debugging, the return status contains some debug info:
104 * - bits 31..24 are error class: 1 is timeout, 2 is 'status mismatch'.
105 * - bits 23..16 are the last value of the control register.
106 * - bits 15..8 are the last value of the status register.
107 * - bits 7..0 are the expected value of the status register.
108 */
109
110#define MVTWSI_ERROR_WRONG_STATUS 0x01
111#define MVTWSI_ERROR_TIMEOUT 0x02
112
113#define MVTWSI_ERROR(ec, lc, ls, es) (((ec << 24) & 0xFF000000) | \
114 ((lc << 16) & 0x00FF0000) | ((ls<<8) & 0x0000FF00) | (es & 0xFF))
115
116/*
117 * Wait for IFLG to raise, or return 'timeout'; then if status is as expected,
118 * return 0 (ok) or return 'wrong status'.
119 */
120static int twsi_wait(int expected_status)
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200121{
Albert Aribaud306563a2010-08-27 18:26:05 +0200122 int control, status;
123 int timeout = 1000;
124
125 do {
126 control = readl(&twsi->control);
127 if (control & MVTWSI_CONTROL_IFLG) {
128 status = readl(&twsi->status);
129 if (status == expected_status)
130 return 0;
131 else
132 return MVTWSI_ERROR(
133 MVTWSI_ERROR_WRONG_STATUS,
134 control, status, expected_status);
135 }
136 udelay(10); /* one clock cycle at 100 kHz */
137 } while (timeout--);
138 status = readl(&twsi->status);
139 return MVTWSI_ERROR(
140 MVTWSI_ERROR_TIMEOUT, control, status, expected_status);
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200141}
142
Albert Aribaud306563a2010-08-27 18:26:05 +0200143/*
144 * These flags are ORed to any write to the control register
145 * They allow global setting of TWSIEN and ACK.
146 * By default none are set.
147 * twsi_start() sets TWSIEN (in case the controller was disabled)
148 * twsi_recv() sets ACK or resets it depending on expected status.
149 */
150static u8 twsi_control_flags = MVTWSI_CONTROL_TWSIEN;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200151
Albert Aribaud306563a2010-08-27 18:26:05 +0200152/*
153 * Assert the START condition, either in a single I2C transaction
154 * or inside back-to-back ones (repeated starts).
155 */
156static int twsi_start(int expected_status)
157{
158 /* globally set TWSIEN in case it was not */
159 twsi_control_flags |= MVTWSI_CONTROL_TWSIEN;
160 /* assert START */
161 writel(twsi_control_flags | MVTWSI_CONTROL_START, &twsi->control);
162 /* wait for controller to process START */
163 return twsi_wait(expected_status);
164}
165
166/*
167 * Send a byte (i2c address or data).
168 */
169static int twsi_send(u8 byte, int expected_status)
170{
171 /* put byte in data register for sending */
172 writel(byte, &twsi->data);
173 /* clear any pending interrupt -- that'll cause sending */
174 writel(twsi_control_flags, &twsi->control);
175 /* wait for controller to receive byte and check ACK */
176 return twsi_wait(expected_status);
177}
178
179/*
180 * Receive a byte.
181 * Global mvtwsi_control_flags variable says if we should ack or nak.
182 */
183static int twsi_recv(u8 *byte)
184{
185 int expected_status, status;
186
187 /* compute expected status based on ACK bit in global control flags */
188 if (twsi_control_flags & MVTWSI_CONTROL_ACK)
189 expected_status = MVTWSI_STATUS_DATA_R_ACK;
190 else
191 expected_status = MVTWSI_STATUS_DATA_R_NAK;
192 /* acknowledge *previous state* and launch receive */
193 writel(twsi_control_flags, &twsi->control);
194 /* wait for controller to receive byte and assert ACK or NAK */
195 status = twsi_wait(expected_status);
196 /* if we did receive expected byte then store it */
197 if (status == 0)
198 *byte = readl(&twsi->data);
199 /* return status */
200 return status;
201}
202
203/*
204 * Assert the STOP condition.
205 * This is also used to force the bus back in idle (SDA=SCL=1).
206 */
207static int twsi_stop(int status)
208{
209 int control, stop_status;
210 int timeout = 1000;
211
212 /* assert STOP */
213 control = MVTWSI_CONTROL_TWSIEN | MVTWSI_CONTROL_STOP;
214 writel(control, &twsi->control);
215 /* wait for IDLE; IFLG won't rise so twsi_wait() is no use. */
216 do {
217 stop_status = readl(&twsi->status);
218 if (stop_status == MVTWSI_STATUS_IDLE)
219 break;
220 udelay(10); /* one clock cycle at 100 kHz */
221 } while (timeout--);
222 control = readl(&twsi->control);
223 if (stop_status != MVTWSI_STATUS_IDLE)
224 if (status == 0)
225 status = MVTWSI_ERROR(
226 MVTWSI_ERROR_TIMEOUT,
227 control, status, MVTWSI_STATUS_IDLE);
228 return status;
229}
230
Stefan Roesef582a152015-03-18 09:30:54 +0100231static unsigned int twsi_calc_freq(const int n, const int m)
232{
233#ifdef CONFIG_SUNXI
234 return CONFIG_SYS_TCLK / (10 * (m + 1) * (1 << n));
235#else
236 return CONFIG_SYS_TCLK / (10 * (m + 1) * (2 << n));
237#endif
238}
Albert Aribaud306563a2010-08-27 18:26:05 +0200239
240/*
Albert Aribaud306563a2010-08-27 18:26:05 +0200241 * Reset controller.
Albert Aribaud306563a2010-08-27 18:26:05 +0200242 * Controller reset also resets the baud rate and slave address, so
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200243 * they must be re-established afterwards.
Albert Aribaud306563a2010-08-27 18:26:05 +0200244 */
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200245static void twsi_reset(struct i2c_adapter *adap)
Albert Aribaud306563a2010-08-27 18:26:05 +0200246{
247 /* ensure controller will be enabled by any twsi*() function */
248 twsi_control_flags = MVTWSI_CONTROL_TWSIEN;
249 /* reset controller */
250 writel(0, &twsi->soft_reset);
251 /* wait 2 ms -- this is what the Marvell LSP does */
252 udelay(20000);
Albert Aribaud306563a2010-08-27 18:26:05 +0200253}
254
255/*
256 * I2C init called by cmd_i2c when doing 'i2c reset'.
257 * Sets baud to the highest possible value not exceeding requested one.
258 */
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200259static unsigned int twsi_i2c_set_bus_speed(struct i2c_adapter *adap,
260 unsigned int requested_speed)
Albert Aribaud306563a2010-08-27 18:26:05 +0200261{
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200262 unsigned int tmp_speed, highest_speed, n, m;
263 unsigned int baud = 0x44; /* baudrate at controller reset */
Albert Aribaud306563a2010-08-27 18:26:05 +0200264
265 /* use actual speed to collect progressively higher values */
266 highest_speed = 0;
267 /* compute m, n setting for highest speed not above requested speed */
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200268 for (n = 0; n < 8; n++) {
269 for (m = 0; m < 16; m++) {
Stefan Roesef582a152015-03-18 09:30:54 +0100270 tmp_speed = twsi_calc_freq(n, m);
Albert Aribaud306563a2010-08-27 18:26:05 +0200271 if ((tmp_speed <= requested_speed)
272 && (tmp_speed > highest_speed)) {
273 highest_speed = tmp_speed;
274 baud = (m << 3) | n;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200275 }
276 }
277 }
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200278 writel(baud, &twsi->baudrate);
279 return 0;
280}
281
282static void twsi_i2c_init(struct i2c_adapter *adap, int speed, int slaveadd)
283{
Albert Aribaud306563a2010-08-27 18:26:05 +0200284 /* reset controller */
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200285 twsi_reset(adap);
286 /* set speed */
287 twsi_i2c_set_bus_speed(adap, speed);
288 /* set slave address even though we don't use it */
289 writel(slaveadd, &twsi->slave_address);
290 writel(0, &twsi->xtnd_slave_addr);
291 /* assert STOP but don't care for the result */
292 (void) twsi_stop(0);
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200293}
294
Albert Aribaud306563a2010-08-27 18:26:05 +0200295/*
296 * Begin I2C transaction with expected start status, at given address.
297 * Common to i2c_probe, i2c_read and i2c_write.
298 * Expected address status will derive from direction bit (bit 0) in addr.
299 */
300static int i2c_begin(int expected_start_status, u8 addr)
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200301{
Albert Aribaud306563a2010-08-27 18:26:05 +0200302 int status, expected_addr_status;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200303
Albert Aribaud306563a2010-08-27 18:26:05 +0200304 /* compute expected address status from direction bit in addr */
305 if (addr & 1) /* reading */
306 expected_addr_status = MVTWSI_STATUS_ADDR_R_ACK;
307 else /* writing */
308 expected_addr_status = MVTWSI_STATUS_ADDR_W_ACK;
309 /* assert START */
310 status = twsi_start(expected_start_status);
311 /* send out the address if the start went well */
312 if (status == 0)
313 status = twsi_send(addr, expected_addr_status);
314 /* return ok or status of first failure to caller */
315 return status;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200316}
317
Albert Aribaud306563a2010-08-27 18:26:05 +0200318/*
319 * I2C probe called by cmd_i2c when doing 'i2c probe'.
320 * Begin read, nak data byte, end.
321 */
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200322static int twsi_i2c_probe(struct i2c_adapter *adap, uchar chip)
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200323{
Albert Aribaud306563a2010-08-27 18:26:05 +0200324 u8 dummy_byte;
325 int status;
326
327 /* begin i2c read */
328 status = i2c_begin(MVTWSI_STATUS_START, (chip << 1) | 1);
329 /* dummy read was accepted: receive byte but NAK it. */
330 if (status == 0)
331 status = twsi_recv(&dummy_byte);
332 /* Stop transaction */
333 twsi_stop(0);
334 /* return 0 or status of first failure */
335 return status;
336}
337
338/*
339 * I2C read called by cmd_i2c when doing 'i2c read' and by cmd_eeprom.c
340 * Begin write, send address byte(s), begin read, receive data bytes, end.
341 *
342 * NOTE: some EEPROMS want a stop right before the second start, while
343 * some will choke if it is there. Deciding which we should do is eeprom
344 * stuff, not i2c, but at the moment the APIs won't let us put it in
345 * cmd_eeprom, so we have to choose here, and for the moment that'll be
346 * a repeated start without a preceding stop.
347 */
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200348static int twsi_i2c_read(struct i2c_adapter *adap, uchar chip, uint addr,
349 int alen, uchar *data, int length)
Albert Aribaud306563a2010-08-27 18:26:05 +0200350{
351 int status;
352
353 /* begin i2c write to send the address bytes */
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200354 status = i2c_begin(MVTWSI_STATUS_START, (chip << 1));
Albert Aribaud306563a2010-08-27 18:26:05 +0200355 /* send addr bytes */
356 while ((status == 0) && alen--)
357 status = twsi_send(addr >> (8*alen),
358 MVTWSI_STATUS_DATA_W_ACK);
359 /* begin i2c read to receive eeprom data bytes */
360 if (status == 0)
361 status = i2c_begin(
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200362 MVTWSI_STATUS_REPEATED_START, (chip << 1) | 1);
Albert Aribaud306563a2010-08-27 18:26:05 +0200363 /* prepare ACK if at least one byte must be received */
364 if (length > 0)
365 twsi_control_flags |= MVTWSI_CONTROL_ACK;
366 /* now receive actual bytes */
367 while ((status == 0) && length--) {
368 /* reset NAK if we if no more to read now */
369 if (length == 0)
370 twsi_control_flags &= ~MVTWSI_CONTROL_ACK;
371 /* read current byte */
372 status = twsi_recv(data++);
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200373 }
Albert Aribaud306563a2010-08-27 18:26:05 +0200374 /* Stop transaction */
375 status = twsi_stop(status);
376 /* return 0 or status of first failure */
377 return status;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200378}
379
Albert Aribaud306563a2010-08-27 18:26:05 +0200380/*
381 * I2C write called by cmd_i2c when doing 'i2c write' and by cmd_eeprom.c
382 * Begin write, send address byte(s), send data bytes, end.
383 */
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200384static int twsi_i2c_write(struct i2c_adapter *adap, uchar chip, uint addr,
385 int alen, uchar *data, int length)
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200386{
Albert Aribaud306563a2010-08-27 18:26:05 +0200387 int status;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200388
Albert Aribaud306563a2010-08-27 18:26:05 +0200389 /* begin i2c write to send the eeprom adress bytes then data bytes */
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200390 status = i2c_begin(MVTWSI_STATUS_START, (chip << 1));
Albert Aribaud306563a2010-08-27 18:26:05 +0200391 /* send addr bytes */
392 while ((status == 0) && alen--)
393 status = twsi_send(addr >> (8*alen),
394 MVTWSI_STATUS_DATA_W_ACK);
395 /* send data bytes */
396 while ((status == 0) && (length-- > 0))
397 status = twsi_send(*(data++), MVTWSI_STATUS_DATA_W_ACK);
398 /* Stop transaction */
399 status = twsi_stop(status);
400 /* return 0 or status of first failure */
401 return status;
Heiko Schocher4ce5a722009-07-20 09:59:37 +0200402}
403
Hans de Goede0db2bbd2014-06-13 22:55:48 +0200404U_BOOT_I2C_ADAP_COMPLETE(twsi0, twsi_i2c_init, twsi_i2c_probe,
405 twsi_i2c_read, twsi_i2c_write,
406 twsi_i2c_set_bus_speed,
407 CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE, 0)