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