1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2009-2013, 2016-2018, The Linux Foundation. All rights reserved.
4 * Copyright (c) 2014, Sony Mobile Communications AB.
7 * Inspired by corresponding driver in Linux: drivers/i2c/busses/i2c-qup.c
13 #include <dm/device_compat.h>
14 #include <linux/delay.h>
15 #include <linux/errno.h>
16 #include <linux/err.h>
17 #include <linux/compat.h>
18 #include <linux/bitops.h>
25 #include <asm/arch/gpio.h>
27 #include <asm/system.h>
30 #include <dm/pinctrl.h>
33 #define QUP_CONFIG 0x000
34 #define QUP_STATE 0x004
35 #define QUP_IO_MODE 0x008
36 #define QUP_SW_RESET 0x00c
37 #define QUP_OPERATIONAL 0x018
38 #define QUP_ERROR_FLAGS 0x01c /* NOT USED */
39 #define QUP_ERROR_FLAGS_EN 0x020 /* NOT USED */
40 #define QUP_TEST_CTRL 0x024 /* NOT USED */
41 #define QUP_OPERATIONAL_MASK 0x028 /* NOT USED */
42 #define QUP_HW_VERSION 0x030
43 #define QUP_MX_OUTPUT_CNT 0x100
44 #define QUP_OUT_DEBUG 0x108 /* NOT USED */
45 #define QUP_OUT_FIFO_CNT 0x10C /* NOT USED */
46 #define QUP_OUT_FIFO_BASE 0x110
47 #define QUP_MX_WRITE_CNT 0x150
48 #define QUP_MX_INPUT_CNT 0x200
49 #define QUP_MX_READ_CNT 0x208
50 #define QUP_IN_READ_CUR 0x20C /* NOT USED */
51 #define QUP_IN_DEBUG 0x210 /* NOT USED */
52 #define QUP_IN_FIFO_CNT 0x214 /* NOT USED */
53 #define QUP_IN_FIFO_BASE 0x218
54 #define QUP_I2C_CLK_CTL 0x400
55 #define QUP_I2C_STATUS 0x404 /* NOT USED */
56 #define QUP_I2C_MASTER_GEN 0x408
57 #define QUP_I2C_MASTER_BUS_CLR 0x40C /* NOT USED */
59 /* QUP States and reset values */
60 #define QUP_RESET_STATE 0
61 #define QUP_RUN_STATE 1
62 #define QUP_PAUSE_STATE 3
63 #define QUP_STATE_MASK 3
65 #define QUP_STATE_VALID BIT(2)
66 #define QUP_I2C_MAST_GEN BIT(4)
67 #define QUP_I2C_FLUSH BIT(6)
69 #define QUP_OPERATIONAL_RESET 0x000ff0
70 #define QUP_I2C_STATUS_RESET 0xfffffc
72 /* QUP OPERATIONAL FLAGS */
73 #define QUP_I2C_NACK_FLAG BIT(3)
74 #define QUP_OUT_NOT_EMPTY BIT(4)
75 #define QUP_IN_NOT_EMPTY BIT(5)
76 #define QUP_OUT_FULL BIT(6)
77 #define QUP_OUT_SVC_FLAG BIT(8)
78 #define QUP_IN_SVC_FLAG BIT(9)
79 #define QUP_MX_OUTPUT_DONE BIT(10)
80 #define QUP_MX_INPUT_DONE BIT(11)
81 #define OUT_BLOCK_WRITE_REQ BIT(12)
82 #define IN_BLOCK_READ_REQ BIT(13)
85 * QUP engine acting as I2C controller is referred to as
86 * I2C mini core, following are related macros.
88 #define QUP_NO_OUTPUT BIT(6)
89 #define QUP_NO_INPUT BIT(7)
90 #define QUP_CLOCK_AUTO_GATE BIT(13)
91 #define QUP_I2C_MINI_CORE (2 << 8)
92 #define QUP_I2C_N_VAL_V2 7
94 /* Packing/Unpacking words in FIFOs, and IO modes */
95 #define QUP_OUTPUT_BLK_MODE BIT(10)
96 #define QUP_OUTPUT_BAM_MODE (BIT(10) | BIT(11))
97 #define QUP_INPUT_BLK_MODE BIT(12)
98 #define QUP_INPUT_BAM_MODE (BIT(12) | BIT(13))
99 #define QUP_BAM_MODE (QUP_OUTPUT_BAM_MODE | QUP_INPUT_BAM_MODE)
100 #define QUP_BLK_MODE (QUP_OUTPUT_BLK_MODE | QUP_INPUT_BLK_MODE)
101 #define QUP_UNPACK_EN BIT(14)
102 #define QUP_PACK_EN BIT(15)
104 #define QUP_REPACK_EN (QUP_UNPACK_EN | QUP_PACK_EN)
105 #define QUP_V2_TAGS_EN 1
107 #define QUP_OUTPUT_BLOCK_SIZE(x) (((x) >> 0) & 0x03)
108 #define QUP_OUTPUT_FIFO_SIZE(x) (((x) >> 2) & 0x07)
109 #define QUP_INPUT_BLOCK_SIZE(x) (((x) >> 5) & 0x03)
110 #define QUP_INPUT_FIFO_SIZE(x) (((x) >> 7) & 0x07)
113 #define QUP_TAG_V2_START 0x81
114 #define QUP_TAG_V2_DATAWR 0x82
115 #define QUP_TAG_V2_DATAWR_STOP 0x83
116 #define QUP_TAG_V2_DATARD 0x85
117 #define QUP_TAG_V2_DATARD_NACK 0x86
118 #define QUP_TAG_V2_DATARD_STOP 0x87
120 #define QUP_I2C_MX_CONFIG_DURING_RUN BIT(31)
122 /* Minimum transfer timeout for i2c transfers in micro seconds */
123 #define TOUT_CNT (2 * 1000 * 1000)
125 /* Default values. Use these if FW query fails */
126 #define DEFAULT_CLK_FREQ I2C_SPEED_STANDARD_RATE
127 #define DEFAULT_SRC_CLK 19200000
130 * Max tags length (start, stop and maximum 2 bytes address) for each QUP
133 #define QUP_MAX_TAGS_LEN 4
134 /* Max data length for each DATARD tags */
135 #define RECV_MAX_DATA_LEN 254
136 /* TAG length for DATA READ in RX FIFO */
137 #define READ_RX_TAGS_LEN 2
139 struct qup_i2c_priv {
149 static inline u8 i2c_8bit_addr_from_msg(const struct i2c_msg *msg)
151 return (msg->addr << 1) | (msg->flags & I2C_M_RD ? 1 : 0);
154 static int qup_i2c_poll_state_mask(struct qup_i2c_priv *qup,
155 u32 req_state, u32 req_mask)
161 * State transition takes 3 AHB clocks cycles + 3 I2C master clock
162 * cycles. So retry once after a 1uS delay.
165 state = readl(qup->base + QUP_STATE);
167 if (state & QUP_STATE_VALID &&
168 (state & req_mask) == req_state)
177 static int qup_i2c_poll_state(struct qup_i2c_priv *qup, u32 req_state)
179 return qup_i2c_poll_state_mask(qup, req_state, QUP_STATE_MASK);
182 static int qup_i2c_poll_state_valid(struct qup_i2c_priv *qup)
184 return qup_i2c_poll_state_mask(qup, 0, 0);
187 static int qup_i2c_poll_state_i2c_master(struct qup_i2c_priv *qup)
189 return qup_i2c_poll_state_mask(qup, QUP_I2C_MAST_GEN, QUP_I2C_MAST_GEN);
192 static int qup_i2c_change_state(struct qup_i2c_priv *qup, u32 state)
194 if (qup_i2c_poll_state_valid(qup) != 0)
197 writel(state, qup->base + QUP_STATE);
199 if (qup_i2c_poll_state(qup, state) != 0)
205 * Function to check wheather Input or Output FIFO
206 * has data to be serviced
208 static int qup_i2c_check_fifo_status(struct qup_i2c_priv *qup, u32 reg_addr,
211 unsigned long count = TOUT_CNT;
212 u32 val, status_flag;
216 val = readl(qup->base + reg_addr);
217 status_flag = val & flags;
220 printf("%s, timeout\n", __func__);
227 } while (!status_flag);
233 * Function to configure Input and Output enable/disable
235 static void qup_i2c_enable_io_config(struct qup_i2c_priv *qup, u32 write_cnt,
238 u32 qup_config = QUP_I2C_MINI_CORE | QUP_I2C_N_VAL_V2;
240 writel(qup->config_run | write_cnt, qup->base + QUP_MX_WRITE_CNT);
243 writel(qup->config_run | read_cnt, qup->base + QUP_MX_READ_CNT);
245 qup_config |= QUP_NO_INPUT;
247 writel(qup_config, qup->base + QUP_CONFIG);
250 static unsigned int qup_i2c_read_word(struct qup_i2c_priv *qup)
252 return readl(qup->base + QUP_IN_FIFO_BASE);
255 static void qup_i2c_write_word(struct qup_i2c_priv *qup, u32 word)
257 writel(word, qup->base + QUP_OUT_FIFO_BASE);
260 static int qup_i2c_blsp_read(struct qup_i2c_priv *qup, unsigned int addr,
261 bool last, u8 *buffer, unsigned int bytes)
263 unsigned int i, j, word;
266 /* FIFO mode size limitation, for larger size implement block mode */
267 if (bytes > (qup->in_fifo_sz - READ_RX_TAGS_LEN))
270 qup_i2c_enable_io_config(qup, QUP_MAX_TAGS_LEN,
271 bytes + READ_RX_TAGS_LEN);
274 qup_i2c_write_word(qup, QUP_TAG_V2_START | addr << 8 |
275 QUP_TAG_V2_DATARD_STOP << 16 |
278 qup_i2c_write_word(qup, QUP_TAG_V2_START | addr << 8 |
279 QUP_TAG_V2_DATARD << 16 | bytes << 24);
281 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
285 ret = qup_i2c_check_fifo_status(qup, QUP_OPERATIONAL, QUP_OUT_SVC_FLAG);
288 writel(QUP_OUT_SVC_FLAG, qup->base + QUP_OPERATIONAL);
290 ret = qup_i2c_check_fifo_status(qup, QUP_OPERATIONAL, QUP_IN_SVC_FLAG);
293 writel(QUP_IN_SVC_FLAG, qup->base + QUP_OPERATIONAL);
295 word = qup_i2c_read_word(qup);
296 *(buffer++) = (word >> (8 * READ_RX_TAGS_LEN)) & 0xff;
298 *(buffer++) = (word >> (8 * (READ_RX_TAGS_LEN + 1))) & 0xff;
300 for (i = 2; i < bytes; i += 4) {
301 word = qup_i2c_read_word(qup);
303 for (j = 0; j < 4; j++) {
304 if ((i + j) == bytes)
306 *buffer = (word >> (j * 8)) & 0xff;
311 ret = qup_i2c_change_state(qup, QUP_PAUSE_STATE);
315 static int qup_i2c_blsp_write(struct qup_i2c_priv *qup, unsigned int addr,
316 bool first, bool last, const u8 *buffer,
323 /* FIFO mode size limitation, for larger size implement block mode */
324 if (bytes > (qup->out_fifo_sz - QUP_MAX_TAGS_LEN))
327 qup_i2c_enable_io_config(qup, bytes + QUP_MAX_TAGS_LEN, 0);
330 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
334 writel(qup->clk_ctl, qup->base + QUP_I2C_CLK_CTL);
336 ret = qup_i2c_change_state(qup, QUP_PAUSE_STATE);
342 qup_i2c_write_word(qup, QUP_TAG_V2_START | addr << 8 |
343 QUP_TAG_V2_DATAWR_STOP << 16 |
346 qup_i2c_write_word(qup, QUP_TAG_V2_START | addr << 8 |
347 QUP_TAG_V2_DATAWR << 16 | bytes << 24);
349 for (i = 0; i < bytes; i++) {
350 /* Write the byte of data */
351 word |= *buffer << ((i % 4) * 8);
353 qup_i2c_write_word(qup, word);
360 qup_i2c_write_word(qup, word);
362 ret = qup_i2c_change_state(qup, QUP_RUN_STATE);
366 ret = qup_i2c_check_fifo_status(qup, QUP_OPERATIONAL, QUP_OUT_SVC_FLAG);
369 writel(QUP_OUT_SVC_FLAG, qup->base + QUP_OPERATIONAL);
371 ret = qup_i2c_change_state(qup, QUP_PAUSE_STATE);
375 static void qup_i2c_conf_mode_v2(struct qup_i2c_priv *qup)
377 u32 io_mode = QUP_REPACK_EN;
379 writel(0, qup->base + QUP_MX_OUTPUT_CNT);
380 writel(0, qup->base + QUP_MX_INPUT_CNT);
382 writel(io_mode, qup->base + QUP_IO_MODE);
385 static int qup_i2c_xfer_v2(struct udevice *bus, struct i2c_msg msgs[], int num)
387 struct qup_i2c_priv *qup = dev_get_priv(bus);
391 writel(1, qup->base + QUP_SW_RESET);
392 ret = qup_i2c_poll_state(qup, QUP_RESET_STATE);
396 /* Configure QUP as I2C mini core */
397 writel(QUP_I2C_MINI_CORE | QUP_I2C_N_VAL_V2 | QUP_NO_INPUT,
398 qup->base + QUP_CONFIG);
399 writel(QUP_V2_TAGS_EN, qup->base + QUP_I2C_MASTER_GEN);
401 if (qup_i2c_poll_state_i2c_master(qup)) {
406 qup_i2c_conf_mode_v2(qup);
408 for (idx = 0; idx < num; idx++) {
409 struct i2c_msg *m = &msgs[idx];
411 qup->config_run = !idx ? 0 : QUP_I2C_MX_CONFIG_DURING_RUN;
412 i2c_addr = i2c_8bit_addr_from_msg(m);
414 if (m->flags & I2C_M_RD)
415 ret = qup_i2c_blsp_read(qup, i2c_addr, idx == (num - 1),
418 ret = qup_i2c_blsp_write(qup, i2c_addr, idx == 0,
419 idx == (num - 1), m->buf,
425 qup_i2c_change_state(qup, QUP_RESET_STATE);
429 static int qup_i2c_enable_clocks(struct udevice *dev, struct qup_i2c_priv *qup)
433 ret = clk_enable(&qup->core);
435 dev_err(dev, "clk_enable failed %d\n", ret);
439 ret = clk_enable(&qup->iface);
441 dev_err(dev, "clk_enable failed %d\n", ret);
448 static int qup_i2c_probe(struct udevice *dev)
450 static const int blk_sizes[] = {4, 16, 32};
451 struct qup_i2c_priv *qup = dev_get_priv(dev);
452 u32 io_mode, hw_ver, size, size_idx;
455 qup->base = (phys_addr_t)dev_read_addr_ptr(dev);
459 ret = clk_get_by_name(dev, "core", &qup->core);
461 pr_err("clk_get_by_name(core) failed: %d\n", ret);
464 ret = clk_get_by_name(dev, "iface", &qup->iface);
466 pr_err("clk_get_by_name(iface) failed: %d\n", ret);
469 qup_i2c_enable_clocks(dev, qup);
471 writel(1, qup->base + QUP_SW_RESET);
472 ret = qup_i2c_poll_state_valid(qup);
476 hw_ver = readl(qup->base + QUP_HW_VERSION);
477 dev_dbg(dev, "Revision %x\n", hw_ver);
479 io_mode = readl(qup->base + QUP_IO_MODE);
482 * The block/fifo size w.r.t. 'actual data' is 1/2 due to 'tag'
483 * associated with each byte written/received
485 size_idx = QUP_OUTPUT_BLOCK_SIZE(io_mode);
486 if (size_idx >= ARRAY_SIZE(blk_sizes)) {
490 size = QUP_OUTPUT_FIFO_SIZE(io_mode);
491 qup->out_fifo_sz = blk_sizes[size_idx] * (2 << size);
493 size_idx = QUP_INPUT_BLOCK_SIZE(io_mode);
494 if (size_idx >= ARRAY_SIZE(blk_sizes)) {
498 size = QUP_INPUT_FIFO_SIZE(io_mode);
499 qup->in_fifo_sz = blk_sizes[size_idx] * (2 << size);
501 dev_dbg(dev, "IN:fifo:%d, OUT:fifo:%d\n", qup->in_fifo_sz,
507 static int qup_i2c_set_bus_speed(struct udevice *dev, unsigned int clk_freq)
509 struct qup_i2c_priv *qup = dev_get_priv(dev);
510 unsigned int src_clk_freq;
513 /* We support frequencies up to FAST Mode Plus (1MHz) */
514 if (!clk_freq || clk_freq > I2C_SPEED_FAST_PLUS_RATE) {
515 dev_err(dev, "clock frequency not supported %d\n", clk_freq);
519 src_clk_freq = clk_get_rate(&qup->iface);
520 if ((int)src_clk_freq < 0) {
521 src_clk_freq = DEFAULT_SRC_CLK;
522 dev_dbg(dev, "using default core freq %d\n", src_clk_freq);
525 dev_dbg(dev, "src_clk_freq %u\n", src_clk_freq);
526 dev_dbg(dev, "clk_freq %u\n", clk_freq);
529 if (clk_freq <= I2C_SPEED_STANDARD_RATE) {
530 fs_div = ((src_clk_freq / clk_freq) / 2) - 3;
531 qup->clk_ctl = (hs_div << 8) | (fs_div & 0xff);
533 /* 33%/66% duty cycle */
534 fs_div = ((src_clk_freq / clk_freq) - 6) * 2 / 3;
535 qup->clk_ctl = ((fs_div / 2) << 16) | (hs_div << 8) | (fs_div & 0xff);
538 dev_dbg(dev, "clk_ctl %u\n", qup->clk_ctl);
543 /* Probe to see if a chip is present. */
544 static int qup_i2c_probe_chip(struct udevice *dev, uint chip_addr,
547 struct qup_i2c_priv *qup = dev_get_priv(dev);
548 u32 hw_ver = readl(qup->base + QUP_HW_VERSION);
550 return hw_ver ? 0 : -1;
553 static const struct dm_i2c_ops qup_i2c_ops = {
554 .xfer = qup_i2c_xfer_v2,
555 .probe_chip = qup_i2c_probe_chip,
556 .set_bus_speed = qup_i2c_set_bus_speed,
560 * Currently this driver only supports v2.x of QUP I2C controller, hence
561 * functions above are named with a _v2 suffix. So when we have the
562 * v1.1.1 support added as per the Linux counterpart then it should be easy
563 * to add corresponding functions named with a _v1 suffix.
565 static const struct udevice_id qup_i2c_ids[] = {
566 { .compatible = "qcom,i2c-qup-v2.1.1" },
567 { .compatible = "qcom,i2c-qup-v2.2.1" },
571 U_BOOT_DRIVER(i2c_qup) = {
574 .of_match = qup_i2c_ids,
575 .probe = qup_i2c_probe,
576 .priv_auto = sizeof(struct qup_i2c_priv),