mxc_i2c: change slave addr if conflicts with destination.
[platform/kernel/u-boot.git] / drivers / i2c / mxc_i2c.c
1 /*
2  * i2c driver for Freescale i.MX series
3  *
4  * (c) 2007 Pengutronix, Sascha Hauer <s.hauer@pengutronix.de>
5  * (c) 2011 Marek Vasut <marek.vasut@gmail.com>
6  *
7  * Based on i2c-imx.c from linux kernel:
8  *  Copyright (C) 2005 Torsten Koschorrek <koschorrek at synertronixx.de>
9  *  Copyright (C) 2005 Matthias Blaschke <blaschke at synertronixx.de>
10  *  Copyright (C) 2007 RightHand Technologies, Inc.
11  *  Copyright (C) 2008 Darius Augulis <darius.augulis at teltonika.lt>
12  *
13  *
14  * See file CREDITS for list of people who contributed to this
15  * project.
16  *
17  * This program is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU General Public License as
19  * published by the Free Software Foundation; either version 2 of
20  * the License, or (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
30  * MA 02111-1307 USA
31  */
32
33 #include <common.h>
34 #include <asm/arch/clock.h>
35 #include <asm/arch/imx-regs.h>
36 #include <asm/errno.h>
37 #include <asm/io.h>
38 #include <i2c.h>
39 #include <watchdog.h>
40
41 struct mxc_i2c_regs {
42         uint32_t        iadr;
43         uint32_t        ifdr;
44         uint32_t        i2cr;
45         uint32_t        i2sr;
46         uint32_t        i2dr;
47 };
48
49 #define I2CR_IEN        (1 << 7)
50 #define I2CR_IIEN       (1 << 6)
51 #define I2CR_MSTA       (1 << 5)
52 #define I2CR_MTX        (1 << 4)
53 #define I2CR_TX_NO_AK   (1 << 3)
54 #define I2CR_RSTA       (1 << 2)
55
56 #define I2SR_ICF        (1 << 7)
57 #define I2SR_IBB        (1 << 5)
58 #define I2SR_IIF        (1 << 1)
59 #define I2SR_RX_NO_AK   (1 << 0)
60
61 #ifdef CONFIG_SYS_I2C_BASE
62 #define I2C_BASE        CONFIG_SYS_I2C_BASE
63 #else
64 #error "define CONFIG_SYS_I2C_BASE to use the mxc_i2c driver"
65 #endif
66
67 static u16 i2c_clk_div[50][2] = {
68         { 22,   0x20 }, { 24,   0x21 }, { 26,   0x22 }, { 28,   0x23 },
69         { 30,   0x00 }, { 32,   0x24 }, { 36,   0x25 }, { 40,   0x26 },
70         { 42,   0x03 }, { 44,   0x27 }, { 48,   0x28 }, { 52,   0x05 },
71         { 56,   0x29 }, { 60,   0x06 }, { 64,   0x2A }, { 72,   0x2B },
72         { 80,   0x2C }, { 88,   0x09 }, { 96,   0x2D }, { 104,  0x0A },
73         { 112,  0x2E }, { 128,  0x2F }, { 144,  0x0C }, { 160,  0x30 },
74         { 192,  0x31 }, { 224,  0x32 }, { 240,  0x0F }, { 256,  0x33 },
75         { 288,  0x10 }, { 320,  0x34 }, { 384,  0x35 }, { 448,  0x36 },
76         { 480,  0x13 }, { 512,  0x37 }, { 576,  0x14 }, { 640,  0x38 },
77         { 768,  0x39 }, { 896,  0x3A }, { 960,  0x17 }, { 1024, 0x3B },
78         { 1152, 0x18 }, { 1280, 0x3C }, { 1536, 0x3D }, { 1792, 0x3E },
79         { 1920, 0x1B }, { 2048, 0x3F }, { 2304, 0x1C }, { 2560, 0x1D },
80         { 3072, 0x1E }, { 3840, 0x1F }
81 };
82
83 /*
84  * Calculate and set proper clock divider
85  */
86 static uint8_t i2c_imx_get_clk(unsigned int rate)
87 {
88         unsigned int i2c_clk_rate;
89         unsigned int div;
90         u8 clk_div;
91
92 #if defined(CONFIG_MX31)
93         struct clock_control_regs *sc_regs =
94                 (struct clock_control_regs *)CCM_BASE;
95
96         /* start the required I2C clock */
97         writel(readl(&sc_regs->cgr0) | (3 << CONFIG_SYS_I2C_CLK_OFFSET),
98                 &sc_regs->cgr0);
99 #endif
100
101         /* Divider value calculation */
102         i2c_clk_rate = mxc_get_clock(MXC_IPG_PERCLK);
103         div = (i2c_clk_rate + rate - 1) / rate;
104         if (div < i2c_clk_div[0][0])
105                 clk_div = 0;
106         else if (div > i2c_clk_div[ARRAY_SIZE(i2c_clk_div) - 1][0])
107                 clk_div = ARRAY_SIZE(i2c_clk_div) - 1;
108         else
109                 for (clk_div = 0; i2c_clk_div[clk_div][0] < div; clk_div++)
110                         ;
111
112         /* Store divider value */
113         return clk_div;
114 }
115
116 /*
117  * Init I2C Bus
118  */
119 void i2c_init(int speed, int unused)
120 {
121         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
122         u8 clk_idx = i2c_imx_get_clk(speed);
123         u8 idx = i2c_clk_div[clk_idx][1];
124
125         /* Store divider value */
126         writeb(idx, &i2c_regs->ifdr);
127
128         /* Reset module */
129         writeb(0, &i2c_regs->i2cr);
130         writeb(0, &i2c_regs->i2sr);
131 }
132
133 /*
134  * Set I2C Speed
135  */
136 int i2c_set_bus_speed(unsigned int speed)
137 {
138         i2c_init(speed, 0);
139         return 0;
140 }
141
142 /*
143  * Get I2C Speed
144  */
145 unsigned int i2c_get_bus_speed(void)
146 {
147         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
148         u8 clk_idx = readb(&i2c_regs->ifdr);
149         u8 clk_div;
150
151         for (clk_div = 0; i2c_clk_div[clk_div][1] != clk_idx; clk_div++)
152                 ;
153
154         return mxc_get_clock(MXC_IPG_PERCLK) / i2c_clk_div[clk_div][0];
155 }
156
157 #define ST_BUS_IDLE (0 | (I2SR_IBB << 8))
158 #define ST_BUS_BUSY (I2SR_IBB | (I2SR_IBB << 8))
159 #define ST_IIF (I2SR_IIF | (I2SR_IIF << 8))
160
161 static int wait_for_sr_state(struct mxc_i2c_regs *i2c_regs, unsigned state)
162 {
163         unsigned sr;
164         ulong elapsed;
165         ulong start_time = get_timer(0);
166         for (;;) {
167                 sr = readb(&i2c_regs->i2sr);
168                 if ((sr & (state >> 8)) == (unsigned char)state)
169                         return sr;
170                 WATCHDOG_RESET();
171                 elapsed = get_timer(start_time);
172                 if (elapsed > (CONFIG_SYS_HZ / 10))     /* .1 seconds */
173                         break;
174         }
175         printf("%s: failed sr=%x cr=%x state=%x\n", __func__,
176                         sr, readb(&i2c_regs->i2cr), state);
177         return -ETIMEDOUT;
178 }
179
180 static int tx_byte(struct mxc_i2c_regs *i2c_regs, u8 byte)
181 {
182         int ret;
183
184         writeb(0, &i2c_regs->i2sr);
185         writeb(byte, &i2c_regs->i2dr);
186         ret = wait_for_sr_state(i2c_regs, ST_IIF);
187         if (ret < 0)
188                 return ret;
189         if (ret & I2SR_RX_NO_AK)
190                 return -ENODEV;
191         return 0;
192 }
193
194 /*
195  * Stop I2C transaction
196  */
197 void i2c_imx_stop(void)
198 {
199         int ret;
200         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
201         unsigned int temp = readb(&i2c_regs->i2cr);
202
203         temp &= ~(I2CR_MSTA | I2CR_MTX);
204         writeb(temp, &i2c_regs->i2cr);
205         ret = wait_for_sr_state(i2c_regs, ST_BUS_IDLE);
206         if (ret < 0)
207                 printf("%s:trigger stop failed\n", __func__);
208 }
209
210 /*
211  * Send start signal, chip address and
212  * write register address
213  */
214 static int i2c_init_transfer(struct mxc_i2c_regs *i2c_regs,
215                 uchar chip, uint addr, int alen)
216 {
217         unsigned int temp;
218         int ret;
219
220         /* Enable I2C controller */
221         if (!(readb(&i2c_regs->i2cr) & I2CR_IEN)) {
222                 writeb(I2CR_IEN, &i2c_regs->i2cr);
223                 /* Wait for controller to be stable */
224                 udelay(50);
225         }
226         if (readb(&i2c_regs->iadr) == (chip << 1))
227                 writeb((chip << 1) ^ 2, &i2c_regs->iadr);
228         writeb(0, &i2c_regs->i2sr);
229         ret = wait_for_sr_state(i2c_regs, ST_BUS_IDLE);
230         if (ret < 0)
231                 goto exit;
232
233         /* Start I2C transaction */
234         temp = readb(&i2c_regs->i2cr);
235         temp |= I2CR_MSTA;
236         writeb(temp, &i2c_regs->i2cr);
237
238         ret = wait_for_sr_state(i2c_regs, ST_BUS_BUSY);
239         if (ret < 0)
240                 goto exit;
241
242         temp |= I2CR_MTX | I2CR_TX_NO_AK;
243         writeb(temp, &i2c_regs->i2cr);
244
245         /* write slave address */
246         ret = tx_byte(i2c_regs, chip << 1);
247         if (ret < 0)
248                 goto exit;
249
250         while (alen--) {
251                 ret = tx_byte(i2c_regs, (addr >> (alen * 8)) & 0xff);
252                 if (ret < 0)
253                         goto exit;
254         }
255         return 0;
256 exit:
257         i2c_imx_stop();
258         /* Disable I2C controller */
259         writeb(0, &i2c_regs->i2cr);
260         return ret;
261 }
262
263 /*
264  * Read data from I2C device
265  */
266 int i2c_read(uchar chip, uint addr, int alen, uchar *buf, int len)
267 {
268         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
269         int ret;
270         unsigned int temp;
271         int i;
272
273         ret = i2c_init_transfer(i2c_regs, chip, addr, alen);
274         if (ret < 0)
275                 return ret;
276
277         temp = readb(&i2c_regs->i2cr);
278         temp |= I2CR_RSTA;
279         writeb(temp, &i2c_regs->i2cr);
280
281         ret = tx_byte(i2c_regs, (chip << 1) | 1);
282         if (ret < 0) {
283                 i2c_imx_stop();
284                 return ret;
285         }
286
287         /* setup bus to read data */
288         temp = readb(&i2c_regs->i2cr);
289         temp &= ~(I2CR_MTX | I2CR_TX_NO_AK);
290         if (len == 1)
291                 temp |= I2CR_TX_NO_AK;
292         writeb(temp, &i2c_regs->i2cr);
293         writeb(0, &i2c_regs->i2sr);
294         readb(&i2c_regs->i2dr);         /* dummy read to clear ICF */
295
296         /* read data */
297         for (i = 0; i < len; i++) {
298                 ret = wait_for_sr_state(i2c_regs, ST_IIF);
299                 if (ret < 0) {
300                         i2c_imx_stop();
301                         return ret;
302                 }
303
304                 /*
305                  * It must generate STOP before read I2DR to prevent
306                  * controller from generating another clock cycle
307                  */
308                 if (i == (len - 1)) {
309                         i2c_imx_stop();
310                 } else if (i == (len - 2)) {
311                         temp = readb(&i2c_regs->i2cr);
312                         temp |= I2CR_TX_NO_AK;
313                         writeb(temp, &i2c_regs->i2cr);
314                 }
315                 writeb(0, &i2c_regs->i2sr);
316                 buf[i] = readb(&i2c_regs->i2dr);
317         }
318
319         i2c_imx_stop();
320
321         return 0;
322 }
323
324 /*
325  * Write data to I2C device
326  */
327 int i2c_write(uchar chip, uint addr, int alen, uchar *buf, int len)
328 {
329         struct mxc_i2c_regs *i2c_regs = (struct mxc_i2c_regs *)I2C_BASE;
330         int ret;
331         int i;
332
333         ret = i2c_init_transfer(i2c_regs, chip, addr, alen);
334         if (ret < 0)
335                 return ret;
336
337         for (i = 0; i < len; i++) {
338                 ret = tx_byte(i2c_regs, buf[i]);
339                 if (ret < 0)
340                         break;
341         }
342
343         i2c_imx_stop();
344
345         return ret;
346 }
347
348 /*
349  * Test if a chip at a given address responds (probe the chip)
350  */
351 int i2c_probe(uchar chip)
352 {
353         return i2c_write(chip, 0, 0, NULL, 0);
354 }