2 * (C) Copyright 2003-2004
3 * Humboldt Solutions Ltd, adrian@humboldt.co.uk.
5 * This is a combined i2c adapter and algorithm driver for the
6 * MPC107/Tsi107 PowerPC northbridge and processors that include
7 * the same I2C unit (8240, 8245, 85xx).
11 * This file is licensed under the terms of the GNU General Public
12 * License version 2. This program is licensed "as is" without any
13 * warranty of any kind, whether express or implied.
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/sched.h>
19 #include <linux/init.h>
20 #include <linux/of_platform.h>
21 #include <linux/of_i2c.h>
24 #include <linux/fsl_devices.h>
25 #include <linux/i2c.h>
26 #include <linux/interrupt.h>
27 #include <linux/delay.h>
29 #include <asm/mpc52xx.h>
30 #include <sysdev/fsl_soc.h>
32 #define DRV_NAME "mpc-i2c"
34 #define MPC_I2C_FDR 0x04
35 #define MPC_I2C_CR 0x08
36 #define MPC_I2C_SR 0x0c
37 #define MPC_I2C_DR 0x10
38 #define MPC_I2C_DFSRR 0x14
59 wait_queue_head_t queue;
60 struct i2c_adapter adap;
64 struct mpc_i2c_divider {
66 u16 fdr; /* including dfsrr */
69 struct mpc_i2c_match_data {
70 void (*setclock)(struct device_node *node,
72 u32 clock, u32 prescaler);
76 static inline void writeccr(struct mpc_i2c *i2c, u32 x)
78 writeb(x, i2c->base + MPC_I2C_CR);
81 static irqreturn_t mpc_i2c_isr(int irq, void *dev_id)
83 struct mpc_i2c *i2c = dev_id;
84 if (readb(i2c->base + MPC_I2C_SR) & CSR_MIF) {
85 /* Read again to allow register to stabilise */
86 i2c->interrupt = readb(i2c->base + MPC_I2C_SR);
87 writeb(0, i2c->base + MPC_I2C_SR);
93 /* Sometimes 9th clock pulse isn't generated, and slave doesn't release
94 * the bus, because it wants to send ACK.
95 * Following sequence of enabling/disabling and sending start/stop generates
96 * the pulse, so it's all OK.
98 static void mpc_i2c_fixup(struct mpc_i2c *i2c)
102 writeccr(i2c, CCR_MEN);
104 writeccr(i2c, CCR_MSTA | CCR_MTX);
106 writeccr(i2c, CCR_MSTA | CCR_MTX | CCR_MEN);
108 writeccr(i2c, CCR_MEN);
112 static int i2c_wait(struct mpc_i2c *i2c, unsigned timeout, int writing)
114 unsigned long orig_jiffies = jiffies;
118 if (i2c->irq == NO_IRQ) {
119 while (!(readb(i2c->base + MPC_I2C_SR) & CSR_MIF)) {
121 if (time_after(jiffies, orig_jiffies + timeout)) {
122 dev_dbg(i2c->dev, "timeout\n");
128 x = readb(i2c->base + MPC_I2C_SR);
129 writeb(0, i2c->base + MPC_I2C_SR);
132 result = wait_event_timeout(i2c->queue,
133 (i2c->interrupt & CSR_MIF), timeout);
135 if (unlikely(!(i2c->interrupt & CSR_MIF))) {
136 dev_dbg(i2c->dev, "wait timeout\n");
148 if (!(x & CSR_MCF)) {
149 dev_dbg(i2c->dev, "unfinished\n");
154 dev_dbg(i2c->dev, "MAL\n");
158 if (writing && (x & CSR_RXAK)) {
159 dev_dbg(i2c->dev, "No RXAK\n");
161 writeccr(i2c, CCR_MEN);
167 #ifdef CONFIG_PPC_52xx
168 static const struct mpc_i2c_divider mpc_i2c_dividers_52xx[] = {
169 {20, 0x20}, {22, 0x21}, {24, 0x22}, {26, 0x23},
170 {28, 0x24}, {30, 0x01}, {32, 0x25}, {34, 0x02},
171 {36, 0x26}, {40, 0x27}, {44, 0x04}, {48, 0x28},
172 {52, 0x63}, {56, 0x29}, {60, 0x41}, {64, 0x2a},
173 {68, 0x07}, {72, 0x2b}, {80, 0x2c}, {88, 0x09},
174 {96, 0x2d}, {104, 0x0a}, {112, 0x2e}, {120, 0x81},
175 {128, 0x2f}, {136, 0x47}, {144, 0x0c}, {160, 0x30},
176 {176, 0x49}, {192, 0x31}, {208, 0x4a}, {224, 0x32},
177 {240, 0x0f}, {256, 0x33}, {272, 0x87}, {288, 0x10},
178 {320, 0x34}, {352, 0x89}, {384, 0x35}, {416, 0x8a},
179 {448, 0x36}, {480, 0x13}, {512, 0x37}, {576, 0x14},
180 {640, 0x38}, {768, 0x39}, {896, 0x3a}, {960, 0x17},
181 {1024, 0x3b}, {1152, 0x18}, {1280, 0x3c}, {1536, 0x3d},
182 {1792, 0x3e}, {1920, 0x1b}, {2048, 0x3f}, {2304, 0x1c},
183 {2560, 0x1d}, {3072, 0x1e}, {3584, 0x7e}, {3840, 0x1f},
184 {4096, 0x7f}, {4608, 0x5c}, {5120, 0x5d}, {6144, 0x5e},
185 {7168, 0xbe}, {7680, 0x5f}, {8192, 0xbf}, {9216, 0x9c},
186 {10240, 0x9d}, {12288, 0x9e}, {15360, 0x9f}
189 int mpc_i2c_get_fdr_52xx(struct device_node *node, u32 clock, int prescaler)
191 const struct mpc52xx_i2c_divider *div = NULL;
192 unsigned int pvr = mfspr(SPRN_PVR);
199 /* Determine divider value */
200 divider = mpc52xx_find_ipb_freq(node) / clock;
203 * We want to choose an FDR/DFSR that generates an I2C bus speed that
204 * is equal to or lower than the requested speed.
206 for (i = 0; i < ARRAY_SIZE(mpc52xx_i2c_dividers); i++) {
207 div = &mpc_i2c_dividers_52xx[i];
208 /* Old MPC5200 rev A CPUs do not support the high bits */
209 if (div->fdr & 0xc0 && pvr == 0x80822011)
211 if (div->divider >= divider)
215 return div ? (int)div->fdr : -EINVAL;
218 static void mpc_i2c_setclock_52xx(struct device_node *node,
220 u32 clock, u32 prescaler)
222 int fdr = mpc52xx_i2c_get_fdr(node, clock, prescaler);
225 fdr = 0x3f; /* backward compatibility */
226 writeb(fdr & 0xff, i2c->base + MPC_I2C_FDR);
227 dev_info(i2c->dev, "clock %d Hz (fdr=%d)\n", clock, fdr);
229 #else /* !CONFIG_PPC_52xx */
230 static void mpc_i2c_setclock_52xx(struct device_node *node,
232 u32 clock, u32 prescaler)
235 #endif /* CONFIG_PPC_52xx*/
237 #ifdef CONFIG_FSL_SOC
238 static const struct mpc_i2c_divider mpc_i2c_dividers_8xxx[] = {
239 {160, 0x0120}, {192, 0x0121}, {224, 0x0122}, {256, 0x0123},
240 {288, 0x0100}, {320, 0x0101}, {352, 0x0601}, {384, 0x0102},
241 {416, 0x0602}, {448, 0x0126}, {480, 0x0103}, {512, 0x0127},
242 {544, 0x0b03}, {576, 0x0104}, {608, 0x1603}, {640, 0x0105},
243 {672, 0x2003}, {704, 0x0b05}, {736, 0x2b03}, {768, 0x0106},
244 {800, 0x3603}, {832, 0x0b06}, {896, 0x012a}, {960, 0x0107},
245 {1024, 0x012b}, {1088, 0x1607}, {1152, 0x0108}, {1216, 0x2b07},
246 {1280, 0x0109}, {1408, 0x1609}, {1536, 0x010a}, {1664, 0x160a},
247 {1792, 0x012e}, {1920, 0x010b}, {2048, 0x012f}, {2176, 0x2b0b},
248 {2304, 0x010c}, {2560, 0x010d}, {2816, 0x2b0d}, {3072, 0x010e},
249 {3328, 0x2b0e}, {3584, 0x0132}, {3840, 0x010f}, {4096, 0x0133},
250 {4608, 0x0110}, {5120, 0x0111}, {6144, 0x0112}, {7168, 0x0136},
251 {7680, 0x0113}, {8192, 0x0137}, {9216, 0x0114}, {10240, 0x0115},
252 {12288, 0x0116}, {14336, 0x013a}, {15360, 0x0117}, {16384, 0x013b},
253 {18432, 0x0118}, {20480, 0x0119}, {24576, 0x011a}, {28672, 0x013e},
254 {30720, 0x011b}, {32768, 0x013f}, {36864, 0x011c}, {40960, 0x011d},
255 {49152, 0x011e}, {61440, 0x011f}
258 u32 mpc_i2c_get_sec_cfg_8xxx(void)
260 struct device_node *node = NULL;
264 node = of_find_node_by_name(NULL, "global-utilities");
266 const u32 *prop = of_get_property(node, "reg", NULL);
269 * Map and check POR Device Status Register 2
270 * (PORDEVSR2) at 0xE0014
272 reg = ioremap(get_immrbase() + *prop + 0x14, 0x4);
275 "Error: couldn't map PORDEVSR2\n");
277 val = in_be32(reg) & 0x00000080; /* sec-cfg */
287 int mpc_i2c_get_fdr_8xxx(struct device_node *node, u32 clock, u32 prescaler)
289 const struct mpc_i2c_divider *div = NULL;
296 /* Determine proper divider value */
297 if (of_device_is_compatible(node, "fsl,mpc8544-i2c"))
298 prescaler = mpc_i2c_get_sec_cfg_8xxx() ? 3 : 2;
302 divider = fsl_get_sys_freq() / clock / prescaler;
304 pr_debug("I2C: src_clock=%d clock=%d divider=%d\n",
305 fsl_get_sys_freq(), clock, divider);
308 * We want to choose an FDR/DFSR that generates an I2C bus speed that
309 * is equal to or lower than the requested speed.
311 for (i = 0; i < ARRAY_SIZE(mpc_i2c_dividers_8xxx); i++) {
312 div = &mpc_i2c_dividers_8xxx[i];
313 if (div->divider >= divider)
317 return div ? (int)div->fdr : -EINVAL;
320 static void mpc_i2c_setclock_8xxx(struct device_node *node,
322 u32 clock, u32 prescaler)
324 int fdr = mpc_i2c_get_fdr_8xxx(node, clock, prescaler);
327 fdr = 0x1031; /* backward compatibility */
328 writeb(fdr & 0xff, i2c->base + MPC_I2C_FDR);
329 writeb((fdr >> 8) & 0xff, i2c->base + MPC_I2C_DFSRR);
330 dev_info(i2c->dev, "clock %d Hz (dfsrr=%d fdr=%d)\n",
331 clock, fdr >> 8, fdr & 0xff);
334 #else /* !CONFIG_FSL_SOC */
335 static void mpc_i2c_setclock_8xxx(struct device_node *node,
337 u32 clock, u32 prescaler)
340 #endif /* CONFIG_FSL_SOC */
342 static void mpc_i2c_start(struct mpc_i2c *i2c)
344 /* Clear arbitration */
345 writeb(0, i2c->base + MPC_I2C_SR);
347 writeccr(i2c, CCR_MEN);
350 static void mpc_i2c_stop(struct mpc_i2c *i2c)
352 writeccr(i2c, CCR_MEN);
355 static int mpc_write(struct mpc_i2c *i2c, int target,
356 const u8 *data, int length, int restart)
359 unsigned timeout = i2c->adap.timeout;
360 u32 flags = restart ? CCR_RSTA : 0;
364 writeccr(i2c, CCR_MEN);
365 /* Start as master */
366 writeccr(i2c, CCR_MIEN | CCR_MEN | CCR_MSTA | CCR_MTX | flags);
367 /* Write target byte */
368 writeb((target << 1), i2c->base + MPC_I2C_DR);
370 result = i2c_wait(i2c, timeout, 1);
374 for (i = 0; i < length; i++) {
375 /* Write data byte */
376 writeb(data[i], i2c->base + MPC_I2C_DR);
378 result = i2c_wait(i2c, timeout, 1);
386 static int mpc_read(struct mpc_i2c *i2c, int target,
387 u8 *data, int length, int restart)
389 unsigned timeout = i2c->adap.timeout;
391 u32 flags = restart ? CCR_RSTA : 0;
395 writeccr(i2c, CCR_MEN);
396 /* Switch to read - restart */
397 writeccr(i2c, CCR_MIEN | CCR_MEN | CCR_MSTA | CCR_MTX | flags);
398 /* Write target address byte - this time with the read flag set */
399 writeb((target << 1) | 1, i2c->base + MPC_I2C_DR);
401 result = i2c_wait(i2c, timeout, 1);
407 writeccr(i2c, CCR_MIEN | CCR_MEN | CCR_MSTA | CCR_TXAK);
409 writeccr(i2c, CCR_MIEN | CCR_MEN | CCR_MSTA);
411 readb(i2c->base + MPC_I2C_DR);
414 for (i = 0; i < length; i++) {
415 result = i2c_wait(i2c, timeout, 0);
419 /* Generate txack on next to last byte */
421 writeccr(i2c, CCR_MIEN | CCR_MEN | CCR_MSTA | CCR_TXAK);
422 /* Generate stop on last byte */
424 writeccr(i2c, CCR_MIEN | CCR_MEN | CCR_TXAK);
425 data[i] = readb(i2c->base + MPC_I2C_DR);
431 static int mpc_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
433 struct i2c_msg *pmsg;
436 unsigned long orig_jiffies = jiffies;
437 struct mpc_i2c *i2c = i2c_get_adapdata(adap);
441 /* Allow bus up to 1s to become not busy */
442 while (readb(i2c->base + MPC_I2C_SR) & CSR_MBB) {
443 if (signal_pending(current)) {
444 dev_dbg(i2c->dev, "Interrupted\n");
448 if (time_after(jiffies, orig_jiffies + HZ)) {
449 dev_dbg(i2c->dev, "timeout\n");
450 if (readb(i2c->base + MPC_I2C_SR) ==
451 (CSR_MCF | CSR_MBB | CSR_RXAK))
458 for (i = 0; ret >= 0 && i < num; i++) {
461 "Doing %s %d bytes to 0x%02x - %d of %d messages\n",
462 pmsg->flags & I2C_M_RD ? "read" : "write",
463 pmsg->len, pmsg->addr, i + 1, num);
464 if (pmsg->flags & I2C_M_RD)
466 mpc_read(i2c, pmsg->addr, pmsg->buf, pmsg->len, i);
469 mpc_write(i2c, pmsg->addr, pmsg->buf, pmsg->len, i);
472 return (ret < 0) ? ret : num;
475 static u32 mpc_functionality(struct i2c_adapter *adap)
477 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
480 static const struct i2c_algorithm mpc_algo = {
481 .master_xfer = mpc_xfer,
482 .functionality = mpc_functionality,
485 static struct i2c_adapter mpc_ops = {
486 .owner = THIS_MODULE,
487 .name = "MPC adapter",
492 static int __devinit fsl_i2c_probe(struct of_device *op,
493 const struct of_device_id *match)
501 i2c = kzalloc(sizeof(*i2c), GFP_KERNEL);
505 i2c->dev = &op->dev; /* for debug and error output */
507 init_waitqueue_head(&i2c->queue);
509 i2c->base = of_iomap(op->node, 0);
511 dev_err(i2c->dev, "failed to map controller\n");
516 i2c->irq = irq_of_parse_and_map(op->node, 0);
517 if (i2c->irq != NO_IRQ) { /* i2c->irq = NO_IRQ implies polling */
518 result = request_irq(i2c->irq, mpc_i2c_isr,
519 IRQF_SHARED, "i2c-mpc", i2c);
521 dev_err(i2c->dev, "failed to attach interrupt\n");
526 if (!of_get_property(op->node, "fsl,preserve-clocking", NULL)) {
527 prop = of_get_property(op->node, "clock-frequency", &plen);
528 if (prop && plen == sizeof(u32))
532 struct mpc_i2c_match_data *data =
533 (struct mpc_i2c_match_data *)match->data;
534 data->setclock(op->node, i2c, clock, data->prescaler);
536 /* Backwards compatibility */
537 if (of_get_property(op->node, "dfsrr", NULL))
538 mpc_i2c_setclock_8xxx(op->node, i2c,
543 dev_set_drvdata(&op->dev, i2c);
546 i2c_set_adapdata(&i2c->adap, i2c);
547 i2c->adap.dev.parent = &op->dev;
549 result = i2c_add_adapter(&i2c->adap);
551 dev_err(i2c->dev, "failed to add adapter\n");
554 of_register_i2c_devices(&i2c->adap, op->node);
559 dev_set_drvdata(&op->dev, NULL);
560 free_irq(i2c->irq, i2c);
562 irq_dispose_mapping(i2c->irq);
569 static int __devexit fsl_i2c_remove(struct of_device *op)
571 struct mpc_i2c *i2c = dev_get_drvdata(&op->dev);
573 i2c_del_adapter(&i2c->adap);
574 dev_set_drvdata(&op->dev, NULL);
576 if (i2c->irq != NO_IRQ)
577 free_irq(i2c->irq, i2c);
579 irq_dispose_mapping(i2c->irq);
585 static const struct of_device_id mpc_i2c_of_match[] = {
586 {.compatible = "mpc5200-i2c",
587 .data = &(struct mpc_i2c_match_data) {
588 .setclock = mpc_i2c_setclock_52xx,
591 {.compatible = "fsl,mpc5200b-i2c",
592 .data = &(struct mpc_i2c_match_data) {
593 .setclock = mpc_i2c_setclock_52xx,
596 {.compatible = "fsl,mpc5200-i2c",
597 .data = &(struct mpc_i2c_match_data) {
598 .setclock = mpc_i2c_setclock_52xx,
601 {.compatible = "fsl,mpc8313-i2c",
602 .data = &(struct mpc_i2c_match_data) {
603 .setclock = mpc_i2c_setclock_8xxx,
606 {.compatible = "fsl,mpc8543-i2c",
607 .data = &(struct mpc_i2c_match_data) {
608 .setclock = mpc_i2c_setclock_8xxx,
612 {.compatible = "fsl,mpc8544-i2c",
613 .data = &(struct mpc_i2c_match_data) {
614 .setclock = mpc_i2c_setclock_8xxx,
617 /* Backward compatibility */
619 {.compatible = "fsl-i2c", },
623 MODULE_DEVICE_TABLE(of, mpc_i2c_of_match);
626 /* Structure for a device driver */
627 static struct of_platform_driver mpc_i2c_driver = {
628 .match_table = mpc_i2c_of_match,
629 .probe = fsl_i2c_probe,
630 .remove = __devexit_p(fsl_i2c_remove),
632 .owner = THIS_MODULE,
637 static int __init fsl_i2c_init(void)
641 rv = of_register_platform_driver(&mpc_i2c_driver);
643 printk(KERN_ERR DRV_NAME
644 " of_register_platform_driver failed (%i)\n", rv);
648 static void __exit fsl_i2c_exit(void)
650 of_unregister_platform_driver(&mpc_i2c_driver);
653 module_init(fsl_i2c_init);
654 module_exit(fsl_i2c_exit);
656 MODULE_AUTHOR("Adrian Cox <adrian@humboldt.co.uk>");
657 MODULE_DESCRIPTION("I2C-Bus adapter for MPC107 bridge and "
658 "MPC824x/85xx/52xx processors");
659 MODULE_LICENSE("GPL");