1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* linux/drivers/i2c/busses/i2c-s3c2410.c
4 * Copyright (C) 2004,2005,2009 Simtec Electronics
5 * Ben Dooks <ben@simtec.co.uk>
7 * S3C2410 I2C Controller
10 #include <linux/kernel.h>
11 #include <linux/module.h>
13 #include <linux/i2c.h>
14 #include <linux/init.h>
15 #include <linux/time.h>
16 #include <linux/interrupt.h>
17 #include <linux/delay.h>
18 #include <linux/errno.h>
19 #include <linux/err.h>
20 #include <linux/platform_device.h>
21 #include <linux/pm_runtime.h>
22 #include <linux/clk.h>
23 #include <linux/cpufreq.h>
24 #include <linux/slab.h>
27 #include <linux/gpio/consumer.h>
28 #include <linux/pinctrl/consumer.h>
29 #include <linux/mfd/syscon.h>
30 #include <linux/regmap.h>
34 #include <linux/platform_data/i2c-s3c2410.h>
36 /* see s3c2410x user guide, v1.1, section 9 (p447) for more info */
38 #define S3C2410_IICCON 0x00
39 #define S3C2410_IICSTAT 0x04
40 #define S3C2410_IICADD 0x08
41 #define S3C2410_IICDS 0x0C
42 #define S3C2440_IICLC 0x10
44 #define S3C2410_IICCON_ACKEN (1 << 7)
45 #define S3C2410_IICCON_TXDIV_16 (0 << 6)
46 #define S3C2410_IICCON_TXDIV_512 (1 << 6)
47 #define S3C2410_IICCON_IRQEN (1 << 5)
48 #define S3C2410_IICCON_IRQPEND (1 << 4)
49 #define S3C2410_IICCON_SCALE(x) ((x) & 0xf)
50 #define S3C2410_IICCON_SCALEMASK (0xf)
52 #define S3C2410_IICSTAT_MASTER_RX (2 << 6)
53 #define S3C2410_IICSTAT_MASTER_TX (3 << 6)
54 #define S3C2410_IICSTAT_SLAVE_RX (0 << 6)
55 #define S3C2410_IICSTAT_SLAVE_TX (1 << 6)
56 #define S3C2410_IICSTAT_MODEMASK (3 << 6)
58 #define S3C2410_IICSTAT_START (1 << 5)
59 #define S3C2410_IICSTAT_BUSBUSY (1 << 5)
60 #define S3C2410_IICSTAT_TXRXEN (1 << 4)
61 #define S3C2410_IICSTAT_ARBITR (1 << 3)
62 #define S3C2410_IICSTAT_ASSLAVE (1 << 2)
63 #define S3C2410_IICSTAT_ADDR0 (1 << 1)
64 #define S3C2410_IICSTAT_LASTBIT (1 << 0)
66 #define S3C2410_IICLC_SDA_DELAY0 (0 << 0)
67 #define S3C2410_IICLC_SDA_DELAY5 (1 << 0)
68 #define S3C2410_IICLC_SDA_DELAY10 (2 << 0)
69 #define S3C2410_IICLC_SDA_DELAY15 (3 << 0)
70 #define S3C2410_IICLC_SDA_DELAY_MASK (3 << 0)
72 #define S3C2410_IICLC_FILTER_ON (1 << 2)
74 /* Treat S3C2410 as baseline hardware, anything else is supported via quirks */
75 #define QUIRK_S3C2440 (1 << 0)
76 #define QUIRK_HDMIPHY (1 << 1)
77 #define QUIRK_NO_GPIO (1 << 2)
78 #define QUIRK_POLL (1 << 3)
80 /* Max time to wait for bus to become idle after a xfer (in us) */
81 #define S3C2410_IDLE_TIMEOUT 5000
83 /* Exynos5 Sysreg offset */
84 #define EXYNOS5_SYS_I2C_CFG 0x0234
86 /* i2c controller state */
87 enum s3c24xx_i2c_state {
96 wait_queue_head_t wait;
97 kernel_ulong_t quirks;
100 unsigned int msg_num;
101 unsigned int msg_idx;
102 unsigned int msg_ptr;
104 unsigned int tx_setup;
107 enum s3c24xx_i2c_state state;
108 unsigned long clkrate;
113 struct i2c_adapter adap;
115 struct s3c2410_platform_i2c *pdata;
116 struct gpio_desc *gpios[2];
117 struct pinctrl *pctrl;
118 #if defined(CONFIG_ARM_S3C24XX_CPUFREQ)
119 struct notifier_block freq_transition;
121 struct regmap *sysreg;
122 unsigned int sys_i2c_cfg;
125 static const struct platform_device_id s3c24xx_driver_ids[] = {
127 .name = "s3c2410-i2c",
130 .name = "s3c2440-i2c",
131 .driver_data = QUIRK_S3C2440,
133 .name = "s3c2440-hdmiphy-i2c",
134 .driver_data = QUIRK_S3C2440 | QUIRK_HDMIPHY | QUIRK_NO_GPIO,
137 MODULE_DEVICE_TABLE(platform, s3c24xx_driver_ids);
139 static int i2c_s3c_irq_nextbyte(struct s3c24xx_i2c *i2c, unsigned long iicstat);
142 static const struct of_device_id s3c24xx_i2c_match[] = {
143 { .compatible = "samsung,s3c2410-i2c", .data = (void *)0 },
144 { .compatible = "samsung,s3c2440-i2c", .data = (void *)QUIRK_S3C2440 },
145 { .compatible = "samsung,s3c2440-hdmiphy-i2c",
146 .data = (void *)(QUIRK_S3C2440 | QUIRK_HDMIPHY | QUIRK_NO_GPIO) },
147 { .compatible = "samsung,exynos5-sata-phy-i2c",
148 .data = (void *)(QUIRK_S3C2440 | QUIRK_POLL | QUIRK_NO_GPIO) },
151 MODULE_DEVICE_TABLE(of, s3c24xx_i2c_match);
155 * Get controller type either from device tree or platform device variant.
157 static inline kernel_ulong_t s3c24xx_get_device_quirks(struct platform_device *pdev)
159 if (pdev->dev.of_node) {
160 const struct of_device_id *match;
162 match = of_match_node(s3c24xx_i2c_match, pdev->dev.of_node);
163 return (kernel_ulong_t)match->data;
166 return platform_get_device_id(pdev)->driver_data;
170 * Complete the message and wake up the caller, using the given return code,
171 * or zero to mean ok.
173 static inline void s3c24xx_i2c_master_complete(struct s3c24xx_i2c *i2c, int ret)
175 dev_dbg(i2c->dev, "master_complete %d\n", ret);
184 if (!(i2c->quirks & QUIRK_POLL))
188 static inline void s3c24xx_i2c_disable_ack(struct s3c24xx_i2c *i2c)
192 tmp = readl(i2c->regs + S3C2410_IICCON);
193 writel(tmp & ~S3C2410_IICCON_ACKEN, i2c->regs + S3C2410_IICCON);
196 static inline void s3c24xx_i2c_enable_ack(struct s3c24xx_i2c *i2c)
200 tmp = readl(i2c->regs + S3C2410_IICCON);
201 writel(tmp | S3C2410_IICCON_ACKEN, i2c->regs + S3C2410_IICCON);
204 /* irq enable/disable functions */
205 static inline void s3c24xx_i2c_disable_irq(struct s3c24xx_i2c *i2c)
209 tmp = readl(i2c->regs + S3C2410_IICCON);
210 writel(tmp & ~S3C2410_IICCON_IRQEN, i2c->regs + S3C2410_IICCON);
213 static inline void s3c24xx_i2c_enable_irq(struct s3c24xx_i2c *i2c)
217 tmp = readl(i2c->regs + S3C2410_IICCON);
218 writel(tmp | S3C2410_IICCON_IRQEN, i2c->regs + S3C2410_IICCON);
221 static bool is_ack(struct s3c24xx_i2c *i2c)
225 for (tries = 50; tries; --tries) {
226 unsigned long tmp = readl(i2c->regs + S3C2410_IICCON);
228 if (!(tmp & S3C2410_IICCON_ACKEN)) {
230 * Wait a bit for the bus to stabilize,
231 * delay estimated experimentally.
233 usleep_range(100, 200);
236 if (tmp & S3C2410_IICCON_IRQPEND) {
237 if (!(readl(i2c->regs + S3C2410_IICSTAT)
238 & S3C2410_IICSTAT_LASTBIT))
241 usleep_range(1000, 2000);
243 dev_err(i2c->dev, "ack was not received\n");
248 * put the start of a message onto the bus
250 static void s3c24xx_i2c_message_start(struct s3c24xx_i2c *i2c,
253 unsigned int addr = (msg->addr & 0x7f) << 1;
255 unsigned long iiccon;
258 stat |= S3C2410_IICSTAT_TXRXEN;
260 if (msg->flags & I2C_M_RD) {
261 stat |= S3C2410_IICSTAT_MASTER_RX;
264 stat |= S3C2410_IICSTAT_MASTER_TX;
266 if (msg->flags & I2C_M_REV_DIR_ADDR)
269 /* todo - check for whether ack wanted or not */
270 s3c24xx_i2c_enable_ack(i2c);
272 iiccon = readl(i2c->regs + S3C2410_IICCON);
273 writel(stat, i2c->regs + S3C2410_IICSTAT);
275 dev_dbg(i2c->dev, "START: %08lx to IICSTAT, %02x to DS\n", stat, addr);
276 writeb(addr, i2c->regs + S3C2410_IICDS);
279 * delay here to ensure the data byte has gotten onto the bus
280 * before the transaction is started
282 ndelay(i2c->tx_setup);
284 dev_dbg(i2c->dev, "iiccon, %08lx\n", iiccon);
285 writel(iiccon, i2c->regs + S3C2410_IICCON);
287 stat |= S3C2410_IICSTAT_START;
288 writel(stat, i2c->regs + S3C2410_IICSTAT);
291 static inline void s3c24xx_i2c_stop(struct s3c24xx_i2c *i2c, int ret)
293 unsigned long iicstat = readl(i2c->regs + S3C2410_IICSTAT);
295 dev_dbg(i2c->dev, "STOP\n");
298 * The datasheet says that the STOP sequence should be:
299 * 1) I2CSTAT.5 = 0 - Clear BUSY (or 'generate STOP')
300 * 2) I2CCON.4 = 0 - Clear IRQPEND
301 * 3) Wait until the stop condition takes effect.
302 * 4*) I2CSTAT.4 = 0 - Clear TXRXEN
304 * Where, step "4*" is only for buses with the "HDMIPHY" quirk.
306 * However, after much experimentation, it appears that:
307 * a) normal buses automatically clear BUSY and transition from
308 * Master->Slave when they complete generating a STOP condition.
309 * Therefore, step (3) can be done in doxfer() by polling I2CCON.4
310 * after starting the STOP generation here.
311 * b) HDMIPHY bus does neither, so there is no way to do step 3.
312 * There is no indication when this bus has finished generating
315 * In fact, we have found that as soon as the IRQPEND bit is cleared in
316 * step 2, the HDMIPHY bus generates the STOP condition, and then
317 * immediately starts transferring another data byte, even though the
318 * bus is supposedly stopped. This is presumably because the bus is
319 * still in "Master" mode, and its BUSY bit is still set.
321 * To avoid these extra post-STOP transactions on HDMI phy devices, we
322 * just disable Serial Output on the bus (I2CSTAT.4 = 0) directly,
323 * instead of first generating a proper STOP condition. This should
324 * float SDA & SCK terminating the transfer. Subsequent transfers
325 * start with a proper START condition, and proceed normally.
327 * The HDMIPHY bus is an internal bus that always has exactly two
328 * devices, the host as Master and the HDMIPHY device as the slave.
329 * Skipping the STOP condition has been tested on this bus and works.
331 if (i2c->quirks & QUIRK_HDMIPHY) {
332 /* Stop driving the I2C pins */
333 iicstat &= ~S3C2410_IICSTAT_TXRXEN;
335 /* stop the transfer */
336 iicstat &= ~S3C2410_IICSTAT_START;
338 writel(iicstat, i2c->regs + S3C2410_IICSTAT);
340 i2c->state = STATE_STOP;
342 s3c24xx_i2c_master_complete(i2c, ret);
343 s3c24xx_i2c_disable_irq(i2c);
347 * helper functions to determine the current state in the set of
348 * messages we are sending
352 * returns TRUE if the current message is the last in the set
354 static inline int is_lastmsg(struct s3c24xx_i2c *i2c)
356 return i2c->msg_idx >= (i2c->msg_num - 1);
360 * returns TRUE if we this is the last byte in the current message
362 static inline int is_msglast(struct s3c24xx_i2c *i2c)
365 * msg->len is always 1 for the first byte of smbus block read.
366 * Actual length will be read from slave. More bytes will be
367 * read according to the length then.
369 if (i2c->msg->flags & I2C_M_RECV_LEN && i2c->msg->len == 1)
372 return i2c->msg_ptr == i2c->msg->len-1;
376 * returns TRUE if we reached the end of the current message
378 static inline int is_msgend(struct s3c24xx_i2c *i2c)
380 return i2c->msg_ptr >= i2c->msg->len;
384 * process an interrupt and work out what to do
386 static int i2c_s3c_irq_nextbyte(struct s3c24xx_i2c *i2c, unsigned long iicstat)
392 switch (i2c->state) {
395 dev_err(i2c->dev, "%s: called in STATE_IDLE\n", __func__);
399 dev_err(i2c->dev, "%s: called in STATE_STOP\n", __func__);
400 s3c24xx_i2c_disable_irq(i2c);
405 * last thing we did was send a start condition on the
406 * bus, or started a new i2c message
408 if (iicstat & S3C2410_IICSTAT_LASTBIT &&
409 !(i2c->msg->flags & I2C_M_IGNORE_NAK)) {
410 /* ack was not received... */
411 dev_dbg(i2c->dev, "ack was not received\n");
412 s3c24xx_i2c_stop(i2c, -ENXIO);
416 if (i2c->msg->flags & I2C_M_RD)
417 i2c->state = STATE_READ;
419 i2c->state = STATE_WRITE;
422 * Terminate the transfer if there is nothing to do
423 * as this is used by the i2c probe to find devices.
425 if (is_lastmsg(i2c) && i2c->msg->len == 0) {
426 s3c24xx_i2c_stop(i2c, 0);
430 if (i2c->state == STATE_READ)
434 * fall through to the write state, as we will need to
435 * send a byte as well
440 * we are writing data to the device... check for the
441 * end of the message, and if so, work out what to do
443 if (!(i2c->msg->flags & I2C_M_IGNORE_NAK)) {
444 if (iicstat & S3C2410_IICSTAT_LASTBIT) {
445 dev_dbg(i2c->dev, "WRITE: No Ack\n");
447 s3c24xx_i2c_stop(i2c, -ECONNREFUSED);
454 if (!is_msgend(i2c)) {
455 byte = i2c->msg->buf[i2c->msg_ptr++];
456 writeb(byte, i2c->regs + S3C2410_IICDS);
459 * delay after writing the byte to allow the
460 * data setup time on the bus, as writing the
461 * data to the register causes the first bit
462 * to appear on SDA, and SCL will change as
463 * soon as the interrupt is acknowledged
465 ndelay(i2c->tx_setup);
467 } else if (!is_lastmsg(i2c)) {
468 /* we need to go to the next i2c message */
470 dev_dbg(i2c->dev, "WRITE: Next Message\n");
476 /* check to see if we need to do another message */
477 if (i2c->msg->flags & I2C_M_NOSTART) {
479 if (i2c->msg->flags & I2C_M_RD) {
481 * cannot do this, the controller
482 * forces us to send a new START
483 * when we change direction
486 "missing START before write->read\n");
487 s3c24xx_i2c_stop(i2c, -EINVAL);
493 /* send the new start */
494 s3c24xx_i2c_message_start(i2c, i2c->msg);
495 i2c->state = STATE_START;
500 s3c24xx_i2c_stop(i2c, 0);
506 * we have a byte of data in the data register, do
507 * something with it, and then work out whether we are
508 * going to do any more read/write
510 byte = readb(i2c->regs + S3C2410_IICDS);
511 i2c->msg->buf[i2c->msg_ptr++] = byte;
513 /* Add actual length to read for smbus block read */
514 if (i2c->msg->flags & I2C_M_RECV_LEN && i2c->msg->len == 1)
515 i2c->msg->len += byte;
517 if (is_msglast(i2c)) {
518 /* last byte of buffer */
521 s3c24xx_i2c_disable_ack(i2c);
523 } else if (is_msgend(i2c)) {
525 * ok, we've read the entire buffer, see if there
526 * is anything else we need to do
528 if (is_lastmsg(i2c)) {
529 /* last message, send stop and complete */
530 dev_dbg(i2c->dev, "READ: Send Stop\n");
532 s3c24xx_i2c_stop(i2c, 0);
534 /* go to the next transfer */
535 dev_dbg(i2c->dev, "READ: Next Transfer\n");
546 /* acknowlegde the IRQ and get back on with the work */
549 tmp = readl(i2c->regs + S3C2410_IICCON);
550 tmp &= ~S3C2410_IICCON_IRQPEND;
551 writel(tmp, i2c->regs + S3C2410_IICCON);
557 * top level IRQ servicing routine
559 static irqreturn_t s3c24xx_i2c_irq(int irqno, void *dev_id)
561 struct s3c24xx_i2c *i2c = dev_id;
562 unsigned long status;
565 status = readl(i2c->regs + S3C2410_IICSTAT);
567 if (status & S3C2410_IICSTAT_ARBITR) {
568 /* deal with arbitration loss */
569 dev_err(i2c->dev, "deal with arbitration loss\n");
572 if (i2c->state == STATE_IDLE) {
573 dev_dbg(i2c->dev, "IRQ: error i2c->state == IDLE\n");
575 tmp = readl(i2c->regs + S3C2410_IICCON);
576 tmp &= ~S3C2410_IICCON_IRQPEND;
577 writel(tmp, i2c->regs + S3C2410_IICCON);
582 * pretty much this leaves us with the fact that we've
583 * transmitted or received whatever byte we last sent
585 i2c_s3c_irq_nextbyte(i2c, status);
592 * Disable the bus so that we won't get any interrupts from now on, or try
593 * to drive any lines. This is the default state when we don't have
594 * anything to send/receive.
596 * If there is an event on the bus, or we have a pre-existing event at
597 * kernel boot time, we may not notice the event and the I2C controller
598 * will lock the bus with the I2C clock line low indefinitely.
600 static inline void s3c24xx_i2c_disable_bus(struct s3c24xx_i2c *i2c)
604 /* Stop driving the I2C pins */
605 tmp = readl(i2c->regs + S3C2410_IICSTAT);
606 tmp &= ~S3C2410_IICSTAT_TXRXEN;
607 writel(tmp, i2c->regs + S3C2410_IICSTAT);
609 /* We don't expect any interrupts now, and don't want send acks */
610 tmp = readl(i2c->regs + S3C2410_IICCON);
611 tmp &= ~(S3C2410_IICCON_IRQEN | S3C2410_IICCON_IRQPEND |
612 S3C2410_IICCON_ACKEN);
613 writel(tmp, i2c->regs + S3C2410_IICCON);
618 * get the i2c bus for a master transaction
620 static int s3c24xx_i2c_set_master(struct s3c24xx_i2c *i2c)
622 unsigned long iicstat;
625 while (timeout-- > 0) {
626 iicstat = readl(i2c->regs + S3C2410_IICSTAT);
628 if (!(iicstat & S3C2410_IICSTAT_BUSBUSY))
638 * wait for the i2c bus to become idle.
640 static void s3c24xx_i2c_wait_idle(struct s3c24xx_i2c *i2c)
642 unsigned long iicstat;
647 /* ensure the stop has been through the bus */
649 dev_dbg(i2c->dev, "waiting for bus idle\n");
651 start = now = ktime_get();
654 * Most of the time, the bus is already idle within a few usec of the
655 * end of a transaction. However, really slow i2c devices can stretch
656 * the clock, delaying STOP generation.
658 * On slower SoCs this typically happens within a very small number of
659 * instructions so busy wait briefly to avoid scheduling overhead.
662 iicstat = readl(i2c->regs + S3C2410_IICSTAT);
663 while ((iicstat & S3C2410_IICSTAT_START) && --spins) {
665 iicstat = readl(i2c->regs + S3C2410_IICSTAT);
669 * If we do get an appreciable delay as a compromise between idle
670 * detection latency for the normal, fast case, and system load in the
671 * slow device case, use an exponential back off in the polling loop,
672 * up to 1/10th of the total timeout, then continue to poll at a
673 * constant rate up to the timeout.
676 while ((iicstat & S3C2410_IICSTAT_START) &&
677 ktime_us_delta(now, start) < S3C2410_IDLE_TIMEOUT) {
678 usleep_range(delay, 2 * delay);
679 if (delay < S3C2410_IDLE_TIMEOUT / 10)
682 iicstat = readl(i2c->regs + S3C2410_IICSTAT);
685 if (iicstat & S3C2410_IICSTAT_START)
686 dev_warn(i2c->dev, "timeout waiting for bus idle\n");
690 * this starts an i2c transfer
692 static int s3c24xx_i2c_doxfer(struct s3c24xx_i2c *i2c,
693 struct i2c_msg *msgs, int num)
695 unsigned long timeout = 0;
698 ret = s3c24xx_i2c_set_master(i2c);
700 dev_err(i2c->dev, "cannot get bus (error %d)\n", ret);
709 i2c->state = STATE_START;
711 s3c24xx_i2c_enable_irq(i2c);
712 s3c24xx_i2c_message_start(i2c, msgs);
714 if (i2c->quirks & QUIRK_POLL) {
715 while ((i2c->msg_num != 0) && is_ack(i2c)) {
716 unsigned long stat = readl(i2c->regs + S3C2410_IICSTAT);
718 i2c_s3c_irq_nextbyte(i2c, stat);
720 stat = readl(i2c->regs + S3C2410_IICSTAT);
721 if (stat & S3C2410_IICSTAT_ARBITR)
722 dev_err(i2c->dev, "deal with arbitration loss\n");
725 timeout = wait_event_timeout(i2c->wait, i2c->msg_num == 0, HZ * 5);
731 * Having these next two as dev_err() makes life very
732 * noisy when doing an i2cdetect
735 dev_dbg(i2c->dev, "timeout\n");
737 dev_dbg(i2c->dev, "incomplete xfer (%d)\n", ret);
739 /* For QUIRK_HDMIPHY, bus is already disabled */
740 if (i2c->quirks & QUIRK_HDMIPHY)
743 s3c24xx_i2c_wait_idle(i2c);
745 s3c24xx_i2c_disable_bus(i2c);
748 i2c->state = STATE_IDLE;
754 * first port of call from the i2c bus code when an message needs
755 * transferring across the i2c bus.
757 static int s3c24xx_i2c_xfer(struct i2c_adapter *adap,
758 struct i2c_msg *msgs, int num)
760 struct s3c24xx_i2c *i2c = (struct s3c24xx_i2c *)adap->algo_data;
764 ret = clk_enable(i2c->clk);
768 for (retry = 0; retry < adap->retries; retry++) {
770 ret = s3c24xx_i2c_doxfer(i2c, msgs, num);
772 if (ret != -EAGAIN) {
773 clk_disable(i2c->clk);
777 dev_dbg(i2c->dev, "Retrying transmission (%d)\n", retry);
782 clk_disable(i2c->clk);
786 /* declare our i2c functionality */
787 static u32 s3c24xx_i2c_func(struct i2c_adapter *adap)
789 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_NOSTART |
790 I2C_FUNC_PROTOCOL_MANGLING;
793 /* i2c bus registration info */
794 static const struct i2c_algorithm s3c24xx_i2c_algorithm = {
795 .master_xfer = s3c24xx_i2c_xfer,
796 .functionality = s3c24xx_i2c_func,
800 * return the divisor settings for a given frequency
802 static int s3c24xx_i2c_calcdivisor(unsigned long clkin, unsigned int wanted,
803 unsigned int *div1, unsigned int *divs)
805 unsigned int calc_divs = clkin / wanted;
806 unsigned int calc_div1;
808 if (calc_divs > (16*16))
813 calc_divs += calc_div1-1;
814 calc_divs /= calc_div1;
824 return clkin / (calc_divs * calc_div1);
828 * work out a divisor for the user requested frequency setting,
829 * either by the requested frequency, or scanning the acceptable
830 * range of frequencies until something is found
832 static int s3c24xx_i2c_clockrate(struct s3c24xx_i2c *i2c, unsigned int *got)
834 struct s3c2410_platform_i2c *pdata = i2c->pdata;
835 unsigned long clkin = clk_get_rate(i2c->clk);
836 unsigned int divs, div1;
837 unsigned long target_frequency;
841 i2c->clkrate = clkin;
842 clkin /= 1000; /* clkin now in KHz */
844 dev_dbg(i2c->dev, "pdata desired frequency %lu\n", pdata->frequency);
846 target_frequency = pdata->frequency ?: I2C_MAX_STANDARD_MODE_FREQ;
848 target_frequency /= 1000; /* Target frequency now in KHz */
850 freq = s3c24xx_i2c_calcdivisor(clkin, target_frequency, &div1, &divs);
852 if (freq > target_frequency) {
854 "Unable to achieve desired frequency %luKHz." \
855 " Lowest achievable %dKHz\n", target_frequency, freq);
861 iiccon = readl(i2c->regs + S3C2410_IICCON);
862 iiccon &= ~(S3C2410_IICCON_SCALEMASK | S3C2410_IICCON_TXDIV_512);
866 iiccon |= S3C2410_IICCON_TXDIV_512;
868 if (i2c->quirks & QUIRK_POLL)
869 iiccon |= S3C2410_IICCON_SCALE(2);
871 writel(iiccon, i2c->regs + S3C2410_IICCON);
873 if (i2c->quirks & QUIRK_S3C2440) {
874 unsigned long sda_delay;
876 if (pdata->sda_delay) {
877 sda_delay = clkin * pdata->sda_delay;
878 sda_delay = DIV_ROUND_UP(sda_delay, 1000000);
879 sda_delay = DIV_ROUND_UP(sda_delay, 5);
882 sda_delay |= S3C2410_IICLC_FILTER_ON;
886 dev_dbg(i2c->dev, "IICLC=%08lx\n", sda_delay);
887 writel(sda_delay, i2c->regs + S3C2440_IICLC);
893 #if defined(CONFIG_ARM_S3C24XX_CPUFREQ)
895 #define freq_to_i2c(_n) container_of(_n, struct s3c24xx_i2c, freq_transition)
897 static int s3c24xx_i2c_cpufreq_transition(struct notifier_block *nb,
898 unsigned long val, void *data)
900 struct s3c24xx_i2c *i2c = freq_to_i2c(nb);
905 delta_f = clk_get_rate(i2c->clk) - i2c->clkrate;
907 /* if we're post-change and the input clock has slowed down
908 * or at pre-change and the clock is about to speed up, then
909 * adjust our clock rate. <0 is slow, >0 speedup.
912 if ((val == CPUFREQ_POSTCHANGE && delta_f < 0) ||
913 (val == CPUFREQ_PRECHANGE && delta_f > 0)) {
914 i2c_lock_bus(&i2c->adap, I2C_LOCK_ROOT_ADAPTER);
915 ret = s3c24xx_i2c_clockrate(i2c, &got);
916 i2c_unlock_bus(&i2c->adap, I2C_LOCK_ROOT_ADAPTER);
919 dev_err(i2c->dev, "cannot find frequency (%d)\n", ret);
921 dev_info(i2c->dev, "setting freq %d\n", got);
927 static inline int s3c24xx_i2c_register_cpufreq(struct s3c24xx_i2c *i2c)
929 i2c->freq_transition.notifier_call = s3c24xx_i2c_cpufreq_transition;
931 return cpufreq_register_notifier(&i2c->freq_transition,
932 CPUFREQ_TRANSITION_NOTIFIER);
935 static inline void s3c24xx_i2c_deregister_cpufreq(struct s3c24xx_i2c *i2c)
937 cpufreq_unregister_notifier(&i2c->freq_transition,
938 CPUFREQ_TRANSITION_NOTIFIER);
942 static inline int s3c24xx_i2c_register_cpufreq(struct s3c24xx_i2c *i2c)
947 static inline void s3c24xx_i2c_deregister_cpufreq(struct s3c24xx_i2c *i2c)
953 static int s3c24xx_i2c_parse_dt_gpio(struct s3c24xx_i2c *i2c)
957 if (i2c->quirks & QUIRK_NO_GPIO)
960 for (i = 0; i < 2; i++) {
961 i2c->gpios[i] = devm_gpiod_get_index(i2c->dev, NULL,
963 if (IS_ERR(i2c->gpios[i])) {
964 dev_err(i2c->dev, "i2c gpio invalid at index %d\n", i);
972 static int s3c24xx_i2c_parse_dt_gpio(struct s3c24xx_i2c *i2c)
979 * initialise the controller, set the IO lines and frequency
981 static int s3c24xx_i2c_init(struct s3c24xx_i2c *i2c)
983 struct s3c2410_platform_i2c *pdata;
986 /* get the plafrom data */
990 /* write slave address */
992 writeb(pdata->slave_addr, i2c->regs + S3C2410_IICADD);
994 dev_info(i2c->dev, "slave address 0x%02x\n", pdata->slave_addr);
996 writel(0, i2c->regs + S3C2410_IICCON);
997 writel(0, i2c->regs + S3C2410_IICSTAT);
999 /* we need to work out the divisors for the clock... */
1001 if (s3c24xx_i2c_clockrate(i2c, &freq) != 0) {
1002 dev_err(i2c->dev, "cannot meet bus frequency required\n");
1006 /* todo - check that the i2c lines aren't being dragged anywhere */
1008 dev_info(i2c->dev, "bus frequency set to %d KHz\n", freq);
1009 dev_dbg(i2c->dev, "S3C2410_IICCON=0x%02x\n",
1010 readl(i2c->regs + S3C2410_IICCON));
1017 * Parse the device tree node and retreive the platform data.
1020 s3c24xx_i2c_parse_dt(struct device_node *np, struct s3c24xx_i2c *i2c)
1022 struct s3c2410_platform_i2c *pdata = i2c->pdata;
1028 pdata->bus_num = -1; /* i2c bus number is dynamically assigned */
1029 of_property_read_u32(np, "samsung,i2c-sda-delay", &pdata->sda_delay);
1030 of_property_read_u32(np, "samsung,i2c-slave-addr", &pdata->slave_addr);
1031 of_property_read_u32(np, "samsung,i2c-max-bus-freq",
1032 (u32 *)&pdata->frequency);
1034 * Exynos5's legacy i2c controller and new high speed i2c
1035 * controller have muxed interrupt sources. By default the
1036 * interrupts for 4-channel HS-I2C controller are enabled.
1037 * If nodes for first four channels of legacy i2c controller
1038 * are available then re-configure the interrupts via the
1041 id = of_alias_get_id(np, "i2c");
1042 i2c->sysreg = syscon_regmap_lookup_by_phandle(np,
1043 "samsung,sysreg-phandle");
1044 if (IS_ERR(i2c->sysreg))
1047 regmap_update_bits(i2c->sysreg, EXYNOS5_SYS_I2C_CFG, BIT(id), 0);
1051 s3c24xx_i2c_parse_dt(struct device_node *np, struct s3c24xx_i2c *i2c) { }
1054 static int s3c24xx_i2c_probe(struct platform_device *pdev)
1056 struct s3c24xx_i2c *i2c;
1057 struct s3c2410_platform_i2c *pdata = NULL;
1058 struct resource *res;
1061 if (!pdev->dev.of_node) {
1062 pdata = dev_get_platdata(&pdev->dev);
1064 dev_err(&pdev->dev, "no platform data\n");
1069 i2c = devm_kzalloc(&pdev->dev, sizeof(struct s3c24xx_i2c), GFP_KERNEL);
1073 i2c->pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
1077 i2c->quirks = s3c24xx_get_device_quirks(pdev);
1078 i2c->sysreg = ERR_PTR(-ENOENT);
1080 memcpy(i2c->pdata, pdata, sizeof(*pdata));
1082 s3c24xx_i2c_parse_dt(pdev->dev.of_node, i2c);
1084 strlcpy(i2c->adap.name, "s3c2410-i2c", sizeof(i2c->adap.name));
1085 i2c->adap.owner = THIS_MODULE;
1086 i2c->adap.algo = &s3c24xx_i2c_algorithm;
1087 i2c->adap.retries = 2;
1088 i2c->adap.class = I2C_CLASS_DEPRECATED;
1091 init_waitqueue_head(&i2c->wait);
1093 /* find the clock and enable it */
1094 i2c->dev = &pdev->dev;
1095 i2c->clk = devm_clk_get(&pdev->dev, "i2c");
1096 if (IS_ERR(i2c->clk)) {
1097 dev_err(&pdev->dev, "cannot get clock\n");
1101 dev_dbg(&pdev->dev, "clock source %p\n", i2c->clk);
1103 /* map the registers */
1104 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1105 i2c->regs = devm_ioremap_resource(&pdev->dev, res);
1107 if (IS_ERR(i2c->regs))
1108 return PTR_ERR(i2c->regs);
1110 dev_dbg(&pdev->dev, "registers %p (%p)\n",
1113 /* setup info block for the i2c core */
1114 i2c->adap.algo_data = i2c;
1115 i2c->adap.dev.parent = &pdev->dev;
1116 i2c->pctrl = devm_pinctrl_get_select_default(i2c->dev);
1118 /* inititalise the i2c gpio lines */
1119 if (i2c->pdata->cfg_gpio)
1120 i2c->pdata->cfg_gpio(to_platform_device(i2c->dev));
1121 else if (IS_ERR(i2c->pctrl) && s3c24xx_i2c_parse_dt_gpio(i2c))
1124 /* initialise the i2c controller */
1125 ret = clk_prepare_enable(i2c->clk);
1127 dev_err(&pdev->dev, "I2C clock enable failed\n");
1131 ret = s3c24xx_i2c_init(i2c);
1132 clk_disable(i2c->clk);
1134 dev_err(&pdev->dev, "I2C controller init failed\n");
1135 clk_unprepare(i2c->clk);
1140 * find the IRQ for this unit (note, this relies on the init call to
1141 * ensure no current IRQs pending
1143 if (!(i2c->quirks & QUIRK_POLL)) {
1144 i2c->irq = ret = platform_get_irq(pdev, 0);
1146 dev_err(&pdev->dev, "cannot find IRQ\n");
1147 clk_unprepare(i2c->clk);
1151 ret = devm_request_irq(&pdev->dev, i2c->irq, s3c24xx_i2c_irq,
1152 0, dev_name(&pdev->dev), i2c);
1154 dev_err(&pdev->dev, "cannot claim IRQ %d\n", i2c->irq);
1155 clk_unprepare(i2c->clk);
1160 ret = s3c24xx_i2c_register_cpufreq(i2c);
1162 dev_err(&pdev->dev, "failed to register cpufreq notifier\n");
1163 clk_unprepare(i2c->clk);
1168 * Note, previous versions of the driver used i2c_add_adapter()
1169 * to add the bus at any number. We now pass the bus number via
1170 * the platform data, so if unset it will now default to always
1173 i2c->adap.nr = i2c->pdata->bus_num;
1174 i2c->adap.dev.of_node = pdev->dev.of_node;
1176 platform_set_drvdata(pdev, i2c);
1178 pm_runtime_enable(&pdev->dev);
1180 ret = i2c_add_numbered_adapter(&i2c->adap);
1182 pm_runtime_disable(&pdev->dev);
1183 s3c24xx_i2c_deregister_cpufreq(i2c);
1184 clk_unprepare(i2c->clk);
1188 dev_info(&pdev->dev, "%s: S3C I2C adapter\n", dev_name(&i2c->adap.dev));
1192 static int s3c24xx_i2c_remove(struct platform_device *pdev)
1194 struct s3c24xx_i2c *i2c = platform_get_drvdata(pdev);
1196 clk_unprepare(i2c->clk);
1198 pm_runtime_disable(&pdev->dev);
1200 s3c24xx_i2c_deregister_cpufreq(i2c);
1202 i2c_del_adapter(&i2c->adap);
1207 #ifdef CONFIG_PM_SLEEP
1208 static int s3c24xx_i2c_suspend_noirq(struct device *dev)
1210 struct s3c24xx_i2c *i2c = dev_get_drvdata(dev);
1212 i2c_mark_adapter_suspended(&i2c->adap);
1214 if (!IS_ERR(i2c->sysreg))
1215 regmap_read(i2c->sysreg, EXYNOS5_SYS_I2C_CFG, &i2c->sys_i2c_cfg);
1220 static int s3c24xx_i2c_resume_noirq(struct device *dev)
1222 struct s3c24xx_i2c *i2c = dev_get_drvdata(dev);
1225 if (!IS_ERR(i2c->sysreg))
1226 regmap_write(i2c->sysreg, EXYNOS5_SYS_I2C_CFG, i2c->sys_i2c_cfg);
1228 ret = clk_enable(i2c->clk);
1231 s3c24xx_i2c_init(i2c);
1232 clk_disable(i2c->clk);
1233 i2c_mark_adapter_resumed(&i2c->adap);
1240 static const struct dev_pm_ops s3c24xx_i2c_dev_pm_ops = {
1241 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(s3c24xx_i2c_suspend_noirq,
1242 s3c24xx_i2c_resume_noirq)
1245 #define S3C24XX_DEV_PM_OPS (&s3c24xx_i2c_dev_pm_ops)
1247 #define S3C24XX_DEV_PM_OPS NULL
1250 static struct platform_driver s3c24xx_i2c_driver = {
1251 .probe = s3c24xx_i2c_probe,
1252 .remove = s3c24xx_i2c_remove,
1253 .id_table = s3c24xx_driver_ids,
1256 .pm = S3C24XX_DEV_PM_OPS,
1257 .of_match_table = of_match_ptr(s3c24xx_i2c_match),
1261 static int __init i2c_adap_s3c_init(void)
1263 return platform_driver_register(&s3c24xx_i2c_driver);
1265 subsys_initcall(i2c_adap_s3c_init);
1267 static void __exit i2c_adap_s3c_exit(void)
1269 platform_driver_unregister(&s3c24xx_i2c_driver);
1271 module_exit(i2c_adap_s3c_exit);
1273 MODULE_DESCRIPTION("S3C24XX I2C Bus driver");
1274 MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
1275 MODULE_LICENSE("GPL");