]> git.ipfire.org Git - people/ms/u-boot.git/blame - drivers/i2c/ppc4xx_i2c.c
samsung: i2c: Split the high-speed I2C code into a new driver
[people/ms/u-boot.git] / drivers / i2c / ppc4xx_i2c.c
CommitLineData
79b2d0bb 1/*
eb5eb2b0 2 * (C) Copyright 2007-2009
79b2d0bb
SR
3 * Stefan Roese, DENX Software Engineering, sr@denx.de.
4 *
5 * based on work by Anne Sophie Harnois <anne-sophie.harnois@nextream.fr>
6 *
7 * (C) Copyright 2001
8 * Bill Hunter, Wave 7 Optics, williamhunter@mediaone.net
9 *
1a459660 10 * SPDX-License-Identifier: GPL-2.0+
79b2d0bb 11 */
c609719b
WD
12
13#include <common.h>
b36df561
SR
14#include <asm/ppc4xx.h>
15#include <asm/ppc4xx-i2c.h>
c609719b 16#include <i2c.h>
61f2b38a 17#include <asm/io.h>
c609719b 18
d87080b7
WD
19DECLARE_GLOBAL_DATA_PTR;
20
880540de
DE
21static inline struct ppc4xx_i2c *ppc4xx_get_i2c(int hwadapnr)
22{
23 unsigned long base;
24
25#if defined(CONFIG_440EP) || defined(CONFIG_440GR) || \
26 defined(CONFIG_440EPX) || defined(CONFIG_440GRX) || \
27 defined(CONFIG_460EX) || defined(CONFIG_460GT)
28 base = CONFIG_SYS_PERIPHERAL_BASE + 0x00000700 + (hwadapnr * 0x100);
29#elif defined(CONFIG_440) || defined(CONFIG_405EX)
30/* all remaining 440 variants */
31 base = CONFIG_SYS_PERIPHERAL_BASE + 0x00000400 + (hwadapnr * 0x100);
32#else
33/* all 405 variants */
34 base = 0xEF600500 + (hwadapnr * 0x100);
79b2d0bb 35#endif
880540de
DE
36 return (struct ppc4xx_i2c *)base;
37}
c609719b 38
880540de 39static void _i2c_bus_reset(struct i2c_adapter *adap)
c609719b 40{
880540de 41 struct ppc4xx_i2c *i2c = ppc4xx_get_i2c(adap->hwadapnr);
79b2d0bb
SR
42 int i;
43 u8 dc;
c609719b
WD
44
45 /* Reset status register */
46 /* write 1 in SCMP and IRQA to clear these fields */
eb5eb2b0 47 out_8(&i2c->sts, 0x0A);
c609719b
WD
48
49 /* write 1 in IRQP IRQD LA ICT XFRA to clear these fields */
eb5eb2b0 50 out_8(&i2c->extsts, 0x8F);
79b2d0bb 51
53677ef1 52 /* Place chip in the reset state */
eb5eb2b0 53 out_8(&i2c->xtcntlss, IIC_XTCNTLSS_SRST);
79b2d0bb
SR
54
55 /* Check if bus is free */
eb5eb2b0 56 dc = in_8(&i2c->directcntl);
79b2d0bb
SR
57 if (!DIRCTNL_FREE(dc)){
58 /* Try to set bus free state */
eb5eb2b0 59 out_8(&i2c->directcntl, IIC_DIRCNTL_SDAC | IIC_DIRCNTL_SCC);
79b2d0bb
SR
60
61 /* Wait until we regain bus control */
62 for (i = 0; i < 100; ++i) {
eb5eb2b0 63 dc = in_8(&i2c->directcntl);
79b2d0bb
SR
64 if (DIRCTNL_FREE(dc))
65 break;
66
67 /* Toggle SCL line */
68 dc ^= IIC_DIRCNTL_SCC;
eb5eb2b0 69 out_8(&i2c->directcntl, dc);
79b2d0bb
SR
70 udelay(10);
71 dc ^= IIC_DIRCNTL_SCC;
eb5eb2b0 72 out_8(&i2c->directcntl, dc);
c609719b
WD
73 }
74 }
79b2d0bb
SR
75
76 /* Remove reset */
eb5eb2b0 77 out_8(&i2c->xtcntlss, 0);
c609719b
WD
78}
79
880540de 80static void ppc4xx_i2c_init(struct i2c_adapter *adap, int speed, int slaveaddr)
c609719b 81{
880540de 82 struct ppc4xx_i2c *i2c = ppc4xx_get_i2c(adap->hwadapnr);
c609719b
WD
83 int val, divisor;
84
6d0f6bcf 85#ifdef CONFIG_SYS_I2C_INIT_BOARD
eb5eb2b0
SR
86 /*
87 * Call board specific i2c bus reset routine before accessing the
88 * environment, which might be in a chip on that bus. For details
89 * about this problem see doc/I2C_Edge_Conditions.
90 */
47cd00fa
WD
91 i2c_init_board();
92#endif
93
880540de
DE
94 /* Handle possible failed I2C state */
95 /* FIXME: put this into i2c_init_board()? */
96 _i2c_bus_reset(adap);
c609719b 97
880540de
DE
98 /* clear lo master address */
99 out_8(&i2c->lmadr, 0);
c609719b 100
880540de
DE
101 /* clear hi master address */
102 out_8(&i2c->hmadr, 0);
c609719b 103
880540de
DE
104 /* clear lo slave address */
105 out_8(&i2c->lsadr, 0);
c609719b 106
880540de
DE
107 /* clear hi slave address */
108 out_8(&i2c->hsadr, 0);
c609719b 109
880540de
DE
110 /* Clock divide Register */
111 /* set divisor according to freq_opb */
112 divisor = (get_OPB_freq() - 1) / 10000000;
113 if (divisor == 0)
114 divisor = 1;
115 out_8(&i2c->clkdiv, divisor);
c609719b 116
880540de
DE
117 /* no interrupts */
118 out_8(&i2c->intrmsk, 0);
c609719b 119
880540de
DE
120 /* clear transfer count */
121 out_8(&i2c->xfrcnt, 0);
c609719b 122
880540de
DE
123 /* clear extended control & stat */
124 /* write 1 in SRC SRS SWC SWS to clear these fields */
125 out_8(&i2c->xtcntlss, 0xF0);
c609719b 126
880540de
DE
127 /* Mode Control Register
128 Flush Slave/Master data buffer */
129 out_8(&i2c->mdcntl, IIC_MDCNTL_FSDB | IIC_MDCNTL_FMDB);
c609719b 130
880540de 131 val = in_8(&i2c->mdcntl);
c609719b 132
880540de
DE
133 /* Ignore General Call, slave transfers are ignored,
134 * disable interrupts, exit unknown bus state, enable hold
135 * SCL 100kHz normaly or FastMode for 400kHz and above
136 */
c609719b 137
880540de
DE
138 val |= IIC_MDCNTL_EUBS | IIC_MDCNTL_HSCL;
139 if (speed >= 400000)
140 val |= IIC_MDCNTL_FSM;
141 out_8(&i2c->mdcntl, val);
c609719b 142
880540de
DE
143 /* clear control reg */
144 out_8(&i2c->cntl, 0x00);
c609719b
WD
145}
146
147/*
79b2d0bb
SR
148 * This code tries to use the features of the 405GP i2c
149 * controller. It will transfer up to 4 bytes in one pass
150 * on the loop. It only does out_8((u8 *)lbz) to the buffer when it
151 * is possible to do out16(lhz) transfers.
152 *
153 * cmd_type is 0 for write 1 for read.
154 *
155 * addr_len can take any value from 0-255, it is only limited
156 * by the char, we could make it larger if needed. If it is
157 * 0 we skip the address write cycle.
158 *
159 * Typical case is a Write of an addr followd by a Read. The
160 * IBM FAQ does not cover this. On the last byte of the write
7e78f7ad 161 * we don't set the creg CHT bit but the RPST bit.
79b2d0bb
SR
162 *
163 * It does not support address only transfers, there must be
164 * a data part. If you want to write the address yourself, put
165 * it in the data pointer.
166 *
167 * It does not support transfer to/from address 0.
168 *
169 * It does not check XFRCNT.
170 */
880540de
DE
171static int _i2c_transfer(struct i2c_adapter *adap,
172 unsigned char cmd_type,
79b2d0bb
SR
173 unsigned char chip,
174 unsigned char addr[],
175 unsigned char addr_len,
176 unsigned char data[],
177 unsigned short data_len)
c609719b 178{
880540de 179 struct ppc4xx_i2c *i2c = ppc4xx_get_i2c(adap->hwadapnr);
eb5eb2b0 180 u8 *ptr;
8bde7f77 181 int reading;
eb5eb2b0 182 int tran, cnt;
8bde7f77
WD
183 int result;
184 int status;
185 int i;
eb5eb2b0 186 u8 creg;
8bde7f77 187
79b2d0bb
SR
188 if (data == 0 || data_len == 0) {
189 /* Don't support data transfer of no length or to address 0 */
8bde7f77
WD
190 printf( "i2c_transfer: bad call\n" );
191 return IIC_NOK;
192 }
79b2d0bb 193 if (addr && addr_len) {
8bde7f77
WD
194 ptr = addr;
195 cnt = addr_len;
196 reading = 0;
79b2d0bb 197 } else {
8bde7f77
WD
198 ptr = data;
199 cnt = data_len;
200 reading = cmd_type;
201 }
202
79b2d0bb 203 /* Clear Stop Complete Bit */
eb5eb2b0
SR
204 out_8(&i2c->sts, IIC_STS_SCMP);
205
8bde7f77 206 /* Check init */
79b2d0bb 207 i = 10;
8bde7f77
WD
208 do {
209 /* Get status */
eb5eb2b0 210 status = in_8(&i2c->sts);
8bde7f77 211 i--;
79b2d0bb 212 } while ((status & IIC_STS_PT) && (i > 0));
8bde7f77
WD
213
214 if (status & IIC_STS_PT) {
215 result = IIC_NOK_TOUT;
216 return(result);
217 }
eb5eb2b0 218
79b2d0bb 219 /* flush the Master/Slave Databuffers */
eb5eb2b0
SR
220 out_8(&i2c->mdcntl, in_8(&i2c->mdcntl) |
221 IIC_MDCNTL_FMDB | IIC_MDCNTL_FSDB);
222
79b2d0bb 223 /* need to wait 4 OPB clocks? code below should take that long */
8bde7f77
WD
224
225 /* 7-bit adressing */
eb5eb2b0
SR
226 out_8(&i2c->hmadr, 0);
227 out_8(&i2c->lmadr, chip);
8bde7f77
WD
228
229 tran = 0;
230 result = IIC_OK;
231 creg = 0;
232
79b2d0bb 233 while (tran != cnt && (result == IIC_OK)) {
8bde7f77
WD
234 int bc,j;
235
eb5eb2b0
SR
236 /*
237 * Control register =
238 * Normal transfer, 7-bits adressing, Transfer up to
239 * bc bytes, Normal start, Transfer is a sequence of transfers
79b2d0bb 240 */
8bde7f77
WD
241 creg |= IIC_CNTL_PT;
242
79b2d0bb
SR
243 bc = (cnt - tran) > 4 ? 4 : cnt - tran;
244 creg |= (bc - 1) << 4;
245 /* if the real cmd type is write continue trans */
246 if ((!cmd_type && (ptr == addr)) || ((tran + bc) != cnt))
8bde7f77
WD
247 creg |= IIC_CNTL_CHT;
248
7e78f7ad
DE
249 /* last part of address, prepare for repeated start on read */
250 if (cmd_type && (ptr == addr) && ((tran + bc) == cnt))
251 creg |= IIC_CNTL_RPST;
252
eb5eb2b0 253 if (reading) {
8bde7f77 254 creg |= IIC_CNTL_READ;
eb5eb2b0
SR
255 } else {
256 for(j = 0; j < bc; j++) {
8bde7f77 257 /* Set buffer */
eb5eb2b0
SR
258 out_8(&i2c->mdbuf, ptr[tran + j]);
259 }
260 }
261 out_8(&i2c->cntl, creg);
8bde7f77 262
eb5eb2b0
SR
263 /*
264 * Transfer is in progress
79b2d0bb
SR
265 * we have to wait for upto 5 bytes of data
266 * 1 byte chip address+r/w bit then bc bytes
267 * of data.
268 * udelay(10) is 1 bit time at 100khz
269 * Doubled for slop. 20 is too small.
270 */
eb5eb2b0 271 i = 2 * 5 * 8;
8bde7f77
WD
272 do {
273 /* Get status */
eb5eb2b0 274 status = in_8(&i2c->sts);
79b2d0bb 275 udelay(10);
8bde7f77 276 i--;
eb5eb2b0
SR
277 } while ((status & IIC_STS_PT) && !(status & IIC_STS_ERR) &&
278 (i > 0));
c609719b 279
8bde7f77
WD
280 if (status & IIC_STS_ERR) {
281 result = IIC_NOK;
eb5eb2b0 282 status = in_8(&i2c->extsts);
8bde7f77
WD
283 /* Lost arbitration? */
284 if (status & IIC_EXTSTS_LA)
285 result = IIC_NOK_LA;
286 /* Incomplete transfer? */
287 if (status & IIC_EXTSTS_ICT)
288 result = IIC_NOK_ICT;
289 /* Transfer aborted? */
290 if (status & IIC_EXTSTS_XFRA)
291 result = IIC_NOK_XFRA;
b97cd681
DE
292 /* Is bus free?
293 * If error happened during combined xfer
294 * IIC interface is usually stuck in some strange
295 * state without a valid stop condition.
296 * Brute, but working: generate stop, then soft reset.
297 */
298 if ((status & IIC_EXTSTS_BCS_MASK)
299 != IIC_EXTSTS_BCS_FREE){
300 u8 mdcntl = in_8(&i2c->mdcntl);
301
302 /* Generate valid stop condition */
303 out_8(&i2c->xtcntlss, IIC_XTCNTLSS_SRST);
304 out_8(&i2c->directcntl, IIC_DIRCNTL_SCC);
305 udelay(10);
306 out_8(&i2c->directcntl,
307 IIC_DIRCNTL_SCC | IIC_DIRCNTL_SDAC);
308 out_8(&i2c->xtcntlss, 0);
309
310 ppc4xx_i2c_init(adap, (mdcntl & IIC_MDCNTL_FSM)
311 ? 400000 : 100000, 0);
312 }
8bde7f77
WD
313 } else if ( status & IIC_STS_PT) {
314 result = IIC_NOK_TOUT;
315 }
eb5eb2b0 316
8bde7f77
WD
317 /* Command is reading => get buffer */
318 if ((reading) && (result == IIC_OK)) {
319 /* Are there data in buffer */
320 if (status & IIC_STS_MDBS) {
321 /*
eb5eb2b0
SR
322 * even if we have data we have to wait 4OPB
323 * clocks for it to hit the front of the FIFO,
324 * after that we can just read. We should check
325 * XFCNT here and if the FIFO is full there is
326 * no need to wait.
79b2d0bb
SR
327 */
328 udelay(1);
eb5eb2b0
SR
329 for (j = 0; j < bc; j++)
330 ptr[tran + j] = in_8(&i2c->mdbuf);
8bde7f77
WD
331 } else
332 result = IIC_NOK_DATA;
333 }
334 creg = 0;
79b2d0bb
SR
335 tran += bc;
336 if (ptr == addr && tran == cnt) {
8bde7f77
WD
337 ptr = data;
338 cnt = data_len;
339 tran = 0;
340 reading = cmd_type;
8bde7f77
WD
341 }
342 }
eb5eb2b0 343 return result;
c609719b
WD
344}
345
880540de 346static int ppc4xx_i2c_probe(struct i2c_adapter *adap, uchar chip)
c609719b
WD
347{
348 uchar buf[1];
349
350 buf[0] = 0;
351
8bde7f77
WD
352 /*
353 * What is needed is to send the chip address and verify that the
354 * address was <ACK>ed (i.e. there was a chip at that address which
355 * drove the data line low).
356 */
880540de 357 return (_i2c_transfer(adap, 1, chip << 1, 0, 0, buf, 1) != 0);
c609719b
WD
358}
359
880540de
DE
360static int ppc4xx_i2c_transfer(struct i2c_adapter *adap, uchar chip, uint addr,
361 int alen, uchar *buffer, int len, int read)
c609719b 362{
8bde7f77
WD
363 uchar xaddr[4];
364 int ret;
c609719b 365
79b2d0bb 366 if (alen > 4) {
eb5eb2b0 367 printf("I2C: addr len %d not supported\n", alen);
c609719b
WD
368 return 1;
369 }
370
79b2d0bb 371 if (alen > 0) {
8bde7f77
WD
372 xaddr[0] = (addr >> 24) & 0xFF;
373 xaddr[1] = (addr >> 16) & 0xFF;
374 xaddr[2] = (addr >> 8) & 0xFF;
375 xaddr[3] = addr & 0xFF;
376 }
c609719b
WD
377
378
6d0f6bcf 379#ifdef CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW
c609719b 380 /*
8bde7f77
WD
381 * EEPROM chips that implement "address overflow" are ones
382 * like Catalyst 24WC04/08/16 which has 9/10/11 bits of
383 * address and the extra bits end up in the "chip address"
384 * bit slots. This makes a 24WC08 (1Kbyte) chip look like
385 * four 256 byte chips.
c609719b 386 *
8bde7f77
WD
387 * Note that we consider the length of the address field to
388 * still be one byte because the extra address bits are
389 * hidden in the chip address.
c609719b 390 */
79b2d0bb 391 if (alen > 0)
eb5eb2b0
SR
392 chip |= ((addr >> (alen * 8)) &
393 CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
c609719b 394#endif
880540de
DE
395 ret = _i2c_transfer(adap, read, chip << 1, &xaddr[4 - alen], alen,
396 buffer, len);
397 if (ret) {
e3e454cd 398 printf("I2C %s: failed %d\n", read ? "read" : "write", ret);
8bde7f77
WD
399 return 1;
400 }
eb5eb2b0 401
8bde7f77 402 return 0;
c609719b
WD
403}
404
880540de
DE
405static int ppc4xx_i2c_read(struct i2c_adapter *adap, uchar chip, uint addr,
406 int alen, uchar *buffer, int len)
c609719b 407{
880540de 408 return ppc4xx_i2c_transfer(adap, chip, addr, alen, buffer, len, 1);
eb5eb2b0 409}
c609719b 410
880540de
DE
411static int ppc4xx_i2c_write(struct i2c_adapter *adap, uchar chip, uint addr,
412 int alen, uchar *buffer, int len)
eb5eb2b0 413{
880540de 414 return ppc4xx_i2c_transfer(adap, chip, addr, alen, buffer, len, 0);
c609719b
WD
415}
416
880540de
DE
417static unsigned int ppc4xx_i2c_set_bus_speed(struct i2c_adapter *adap,
418 unsigned int speed)
79b2d0bb 419{
880540de 420 if (speed != adap->speed)
79b2d0bb 421 return -1;
880540de 422 return speed;
79b2d0bb 423}
880540de
DE
424
425/*
426 * Register ppc4xx i2c adapters
427 */
428#ifdef CONFIG_SYS_I2C_PPC4XX_CH0
429U_BOOT_I2C_ADAP_COMPLETE(ppc4xx_0, ppc4xx_i2c_init, ppc4xx_i2c_probe,
430 ppc4xx_i2c_read, ppc4xx_i2c_write,
431 ppc4xx_i2c_set_bus_speed,
432 CONFIG_SYS_I2C_PPC4XX_SPEED_0,
433 CONFIG_SYS_I2C_PPC4XX_SLAVE_0, 0)
434#endif
435#ifdef CONFIG_SYS_I2C_PPC4XX_CH1
436U_BOOT_I2C_ADAP_COMPLETE(ppc4xx_1, ppc4xx_i2c_init, ppc4xx_i2c_probe,
437 ppc4xx_i2c_read, ppc4xx_i2c_write,
438 ppc4xx_i2c_set_bus_speed,
439 CONFIG_SYS_I2C_PPC4XX_SPEED_1,
440 CONFIG_SYS_I2C_PPC4XX_SLAVE_1, 1)
441#endif