1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (c) 2017-2018, The Linux Foundation. All rights reserved.
5 #include <linux/dma-mapping.h>
8 #include <linux/interrupt.h>
10 #include <linux/module.h>
12 #include <linux/of_platform.h>
13 #include <linux/platform_device.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/qcom-geni-se.h>
16 #include <linux/spinlock.h>
18 #define SE_I2C_TX_TRANS_LEN 0x26c
19 #define SE_I2C_RX_TRANS_LEN 0x270
20 #define SE_I2C_SCL_COUNTERS 0x278
22 #define SE_I2C_ERR (M_CMD_OVERRUN_EN | M_ILLEGAL_CMD_EN | M_CMD_FAILURE_EN |\
23 M_GP_IRQ_1_EN | M_GP_IRQ_3_EN | M_GP_IRQ_4_EN)
24 #define SE_I2C_ABORT BIT(1)
26 /* M_CMD OP codes for I2C */
29 #define I2C_WRITE_READ 0x3
30 #define I2C_ADDR_ONLY 0x4
31 #define I2C_BUS_CLEAR 0x6
32 #define I2C_STOP_ON_BUS 0x7
33 /* M_CMD params for I2C */
34 #define PRE_CMD_DELAY BIT(0)
35 #define TIMESTAMP_BEFORE BIT(1)
36 #define STOP_STRETCH BIT(2)
37 #define TIMESTAMP_AFTER BIT(3)
38 #define POST_COMMAND_DELAY BIT(4)
39 #define IGNORE_ADD_NACK BIT(6)
40 #define READ_FINISHED_WITH_ACK BIT(7)
41 #define BYPASS_ADDR_PHASE BIT(8)
42 #define SLV_ADDR_MSK GENMASK(15, 9)
43 #define SLV_ADDR_SHFT 9
44 /* I2C SCL COUNTER fields */
45 #define HIGH_COUNTER_MSK GENMASK(29, 20)
46 #define HIGH_COUNTER_SHFT 20
47 #define LOW_COUNTER_MSK GENMASK(19, 10)
48 #define LOW_COUNTER_SHFT 10
49 #define CYCLE_COUNTER_MSK GENMASK(9, 0)
51 enum geni_i2c_err_code {
64 #define DM_I2C_CB_ERR ((BIT(NACK) | BIT(BUS_PROTO) | BIT(ARB_LOST)) \
67 #define I2C_AUTO_SUSPEND_DELAY 250
68 #define KHZ(freq) (1000 * freq)
69 #define PACKING_BYTES_PW 4
71 #define ABORT_TIMEOUT HZ
72 #define XFER_TIMEOUT HZ
73 #define RST_TIMEOUT HZ
80 struct i2c_adapter adap;
81 struct completion done;
87 const struct geni_i2c_clk_fld *clk_fld;
91 struct geni_i2c_err_log {
96 static const struct geni_i2c_err_log gi2c_log[] = {
97 [GP_IRQ0] = {-EIO, "Unknown I2C err GP_IRQ0"},
98 [NACK] = {-ENXIO, "NACK: slv unresponsive, check its power/reset-ln"},
99 [GP_IRQ2] = {-EIO, "Unknown I2C err GP IRQ2"},
100 [BUS_PROTO] = {-EPROTO, "Bus proto err, noisy/unepxected start/stop"},
101 [ARB_LOST] = {-EAGAIN, "Bus arbitration lost, clock line undriveable"},
102 [GP_IRQ5] = {-EIO, "Unknown I2C err GP IRQ5"},
103 [GENI_OVERRUN] = {-EIO, "Cmd overrun, check GENI cmd-state machine"},
104 [GENI_ILLEGAL_CMD] = {-EIO, "Illegal cmd, check GENI cmd-state machine"},
105 [GENI_ABORT_DONE] = {-ETIMEDOUT, "Abort after timeout successful"},
106 [GENI_TIMEOUT] = {-ETIMEDOUT, "I2C TXN timed out"},
109 struct geni_i2c_clk_fld {
118 * Hardware uses the underlying formula to calculate time periods of
119 * SCL clock cycle. Firmware uses some additional cycles excluded from the
120 * below formula and it is confirmed that the time periods are within
121 * specification limits.
123 * time of high period of SCL: t_high = (t_high_cnt * clk_div) / source_clock
124 * time of low period of SCL: t_low = (t_low_cnt * clk_div) / source_clock
125 * time of full period of SCL: t_cycle = (t_cycle_cnt * clk_div) / source_clock
126 * clk_freq_out = t / t_cycle
127 * source_clock = 19.2 MHz
129 static const struct geni_i2c_clk_fld geni_i2c_clk_map[] = {
130 {KHZ(100), 7, 10, 11, 26},
131 {KHZ(400), 2, 5, 12, 24},
132 {KHZ(1000), 1, 3, 9, 18},
135 static int geni_i2c_clk_map_idx(struct geni_i2c_dev *gi2c)
138 const struct geni_i2c_clk_fld *itr = geni_i2c_clk_map;
140 for (i = 0; i < ARRAY_SIZE(geni_i2c_clk_map); i++, itr++) {
141 if (itr->clk_freq_out == gi2c->clk_freq_out) {
149 static void qcom_geni_i2c_conf(struct geni_i2c_dev *gi2c)
151 const struct geni_i2c_clk_fld *itr = gi2c->clk_fld;
154 writel_relaxed(0, gi2c->se.base + SE_GENI_CLK_SEL);
156 val = (itr->clk_div << CLK_DIV_SHFT) | SER_CLK_EN;
157 writel_relaxed(val, gi2c->se.base + GENI_SER_M_CLK_CFG);
159 val = itr->t_high_cnt << HIGH_COUNTER_SHFT;
160 val |= itr->t_low_cnt << LOW_COUNTER_SHFT;
161 val |= itr->t_cycle_cnt;
162 writel_relaxed(val, gi2c->se.base + SE_I2C_SCL_COUNTERS);
165 static void geni_i2c_err_misc(struct geni_i2c_dev *gi2c)
167 u32 m_cmd = readl_relaxed(gi2c->se.base + SE_GENI_M_CMD0);
168 u32 m_stat = readl_relaxed(gi2c->se.base + SE_GENI_M_IRQ_STATUS);
169 u32 geni_s = readl_relaxed(gi2c->se.base + SE_GENI_STATUS);
170 u32 geni_ios = readl_relaxed(gi2c->se.base + SE_GENI_IOS);
171 u32 dma = readl_relaxed(gi2c->se.base + SE_GENI_DMA_MODE_EN);
175 rx_st = readl_relaxed(gi2c->se.base + SE_DMA_RX_IRQ_STAT);
176 tx_st = readl_relaxed(gi2c->se.base + SE_DMA_TX_IRQ_STAT);
178 rx_st = readl_relaxed(gi2c->se.base + SE_GENI_RX_FIFO_STATUS);
179 tx_st = readl_relaxed(gi2c->se.base + SE_GENI_TX_FIFO_STATUS);
181 dev_dbg(gi2c->se.dev, "DMA:%d tx_stat:0x%x, rx_stat:0x%x, irq-stat:0x%x\n",
182 dma, tx_st, rx_st, m_stat);
183 dev_dbg(gi2c->se.dev, "m_cmd:0x%x, geni_status:0x%x, geni_ios:0x%x\n",
184 m_cmd, geni_s, geni_ios);
187 static void geni_i2c_err(struct geni_i2c_dev *gi2c, int err)
190 gi2c->err = gi2c_log[err].err;
192 dev_dbg(gi2c->se.dev, "len:%d, slv-addr:0x%x, RD/WR:%d\n",
193 gi2c->cur->len, gi2c->cur->addr, gi2c->cur->flags);
195 if (err != NACK && err != GENI_ABORT_DONE) {
196 dev_err(gi2c->se.dev, "%s\n", gi2c_log[err].msg);
197 geni_i2c_err_misc(gi2c);
201 static irqreturn_t geni_i2c_irq(int irq, void *dev)
203 struct geni_i2c_dev *gi2c = dev;
213 spin_lock_irqsave(&gi2c->lock, flags);
214 m_stat = readl_relaxed(gi2c->se.base + SE_GENI_M_IRQ_STATUS);
215 rx_st = readl_relaxed(gi2c->se.base + SE_GENI_RX_FIFO_STATUS);
216 dm_tx_st = readl_relaxed(gi2c->se.base + SE_DMA_TX_IRQ_STAT);
217 dm_rx_st = readl_relaxed(gi2c->se.base + SE_DMA_RX_IRQ_STAT);
218 dma = readl_relaxed(gi2c->se.base + SE_GENI_DMA_MODE_EN);
222 m_stat & (M_CMD_FAILURE_EN | M_CMD_ABORT_EN) ||
223 dm_rx_st & (DM_I2C_CB_ERR)) {
224 if (m_stat & M_GP_IRQ_1_EN)
225 geni_i2c_err(gi2c, NACK);
226 if (m_stat & M_GP_IRQ_3_EN)
227 geni_i2c_err(gi2c, BUS_PROTO);
228 if (m_stat & M_GP_IRQ_4_EN)
229 geni_i2c_err(gi2c, ARB_LOST);
230 if (m_stat & M_CMD_OVERRUN_EN)
231 geni_i2c_err(gi2c, GENI_OVERRUN);
232 if (m_stat & M_ILLEGAL_CMD_EN)
233 geni_i2c_err(gi2c, GENI_ILLEGAL_CMD);
234 if (m_stat & M_CMD_ABORT_EN)
235 geni_i2c_err(gi2c, GENI_ABORT_DONE);
236 if (m_stat & M_GP_IRQ_0_EN)
237 geni_i2c_err(gi2c, GP_IRQ0);
239 /* Disable the TX Watermark interrupt to stop TX */
241 writel_relaxed(0, gi2c->se.base +
242 SE_GENI_TX_WATERMARK_REG);
247 dev_dbg(gi2c->se.dev, "i2c dma tx:0x%x, dma rx:0x%x\n",
252 if (cur->flags & I2C_M_RD &&
253 m_stat & (M_RX_FIFO_WATERMARK_EN | M_RX_FIFO_LAST_EN)) {
254 u32 rxcnt = rx_st & RX_FIFO_WC_MSK;
256 for (j = 0; j < rxcnt; j++) {
260 val = readl_relaxed(gi2c->se.base + SE_GENI_RX_FIFOn);
261 while (gi2c->cur_rd < cur->len && p < sizeof(val)) {
262 cur->buf[gi2c->cur_rd++] = val & 0xff;
266 if (gi2c->cur_rd == cur->len)
269 } else if (!(cur->flags & I2C_M_RD) &&
270 m_stat & M_TX_FIFO_WATERMARK_EN) {
271 for (j = 0; j < gi2c->tx_wm; j++) {
276 while (gi2c->cur_wr < cur->len && p < sizeof(val)) {
277 temp = cur->buf[gi2c->cur_wr++];
278 val |= temp << (p * 8);
281 writel_relaxed(val, gi2c->se.base + SE_GENI_TX_FIFOn);
282 /* TX Complete, Disable the TX Watermark interrupt */
283 if (gi2c->cur_wr == cur->len) {
284 writel_relaxed(0, gi2c->se.base +
285 SE_GENI_TX_WATERMARK_REG);
292 writel_relaxed(m_stat, gi2c->se.base + SE_GENI_M_IRQ_CLEAR);
296 writel_relaxed(dm_tx_st, gi2c->se.base +
299 writel_relaxed(dm_rx_st, gi2c->se.base +
302 /* if this is err with done-bit not set, handle that through timeout. */
303 if (m_stat & M_CMD_DONE_EN || m_stat & M_CMD_ABORT_EN)
304 complete(&gi2c->done);
305 else if (dm_tx_st & TX_DMA_DONE || dm_tx_st & TX_RESET_DONE)
306 complete(&gi2c->done);
307 else if (dm_rx_st & RX_DMA_DONE || dm_rx_st & RX_RESET_DONE)
308 complete(&gi2c->done);
310 spin_unlock_irqrestore(&gi2c->lock, flags);
314 static void geni_i2c_abort_xfer(struct geni_i2c_dev *gi2c)
317 unsigned long time_left = ABORT_TIMEOUT;
320 spin_lock_irqsave(&gi2c->lock, flags);
321 geni_i2c_err(gi2c, GENI_TIMEOUT);
323 geni_se_abort_m_cmd(&gi2c->se);
324 spin_unlock_irqrestore(&gi2c->lock, flags);
326 time_left = wait_for_completion_timeout(&gi2c->done, time_left);
327 val = readl_relaxed(gi2c->se.base + SE_GENI_M_IRQ_STATUS);
328 } while (!(val & M_CMD_ABORT_EN) && time_left);
330 if (!(val & M_CMD_ABORT_EN))
331 dev_err(gi2c->se.dev, "Timeout abort_m_cmd\n");
334 static void geni_i2c_rx_fsm_rst(struct geni_i2c_dev *gi2c)
337 unsigned long time_left = RST_TIMEOUT;
339 writel_relaxed(1, gi2c->se.base + SE_DMA_RX_FSM_RST);
341 time_left = wait_for_completion_timeout(&gi2c->done, time_left);
342 val = readl_relaxed(gi2c->se.base + SE_DMA_RX_IRQ_STAT);
343 } while (!(val & RX_RESET_DONE) && time_left);
345 if (!(val & RX_RESET_DONE))
346 dev_err(gi2c->se.dev, "Timeout resetting RX_FSM\n");
349 static void geni_i2c_tx_fsm_rst(struct geni_i2c_dev *gi2c)
352 unsigned long time_left = RST_TIMEOUT;
354 writel_relaxed(1, gi2c->se.base + SE_DMA_TX_FSM_RST);
356 time_left = wait_for_completion_timeout(&gi2c->done, time_left);
357 val = readl_relaxed(gi2c->se.base + SE_DMA_TX_IRQ_STAT);
358 } while (!(val & TX_RESET_DONE) && time_left);
360 if (!(val & TX_RESET_DONE))
361 dev_err(gi2c->se.dev, "Timeout resetting TX_FSM\n");
364 static int geni_i2c_rx_one_msg(struct geni_i2c_dev *gi2c, struct i2c_msg *msg,
368 enum geni_se_xfer_mode mode;
369 unsigned long time_left = XFER_TIMEOUT;
372 mode = msg->len > 32 ? GENI_SE_DMA : GENI_SE_FIFO;
373 geni_se_select_mode(&gi2c->se, mode);
374 writel_relaxed(msg->len, gi2c->se.base + SE_I2C_RX_TRANS_LEN);
375 geni_se_setup_m_cmd(&gi2c->se, I2C_READ, m_param);
376 if (mode == GENI_SE_DMA) {
379 ret = geni_se_rx_dma_prep(&gi2c->se, msg->buf, msg->len,
383 geni_se_select_mode(&gi2c->se, mode);
387 time_left = wait_for_completion_timeout(&gi2c->done, XFER_TIMEOUT);
389 geni_i2c_abort_xfer(gi2c);
392 if (mode == GENI_SE_DMA) {
394 geni_i2c_rx_fsm_rst(gi2c);
395 geni_se_rx_dma_unprep(&gi2c->se, rx_dma, msg->len);
400 static int geni_i2c_tx_one_msg(struct geni_i2c_dev *gi2c, struct i2c_msg *msg,
404 enum geni_se_xfer_mode mode;
405 unsigned long time_left;
408 mode = msg->len > 32 ? GENI_SE_DMA : GENI_SE_FIFO;
409 geni_se_select_mode(&gi2c->se, mode);
410 writel_relaxed(msg->len, gi2c->se.base + SE_I2C_TX_TRANS_LEN);
411 geni_se_setup_m_cmd(&gi2c->se, I2C_WRITE, m_param);
412 if (mode == GENI_SE_DMA) {
415 ret = geni_se_tx_dma_prep(&gi2c->se, msg->buf, msg->len,
419 geni_se_select_mode(&gi2c->se, mode);
423 if (mode == GENI_SE_FIFO) /* Get FIFO IRQ */
424 writel_relaxed(1, gi2c->se.base + SE_GENI_TX_WATERMARK_REG);
426 time_left = wait_for_completion_timeout(&gi2c->done, XFER_TIMEOUT);
428 geni_i2c_abort_xfer(gi2c);
431 if (mode == GENI_SE_DMA) {
433 geni_i2c_tx_fsm_rst(gi2c);
434 geni_se_tx_dma_unprep(&gi2c->se, tx_dma, msg->len);
439 static int geni_i2c_xfer(struct i2c_adapter *adap,
440 struct i2c_msg msgs[],
443 struct geni_i2c_dev *gi2c = i2c_get_adapdata(adap);
447 reinit_completion(&gi2c->done);
448 ret = pm_runtime_get_sync(gi2c->se.dev);
450 dev_err(gi2c->se.dev, "error turning SE resources:%d\n", ret);
451 pm_runtime_put_noidle(gi2c->se.dev);
452 /* Set device in suspended since resume failed */
453 pm_runtime_set_suspended(gi2c->se.dev);
457 qcom_geni_i2c_conf(gi2c);
458 for (i = 0; i < num; i++) {
459 u32 m_param = i < (num - 1) ? STOP_STRETCH : 0;
461 m_param |= ((msgs[i].addr << SLV_ADDR_SHFT) & SLV_ADDR_MSK);
463 if (msgs[i].flags & I2C_M_RD)
464 ret = geni_i2c_rx_one_msg(gi2c, &msgs[i], m_param);
466 ret = geni_i2c_tx_one_msg(gi2c, &msgs[i], m_param);
474 pm_runtime_mark_last_busy(gi2c->se.dev);
475 pm_runtime_put_autosuspend(gi2c->se.dev);
481 static u32 geni_i2c_func(struct i2c_adapter *adap)
483 return I2C_FUNC_I2C | (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK);
486 static const struct i2c_algorithm geni_i2c_algo = {
487 .master_xfer = geni_i2c_xfer,
488 .functionality = geni_i2c_func,
491 static int geni_i2c_probe(struct platform_device *pdev)
493 struct geni_i2c_dev *gi2c;
494 struct resource *res;
498 gi2c = devm_kzalloc(&pdev->dev, sizeof(*gi2c), GFP_KERNEL);
502 gi2c->se.dev = &pdev->dev;
503 gi2c->se.wrapper = dev_get_drvdata(pdev->dev.parent);
504 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
505 gi2c->se.base = devm_ioremap_resource(&pdev->dev, res);
506 if (IS_ERR(gi2c->se.base))
507 return PTR_ERR(gi2c->se.base);
509 gi2c->se.clk = devm_clk_get(&pdev->dev, "se");
510 if (IS_ERR(gi2c->se.clk)) {
511 ret = PTR_ERR(gi2c->se.clk);
512 dev_err(&pdev->dev, "Err getting SE Core clk %d\n", ret);
516 ret = device_property_read_u32(&pdev->dev, "clock-frequency",
517 &gi2c->clk_freq_out);
520 "Bus frequency not specified, default to 100kHz.\n");
521 gi2c->clk_freq_out = KHZ(100);
524 gi2c->irq = platform_get_irq(pdev, 0);
526 dev_err(&pdev->dev, "IRQ error for i2c-geni\n");
530 ret = geni_i2c_clk_map_idx(gi2c);
532 dev_err(&pdev->dev, "Invalid clk frequency %d Hz: %d\n",
533 gi2c->clk_freq_out, ret);
537 gi2c->adap.algo = &geni_i2c_algo;
538 init_completion(&gi2c->done);
539 spin_lock_init(&gi2c->lock);
540 platform_set_drvdata(pdev, gi2c);
541 ret = devm_request_irq(&pdev->dev, gi2c->irq, geni_i2c_irq,
542 IRQF_TRIGGER_HIGH, "i2c_geni", gi2c);
544 dev_err(&pdev->dev, "Request_irq failed:%d: err:%d\n",
548 /* Disable the interrupt so that the system can enter low-power mode */
549 disable_irq(gi2c->irq);
550 i2c_set_adapdata(&gi2c->adap, gi2c);
551 gi2c->adap.dev.parent = &pdev->dev;
552 gi2c->adap.dev.of_node = pdev->dev.of_node;
553 strlcpy(gi2c->adap.name, "Geni-I2C", sizeof(gi2c->adap.name));
555 ret = geni_se_resources_on(&gi2c->se);
557 dev_err(&pdev->dev, "Error turning on resources %d\n", ret);
560 proto = geni_se_read_proto(&gi2c->se);
561 tx_depth = geni_se_get_tx_fifo_depth(&gi2c->se);
562 if (proto != GENI_SE_I2C) {
563 dev_err(&pdev->dev, "Invalid proto %d\n", proto);
564 geni_se_resources_off(&gi2c->se);
567 gi2c->tx_wm = tx_depth - 1;
568 geni_se_init(&gi2c->se, gi2c->tx_wm, tx_depth);
569 geni_se_config_packing(&gi2c->se, BITS_PER_BYTE, PACKING_BYTES_PW,
571 ret = geni_se_resources_off(&gi2c->se);
573 dev_err(&pdev->dev, "Error turning off resources %d\n", ret);
577 dev_dbg(&pdev->dev, "i2c fifo/se-dma mode. fifo depth:%d\n", tx_depth);
579 ret = i2c_add_adapter(&gi2c->adap);
581 dev_err(&pdev->dev, "Error adding i2c adapter %d\n", ret);
586 pm_runtime_set_suspended(gi2c->se.dev);
587 pm_runtime_set_autosuspend_delay(gi2c->se.dev, I2C_AUTO_SUSPEND_DELAY);
588 pm_runtime_use_autosuspend(gi2c->se.dev);
589 pm_runtime_enable(gi2c->se.dev);
594 static int geni_i2c_remove(struct platform_device *pdev)
596 struct geni_i2c_dev *gi2c = platform_get_drvdata(pdev);
598 pm_runtime_disable(gi2c->se.dev);
599 i2c_del_adapter(&gi2c->adap);
603 static int __maybe_unused geni_i2c_runtime_suspend(struct device *dev)
606 struct geni_i2c_dev *gi2c = dev_get_drvdata(dev);
608 disable_irq(gi2c->irq);
609 ret = geni_se_resources_off(&gi2c->se);
611 enable_irq(gi2c->irq);
621 static int __maybe_unused geni_i2c_runtime_resume(struct device *dev)
624 struct geni_i2c_dev *gi2c = dev_get_drvdata(dev);
626 ret = geni_se_resources_on(&gi2c->se);
630 enable_irq(gi2c->irq);
635 static int __maybe_unused geni_i2c_suspend_noirq(struct device *dev)
637 struct geni_i2c_dev *gi2c = dev_get_drvdata(dev);
639 if (!gi2c->suspended) {
640 geni_i2c_runtime_suspend(dev);
641 pm_runtime_disable(dev);
642 pm_runtime_set_suspended(dev);
643 pm_runtime_enable(dev);
648 static const struct dev_pm_ops geni_i2c_pm_ops = {
649 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(geni_i2c_suspend_noirq, NULL)
650 SET_RUNTIME_PM_OPS(geni_i2c_runtime_suspend, geni_i2c_runtime_resume,
654 static const struct of_device_id geni_i2c_dt_match[] = {
655 { .compatible = "qcom,geni-i2c" },
658 MODULE_DEVICE_TABLE(of, geni_i2c_dt_match);
660 static struct platform_driver geni_i2c_driver = {
661 .probe = geni_i2c_probe,
662 .remove = geni_i2c_remove,
665 .pm = &geni_i2c_pm_ops,
666 .of_match_table = geni_i2c_dt_match,
670 module_platform_driver(geni_i2c_driver);
672 MODULE_DESCRIPTION("I2C Controller Driver for GENI based QUP cores");
673 MODULE_LICENSE("GPL v2");