2 * This is i.MX low power i2c controller driver.
4 * Copyright 2016 Freescale Semiconductor, Inc.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
18 #include <linux/clk.h>
19 #include <linux/completion.h>
20 #include <linux/delay.h>
21 #include <linux/err.h>
22 #include <linux/errno.h>
23 #include <linux/i2c.h>
24 #include <linux/init.h>
25 #include <linux/interrupt.h>
27 #include <linux/kernel.h>
28 #include <linux/module.h>
30 #include <linux/of_device.h>
31 #include <linux/platform_device.h>
32 #include <linux/sched.h>
33 #include <linux/slab.h>
35 #define DRIVER_NAME "imx-lpi2c"
37 #define LPI2C_PARAM 0x04 /* i2c RX/TX FIFO size */
38 #define LPI2C_MCR 0x10 /* i2c contrl register */
39 #define LPI2C_MSR 0x14 /* i2c status register */
40 #define LPI2C_MIER 0x18 /* i2c interrupt enable */
41 #define LPI2C_MCFGR0 0x20 /* i2c master configuration */
42 #define LPI2C_MCFGR1 0x24 /* i2c master configuration */
43 #define LPI2C_MCFGR2 0x28 /* i2c master configuration */
44 #define LPI2C_MCFGR3 0x2C /* i2c master configuration */
45 #define LPI2C_MCCR0 0x48 /* i2c master clk configuration */
46 #define LPI2C_MCCR1 0x50 /* i2c master clk configuration */
47 #define LPI2C_MFCR 0x58 /* i2c master FIFO control */
48 #define LPI2C_MFSR 0x5C /* i2c master FIFO status */
49 #define LPI2C_MTDR 0x60 /* i2c master TX data register */
50 #define LPI2C_MRDR 0x70 /* i2c master RX data register */
53 #define TRAN_DATA 0X00
54 #define RECV_DATA 0X01
56 #define RECV_DISCARD 0X03
57 #define GEN_START 0X04
58 #define START_NACK 0X05
59 #define START_HIGH 0X06
60 #define START_HIGH_NACK 0X07
62 #define MCR_MEN BIT(0)
63 #define MCR_RST BIT(1)
64 #define MCR_DOZEN BIT(2)
65 #define MCR_DBGEN BIT(3)
66 #define MCR_RTF BIT(8)
67 #define MCR_RRF BIT(9)
68 #define MSR_TDF BIT(0)
69 #define MSR_RDF BIT(1)
70 #define MSR_SDF BIT(9)
71 #define MSR_NDF BIT(10)
72 #define MSR_ALF BIT(11)
73 #define MSR_MBF BIT(24)
74 #define MSR_BBF BIT(25)
75 #define MIER_TDIE BIT(0)
76 #define MIER_RDIE BIT(1)
77 #define MIER_SDIE BIT(9)
78 #define MIER_NDIE BIT(10)
79 #define MCFGR1_AUTOSTOP BIT(8)
80 #define MCFGR1_IGNACK BIT(9)
81 #define MRDR_RXEMPTY BIT(14)
83 #define I2C_CLK_RATIO 2
84 #define CHUNK_DATA 256
86 #define LPI2C_DEFAULT_RATE 100000
87 #define STARDARD_MAX_BITRATE 400000
88 #define FAST_MAX_BITRATE 1000000
89 #define FAST_PLUS_MAX_BITRATE 3400000
90 #define HIGHSPEED_MAX_BITRATE 5000000
93 STANDARD, /* 100+Kbps */
95 FAST_PLUS, /* 1.0+Mbps */
97 ULTRA_FAST, /* 5.0+Mbps */
100 enum lpi2c_imx_pincfg {
107 struct lpi2c_imx_struct {
108 struct i2c_adapter adapter;
113 struct completion complete;
115 unsigned int delivered;
116 unsigned int block_data;
117 unsigned int bitrate;
118 unsigned int txfifosize;
119 unsigned int rxfifosize;
120 enum lpi2c_imx_mode mode;
123 static void lpi2c_imx_intctrl(struct lpi2c_imx_struct *lpi2c_imx,
126 writel(enable, lpi2c_imx->base + LPI2C_MIER);
129 static int lpi2c_imx_bus_busy(struct lpi2c_imx_struct *lpi2c_imx)
131 unsigned long orig_jiffies = jiffies;
135 temp = readl(lpi2c_imx->base + LPI2C_MSR);
137 /* check for arbitration lost, clear if set */
138 if (temp & MSR_ALF) {
139 writel(temp, lpi2c_imx->base + LPI2C_MSR);
143 if (temp & (MSR_BBF | MSR_MBF))
146 if (time_after(jiffies, orig_jiffies + msecs_to_jiffies(500))) {
147 dev_dbg(&lpi2c_imx->adapter.dev, "bus not work\n");
156 static void lpi2c_imx_set_mode(struct lpi2c_imx_struct *lpi2c_imx)
158 unsigned int bitrate = lpi2c_imx->bitrate;
159 enum lpi2c_imx_mode mode;
161 if (bitrate < STARDARD_MAX_BITRATE)
163 else if (bitrate < FAST_MAX_BITRATE)
165 else if (bitrate < FAST_PLUS_MAX_BITRATE)
167 else if (bitrate < HIGHSPEED_MAX_BITRATE)
172 lpi2c_imx->mode = mode;
175 static int lpi2c_imx_start(struct lpi2c_imx_struct *lpi2c_imx,
176 struct i2c_msg *msgs)
181 temp = readl(lpi2c_imx->base + LPI2C_MCR);
182 temp |= MCR_RRF | MCR_RTF;
183 writel(temp, lpi2c_imx->base + LPI2C_MCR);
184 writel(0x7f00, lpi2c_imx->base + LPI2C_MSR);
186 read = msgs->flags & I2C_M_RD;
187 temp = (msgs->addr << 1 | read) | (GEN_START << 8);
188 writel(temp, lpi2c_imx->base + LPI2C_MTDR);
190 return lpi2c_imx_bus_busy(lpi2c_imx);
193 static void lpi2c_imx_stop(struct lpi2c_imx_struct *lpi2c_imx)
195 unsigned long orig_jiffies = jiffies;
198 writel(GEN_STOP << 8, lpi2c_imx->base + LPI2C_MTDR);
201 temp = readl(lpi2c_imx->base + LPI2C_MSR);
205 if (time_after(jiffies, orig_jiffies + msecs_to_jiffies(500))) {
206 dev_dbg(&lpi2c_imx->adapter.dev, "stop timeout\n");
214 /* CLKLO = I2C_CLK_RATIO * CLKHI, SETHOLD = CLKHI, DATAVD = CLKHI/2 */
215 static int lpi2c_imx_config(struct lpi2c_imx_struct *lpi2c_imx)
217 u8 prescale, filt, sethold, clkhi, clklo, datavd;
218 unsigned int clk_rate, clk_cycle;
219 enum lpi2c_imx_pincfg pincfg;
222 lpi2c_imx_set_mode(lpi2c_imx);
224 clk_rate = clk_get_rate(lpi2c_imx->clk);
225 if (lpi2c_imx->mode == HS || lpi2c_imx->mode == ULTRA_FAST)
230 for (prescale = 0; prescale <= 7; prescale++) {
231 clk_cycle = clk_rate / ((1 << prescale) * lpi2c_imx->bitrate)
233 clkhi = (clk_cycle + I2C_CLK_RATIO) / (I2C_CLK_RATIO + 1);
234 clklo = clk_cycle - clkhi;
242 /* set MCFGR1: PINCFG, PRESCALE, IGNACK */
243 if (lpi2c_imx->mode == ULTRA_FAST)
247 temp = prescale | pincfg << 24;
249 if (lpi2c_imx->mode == ULTRA_FAST)
250 temp |= MCFGR1_IGNACK;
252 writel(temp, lpi2c_imx->base + LPI2C_MCFGR1);
254 /* set MCFGR2: FILTSDA, FILTSCL */
255 temp = (filt << 16) | (filt << 24);
256 writel(temp, lpi2c_imx->base + LPI2C_MCFGR2);
258 /* set MCCR: DATAVD, SETHOLD, CLKHI, CLKLO */
261 temp = datavd << 24 | sethold << 16 | clkhi << 8 | clklo;
263 if (lpi2c_imx->mode == HS)
264 writel(temp, lpi2c_imx->base + LPI2C_MCCR1);
266 writel(temp, lpi2c_imx->base + LPI2C_MCCR0);
271 static int lpi2c_imx_master_enable(struct lpi2c_imx_struct *lpi2c_imx)
276 ret = clk_enable(lpi2c_imx->clk);
281 writel(temp, lpi2c_imx->base + LPI2C_MCR);
282 writel(0, lpi2c_imx->base + LPI2C_MCR);
284 ret = lpi2c_imx_config(lpi2c_imx);
288 temp = readl(lpi2c_imx->base + LPI2C_MCR);
290 writel(temp, lpi2c_imx->base + LPI2C_MCR);
295 clk_disable(lpi2c_imx->clk);
300 static int lpi2c_imx_master_disable(struct lpi2c_imx_struct *lpi2c_imx)
304 temp = readl(lpi2c_imx->base + LPI2C_MCR);
306 writel(temp, lpi2c_imx->base + LPI2C_MCR);
308 clk_disable(lpi2c_imx->clk);
313 static int lpi2c_imx_msg_complete(struct lpi2c_imx_struct *lpi2c_imx)
315 unsigned long timeout;
317 timeout = wait_for_completion_timeout(&lpi2c_imx->complete, HZ);
319 return timeout ? 0 : -ETIMEDOUT;
322 static int lpi2c_imx_txfifo_empty(struct lpi2c_imx_struct *lpi2c_imx)
324 unsigned long orig_jiffies = jiffies;
328 txcnt = readl(lpi2c_imx->base + LPI2C_MFSR) & 0xff;
330 if (readl(lpi2c_imx->base + LPI2C_MSR) & MSR_NDF) {
331 dev_dbg(&lpi2c_imx->adapter.dev, "NDF detected\n");
335 if (time_after(jiffies, orig_jiffies + msecs_to_jiffies(500))) {
336 dev_dbg(&lpi2c_imx->adapter.dev, "txfifo empty timeout\n");
346 static void lpi2c_imx_set_tx_watermark(struct lpi2c_imx_struct *lpi2c_imx)
348 writel(lpi2c_imx->txfifosize >> 1, lpi2c_imx->base + LPI2C_MFCR);
351 static void lpi2c_imx_set_rx_watermark(struct lpi2c_imx_struct *lpi2c_imx)
353 unsigned int temp, remaining;
355 remaining = lpi2c_imx->msglen - lpi2c_imx->delivered;
357 if (remaining > (lpi2c_imx->rxfifosize >> 1))
358 temp = lpi2c_imx->rxfifosize >> 1;
362 writel(temp << 16, lpi2c_imx->base + LPI2C_MFCR);
365 static void lpi2c_imx_write_txfifo(struct lpi2c_imx_struct *lpi2c_imx)
367 unsigned int data, txcnt;
369 txcnt = readl(lpi2c_imx->base + LPI2C_MFSR) & 0xff;
371 while (txcnt < lpi2c_imx->txfifosize) {
372 if (lpi2c_imx->delivered == lpi2c_imx->msglen)
375 data = lpi2c_imx->tx_buf[lpi2c_imx->delivered++];
376 writel(data, lpi2c_imx->base + LPI2C_MTDR);
380 if (lpi2c_imx->delivered < lpi2c_imx->msglen)
381 lpi2c_imx_intctrl(lpi2c_imx, MIER_TDIE | MIER_NDIE);
383 complete(&lpi2c_imx->complete);
386 static void lpi2c_imx_read_rxfifo(struct lpi2c_imx_struct *lpi2c_imx)
388 unsigned int blocklen, remaining;
389 unsigned int temp, data;
392 data = readl(lpi2c_imx->base + LPI2C_MRDR);
393 if (data & MRDR_RXEMPTY)
396 lpi2c_imx->rx_buf[lpi2c_imx->delivered++] = data & 0xff;
400 * First byte is the length of remaining packet in the SMBus block
401 * data read. Add it to msgs->len.
403 if (lpi2c_imx->block_data) {
404 blocklen = lpi2c_imx->rx_buf[0];
405 lpi2c_imx->msglen += blocklen;
408 remaining = lpi2c_imx->msglen - lpi2c_imx->delivered;
411 complete(&lpi2c_imx->complete);
415 /* not finished, still waiting for rx data */
416 lpi2c_imx_set_rx_watermark(lpi2c_imx);
418 /* multiple receive commands */
419 if (lpi2c_imx->block_data) {
420 lpi2c_imx->block_data = 0;
422 temp |= (RECV_DATA << 8);
423 writel(temp, lpi2c_imx->base + LPI2C_MTDR);
424 } else if (!(lpi2c_imx->delivered & 0xff)) {
425 temp = (remaining > CHUNK_DATA ? CHUNK_DATA : remaining) - 1;
426 temp |= (RECV_DATA << 8);
427 writel(temp, lpi2c_imx->base + LPI2C_MTDR);
430 lpi2c_imx_intctrl(lpi2c_imx, MIER_RDIE);
433 static void lpi2c_imx_write(struct lpi2c_imx_struct *lpi2c_imx,
434 struct i2c_msg *msgs)
436 lpi2c_imx->tx_buf = msgs->buf;
437 lpi2c_imx_set_tx_watermark(lpi2c_imx);
438 lpi2c_imx_write_txfifo(lpi2c_imx);
441 static void lpi2c_imx_read(struct lpi2c_imx_struct *lpi2c_imx,
442 struct i2c_msg *msgs)
446 lpi2c_imx->rx_buf = msgs->buf;
447 lpi2c_imx->block_data = msgs->flags & I2C_M_RECV_LEN;
449 lpi2c_imx_set_rx_watermark(lpi2c_imx);
450 temp = msgs->len > CHUNK_DATA ? CHUNK_DATA - 1 : msgs->len - 1;
451 temp |= (RECV_DATA << 8);
452 writel(temp, lpi2c_imx->base + LPI2C_MTDR);
454 lpi2c_imx_intctrl(lpi2c_imx, MIER_RDIE | MIER_NDIE);
457 static int lpi2c_imx_xfer(struct i2c_adapter *adapter,
458 struct i2c_msg *msgs, int num)
460 struct lpi2c_imx_struct *lpi2c_imx = i2c_get_adapdata(adapter);
464 result = lpi2c_imx_master_enable(lpi2c_imx);
468 for (i = 0; i < num; i++) {
469 result = lpi2c_imx_start(lpi2c_imx, &msgs[i]);
474 if (num == 1 && msgs[0].len == 0)
477 lpi2c_imx->delivered = 0;
478 lpi2c_imx->msglen = msgs[i].len;
479 init_completion(&lpi2c_imx->complete);
481 if (msgs[i].flags & I2C_M_RD)
482 lpi2c_imx_read(lpi2c_imx, &msgs[i]);
484 lpi2c_imx_write(lpi2c_imx, &msgs[i]);
486 result = lpi2c_imx_msg_complete(lpi2c_imx);
490 if (!(msgs[i].flags & I2C_M_RD)) {
491 result = lpi2c_imx_txfifo_empty(lpi2c_imx);
498 lpi2c_imx_stop(lpi2c_imx);
500 temp = readl(lpi2c_imx->base + LPI2C_MSR);
501 if ((temp & MSR_NDF) && !result)
505 lpi2c_imx_master_disable(lpi2c_imx);
507 dev_dbg(&lpi2c_imx->adapter.dev, "<%s> exit with: %s: %d\n", __func__,
508 (result < 0) ? "error" : "success msg",
509 (result < 0) ? result : num);
511 return (result < 0) ? result : num;
514 static irqreturn_t lpi2c_imx_isr(int irq, void *dev_id)
516 struct lpi2c_imx_struct *lpi2c_imx = dev_id;
519 lpi2c_imx_intctrl(lpi2c_imx, 0);
520 temp = readl(lpi2c_imx->base + LPI2C_MSR);
523 lpi2c_imx_read_rxfifo(lpi2c_imx);
526 lpi2c_imx_write_txfifo(lpi2c_imx);
529 complete(&lpi2c_imx->complete);
534 static u32 lpi2c_imx_func(struct i2c_adapter *adapter)
536 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
537 I2C_FUNC_SMBUS_READ_BLOCK_DATA;
540 static struct i2c_algorithm lpi2c_imx_algo = {
541 .master_xfer = lpi2c_imx_xfer,
542 .functionality = lpi2c_imx_func,
545 static const struct of_device_id lpi2c_imx_of_match[] = {
546 { .compatible = "fsl,imx7ulp-lpi2c" },
547 { .compatible = "fsl,imx8dv-lpi2c" },
550 MODULE_DEVICE_TABLE(of, lpi2c_imx_of_match);
552 static int lpi2c_imx_probe(struct platform_device *pdev)
554 struct lpi2c_imx_struct *lpi2c_imx;
555 struct resource *res;
559 lpi2c_imx = devm_kzalloc(&pdev->dev, sizeof(*lpi2c_imx), GFP_KERNEL);
563 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
564 lpi2c_imx->base = devm_ioremap_resource(&pdev->dev, res);
565 if (IS_ERR(lpi2c_imx->base))
566 return PTR_ERR(lpi2c_imx->base);
568 irq = platform_get_irq(pdev, 0);
570 dev_err(&pdev->dev, "can't get irq number\n");
574 lpi2c_imx->adapter.owner = THIS_MODULE;
575 lpi2c_imx->adapter.algo = &lpi2c_imx_algo;
576 lpi2c_imx->adapter.dev.parent = &pdev->dev;
577 lpi2c_imx->adapter.dev.of_node = pdev->dev.of_node;
578 strlcpy(lpi2c_imx->adapter.name, pdev->name,
579 sizeof(lpi2c_imx->adapter.name));
581 lpi2c_imx->clk = devm_clk_get(&pdev->dev, NULL);
582 if (IS_ERR(lpi2c_imx->clk)) {
583 dev_err(&pdev->dev, "can't get I2C peripheral clock\n");
584 return PTR_ERR(lpi2c_imx->clk);
587 ret = of_property_read_u32(pdev->dev.of_node,
588 "clock-frequency", &lpi2c_imx->bitrate);
590 lpi2c_imx->bitrate = LPI2C_DEFAULT_RATE;
592 ret = devm_request_irq(&pdev->dev, irq, lpi2c_imx_isr, 0,
593 pdev->name, lpi2c_imx);
595 dev_err(&pdev->dev, "can't claim irq %d\n", irq);
599 i2c_set_adapdata(&lpi2c_imx->adapter, lpi2c_imx);
600 platform_set_drvdata(pdev, lpi2c_imx);
602 ret = clk_prepare_enable(lpi2c_imx->clk);
604 dev_err(&pdev->dev, "clk enable failed %d\n", ret);
608 temp = readl(lpi2c_imx->base + LPI2C_PARAM);
609 lpi2c_imx->txfifosize = 1 << (temp & 0x0f);
610 lpi2c_imx->rxfifosize = 1 << ((temp >> 8) & 0x0f);
612 clk_disable(lpi2c_imx->clk);
614 ret = i2c_add_adapter(&lpi2c_imx->adapter);
618 dev_info(&lpi2c_imx->adapter.dev, "LPI2C adapter registered\n");
623 clk_unprepare(lpi2c_imx->clk);
628 static int lpi2c_imx_remove(struct platform_device *pdev)
630 struct lpi2c_imx_struct *lpi2c_imx = platform_get_drvdata(pdev);
632 i2c_del_adapter(&lpi2c_imx->adapter);
634 clk_unprepare(lpi2c_imx->clk);
639 static struct platform_driver lpi2c_imx_driver = {
640 .probe = lpi2c_imx_probe,
641 .remove = lpi2c_imx_remove,
644 .of_match_table = lpi2c_imx_of_match,
648 module_platform_driver(lpi2c_imx_driver);
650 MODULE_AUTHOR("Gao Pan <pandy.gao@nxp.com>");
651 MODULE_DESCRIPTION("I2C adapter driver for LPI2C bus");
652 MODULE_LICENSE("GPL");