2 * Freescale CPM1/CPM2 I2C interface.
5 * moved into proper i2c interface;
8 * Parts from dbox2_i2c.c (cvs.tuxbox.org)
11 * (C) 2007 Montavista Software, Inc.
14 * Converted to of_platform_device. Renamed to i2c-cpm.c.
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2 of the License, or
20 * (at your option) any later version.
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.
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/delay.h>
31 #include <linux/slab.h>
32 #include <linux/interrupt.h>
33 #include <linux/errno.h>
34 #include <linux/stddef.h>
35 #include <linux/i2c.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/of_address.h>
39 #include <linux/of_device.h>
40 #include <linux/of_irq.h>
41 #include <linux/of_platform.h>
42 #include <sysdev/fsl_soc.h>
45 /* Try to define this if you have an older CPU (earlier than rev D4) */
46 /* However, better use a GPIO based bitbang driver in this case :/ */
47 #undef I2C_CHIP_ERRATA
49 #define CPM_MAX_READ 513
52 #define I2C_EB (0x10) /* Big endian mode */
53 #define I2C_EB_CPM2 (0x30) /* Big endian mode, memory snoop */
55 #define DPRAM_BASE ((u8 __iomem __force *)cpm_muram_addr(0))
57 /* I2C parameter RAM. */
59 ushort rbase; /* Rx Buffer descriptor base address */
60 ushort tbase; /* Tx Buffer descriptor base address */
61 u_char rfcr; /* Rx function code */
62 u_char tfcr; /* Tx function code */
63 ushort mrblr; /* Max receive buffer length */
64 uint rstate; /* Internal */
65 uint rdp; /* Internal */
66 ushort rbptr; /* Rx Buffer descriptor pointer */
67 ushort rbc; /* Internal */
68 uint rxtmp; /* Internal */
69 uint tstate; /* Internal */
70 uint tdp; /* Internal */
71 ushort tbptr; /* Tx Buffer descriptor pointer */
72 ushort tbc; /* Internal */
73 uint txtmp; /* Internal */
74 char res1[4]; /* Reserved */
75 ushort rpbase; /* Relocation pointer */
76 char res2[2]; /* Reserved */
79 #define I2COM_START 0x80
80 #define I2COM_MASTER 0x01
81 #define I2CER_TXE 0x10
82 #define I2CER_BUSY 0x04
83 #define I2CER_TXB 0x02
84 #define I2CER_RXB 0x01
104 struct platform_device *ofdev;
105 struct i2c_adapter adap;
107 int version; /* CPM1=1, CPM2=2 */
111 struct i2c_reg __iomem *i2c_reg;
112 struct i2c_ram __iomem *i2c_ram;
114 wait_queue_head_t i2c_wait;
115 cbd_t __iomem *tbase;
116 cbd_t __iomem *rbase;
117 u_char *txbuf[CPM_MAXBD];
118 u_char *rxbuf[CPM_MAXBD];
119 u32 txdma[CPM_MAXBD];
120 u32 rxdma[CPM_MAXBD];
123 static irqreturn_t cpm_i2c_interrupt(int irq, void *dev_id)
126 struct i2c_reg __iomem *i2c_reg;
127 struct i2c_adapter *adap = dev_id;
130 cpm = i2c_get_adapdata(dev_id);
131 i2c_reg = cpm->i2c_reg;
133 /* Clear interrupt. */
134 i = in_8(&i2c_reg->i2cer);
135 out_8(&i2c_reg->i2cer, i);
137 dev_dbg(&adap->dev, "Interrupt: %x\n", i);
139 wake_up(&cpm->i2c_wait);
141 return i ? IRQ_HANDLED : IRQ_NONE;
144 static void cpm_reset_i2c_params(struct cpm_i2c *cpm)
146 struct i2c_ram __iomem *i2c_ram = cpm->i2c_ram;
148 /* Set up the I2C parameters in the parameter ram. */
149 out_be16(&i2c_ram->tbase, (u8 __iomem *)cpm->tbase - DPRAM_BASE);
150 out_be16(&i2c_ram->rbase, (u8 __iomem *)cpm->rbase - DPRAM_BASE);
152 if (cpm->version == 1) {
153 out_8(&i2c_ram->tfcr, I2C_EB);
154 out_8(&i2c_ram->rfcr, I2C_EB);
156 out_8(&i2c_ram->tfcr, I2C_EB_CPM2);
157 out_8(&i2c_ram->rfcr, I2C_EB_CPM2);
160 out_be16(&i2c_ram->mrblr, CPM_MAX_READ);
162 out_be32(&i2c_ram->rstate, 0);
163 out_be32(&i2c_ram->rdp, 0);
164 out_be16(&i2c_ram->rbptr, 0);
165 out_be16(&i2c_ram->rbc, 0);
166 out_be32(&i2c_ram->rxtmp, 0);
167 out_be32(&i2c_ram->tstate, 0);
168 out_be32(&i2c_ram->tdp, 0);
169 out_be16(&i2c_ram->tbptr, 0);
170 out_be16(&i2c_ram->tbc, 0);
171 out_be32(&i2c_ram->txtmp, 0);
174 static void cpm_i2c_force_close(struct i2c_adapter *adap)
176 struct cpm_i2c *cpm = i2c_get_adapdata(adap);
177 struct i2c_reg __iomem *i2c_reg = cpm->i2c_reg;
179 dev_dbg(&adap->dev, "cpm_i2c_force_close()\n");
181 cpm_command(cpm->cp_command, CPM_CR_CLOSE_RX_BD);
183 out_8(&i2c_reg->i2cmr, 0x00); /* Disable all interrupts */
184 out_8(&i2c_reg->i2cer, 0xff);
187 static void cpm_i2c_parse_message(struct i2c_adapter *adap,
188 struct i2c_msg *pmsg, int num, int tx, int rx)
195 struct cpm_i2c *cpm = i2c_get_adapdata(adap);
197 tbdf = cpm->tbase + tx;
198 rbdf = cpm->rbase + rx;
200 addr = pmsg->addr << 1;
201 if (pmsg->flags & I2C_M_RD)
207 /* Align read buffer */
208 rb = (u_char *) (((ulong) rb + 1) & ~1);
210 tb[0] = addr; /* Device address byte w/rw flag */
212 out_be16(&tbdf->cbd_datlen, pmsg->len + 1);
213 out_be16(&tbdf->cbd_sc, 0);
215 if (!(pmsg->flags & I2C_M_NOSTART))
216 setbits16(&tbdf->cbd_sc, BD_I2C_START);
219 setbits16(&tbdf->cbd_sc, BD_SC_LAST | BD_SC_WRAP);
221 if (pmsg->flags & I2C_M_RD) {
223 * To read, we need an empty buffer of the proper length.
224 * All that is used is the first byte for address, the remainder
225 * is just used for timing (and doesn't really have to exist).
228 dev_dbg(&adap->dev, "cpm_i2c_read(abyte=0x%x)\n", addr);
230 out_be16(&rbdf->cbd_datlen, 0);
231 out_be16(&rbdf->cbd_sc, BD_SC_EMPTY | BD_SC_INTRPT);
233 if (rx + 1 == CPM_MAXBD)
234 setbits16(&rbdf->cbd_sc, BD_SC_WRAP);
237 setbits16(&tbdf->cbd_sc, BD_SC_READY);
239 dev_dbg(&adap->dev, "cpm_i2c_write(abyte=0x%x)\n", addr);
241 memcpy(tb+1, pmsg->buf, pmsg->len);
244 setbits16(&tbdf->cbd_sc, BD_SC_READY | BD_SC_INTRPT);
248 static int cpm_i2c_check_message(struct i2c_adapter *adap,
249 struct i2c_msg *pmsg, int tx, int rx)
255 struct cpm_i2c *cpm = i2c_get_adapdata(adap);
257 tbdf = cpm->tbase + tx;
258 rbdf = cpm->rbase + rx;
263 /* Align read buffer */
264 rb = (u_char *) (((uint) rb + 1) & ~1);
267 if (pmsg->flags & I2C_M_RD) {
268 dev_dbg(&adap->dev, "tx sc 0x%04x, rx sc 0x%04x\n",
269 in_be16(&tbdf->cbd_sc), in_be16(&rbdf->cbd_sc));
271 if (in_be16(&tbdf->cbd_sc) & BD_SC_NAK) {
272 dev_dbg(&adap->dev, "I2C read; No ack\n");
275 if (in_be16(&rbdf->cbd_sc) & BD_SC_EMPTY) {
277 "I2C read; complete but rbuf empty\n");
280 if (in_be16(&rbdf->cbd_sc) & BD_SC_OV) {
281 dev_err(&adap->dev, "I2C read; Overrun\n");
284 memcpy(pmsg->buf, rb, pmsg->len);
286 dev_dbg(&adap->dev, "tx sc %d 0x%04x\n", tx,
287 in_be16(&tbdf->cbd_sc));
289 if (in_be16(&tbdf->cbd_sc) & BD_SC_NAK) {
290 dev_dbg(&adap->dev, "I2C write; No ack\n");
293 if (in_be16(&tbdf->cbd_sc) & BD_SC_UN) {
294 dev_err(&adap->dev, "I2C write; Underrun\n");
297 if (in_be16(&tbdf->cbd_sc) & BD_SC_CL) {
298 dev_err(&adap->dev, "I2C write; Collision\n");
305 static int cpm_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
307 struct cpm_i2c *cpm = i2c_get_adapdata(adap);
308 struct i2c_reg __iomem *i2c_reg = cpm->i2c_reg;
309 struct i2c_ram __iomem *i2c_ram = cpm->i2c_ram;
310 struct i2c_msg *pmsg;
320 /* Check if we have any oversized READ requests */
321 for (i = 0; i < num; i++) {
323 if (pmsg->len >= CPM_MAX_READ)
327 /* Reset to use first buffer */
328 out_be16(&i2c_ram->rbptr, in_be16(&i2c_ram->rbase));
329 out_be16(&i2c_ram->tbptr, in_be16(&i2c_ram->tbase));
338 * If there was a collision in the last i2c transaction,
339 * Set I2COM_MASTER as it was cleared during collision.
341 if (in_be16(&tbdf->cbd_sc) & BD_SC_CL) {
342 out_8(&cpm->i2c_reg->i2com, I2COM_MASTER);
347 dev_dbg(&adap->dev, "R: %d T: %d\n", rptr, tptr);
349 cpm_i2c_parse_message(adap, pmsg, num, tptr, rptr);
350 if (pmsg->flags & I2C_M_RD)
354 /* Start transfer now */
355 /* Enable RX/TX/Error interupts */
356 out_8(&i2c_reg->i2cmr, I2CER_TXE | I2CER_TXB | I2CER_RXB);
357 out_8(&i2c_reg->i2cer, 0xff); /* Clear interrupt status */
358 /* Chip bug, set enable here */
359 setbits8(&i2c_reg->i2mod, I2MOD_EN); /* Enable */
360 /* Begin transmission */
361 setbits8(&i2c_reg->i2com, I2COM_START);
367 /* Check for outstanding messages */
368 dev_dbg(&adap->dev, "test ready.\n");
370 if (pmsg->flags & I2C_M_RD)
371 ret = wait_event_timeout(cpm->i2c_wait,
372 (in_be16(&tbdf[tptr].cbd_sc) & BD_SC_NAK) ||
373 !(in_be16(&rbdf[rptr].cbd_sc) & BD_SC_EMPTY),
376 ret = wait_event_timeout(cpm->i2c_wait,
377 !(in_be16(&tbdf[tptr].cbd_sc) & BD_SC_READY),
381 dev_err(&adap->dev, "I2C transfer: timeout\n");
385 dev_dbg(&adap->dev, "ready.\n");
386 ret = cpm_i2c_check_message(adap, pmsg, tptr, rptr);
388 if (pmsg->flags & I2C_M_RD)
394 #ifdef I2C_CHIP_ERRATA
396 * Chip errata, clear enable. This is not needed on rev D4 CPUs.
397 * Disabling I2C too early may cause too short stop condition
400 clrbits8(&i2c_reg->i2mod, I2MOD_EN);
405 cpm_i2c_force_close(adap);
406 #ifdef I2C_CHIP_ERRATA
408 * Chip errata, clear enable. This is not needed on rev D4 CPUs.
410 clrbits8(&i2c_reg->i2mod, I2MOD_EN);
415 static u32 cpm_i2c_func(struct i2c_adapter *adap)
417 return I2C_FUNC_I2C | (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK);
420 /* -----exported algorithm data: ------------------------------------- */
422 static const struct i2c_algorithm cpm_i2c_algo = {
423 .master_xfer = cpm_i2c_xfer,
424 .functionality = cpm_i2c_func,
427 static const struct i2c_adapter cpm_ops = {
428 .owner = THIS_MODULE,
430 .algo = &cpm_i2c_algo,
433 static int cpm_i2c_setup(struct cpm_i2c *cpm)
435 struct platform_device *ofdev = cpm->ofdev;
438 void __iomem *i2c_base;
443 dev_dbg(&cpm->ofdev->dev, "cpm_i2c_setup()\n");
445 init_waitqueue_head(&cpm->i2c_wait);
447 cpm->irq = irq_of_parse_and_map(ofdev->dev.of_node, 0);
451 /* Install interrupt handler. */
452 ret = request_irq(cpm->irq, cpm_i2c_interrupt, 0, "cpm_i2c",
457 /* I2C parameter RAM */
458 i2c_base = of_iomap(ofdev->dev.of_node, 1);
459 if (i2c_base == NULL) {
464 if (of_device_is_compatible(ofdev->dev.of_node, "fsl,cpm1-i2c")) {
466 /* Check for and use a microcode relocation patch. */
467 cpm->i2c_ram = i2c_base;
468 cpm->i2c_addr = in_be16(&cpm->i2c_ram->rpbase);
471 * Maybe should use cpm_muram_alloc instead of hardcoding
472 * this in micropatch.c
475 cpm->i2c_ram = cpm_muram_addr(cpm->i2c_addr);
481 } else if (of_device_is_compatible(ofdev->dev.of_node, "fsl,cpm2-i2c")) {
482 cpm->i2c_addr = cpm_muram_alloc(sizeof(struct i2c_ram), 64);
483 cpm->i2c_ram = cpm_muram_addr(cpm->i2c_addr);
484 out_be16(i2c_base, cpm->i2c_addr);
495 /* I2C control/status registers */
496 cpm->i2c_reg = of_iomap(ofdev->dev.of_node, 0);
497 if (cpm->i2c_reg == NULL) {
502 data = of_get_property(ofdev->dev.of_node, "fsl,cpm-command", &len);
503 if (!data || len != 4) {
507 cpm->cp_command = *data;
509 data = of_get_property(ofdev->dev.of_node, "linux,i2c-class", &len);
510 if (data && len == 4)
511 cpm->adap.class = *data;
513 data = of_get_property(ofdev->dev.of_node, "clock-frequency", &len);
514 if (data && len == 4)
517 cpm->freq = 60000; /* use 60kHz i2c clock by default */
520 * Allocate space for CPM_MAXBD transmit and receive buffer
521 * descriptors in the DP ram.
523 cpm->dp_addr = cpm_muram_alloc(sizeof(cbd_t) * 2 * CPM_MAXBD, 8);
529 cpm->tbase = cpm_muram_addr(cpm->dp_addr);
530 cpm->rbase = cpm_muram_addr(cpm->dp_addr + sizeof(cbd_t) * CPM_MAXBD);
532 /* Allocate TX and RX buffers */
537 for (i = 0; i < CPM_MAXBD; i++) {
538 cpm->rxbuf[i] = dma_alloc_coherent(&cpm->ofdev->dev,
540 &cpm->rxdma[i], GFP_KERNEL);
541 if (!cpm->rxbuf[i]) {
545 out_be32(&rbdf[i].cbd_bufaddr, ((cpm->rxdma[i] + 1) & ~1));
547 cpm->txbuf[i] = (unsigned char *)dma_alloc_coherent(&cpm->ofdev->dev, CPM_MAX_READ + 1, &cpm->txdma[i], GFP_KERNEL);
548 if (!cpm->txbuf[i]) {
552 out_be32(&tbdf[i].cbd_bufaddr, cpm->txdma[i]);
555 /* Initialize Tx/Rx parameters. */
557 cpm_reset_i2c_params(cpm);
559 dev_dbg(&cpm->ofdev->dev, "i2c_ram 0x%p, i2c_addr 0x%04x, freq %d\n",
560 cpm->i2c_ram, cpm->i2c_addr, cpm->freq);
561 dev_dbg(&cpm->ofdev->dev, "tbase 0x%04x, rbase 0x%04x\n",
562 (u8 __iomem *)cpm->tbase - DPRAM_BASE,
563 (u8 __iomem *)cpm->rbase - DPRAM_BASE);
565 cpm_command(cpm->cp_command, CPM_CR_INIT_TRX);
568 * Select an invalid address. Just make sure we don't use loopback mode
570 out_8(&cpm->i2c_reg->i2add, 0x7f << 1);
573 * PDIV is set to 00 in i2mod, so brgclk/32 is used as input to the
574 * i2c baud rate generator. This is divided by 2 x (DIV + 3) to get
575 * the actual i2c bus frequency.
577 brg = get_brgfreq() / (32 * 2 * cpm->freq) - 3;
578 out_8(&cpm->i2c_reg->i2brg, brg);
580 out_8(&cpm->i2c_reg->i2mod, 0x00);
581 out_8(&cpm->i2c_reg->i2com, I2COM_MASTER); /* Master mode */
583 /* Disable interrupts. */
584 out_8(&cpm->i2c_reg->i2cmr, 0);
585 out_8(&cpm->i2c_reg->i2cer, 0xff);
590 for (i = 0; i < CPM_MAXBD; i++) {
592 dma_free_coherent(&cpm->ofdev->dev, CPM_MAX_READ + 1,
593 cpm->rxbuf[i], cpm->rxdma[i]);
595 dma_free_coherent(&cpm->ofdev->dev, CPM_MAX_READ + 1,
596 cpm->txbuf[i], cpm->txdma[i]);
598 cpm_muram_free(cpm->dp_addr);
600 iounmap(cpm->i2c_reg);
602 if ((cpm->version == 1) && (!cpm->i2c_addr))
603 iounmap(cpm->i2c_ram);
604 if (cpm->version == 2)
605 cpm_muram_free(cpm->i2c_addr);
607 free_irq(cpm->irq, &cpm->adap);
611 static void cpm_i2c_shutdown(struct cpm_i2c *cpm)
616 clrbits8(&cpm->i2c_reg->i2mod, I2MOD_EN);
618 /* Disable interrupts */
619 out_8(&cpm->i2c_reg->i2cmr, 0);
620 out_8(&cpm->i2c_reg->i2cer, 0xff);
622 free_irq(cpm->irq, &cpm->adap);
624 /* Free all memory */
625 for (i = 0; i < CPM_MAXBD; i++) {
626 dma_free_coherent(&cpm->ofdev->dev, CPM_MAX_READ + 1,
627 cpm->rxbuf[i], cpm->rxdma[i]);
628 dma_free_coherent(&cpm->ofdev->dev, CPM_MAX_READ + 1,
629 cpm->txbuf[i], cpm->txdma[i]);
632 cpm_muram_free(cpm->dp_addr);
633 iounmap(cpm->i2c_reg);
635 if ((cpm->version == 1) && (!cpm->i2c_addr))
636 iounmap(cpm->i2c_ram);
637 if (cpm->version == 2)
638 cpm_muram_free(cpm->i2c_addr);
641 static int cpm_i2c_probe(struct platform_device *ofdev)
647 cpm = kzalloc(sizeof(struct cpm_i2c), GFP_KERNEL);
653 platform_set_drvdata(ofdev, cpm);
656 i2c_set_adapdata(&cpm->adap, cpm);
657 cpm->adap.dev.parent = &ofdev->dev;
658 cpm->adap.dev.of_node = of_node_get(ofdev->dev.of_node);
660 result = cpm_i2c_setup(cpm);
662 dev_err(&ofdev->dev, "Unable to init hardware\n");
666 /* register new adapter to i2c module... */
668 data = of_get_property(ofdev->dev.of_node, "linux,i2c-index", &len);
669 cpm->adap.nr = (data && len == 4) ? be32_to_cpup(data) : -1;
670 result = i2c_add_numbered_adapter(&cpm->adap);
673 dev_err(&ofdev->dev, "Unable to register with I2C\n");
677 dev_dbg(&ofdev->dev, "hw routines for %s registered.\n",
682 cpm_i2c_shutdown(cpm);
689 static int cpm_i2c_remove(struct platform_device *ofdev)
691 struct cpm_i2c *cpm = platform_get_drvdata(ofdev);
693 i2c_del_adapter(&cpm->adap);
695 cpm_i2c_shutdown(cpm);
702 static const struct of_device_id cpm_i2c_match[] = {
704 .compatible = "fsl,cpm1-i2c",
707 .compatible = "fsl,cpm2-i2c",
712 MODULE_DEVICE_TABLE(of, cpm_i2c_match);
714 static struct platform_driver cpm_i2c_driver = {
715 .probe = cpm_i2c_probe,
716 .remove = cpm_i2c_remove,
718 .name = "fsl-i2c-cpm",
719 .of_match_table = cpm_i2c_match,
723 module_platform_driver(cpm_i2c_driver);
726 MODULE_DESCRIPTION("I2C-Bus adapter routines for CPM boards");
727 MODULE_LICENSE("GPL");