2 * Copyright (c) 2009-2013, The Linux Foundation. All rights reserved.
3 * Copyright (c) 2014, Sony Mobile Communications AB.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 and
8 * only version 2 as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
17 #include <linux/atomic.h>
18 #include <linux/clk.h>
19 #include <linux/delay.h>
20 #include <linux/dmaengine.h>
21 #include <linux/dmapool.h>
22 #include <linux/dma-mapping.h>
23 #include <linux/err.h>
24 #include <linux/i2c.h>
25 #include <linux/interrupt.h>
27 #include <linux/module.h>
29 #include <linux/platform_device.h>
30 #include <linux/pm_runtime.h>
31 #include <linux/scatterlist.h>
34 #define QUP_CONFIG 0x000
35 #define QUP_STATE 0x004
36 #define QUP_IO_MODE 0x008
37 #define QUP_SW_RESET 0x00c
38 #define QUP_OPERATIONAL 0x018
39 #define QUP_ERROR_FLAGS 0x01c
40 #define QUP_ERROR_FLAGS_EN 0x020
41 #define QUP_OPERATIONAL_MASK 0x028
42 #define QUP_HW_VERSION 0x030
43 #define QUP_MX_OUTPUT_CNT 0x100
44 #define QUP_OUT_FIFO_BASE 0x110
45 #define QUP_MX_WRITE_CNT 0x150
46 #define QUP_MX_INPUT_CNT 0x200
47 #define QUP_MX_READ_CNT 0x208
48 #define QUP_IN_FIFO_BASE 0x218
49 #define QUP_I2C_CLK_CTL 0x400
50 #define QUP_I2C_STATUS 0x404
51 #define QUP_I2C_MASTER_GEN 0x408
53 /* QUP States and reset values */
54 #define QUP_RESET_STATE 0
55 #define QUP_RUN_STATE 1
56 #define QUP_PAUSE_STATE 3
57 #define QUP_STATE_MASK 3
59 #define QUP_STATE_VALID BIT(2)
60 #define QUP_I2C_MAST_GEN BIT(4)
61 #define QUP_I2C_FLUSH BIT(6)
63 #define QUP_OPERATIONAL_RESET 0x000ff0
64 #define QUP_I2C_STATUS_RESET 0xfffffc
66 /* QUP OPERATIONAL FLAGS */
67 #define QUP_I2C_NACK_FLAG BIT(3)
68 #define QUP_OUT_NOT_EMPTY BIT(4)
69 #define QUP_IN_NOT_EMPTY BIT(5)
70 #define QUP_OUT_FULL BIT(6)
71 #define QUP_OUT_SVC_FLAG BIT(8)
72 #define QUP_IN_SVC_FLAG BIT(9)
73 #define QUP_MX_OUTPUT_DONE BIT(10)
74 #define QUP_MX_INPUT_DONE BIT(11)
76 /* I2C mini core related values */
77 #define QUP_CLOCK_AUTO_GATE BIT(13)
78 #define I2C_MINI_CORE (2 << 8)
80 #define I2C_N_VAL_V2 7
82 /* Most significant word offset in FIFO port */
83 #define QUP_MSW_SHIFT (I2C_N_VAL + 1)
85 /* Packing/Unpacking words in FIFOs, and IO modes */
86 #define QUP_OUTPUT_BLK_MODE (1 << 10)
87 #define QUP_OUTPUT_BAM_MODE (3 << 10)
88 #define QUP_INPUT_BLK_MODE (1 << 12)
89 #define QUP_INPUT_BAM_MODE (3 << 12)
90 #define QUP_BAM_MODE (QUP_OUTPUT_BAM_MODE | QUP_INPUT_BAM_MODE)
91 #define QUP_UNPACK_EN BIT(14)
92 #define QUP_PACK_EN BIT(15)
94 #define QUP_REPACK_EN (QUP_UNPACK_EN | QUP_PACK_EN)
95 #define QUP_V2_TAGS_EN 1
97 #define QUP_OUTPUT_BLOCK_SIZE(x)(((x) >> 0) & 0x03)
98 #define QUP_OUTPUT_FIFO_SIZE(x) (((x) >> 2) & 0x07)
99 #define QUP_INPUT_BLOCK_SIZE(x) (((x) >> 5) & 0x03)
100 #define QUP_INPUT_FIFO_SIZE(x) (((x) >> 7) & 0x07)
103 #define QUP_TAG_START (1 << 8)
104 #define QUP_TAG_DATA (2 << 8)
105 #define QUP_TAG_STOP (3 << 8)
106 #define QUP_TAG_REC (4 << 8)
107 #define QUP_BAM_INPUT_EOT 0x93
108 #define QUP_BAM_FLUSH_STOP 0x96
111 #define QUP_TAG_V2_START 0x81
112 #define QUP_TAG_V2_DATAWR 0x82
113 #define QUP_TAG_V2_DATAWR_STOP 0x83
114 #define QUP_TAG_V2_DATARD 0x85
115 #define QUP_TAG_V2_DATARD_STOP 0x87
117 /* Status, Error flags */
118 #define I2C_STATUS_WR_BUFFER_FULL BIT(0)
119 #define I2C_STATUS_BUS_ACTIVE BIT(8)
120 #define I2C_STATUS_ERROR_MASK 0x38000fc
121 #define QUP_STATUS_ERROR_FLAGS 0x7c
123 #define QUP_READ_LIMIT 256
125 #define RESET_BIT 0x0
127 #define QUP_I2C_MX_CONFIG_DURING_RUN BIT(31)
129 #define MX_TX_RX_LEN SZ_64K
130 #define MX_BLOCKS (MX_TX_RX_LEN / QUP_READ_LIMIT)
132 /* Max timeout in ms for 32k bytes */
135 struct qup_i2c_block {
150 struct qup_i2c_tag tag;
151 struct dma_chan *dma;
152 struct scatterlist *sg;
161 struct i2c_adapter adap;
169 unsigned long one_byte_t;
170 struct qup_i2c_block blk;
173 /* Current posion in user message buffer */
175 /* I2C protocol errors */
177 /* QUP core errors */
180 /* To check if this is the last msg */
183 /* To configure when bus is in run state */
188 struct dma_pool *dpool;
189 struct qup_i2c_tag start_tag;
190 struct qup_i2c_bam brx;
191 struct qup_i2c_bam btx;
193 struct completion xfer;
196 static irqreturn_t qup_i2c_interrupt(int irq, void *dev)
198 struct qup_i2c_dev *qup = dev;
203 bus_err = readl(qup->base + QUP_I2C_STATUS);
204 qup_err = readl(qup->base + QUP_ERROR_FLAGS);
205 opflags = readl(qup->base + QUP_OPERATIONAL);
208 /* Clear Error interrupt */
209 writel(QUP_RESET_STATE, qup->base + QUP_STATE);
213 bus_err &= I2C_STATUS_ERROR_MASK;
214 qup_err &= QUP_STATUS_ERROR_FLAGS;
216 /* Clear the error bits in QUP_ERROR_FLAGS */
218 writel(qup_err, qup->base + QUP_ERROR_FLAGS);
220 /* Clear the error bits in QUP_I2C_STATUS */
222 writel(bus_err, qup->base + QUP_I2C_STATUS);
224 /* Reset the QUP State in case of error */
225 if (qup_err || bus_err) {
226 writel(QUP_RESET_STATE, qup->base + QUP_STATE);
230 if (opflags & QUP_IN_SVC_FLAG)
231 writel(QUP_IN_SVC_FLAG, qup->base + QUP_OPERATIONAL);
233 if (opflags & QUP_OUT_SVC_FLAG)
234 writel(QUP_OUT_SVC_FLAG, qup->base + QUP_OPERATIONAL);
237 qup->qup_err = qup_err;
238 qup->bus_err = bus_err;
239 complete(&qup->xfer);
243 static int qup_i2c_poll_state_mask(struct qup_i2c_dev *qup,
244 u32 req_state, u32 req_mask)
250 * State transition takes 3 AHB clocks cycles + 3 I2C master clock
251 * cycles. So retry once after a 1uS delay.
254 state = readl(qup->base + QUP_STATE);
256 if (state & QUP_STATE_VALID &&
257 (state & req_mask) == req_state)
266 static int qup_i2c_poll_state(struct qup_i2c_dev *qup, u32 req_state)
268 return qup_i2c_poll_state_mask(qup, req_state, QUP_STATE_MASK);
271 static void qup_i2c_flush(struct qup_i2c_dev *qup)
273 u32 val = readl(qup->base + QUP_STATE);
275 val |= QUP_I2C_FLUSH;
276 writel(val, qup->base + QUP_STATE);
279 static int qup_i2c_poll_state_valid(struct qup_i2c_dev *qup)
281 return qup_i2c_poll_state_mask(qup, 0, 0);
284 static int qup_i2c_poll_state_i2c_master(struct qup_i2c_dev *qup)
286 return qup_i2c_poll_state_mask(qup, QUP_I2C_MAST_GEN, QUP_I2C_MAST_GEN);
289 static int qup_i2c_change_state(struct qup_i2c_dev *qup, u32 state)
291 if (qup_i2c_poll_state_valid(qup) != 0)
294 writel(state, qup->base + QUP_STATE);
296 if (qup_i2c_poll_state(qup, state) != 0)
302 * qup_i2c_wait_ready - wait for a give number of bytes in tx/rx path
303 * @qup: The qup_i2c_dev device
304 * @op: The bit/event to wait on
305 * @val: value of the bit to wait on, 0 or 1
306 * @len: The length the bytes to be transferred
308 static int qup_i2c_wait_ready(struct qup_i2c_dev *qup, int op, bool val,
311 unsigned long timeout;
314 u32 shift = __ffs(op);
317 len *= qup->one_byte_t;
318 /* timeout after a wait of twice the max time */
319 timeout = jiffies + len * 4;
322 opflags = readl(qup->base + QUP_OPERATIONAL);
323 status = readl(qup->base + QUP_I2C_STATUS);
325 if (((opflags & op) >> shift) == val) {
326 if ((op == QUP_OUT_NOT_EMPTY) && qup->is_last) {
327 if (!(status & I2C_STATUS_BUS_ACTIVE)) {
337 if (time_after(jiffies, timeout)) {
341 usleep_range(len, len * 2);
345 if (qup->bus_err || qup->qup_err)
346 ret = (qup->bus_err & QUP_I2C_NACK_FLAG) ? -ENXIO : -EIO;
351 static void qup_i2c_set_write_mode_v2(struct qup_i2c_dev *qup,
354 /* Number of entries to shift out, including the tags */
355 int total = msg->len + qup->blk.tx_tag_len;
357 total |= qup->config_run;
359 if (total < qup->out_fifo_sz) {
361 writel(QUP_REPACK_EN, qup->base + QUP_IO_MODE);
362 writel(total, qup->base + QUP_MX_WRITE_CNT);
364 /* BLOCK mode (transfer data on chunks) */
365 writel(QUP_OUTPUT_BLK_MODE | QUP_REPACK_EN,
366 qup->base + QUP_IO_MODE);
367 writel(total, qup->base + QUP_MX_OUTPUT_CNT);
371 static void qup_i2c_set_write_mode(struct qup_i2c_dev *qup, struct i2c_msg *msg)
373 /* Number of entries to shift out, including the start */
374 int total = msg->len + 1;
376 if (total < qup->out_fifo_sz) {
378 writel(QUP_REPACK_EN, qup->base + QUP_IO_MODE);
379 writel(total, qup->base + QUP_MX_WRITE_CNT);
381 /* BLOCK mode (transfer data on chunks) */
382 writel(QUP_OUTPUT_BLK_MODE | QUP_REPACK_EN,
383 qup->base + QUP_IO_MODE);
384 writel(total, qup->base + QUP_MX_OUTPUT_CNT);
388 static int check_for_fifo_space(struct qup_i2c_dev *qup)
392 ret = qup_i2c_change_state(qup, QUP_PAUSE_STATE);
396 ret = qup_i2c_wait_ready(qup, QUP_OUT_FULL,
397 RESET_BIT, 4 * ONE_BYTE);
399 /* Fifo is full. Drain out the fifo */
400 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
404 ret = qup_i2c_wait_ready(qup, QUP_OUT_NOT_EMPTY,
405 RESET_BIT, 256 * ONE_BYTE);
407 dev_err(qup->dev, "timeout for fifo out full");
411 ret = qup_i2c_change_state(qup, QUP_PAUSE_STATE);
420 static int qup_i2c_issue_write(struct qup_i2c_dev *qup, struct i2c_msg *msg)
422 u32 addr = msg->addr << 1;
429 val = QUP_TAG_START | addr;
436 while (qup->pos < msg->len) {
437 /* Check that there's space in the FIFO for our pair */
438 ret = check_for_fifo_space(qup);
442 if (qup->pos == msg->len - 1)
443 qup_tag = QUP_TAG_STOP;
445 qup_tag = QUP_TAG_DATA;
448 val |= (qup_tag | msg->buf[qup->pos]) << QUP_MSW_SHIFT;
450 val = qup_tag | msg->buf[qup->pos];
452 /* Write out the pair and the last odd value */
453 if (idx & 1 || qup->pos == msg->len - 1)
454 writel(val, qup->base + QUP_OUT_FIFO_BASE);
460 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
465 static void qup_i2c_set_blk_data(struct qup_i2c_dev *qup,
468 memset(&qup->blk, 0, sizeof(qup->blk));
470 qup->blk.data_len = msg->len;
471 qup->blk.count = (msg->len + QUP_READ_LIMIT - 1) / QUP_READ_LIMIT;
473 /* 4 bytes for first block and 2 writes for rest */
474 qup->blk.tx_tag_len = 4 + (qup->blk.count - 1) * 2;
476 /* There are 2 tag bytes that are read in to fifo for every block */
477 if (msg->flags & I2C_M_RD)
478 qup->blk.rx_tag_len = qup->blk.count * 2;
481 static int qup_i2c_send_data(struct qup_i2c_dev *qup, int tlen, u8 *tbuf,
484 u32 val = 0, idx = 0, pos = 0, i = 0, t;
485 int len = tlen + dlen;
490 ret = check_for_fifo_space(qup);
494 t = (len >= 4) ? 4 : len;
497 if (!i && (pos >= tlen)) {
502 val |= buf[pos++] << (idx++ * 8);
505 writel(val, qup->base + QUP_OUT_FIFO_BASE);
511 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
516 static int qup_i2c_get_data_len(struct qup_i2c_dev *qup)
520 if (qup->blk.data_len > QUP_READ_LIMIT)
521 data_len = QUP_READ_LIMIT;
523 data_len = qup->blk.data_len;
528 static int qup_i2c_set_tags(u8 *tags, struct qup_i2c_dev *qup,
529 struct i2c_msg *msg, int is_dma)
531 u16 addr = i2c_8bit_addr_from_msg(msg);
535 int last = (qup->blk.pos == (qup->blk.count - 1)) && (qup->is_last);
537 if (qup->blk.pos == 0) {
538 tags[len++] = QUP_TAG_V2_START;
539 tags[len++] = addr & 0xff;
541 if (msg->flags & I2C_M_TEN)
542 tags[len++] = addr >> 8;
545 /* Send _STOP commands for the last block */
547 if (msg->flags & I2C_M_RD)
548 tags[len++] = QUP_TAG_V2_DATARD_STOP;
550 tags[len++] = QUP_TAG_V2_DATAWR_STOP;
552 if (msg->flags & I2C_M_RD)
553 tags[len++] = QUP_TAG_V2_DATARD;
555 tags[len++] = QUP_TAG_V2_DATAWR;
558 data_len = qup_i2c_get_data_len(qup);
560 /* 0 implies 256 bytes */
561 if (data_len == QUP_READ_LIMIT)
564 tags[len++] = data_len;
566 if ((msg->flags & I2C_M_RD) && last && is_dma) {
567 tags[len++] = QUP_BAM_INPUT_EOT;
568 tags[len++] = QUP_BAM_FLUSH_STOP;
574 static int qup_i2c_issue_xfer_v2(struct qup_i2c_dev *qup, struct i2c_msg *msg)
576 int data_len = 0, tag_len, index;
579 tag_len = qup_i2c_set_tags(qup->blk.tags, qup, msg, 0);
580 index = msg->len - qup->blk.data_len;
582 /* only tags are written for read */
583 if (!(msg->flags & I2C_M_RD))
584 data_len = qup_i2c_get_data_len(qup);
586 ret = qup_i2c_send_data(qup, tag_len, qup->blk.tags,
587 data_len, &msg->buf[index]);
588 qup->blk.data_len -= data_len;
593 static void qup_i2c_bam_cb(void *data)
595 struct qup_i2c_dev *qup = data;
597 complete(&qup->xfer);
600 static int qup_sg_set_buf(struct scatterlist *sg, void *buf,
601 unsigned int buflen, struct qup_i2c_dev *qup,
606 sg_set_buf(sg, buf, buflen);
607 ret = dma_map_sg(qup->dev, sg, 1, dir);
614 static void qup_i2c_rel_dma(struct qup_i2c_dev *qup)
617 dma_release_channel(qup->btx.dma);
619 dma_release_channel(qup->brx.dma);
624 static int qup_i2c_req_dma(struct qup_i2c_dev *qup)
629 qup->btx.dma = dma_request_slave_channel_reason(qup->dev, "tx");
630 if (IS_ERR(qup->btx.dma)) {
631 err = PTR_ERR(qup->btx.dma);
633 dev_err(qup->dev, "\n tx channel not available");
639 qup->brx.dma = dma_request_slave_channel_reason(qup->dev, "rx");
640 if (IS_ERR(qup->brx.dma)) {
641 dev_err(qup->dev, "\n rx channel not available");
642 err = PTR_ERR(qup->brx.dma);
644 qup_i2c_rel_dma(qup);
651 static int qup_i2c_bam_do_xfer(struct qup_i2c_dev *qup, struct i2c_msg *msg,
654 struct dma_async_tx_descriptor *txd, *rxd = NULL;
655 int ret = 0, idx = 0, limit = QUP_READ_LIMIT;
656 dma_cookie_t cookie_rx, cookie_tx;
657 u32 rx_nents = 0, tx_nents = 0, len, blocks, rem;
658 u32 i, tlen, tx_len, tx_buf = 0, rx_buf = 0, off = 0;
662 tx_len = 0, len = 0, i = 0;
664 qup->is_last = (idx == (num - 1));
666 qup_i2c_set_blk_data(qup, msg);
668 blocks = qup->blk.count;
669 rem = msg->len - (blocks - 1) * limit;
671 if (msg->flags & I2C_M_RD) {
672 rx_nents += (blocks * 2) + 1;
675 while (qup->blk.pos < blocks) {
676 tlen = (i == (blocks - 1)) ? rem : limit;
677 tags = &qup->start_tag.start[off + len];
678 len += qup_i2c_set_tags(tags, qup, msg, 1);
679 qup->blk.data_len -= tlen;
681 /* scratch buf to read the start and len tags */
682 ret = qup_sg_set_buf(&qup->brx.sg[rx_buf++],
683 &qup->brx.tag.start[0],
684 2, qup, DMA_FROM_DEVICE);
689 ret = qup_sg_set_buf(&qup->brx.sg[rx_buf++],
690 &msg->buf[limit * i],
699 ret = qup_sg_set_buf(&qup->btx.sg[tx_buf++],
700 &qup->start_tag.start[off],
701 len, qup, DMA_TO_DEVICE);
706 /* scratch buf to read the BAM EOT and FLUSH tags */
707 ret = qup_sg_set_buf(&qup->brx.sg[rx_buf++],
708 &qup->brx.tag.start[0],
709 2, qup, DMA_FROM_DEVICE);
713 tx_nents += (blocks * 2);
715 while (qup->blk.pos < blocks) {
716 tlen = (i == (blocks - 1)) ? rem : limit;
717 tags = &qup->start_tag.start[off + tx_len];
718 len = qup_i2c_set_tags(tags, qup, msg, 1);
719 qup->blk.data_len -= tlen;
721 ret = qup_sg_set_buf(&qup->btx.sg[tx_buf++],
728 ret = qup_sg_set_buf(&qup->btx.sg[tx_buf++],
729 &msg->buf[limit * i],
730 tlen, qup, DMA_TO_DEVICE);
738 if (idx == (num - 1)) {
741 qup->btx.tag.start[0] =
745 qup->btx.tag.start[len - 1] =
747 ret = qup_sg_set_buf(&qup->btx.sg[tx_buf++],
748 &qup->btx.tag.start[0],
749 len, qup, DMA_TO_DEVICE);
759 txd = dmaengine_prep_slave_sg(qup->btx.dma, qup->btx.sg, tx_nents,
761 DMA_PREP_INTERRUPT | DMA_PREP_FENCE);
763 dev_err(qup->dev, "failed to get tx desc\n");
769 txd->callback = qup_i2c_bam_cb;
770 txd->callback_param = qup;
773 cookie_tx = dmaengine_submit(txd);
774 if (dma_submit_error(cookie_tx)) {
779 dma_async_issue_pending(qup->btx.dma);
782 rxd = dmaengine_prep_slave_sg(qup->brx.dma, qup->brx.sg,
783 rx_nents, DMA_DEV_TO_MEM,
786 dev_err(qup->dev, "failed to get rx desc\n");
789 /* abort TX descriptors */
790 dmaengine_terminate_all(qup->btx.dma);
794 rxd->callback = qup_i2c_bam_cb;
795 rxd->callback_param = qup;
796 cookie_rx = dmaengine_submit(rxd);
797 if (dma_submit_error(cookie_rx)) {
802 dma_async_issue_pending(qup->brx.dma);
805 if (!wait_for_completion_timeout(&qup->xfer, TOUT_MAX * HZ)) {
806 dev_err(qup->dev, "normal trans timed out\n");
810 if (ret || qup->bus_err || qup->qup_err) {
811 if (qup_i2c_change_state(qup, QUP_RUN_STATE)) {
812 dev_err(qup->dev, "change to run state timed out");
817 writel(QUP_BAM_INPUT_EOT,
818 qup->base + QUP_OUT_FIFO_BASE);
820 writel(QUP_BAM_FLUSH_STOP, qup->base + QUP_OUT_FIFO_BASE);
824 /* wait for remaining interrupts to occur */
825 if (!wait_for_completion_timeout(&qup->xfer, HZ))
826 dev_err(qup->dev, "flush timed out\n");
828 qup_i2c_rel_dma(qup);
830 ret = (qup->bus_err & QUP_I2C_NACK_FLAG) ? -ENXIO : -EIO;
834 dma_unmap_sg(qup->dev, qup->btx.sg, tx_nents, DMA_TO_DEVICE);
837 dma_unmap_sg(qup->dev, qup->brx.sg, rx_nents,
843 static int qup_i2c_bam_xfer(struct i2c_adapter *adap, struct i2c_msg *msg,
846 struct qup_i2c_dev *qup = i2c_get_adapdata(adap);
849 enable_irq(qup->irq);
850 ret = qup_i2c_req_dma(qup);
855 writel(0, qup->base + QUP_MX_INPUT_CNT);
856 writel(0, qup->base + QUP_MX_OUTPUT_CNT);
859 writel(QUP_REPACK_EN | QUP_BAM_MODE, qup->base + QUP_IO_MODE);
862 writel((0x3 << 8), qup->base + QUP_OPERATIONAL_MASK);
865 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
869 writel(qup->clk_ctl, qup->base + QUP_I2C_CLK_CTL);
872 ret = qup_i2c_bam_do_xfer(qup, qup->msg, num);
874 disable_irq(qup->irq);
880 static int qup_i2c_wait_for_complete(struct qup_i2c_dev *qup,
886 left = wait_for_completion_timeout(&qup->xfer, HZ);
888 writel(1, qup->base + QUP_SW_RESET);
892 if (qup->bus_err || qup->qup_err)
893 ret = (qup->bus_err & QUP_I2C_NACK_FLAG) ? -ENXIO : -EIO;
898 static int qup_i2c_write_one_v2(struct qup_i2c_dev *qup, struct i2c_msg *msg)
904 enable_irq(qup->irq);
905 qup_i2c_set_blk_data(qup, msg);
906 qup_i2c_set_write_mode_v2(qup, msg);
908 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
912 writel(qup->clk_ctl, qup->base + QUP_I2C_CLK_CTL);
915 ret = qup_i2c_issue_xfer_v2(qup, msg);
919 ret = qup_i2c_wait_for_complete(qup, msg);
924 } while (qup->blk.pos < qup->blk.count);
926 ret = qup_i2c_wait_ready(qup, QUP_OUT_NOT_EMPTY, RESET_BIT, ONE_BYTE);
929 disable_irq(qup->irq);
935 static int qup_i2c_write_one(struct qup_i2c_dev *qup, struct i2c_msg *msg)
942 enable_irq(qup->irq);
944 qup_i2c_set_write_mode(qup, msg);
946 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
950 writel(qup->clk_ctl, qup->base + QUP_I2C_CLK_CTL);
953 ret = qup_i2c_change_state(qup, QUP_PAUSE_STATE);
957 ret = qup_i2c_issue_write(qup, msg);
961 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
965 ret = qup_i2c_wait_for_complete(qup, msg);
968 } while (qup->pos < msg->len);
970 /* Wait for the outstanding data in the fifo to drain */
971 ret = qup_i2c_wait_ready(qup, QUP_OUT_NOT_EMPTY, RESET_BIT, ONE_BYTE);
973 disable_irq(qup->irq);
979 static void qup_i2c_set_read_mode(struct qup_i2c_dev *qup, int len)
981 if (len < qup->in_fifo_sz) {
983 writel(QUP_REPACK_EN, qup->base + QUP_IO_MODE);
984 writel(len, qup->base + QUP_MX_READ_CNT);
986 /* BLOCK mode (transfer data on chunks) */
987 writel(QUP_INPUT_BLK_MODE | QUP_REPACK_EN,
988 qup->base + QUP_IO_MODE);
989 writel(len, qup->base + QUP_MX_INPUT_CNT);
993 static void qup_i2c_set_read_mode_v2(struct qup_i2c_dev *qup, int len)
995 int tx_len = qup->blk.tx_tag_len;
997 len += qup->blk.rx_tag_len;
998 len |= qup->config_run;
999 tx_len |= qup->config_run;
1001 if (len < qup->in_fifo_sz) {
1003 writel(QUP_REPACK_EN, qup->base + QUP_IO_MODE);
1004 writel(tx_len, qup->base + QUP_MX_WRITE_CNT);
1005 writel(len, qup->base + QUP_MX_READ_CNT);
1007 /* BLOCK mode (transfer data on chunks) */
1008 writel(QUP_INPUT_BLK_MODE | QUP_REPACK_EN,
1009 qup->base + QUP_IO_MODE);
1010 writel(tx_len, qup->base + QUP_MX_OUTPUT_CNT);
1011 writel(len, qup->base + QUP_MX_INPUT_CNT);
1015 static void qup_i2c_issue_read(struct qup_i2c_dev *qup, struct i2c_msg *msg)
1019 addr = i2c_8bit_addr_from_msg(msg);
1021 /* 0 is used to specify a length 256 (QUP_READ_LIMIT) */
1022 len = (msg->len == QUP_READ_LIMIT) ? 0 : msg->len;
1024 val = ((QUP_TAG_REC | len) << QUP_MSW_SHIFT) | QUP_TAG_START | addr;
1025 writel(val, qup->base + QUP_OUT_FIFO_BASE);
1029 static int qup_i2c_read_fifo(struct qup_i2c_dev *qup, struct i2c_msg *msg)
1035 for (idx = 0; qup->pos < msg->len; idx++) {
1036 if ((idx & 1) == 0) {
1037 /* Check that FIFO have data */
1038 ret = qup_i2c_wait_ready(qup, QUP_IN_NOT_EMPTY,
1039 SET_BIT, 4 * ONE_BYTE);
1043 /* Reading 2 words at time */
1044 val = readl(qup->base + QUP_IN_FIFO_BASE);
1046 msg->buf[qup->pos++] = val & 0xFF;
1048 msg->buf[qup->pos++] = val >> QUP_MSW_SHIFT;
1055 static int qup_i2c_read_fifo_v2(struct qup_i2c_dev *qup,
1056 struct i2c_msg *msg)
1059 int idx, pos = 0, ret = 0, total;
1061 total = qup_i2c_get_data_len(qup);
1063 /* 2 extra bytes for read tags */
1064 while (pos < (total + 2)) {
1065 /* Check that FIFO have data */
1066 ret = qup_i2c_wait_ready(qup, QUP_IN_NOT_EMPTY,
1067 SET_BIT, 4 * ONE_BYTE);
1069 dev_err(qup->dev, "timeout for fifo not empty");
1072 val = readl(qup->base + QUP_IN_FIFO_BASE);
1074 for (idx = 0; idx < 4; idx++, val >>= 8, pos++) {
1075 /* first 2 bytes are tag bytes */
1079 if (pos >= (total + 2))
1082 msg->buf[qup->pos++] = val & 0xff;
1087 qup->blk.data_len -= total;
1092 static int qup_i2c_read_one_v2(struct qup_i2c_dev *qup, struct i2c_msg *msg)
1098 enable_irq(qup->irq);
1099 qup_i2c_set_blk_data(qup, msg);
1100 qup_i2c_set_read_mode_v2(qup, msg->len);
1102 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
1106 writel(qup->clk_ctl, qup->base + QUP_I2C_CLK_CTL);
1109 ret = qup_i2c_issue_xfer_v2(qup, msg);
1113 ret = qup_i2c_wait_for_complete(qup, msg);
1117 ret = qup_i2c_read_fifo_v2(qup, msg);
1122 } while (qup->blk.pos < qup->blk.count);
1125 disable_irq(qup->irq);
1131 static int qup_i2c_read_one(struct qup_i2c_dev *qup, struct i2c_msg *msg)
1138 enable_irq(qup->irq);
1139 qup_i2c_set_read_mode(qup, msg->len);
1141 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
1145 writel(qup->clk_ctl, qup->base + QUP_I2C_CLK_CTL);
1147 ret = qup_i2c_change_state(qup, QUP_PAUSE_STATE);
1151 qup_i2c_issue_read(qup, msg);
1153 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
1158 ret = qup_i2c_wait_for_complete(qup, msg);
1162 ret = qup_i2c_read_fifo(qup, msg);
1165 } while (qup->pos < msg->len);
1168 disable_irq(qup->irq);
1174 static int qup_i2c_xfer(struct i2c_adapter *adap,
1175 struct i2c_msg msgs[],
1178 struct qup_i2c_dev *qup = i2c_get_adapdata(adap);
1181 ret = pm_runtime_get_sync(qup->dev);
1188 writel(1, qup->base + QUP_SW_RESET);
1189 ret = qup_i2c_poll_state(qup, QUP_RESET_STATE);
1193 /* Configure QUP as I2C mini core */
1194 writel(I2C_MINI_CORE | I2C_N_VAL, qup->base + QUP_CONFIG);
1196 for (idx = 0; idx < num; idx++) {
1197 if (msgs[idx].len == 0) {
1202 if (qup_i2c_poll_state_i2c_master(qup)) {
1207 if (msgs[idx].flags & I2C_M_RD)
1208 ret = qup_i2c_read_one(qup, &msgs[idx]);
1210 ret = qup_i2c_write_one(qup, &msgs[idx]);
1215 ret = qup_i2c_change_state(qup, QUP_RESET_STATE);
1224 pm_runtime_mark_last_busy(qup->dev);
1225 pm_runtime_put_autosuspend(qup->dev);
1230 static int qup_i2c_xfer_v2(struct i2c_adapter *adap,
1231 struct i2c_msg msgs[],
1234 struct qup_i2c_dev *qup = i2c_get_adapdata(adap);
1235 int ret, len, idx = 0, use_dma = 0;
1240 ret = pm_runtime_get_sync(qup->dev);
1244 writel(1, qup->base + QUP_SW_RESET);
1245 ret = qup_i2c_poll_state(qup, QUP_RESET_STATE);
1249 /* Configure QUP as I2C mini core */
1250 writel(I2C_MINI_CORE | I2C_N_VAL_V2, qup->base + QUP_CONFIG);
1251 writel(QUP_V2_TAGS_EN, qup->base + QUP_I2C_MASTER_GEN);
1253 if ((qup->is_dma)) {
1254 /* All i2c_msgs should be transferred using either dma or cpu */
1255 for (idx = 0; idx < num; idx++) {
1256 if (msgs[idx].len == 0) {
1261 len = (msgs[idx].len > qup->out_fifo_sz) ||
1262 (msgs[idx].len > qup->in_fifo_sz);
1264 if ((!is_vmalloc_addr(msgs[idx].buf)) && len) {
1276 if (msgs[idx].len == 0) {
1281 if (qup_i2c_poll_state_i2c_master(qup)) {
1286 qup->is_last = (idx == (num - 1));
1288 qup->config_run = QUP_I2C_MX_CONFIG_DURING_RUN;
1290 qup->config_run = 0;
1292 reinit_completion(&qup->xfer);
1295 ret = qup_i2c_bam_xfer(adap, &msgs[idx], num);
1297 if (msgs[idx].flags & I2C_M_RD)
1298 ret = qup_i2c_read_one_v2(qup, &msgs[idx]);
1300 ret = qup_i2c_write_one_v2(qup, &msgs[idx]);
1302 } while ((idx++ < (num - 1)) && !use_dma && !ret);
1305 ret = qup_i2c_change_state(qup, QUP_RESET_STATE);
1310 pm_runtime_mark_last_busy(qup->dev);
1311 pm_runtime_put_autosuspend(qup->dev);
1316 static u32 qup_i2c_func(struct i2c_adapter *adap)
1318 return I2C_FUNC_I2C | (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK);
1321 static const struct i2c_algorithm qup_i2c_algo = {
1322 .master_xfer = qup_i2c_xfer,
1323 .functionality = qup_i2c_func,
1326 static const struct i2c_algorithm qup_i2c_algo_v2 = {
1327 .master_xfer = qup_i2c_xfer_v2,
1328 .functionality = qup_i2c_func,
1332 * The QUP block will issue a NACK and STOP on the bus when reaching
1333 * the end of the read, the length of the read is specified as one byte
1334 * which limits the possible read to 256 (QUP_READ_LIMIT) bytes.
1336 static struct i2c_adapter_quirks qup_i2c_quirks = {
1337 .max_read_len = QUP_READ_LIMIT,
1340 static void qup_i2c_enable_clocks(struct qup_i2c_dev *qup)
1342 clk_prepare_enable(qup->clk);
1343 clk_prepare_enable(qup->pclk);
1346 static void qup_i2c_disable_clocks(struct qup_i2c_dev *qup)
1350 qup_i2c_change_state(qup, QUP_RESET_STATE);
1351 clk_disable_unprepare(qup->clk);
1352 config = readl(qup->base + QUP_CONFIG);
1353 config |= QUP_CLOCK_AUTO_GATE;
1354 writel(config, qup->base + QUP_CONFIG);
1355 clk_disable_unprepare(qup->pclk);
1358 static int qup_i2c_probe(struct platform_device *pdev)
1360 static const int blk_sizes[] = {4, 16, 32};
1361 struct device_node *node = pdev->dev.of_node;
1362 struct qup_i2c_dev *qup;
1363 unsigned long one_bit_t;
1364 struct resource *res;
1365 u32 io_mode, hw_ver, size;
1366 int ret, fs_div, hs_div;
1368 u32 clk_freq = 100000;
1371 qup = devm_kzalloc(&pdev->dev, sizeof(*qup), GFP_KERNEL);
1375 qup->dev = &pdev->dev;
1376 init_completion(&qup->xfer);
1377 platform_set_drvdata(pdev, qup);
1379 of_property_read_u32(node, "clock-frequency", &clk_freq);
1381 if (of_device_is_compatible(pdev->dev.of_node, "qcom,i2c-qup-v1.1.1")) {
1382 qup->adap.algo = &qup_i2c_algo;
1383 qup->adap.quirks = &qup_i2c_quirks;
1385 qup->adap.algo = &qup_i2c_algo_v2;
1386 ret = qup_i2c_req_dma(qup);
1388 if (ret == -EPROBE_DEFER)
1393 blocks = (MX_BLOCKS << 1) + 1;
1394 qup->btx.sg = devm_kzalloc(&pdev->dev,
1395 sizeof(*qup->btx.sg) * blocks,
1401 sg_init_table(qup->btx.sg, blocks);
1403 qup->brx.sg = devm_kzalloc(&pdev->dev,
1404 sizeof(*qup->brx.sg) * blocks,
1410 sg_init_table(qup->brx.sg, blocks);
1412 /* 2 tag bytes for each block + 5 for start, stop tags */
1413 size = blocks * 2 + 5;
1415 qup->start_tag.start = devm_kzalloc(&pdev->dev,
1417 if (!qup->start_tag.start) {
1422 qup->brx.tag.start = devm_kzalloc(&pdev->dev, 2, GFP_KERNEL);
1423 if (!qup->brx.tag.start) {
1428 qup->btx.tag.start = devm_kzalloc(&pdev->dev, 2, GFP_KERNEL);
1429 if (!qup->btx.tag.start) {
1437 /* We support frequencies up to FAST Mode (400KHz) */
1438 if (!clk_freq || clk_freq > 400000) {
1439 dev_err(qup->dev, "clock frequency not supported %d\n",
1444 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1445 qup->base = devm_ioremap_resource(qup->dev, res);
1446 if (IS_ERR(qup->base))
1447 return PTR_ERR(qup->base);
1449 qup->irq = platform_get_irq(pdev, 0);
1451 dev_err(qup->dev, "No IRQ defined\n");
1455 qup->clk = devm_clk_get(qup->dev, "core");
1456 if (IS_ERR(qup->clk)) {
1457 dev_err(qup->dev, "Could not get core clock\n");
1458 return PTR_ERR(qup->clk);
1461 qup->pclk = devm_clk_get(qup->dev, "iface");
1462 if (IS_ERR(qup->pclk)) {
1463 dev_err(qup->dev, "Could not get iface clock\n");
1464 return PTR_ERR(qup->pclk);
1467 qup_i2c_enable_clocks(qup);
1470 * Bootloaders might leave a pending interrupt on certain QUP's,
1471 * so we reset the core before registering for interrupts.
1473 writel(1, qup->base + QUP_SW_RESET);
1474 ret = qup_i2c_poll_state_valid(qup);
1478 ret = devm_request_irq(qup->dev, qup->irq, qup_i2c_interrupt,
1479 IRQF_TRIGGER_HIGH, "i2c_qup", qup);
1481 dev_err(qup->dev, "Request %d IRQ failed\n", qup->irq);
1484 disable_irq(qup->irq);
1486 hw_ver = readl(qup->base + QUP_HW_VERSION);
1487 dev_dbg(qup->dev, "Revision %x\n", hw_ver);
1489 io_mode = readl(qup->base + QUP_IO_MODE);
1492 * The block/fifo size w.r.t. 'actual data' is 1/2 due to 'tag'
1493 * associated with each byte written/received
1495 size = QUP_OUTPUT_BLOCK_SIZE(io_mode);
1496 if (size >= ARRAY_SIZE(blk_sizes)) {
1500 qup->out_blk_sz = blk_sizes[size] / 2;
1502 size = QUP_INPUT_BLOCK_SIZE(io_mode);
1503 if (size >= ARRAY_SIZE(blk_sizes)) {
1507 qup->in_blk_sz = blk_sizes[size] / 2;
1509 size = QUP_OUTPUT_FIFO_SIZE(io_mode);
1510 qup->out_fifo_sz = qup->out_blk_sz * (2 << size);
1512 size = QUP_INPUT_FIFO_SIZE(io_mode);
1513 qup->in_fifo_sz = qup->in_blk_sz * (2 << size);
1515 src_clk_freq = clk_get_rate(qup->clk);
1516 fs_div = ((src_clk_freq / clk_freq) / 2) - 3;
1518 qup->clk_ctl = (hs_div << 8) | (fs_div & 0xff);
1521 * Time it takes for a byte to be clocked out on the bus.
1522 * Each byte takes 9 clock cycles (8 bits + 1 ack).
1524 one_bit_t = (USEC_PER_SEC / clk_freq) + 1;
1525 qup->one_byte_t = one_bit_t * 9;
1527 dev_dbg(qup->dev, "IN:block:%d, fifo:%d, OUT:block:%d, fifo:%d\n",
1528 qup->in_blk_sz, qup->in_fifo_sz,
1529 qup->out_blk_sz, qup->out_fifo_sz);
1531 i2c_set_adapdata(&qup->adap, qup);
1532 qup->adap.dev.parent = qup->dev;
1533 qup->adap.dev.of_node = pdev->dev.of_node;
1534 qup->is_last = true;
1536 strlcpy(qup->adap.name, "QUP I2C adapter", sizeof(qup->adap.name));
1538 pm_runtime_set_autosuspend_delay(qup->dev, MSEC_PER_SEC);
1539 pm_runtime_use_autosuspend(qup->dev);
1540 pm_runtime_set_active(qup->dev);
1541 pm_runtime_enable(qup->dev);
1543 ret = i2c_add_adapter(&qup->adap);
1550 pm_runtime_disable(qup->dev);
1551 pm_runtime_set_suspended(qup->dev);
1553 qup_i2c_disable_clocks(qup);
1556 dma_release_channel(qup->btx.dma);
1558 dma_release_channel(qup->brx.dma);
1562 static int qup_i2c_remove(struct platform_device *pdev)
1564 struct qup_i2c_dev *qup = platform_get_drvdata(pdev);
1567 dma_release_channel(qup->btx.dma);
1568 dma_release_channel(qup->brx.dma);
1571 disable_irq(qup->irq);
1572 qup_i2c_disable_clocks(qup);
1573 i2c_del_adapter(&qup->adap);
1574 pm_runtime_disable(qup->dev);
1575 pm_runtime_set_suspended(qup->dev);
1580 static int qup_i2c_pm_suspend_runtime(struct device *device)
1582 struct qup_i2c_dev *qup = dev_get_drvdata(device);
1584 dev_dbg(device, "pm_runtime: suspending...\n");
1585 qup_i2c_disable_clocks(qup);
1589 static int qup_i2c_pm_resume_runtime(struct device *device)
1591 struct qup_i2c_dev *qup = dev_get_drvdata(device);
1593 dev_dbg(device, "pm_runtime: resuming...\n");
1594 qup_i2c_enable_clocks(qup);
1599 #ifdef CONFIG_PM_SLEEP
1600 static int qup_i2c_suspend(struct device *device)
1602 if (!pm_runtime_suspended(device))
1603 return qup_i2c_pm_suspend_runtime(device);
1607 static int qup_i2c_resume(struct device *device)
1609 qup_i2c_pm_resume_runtime(device);
1610 pm_runtime_mark_last_busy(device);
1611 pm_request_autosuspend(device);
1616 static const struct dev_pm_ops qup_i2c_qup_pm_ops = {
1617 SET_SYSTEM_SLEEP_PM_OPS(
1621 qup_i2c_pm_suspend_runtime,
1622 qup_i2c_pm_resume_runtime,
1626 static const struct of_device_id qup_i2c_dt_match[] = {
1627 { .compatible = "qcom,i2c-qup-v1.1.1" },
1628 { .compatible = "qcom,i2c-qup-v2.1.1" },
1629 { .compatible = "qcom,i2c-qup-v2.2.1" },
1632 MODULE_DEVICE_TABLE(of, qup_i2c_dt_match);
1634 static struct platform_driver qup_i2c_driver = {
1635 .probe = qup_i2c_probe,
1636 .remove = qup_i2c_remove,
1639 .pm = &qup_i2c_qup_pm_ops,
1640 .of_match_table = qup_i2c_dt_match,
1644 module_platform_driver(qup_i2c_driver);
1646 MODULE_LICENSE("GPL v2");
1647 MODULE_ALIAS("platform:i2c_qup");