1 /* linux/drivers/i2c/busses/i2c-s3c2410.c
3 * Copyright (C) 2004,2005 Simtec Electronics
4 * Ben Dooks <ben@simtec.co.uk>
6 * S3C2410 I2C Controller
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/kernel.h>
24 #include <linux/module.h>
26 #include <linux/i2c.h>
27 #include <linux/i2c-id.h>
28 #include <linux/init.h>
29 #include <linux/time.h>
30 #include <linux/interrupt.h>
31 #include <linux/delay.h>
32 #include <linux/errno.h>
33 #include <linux/err.h>
34 #include <linux/platform_device.h>
35 #include <linux/clk.h>
37 #include <asm/hardware.h>
41 #include <asm/arch/regs-gpio.h>
42 #include <asm/plat-s3c/regs-iic.h>
43 #include <asm/plat-s3c/iic.h>
45 /* i2c controller state */
47 enum s3c24xx_i2c_state {
57 wait_queue_head_t wait;
64 unsigned int tx_setup;
66 enum s3c24xx_i2c_state state;
72 struct resource *ioarea;
73 struct i2c_adapter adap;
76 /* default platform data to use if not supplied in the platform_device
79 static struct s3c2410_platform_i2c s3c24xx_i2c_default_platform = {
84 .sda_delay = S3C2410_IICLC_SDA_DELAY5 | S3C2410_IICLC_FILTER_ON,
87 /* s3c24xx_i2c_is2440()
89 * return true is this is an s3c2440
92 static inline int s3c24xx_i2c_is2440(struct s3c24xx_i2c *i2c)
94 struct platform_device *pdev = to_platform_device(i2c->dev);
96 return !strcmp(pdev->name, "s3c2440-i2c");
100 /* s3c24xx_i2c_get_platformdata
102 * get the platform data associated with the given device, or return
103 * the default if there is none
106 static inline struct s3c2410_platform_i2c *s3c24xx_i2c_get_platformdata(struct device *dev)
108 if (dev->platform_data != NULL)
109 return (struct s3c2410_platform_i2c *)dev->platform_data;
111 return &s3c24xx_i2c_default_platform;
114 /* s3c24xx_i2c_master_complete
116 * complete the message and wake up the caller, using the given return code,
117 * or zero to mean ok.
120 static inline void s3c24xx_i2c_master_complete(struct s3c24xx_i2c *i2c, int ret)
122 dev_dbg(i2c->dev, "master_complete %d\n", ret);
134 static inline void s3c24xx_i2c_disable_ack(struct s3c24xx_i2c *i2c)
138 tmp = readl(i2c->regs + S3C2410_IICCON);
139 writel(tmp & ~S3C2410_IICCON_ACKEN, i2c->regs + S3C2410_IICCON);
143 static inline void s3c24xx_i2c_enable_ack(struct s3c24xx_i2c *i2c)
147 tmp = readl(i2c->regs + S3C2410_IICCON);
148 writel(tmp | S3C2410_IICCON_ACKEN, i2c->regs + S3C2410_IICCON);
152 /* irq enable/disable functions */
154 static inline void s3c24xx_i2c_disable_irq(struct s3c24xx_i2c *i2c)
158 tmp = readl(i2c->regs + S3C2410_IICCON);
159 writel(tmp & ~S3C2410_IICCON_IRQEN, i2c->regs + S3C2410_IICCON);
162 static inline void s3c24xx_i2c_enable_irq(struct s3c24xx_i2c *i2c)
166 tmp = readl(i2c->regs + S3C2410_IICCON);
167 writel(tmp | S3C2410_IICCON_IRQEN, i2c->regs + S3C2410_IICCON);
171 /* s3c24xx_i2c_message_start
173 * put the start of a message onto the bus
176 static void s3c24xx_i2c_message_start(struct s3c24xx_i2c *i2c,
179 unsigned int addr = (msg->addr & 0x7f) << 1;
181 unsigned long iiccon;
184 stat |= S3C2410_IICSTAT_TXRXEN;
186 if (msg->flags & I2C_M_RD) {
187 stat |= S3C2410_IICSTAT_MASTER_RX;
190 stat |= S3C2410_IICSTAT_MASTER_TX;
192 if (msg->flags & I2C_M_REV_DIR_ADDR)
195 // todo - check for wether ack wanted or not
196 s3c24xx_i2c_enable_ack(i2c);
198 iiccon = readl(i2c->regs + S3C2410_IICCON);
199 writel(stat, i2c->regs + S3C2410_IICSTAT);
201 dev_dbg(i2c->dev, "START: %08lx to IICSTAT, %02x to DS\n", stat, addr);
202 writeb(addr, i2c->regs + S3C2410_IICDS);
204 /* delay here to ensure the data byte has gotten onto the bus
205 * before the transaction is started */
207 ndelay(i2c->tx_setup);
209 dev_dbg(i2c->dev, "iiccon, %08lx\n", iiccon);
210 writel(iiccon, i2c->regs + S3C2410_IICCON);
212 stat |= S3C2410_IICSTAT_START;
213 writel(stat, i2c->regs + S3C2410_IICSTAT);
216 static inline void s3c24xx_i2c_stop(struct s3c24xx_i2c *i2c, int ret)
218 unsigned long iicstat = readl(i2c->regs + S3C2410_IICSTAT);
220 dev_dbg(i2c->dev, "STOP\n");
222 /* stop the transfer */
223 iicstat &= ~ S3C2410_IICSTAT_START;
224 writel(iicstat, i2c->regs + S3C2410_IICSTAT);
226 i2c->state = STATE_STOP;
228 s3c24xx_i2c_master_complete(i2c, ret);
229 s3c24xx_i2c_disable_irq(i2c);
232 /* helper functions to determine the current state in the set of
233 * messages we are sending */
237 * returns TRUE if the current message is the last in the set
240 static inline int is_lastmsg(struct s3c24xx_i2c *i2c)
242 return i2c->msg_idx >= (i2c->msg_num - 1);
247 * returns TRUE if we this is the last byte in the current message
250 static inline int is_msglast(struct s3c24xx_i2c *i2c)
252 return i2c->msg_ptr == i2c->msg->len-1;
257 * returns TRUE if we reached the end of the current message
260 static inline int is_msgend(struct s3c24xx_i2c *i2c)
262 return i2c->msg_ptr >= i2c->msg->len;
265 /* i2s_s3c_irq_nextbyte
267 * process an interrupt and work out what to do
270 static int i2s_s3c_irq_nextbyte(struct s3c24xx_i2c *i2c, unsigned long iicstat)
276 switch (i2c->state) {
279 dev_err(i2c->dev, "%s: called in STATE_IDLE\n", __func__);
284 dev_err(i2c->dev, "%s: called in STATE_STOP\n", __func__);
285 s3c24xx_i2c_disable_irq(i2c);
289 /* last thing we did was send a start condition on the
290 * bus, or started a new i2c message
293 if (iicstat & S3C2410_IICSTAT_LASTBIT &&
294 !(i2c->msg->flags & I2C_M_IGNORE_NAK)) {
295 /* ack was not received... */
297 dev_dbg(i2c->dev, "ack was not received\n");
298 s3c24xx_i2c_stop(i2c, -EREMOTEIO);
302 if (i2c->msg->flags & I2C_M_RD)
303 i2c->state = STATE_READ;
305 i2c->state = STATE_WRITE;
307 /* terminate the transfer if there is nothing to do
308 * (used by the i2c probe to find devices */
310 if (is_lastmsg(i2c) && i2c->msg->len == 0) {
311 s3c24xx_i2c_stop(i2c, 0);
315 if (i2c->state == STATE_READ)
318 /* fall through to the write state, as we will need to
319 * send a byte as well */
322 /* we are writing data to the device... check for the
323 * end of the message, and if so, work out what to do
327 if (!is_msgend(i2c)) {
328 byte = i2c->msg->buf[i2c->msg_ptr++];
329 writeb(byte, i2c->regs + S3C2410_IICDS);
331 /* delay after writing the byte to allow the
332 * data setup time on the bus, as writing the
333 * data to the register causes the first bit
334 * to appear on SDA, and SCL will change as
335 * soon as the interrupt is acknowledged */
337 ndelay(i2c->tx_setup);
339 } else if (!is_lastmsg(i2c)) {
340 /* we need to go to the next i2c message */
342 dev_dbg(i2c->dev, "WRITE: Next Message\n");
348 /* check to see if we need to do another message */
349 if (i2c->msg->flags & I2C_M_NOSTART) {
351 if (i2c->msg->flags & I2C_M_RD) {
352 /* cannot do this, the controller
353 * forces us to send a new START
354 * when we change direction */
356 s3c24xx_i2c_stop(i2c, -EINVAL);
362 /* send the new start */
363 s3c24xx_i2c_message_start(i2c, i2c->msg);
364 i2c->state = STATE_START;
370 s3c24xx_i2c_stop(i2c, 0);
375 /* we have a byte of data in the data register, do
376 * something with it, and then work out wether we are
377 * going to do any more read/write
380 if (!(i2c->msg->flags & I2C_M_IGNORE_NAK) &&
381 !(is_msglast(i2c) && is_lastmsg(i2c))) {
383 if (iicstat & S3C2410_IICSTAT_LASTBIT) {
384 dev_dbg(i2c->dev, "READ: No Ack\n");
386 s3c24xx_i2c_stop(i2c, -ECONNREFUSED);
391 byte = readb(i2c->regs + S3C2410_IICDS);
392 i2c->msg->buf[i2c->msg_ptr++] = byte;
395 if (is_msglast(i2c)) {
396 /* last byte of buffer */
399 s3c24xx_i2c_disable_ack(i2c);
401 } else if (is_msgend(i2c)) {
402 /* ok, we've read the entire buffer, see if there
403 * is anything else we need to do */
405 if (is_lastmsg(i2c)) {
406 /* last message, send stop and complete */
407 dev_dbg(i2c->dev, "READ: Send Stop\n");
409 s3c24xx_i2c_stop(i2c, 0);
411 /* go to the next transfer */
412 dev_dbg(i2c->dev, "READ: Next Transfer\n");
423 /* acknowlegde the IRQ and get back on with the work */
426 tmp = readl(i2c->regs + S3C2410_IICCON);
427 tmp &= ~S3C2410_IICCON_IRQPEND;
428 writel(tmp, i2c->regs + S3C2410_IICCON);
435 * top level IRQ servicing routine
438 static irqreturn_t s3c24xx_i2c_irq(int irqno, void *dev_id)
440 struct s3c24xx_i2c *i2c = dev_id;
441 unsigned long status;
444 status = readl(i2c->regs + S3C2410_IICSTAT);
446 if (status & S3C2410_IICSTAT_ARBITR) {
447 // deal with arbitration loss
448 dev_err(i2c->dev, "deal with arbitration loss\n");
451 if (i2c->state == STATE_IDLE) {
452 dev_dbg(i2c->dev, "IRQ: error i2c->state == IDLE\n");
454 tmp = readl(i2c->regs + S3C2410_IICCON);
455 tmp &= ~S3C2410_IICCON_IRQPEND;
456 writel(tmp, i2c->regs + S3C2410_IICCON);
460 /* pretty much this leaves us with the fact that we've
461 * transmitted or received whatever byte we last sent */
463 i2s_s3c_irq_nextbyte(i2c, status);
470 /* s3c24xx_i2c_set_master
472 * get the i2c bus for a master transaction
475 static int s3c24xx_i2c_set_master(struct s3c24xx_i2c *i2c)
477 unsigned long iicstat;
480 while (timeout-- > 0) {
481 iicstat = readl(i2c->regs + S3C2410_IICSTAT);
483 if (!(iicstat & S3C2410_IICSTAT_BUSBUSY))
489 dev_dbg(i2c->dev, "timeout: GPEDAT is %08x\n",
490 __raw_readl(S3C2410_GPEDAT));
495 /* s3c24xx_i2c_doxfer
497 * this starts an i2c transfer
500 static int s3c24xx_i2c_doxfer(struct s3c24xx_i2c *i2c, struct i2c_msg *msgs, int num)
502 unsigned long timeout;
505 ret = s3c24xx_i2c_set_master(i2c);
507 dev_err(i2c->dev, "cannot get bus (error %d)\n", ret);
512 spin_lock_irq(&i2c->lock);
518 i2c->state = STATE_START;
520 s3c24xx_i2c_enable_irq(i2c);
521 s3c24xx_i2c_message_start(i2c, msgs);
522 spin_unlock_irq(&i2c->lock);
524 timeout = wait_event_timeout(i2c->wait, i2c->msg_num == 0, HZ * 5);
528 /* having these next two as dev_err() makes life very
529 * noisy when doing an i2cdetect */
532 dev_dbg(i2c->dev, "timeout\n");
534 dev_dbg(i2c->dev, "incomplete xfer (%d)\n", ret);
536 /* ensure the stop has been through the bus */
546 * first port of call from the i2c bus code when an message needs
547 * transferring across the i2c bus.
550 static int s3c24xx_i2c_xfer(struct i2c_adapter *adap,
551 struct i2c_msg *msgs, int num)
553 struct s3c24xx_i2c *i2c = (struct s3c24xx_i2c *)adap->algo_data;
557 for (retry = 0; retry < adap->retries; retry++) {
559 ret = s3c24xx_i2c_doxfer(i2c, msgs, num);
564 dev_dbg(i2c->dev, "Retrying transmission (%d)\n", retry);
572 /* declare our i2c functionality */
573 static u32 s3c24xx_i2c_func(struct i2c_adapter *adap)
575 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_PROTOCOL_MANGLING;
578 /* i2c bus registration info */
580 static const struct i2c_algorithm s3c24xx_i2c_algorithm = {
581 .master_xfer = s3c24xx_i2c_xfer,
582 .functionality = s3c24xx_i2c_func,
585 static struct s3c24xx_i2c s3c24xx_i2c = {
586 .lock = __SPIN_LOCK_UNLOCKED(s3c24xx_i2c.lock),
587 .wait = __WAIT_QUEUE_HEAD_INITIALIZER(s3c24xx_i2c.wait),
590 .name = "s3c2410-i2c",
591 .owner = THIS_MODULE,
592 .algo = &s3c24xx_i2c_algorithm,
594 .class = I2C_CLASS_HWMON,
598 /* s3c24xx_i2c_calcdivisor
600 * return the divisor settings for a given frequency
603 static int s3c24xx_i2c_calcdivisor(unsigned long clkin, unsigned int wanted,
604 unsigned int *div1, unsigned int *divs)
606 unsigned int calc_divs = clkin / wanted;
607 unsigned int calc_div1;
609 if (calc_divs > (16*16))
614 calc_divs += calc_div1-1;
615 calc_divs /= calc_div1;
625 return clkin / (calc_divs * calc_div1);
630 * test wether a frequency is within the acceptable range of error
633 static inline int freq_acceptable(unsigned int freq, unsigned int wanted)
635 int diff = freq - wanted;
637 return (diff >= -2 && diff <= 2);
640 /* s3c24xx_i2c_getdivisor
642 * work out a divisor for the user requested frequency setting,
643 * either by the requested frequency, or scanning the acceptable
644 * range of frequencies until something is found
647 static int s3c24xx_i2c_getdivisor(struct s3c24xx_i2c *i2c,
648 struct s3c2410_platform_i2c *pdata,
649 unsigned long *iicon,
652 unsigned long clkin = clk_get_rate(i2c->clk);
654 unsigned int divs, div1;
658 clkin /= 1000; /* clkin now in KHz */
660 dev_dbg(i2c->dev, "pdata %p, freq %lu %lu..%lu\n",
661 pdata, pdata->bus_freq, pdata->min_freq, pdata->max_freq);
663 if (pdata->bus_freq != 0) {
664 freq = s3c24xx_i2c_calcdivisor(clkin, pdata->bus_freq/1000,
666 if (freq_acceptable(freq, pdata->bus_freq/1000))
670 /* ok, we may have to search for something suitable... */
672 start = (pdata->max_freq == 0) ? pdata->bus_freq : pdata->max_freq;
673 end = pdata->min_freq;
680 for (; start > end; start--) {
681 freq = s3c24xx_i2c_calcdivisor(clkin, start, &div1, &divs);
682 if (freq_acceptable(freq, start))
686 /* cannot find frequency spec */
693 *iicon |= (div1 == 512) ? S3C2410_IICCON_TXDIV_512 : 0;
699 * initialise the controller, set the IO lines and frequency
702 static int s3c24xx_i2c_init(struct s3c24xx_i2c *i2c)
704 unsigned long iicon = S3C2410_IICCON_IRQEN | S3C2410_IICCON_ACKEN;
705 struct s3c2410_platform_i2c *pdata;
708 /* get the plafrom data */
710 pdata = s3c24xx_i2c_get_platformdata(i2c->adap.dev.parent);
712 /* inititalise the gpio */
714 s3c2410_gpio_cfgpin(S3C2410_GPE15, S3C2410_GPE15_IICSDA);
715 s3c2410_gpio_cfgpin(S3C2410_GPE14, S3C2410_GPE14_IICSCL);
717 /* write slave address */
719 writeb(pdata->slave_addr, i2c->regs + S3C2410_IICADD);
721 dev_info(i2c->dev, "slave address 0x%02x\n", pdata->slave_addr);
723 /* we need to work out the divisors for the clock... */
725 if (s3c24xx_i2c_getdivisor(i2c, pdata, &iicon, &freq) != 0) {
726 dev_err(i2c->dev, "cannot meet bus frequency required\n");
730 /* todo - check that the i2c lines aren't being dragged anywhere */
732 dev_info(i2c->dev, "bus frequency set to %d KHz\n", freq);
733 dev_dbg(i2c->dev, "S3C2410_IICCON=0x%02lx\n", iicon);
735 writel(iicon, i2c->regs + S3C2410_IICCON);
737 /* check for s3c2440 i2c controller */
739 if (s3c24xx_i2c_is2440(i2c)) {
740 dev_dbg(i2c->dev, "S3C2440_IICLC=%08x\n", pdata->sda_delay);
742 writel(pdata->sda_delay, i2c->regs + S3C2440_IICLC);
750 * called by the bus driver when a suitable device is found
753 static int s3c24xx_i2c_probe(struct platform_device *pdev)
755 struct s3c24xx_i2c *i2c = &s3c24xx_i2c;
756 struct resource *res;
759 /* find the clock and enable it */
761 i2c->dev = &pdev->dev;
762 i2c->clk = clk_get(&pdev->dev, "i2c");
763 if (IS_ERR(i2c->clk)) {
764 dev_err(&pdev->dev, "cannot get clock\n");
769 dev_dbg(&pdev->dev, "clock source %p\n", i2c->clk);
771 clk_enable(i2c->clk);
773 /* map the registers */
775 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
777 dev_err(&pdev->dev, "cannot find IO resource\n");
782 i2c->ioarea = request_mem_region(res->start, (res->end-res->start)+1,
785 if (i2c->ioarea == NULL) {
786 dev_err(&pdev->dev, "cannot request IO\n");
791 i2c->regs = ioremap(res->start, (res->end-res->start)+1);
793 if (i2c->regs == NULL) {
794 dev_err(&pdev->dev, "cannot map IO\n");
799 dev_dbg(&pdev->dev, "registers %p (%p, %p)\n", i2c->regs, i2c->ioarea, res);
801 /* setup info block for the i2c core */
803 i2c->adap.algo_data = i2c;
804 i2c->adap.dev.parent = &pdev->dev;
806 /* initialise the i2c controller */
808 ret = s3c24xx_i2c_init(i2c);
812 /* find the IRQ for this unit (note, this relies on the init call to
813 * ensure no current IRQs pending
816 res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
818 dev_err(&pdev->dev, "cannot find IRQ\n");
823 ret = request_irq(res->start, s3c24xx_i2c_irq, IRQF_DISABLED,
827 dev_err(&pdev->dev, "cannot claim IRQ\n");
833 dev_dbg(&pdev->dev, "irq resource %p (%lu)\n", res,
834 (unsigned long)res->start);
836 ret = i2c_add_adapter(&i2c->adap);
838 dev_err(&pdev->dev, "failed to add bus to i2c core\n");
842 platform_set_drvdata(pdev, i2c);
844 dev_info(&pdev->dev, "%s: S3C I2C adapter\n", i2c->adap.dev.bus_id);
848 free_irq(i2c->irq->start, i2c);
854 release_resource(i2c->ioarea);
858 clk_disable(i2c->clk);
865 /* s3c24xx_i2c_remove
867 * called when device is removed from the bus
870 static int s3c24xx_i2c_remove(struct platform_device *pdev)
872 struct s3c24xx_i2c *i2c = platform_get_drvdata(pdev);
874 i2c_del_adapter(&i2c->adap);
875 free_irq(i2c->irq->start, i2c);
877 clk_disable(i2c->clk);
882 release_resource(i2c->ioarea);
889 static int s3c24xx_i2c_resume(struct platform_device *dev)
891 struct s3c24xx_i2c *i2c = platform_get_drvdata(dev);
894 s3c24xx_i2c_init(i2c);
900 #define s3c24xx_i2c_resume NULL
903 /* device driver for platform bus bits */
905 static struct platform_driver s3c2410_i2c_driver = {
906 .probe = s3c24xx_i2c_probe,
907 .remove = s3c24xx_i2c_remove,
908 .resume = s3c24xx_i2c_resume,
910 .owner = THIS_MODULE,
911 .name = "s3c2410-i2c",
915 static struct platform_driver s3c2440_i2c_driver = {
916 .probe = s3c24xx_i2c_probe,
917 .remove = s3c24xx_i2c_remove,
918 .resume = s3c24xx_i2c_resume,
920 .owner = THIS_MODULE,
921 .name = "s3c2440-i2c",
925 static int __init i2c_adap_s3c_init(void)
929 ret = platform_driver_register(&s3c2410_i2c_driver);
931 ret = platform_driver_register(&s3c2440_i2c_driver);
933 platform_driver_unregister(&s3c2410_i2c_driver);
939 static void __exit i2c_adap_s3c_exit(void)
941 platform_driver_unregister(&s3c2410_i2c_driver);
942 platform_driver_unregister(&s3c2440_i2c_driver);
945 module_init(i2c_adap_s3c_init);
946 module_exit(i2c_adap_s3c_exit);
948 MODULE_DESCRIPTION("S3C24XX I2C Bus driver");
949 MODULE_AUTHOR("Ben Dooks, <ben@simtec.co.uk>");
950 MODULE_LICENSE("GPL");
951 MODULE_ALIAS("platform:s3c2410-i2c");