2 * drivers/i2c/busses/i2c-bfin-twi.c
4 * Description: Driver for Blackfin Two Wire Interface
6 * Author: sonicz <sonic.zhang@analog.com>
8 * Copyright (c) 2005-2007 Analog Devices, Inc.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include <linux/module.h>
26 #include <linux/kernel.h>
27 #include <linux/init.h>
28 #include <linux/i2c.h>
30 #include <linux/timer.h>
31 #include <linux/spinlock.h>
32 #include <linux/completion.h>
33 #include <linux/interrupt.h>
34 #include <linux/platform_device.h>
36 #include <asm/blackfin.h>
39 #define POLL_TIMEOUT (2 * HZ)
42 #define TWI_I2C_MODE_STANDARD 1
43 #define TWI_I2C_MODE_STANDARDSUB 2
44 #define TWI_I2C_MODE_COMBINED 3
45 #define TWI_I2C_MODE_REPEAT 4
47 struct bfin_twi_iface {
59 struct timer_list timeout_timer;
60 struct i2c_adapter adap;
61 struct completion complete;
67 static struct bfin_twi_iface twi_iface;
69 static void bfin_twi_handle_interrupt(struct bfin_twi_iface *iface)
71 unsigned short twi_int_status = bfin_read_TWI_INT_STAT();
72 unsigned short mast_stat = bfin_read_TWI_MASTER_STAT();
74 if (twi_int_status & XMTSERV) {
75 /* Transmit next data */
76 if (iface->writeNum > 0) {
77 bfin_write_TWI_XMT_DATA8(*(iface->transPtr++));
80 /* start receive immediately after complete sending in
83 else if (iface->cur_mode == TWI_I2C_MODE_COMBINED)
84 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL()
86 else if (iface->manual_stop)
87 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL()
89 else if (iface->cur_mode == TWI_I2C_MODE_REPEAT &&
90 iface->cur_msg+1 < iface->msg_num)
91 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL()
95 bfin_write_TWI_INT_STAT(XMTSERV);
98 if (twi_int_status & RCVSERV) {
99 if (iface->readNum > 0) {
100 /* Receive next data */
101 *(iface->transPtr) = bfin_read_TWI_RCV_DATA8();
102 if (iface->cur_mode == TWI_I2C_MODE_COMBINED) {
103 /* Change combine mode into sub mode after
106 iface->cur_mode = TWI_I2C_MODE_STANDARDSUB;
107 /* Get read number from first byte in block
110 if (iface->readNum == 1 && iface->manual_stop)
111 iface->readNum = *iface->transPtr + 1;
115 } else if (iface->manual_stop) {
116 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL()
119 } else if (iface->cur_mode == TWI_I2C_MODE_REPEAT &&
120 iface->cur_msg+1 < iface->msg_num) {
121 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL()
125 /* Clear interrupt source */
126 bfin_write_TWI_INT_STAT(RCVSERV);
129 if (twi_int_status & MERR) {
130 bfin_write_TWI_INT_STAT(MERR);
131 bfin_write_TWI_INT_MASK(0);
132 bfin_write_TWI_MASTER_STAT(0x3e);
133 bfin_write_TWI_MASTER_CTL(0);
135 iface->result = -EIO;
136 /* if both err and complete int stats are set, return proper
139 if (twi_int_status & MCOMP) {
140 bfin_write_TWI_INT_STAT(MCOMP);
141 bfin_write_TWI_INT_MASK(0);
142 bfin_write_TWI_MASTER_CTL(0);
144 /* If it is a quick transfer, only address bug no data,
145 * not an err, return 1.
147 if (iface->writeNum == 0 && (mast_stat & BUFRDERR))
149 /* If address not acknowledged return -1,
152 else if (!(mast_stat & ANAK))
155 complete(&iface->complete);
158 if (twi_int_status & MCOMP) {
159 bfin_write_TWI_INT_STAT(MCOMP);
161 if (iface->cur_mode == TWI_I2C_MODE_COMBINED) {
162 if (iface->readNum == 0) {
163 /* set the read number to 1 and ask for manual
164 * stop in block combine mode
167 iface->manual_stop = 1;
168 bfin_write_TWI_MASTER_CTL(
169 bfin_read_TWI_MASTER_CTL()
172 /* set the readd number in other
175 bfin_write_TWI_MASTER_CTL(
176 (bfin_read_TWI_MASTER_CTL() &
178 ( iface->readNum << 6));
180 /* remove restart bit and enable master receive */
181 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() &
183 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() |
186 } else if (iface->cur_mode == TWI_I2C_MODE_REPEAT &&
187 iface->cur_msg+1 < iface->msg_num) {
189 iface->transPtr = iface->pmsg[iface->cur_msg].buf;
190 iface->writeNum = iface->readNum =
191 iface->pmsg[iface->cur_msg].len;
192 /* Set Transmit device address */
193 bfin_write_TWI_MASTER_ADDR(
194 iface->pmsg[iface->cur_msg].addr);
195 if (iface->pmsg[iface->cur_msg].flags & I2C_M_RD)
196 iface->read_write = I2C_SMBUS_READ;
198 iface->read_write = I2C_SMBUS_WRITE;
199 /* Transmit first data */
200 if (iface->writeNum > 0) {
201 bfin_write_TWI_XMT_DATA8(
202 *(iface->transPtr++));
208 if (iface->pmsg[iface->cur_msg].len <= 255)
209 bfin_write_TWI_MASTER_CTL(
210 iface->pmsg[iface->cur_msg].len << 6);
212 bfin_write_TWI_MASTER_CTL(0xff << 6);
213 iface->manual_stop = 1;
215 /* remove restart bit and enable master receive */
216 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() &
218 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() |
219 MEN | ((iface->read_write == I2C_SMBUS_READ) ?
224 bfin_write_TWI_INT_MASK(0);
225 bfin_write_TWI_MASTER_CTL(0);
227 complete(&iface->complete);
232 /* Interrupt handler */
233 static irqreturn_t bfin_twi_interrupt_entry(int irq, void *dev_id)
235 struct bfin_twi_iface *iface = dev_id;
238 spin_lock_irqsave(&iface->lock, flags);
239 del_timer(&iface->timeout_timer);
240 bfin_twi_handle_interrupt(iface);
241 spin_unlock_irqrestore(&iface->lock, flags);
245 static void bfin_twi_timeout(unsigned long data)
247 struct bfin_twi_iface *iface = (struct bfin_twi_iface *)data;
250 spin_lock_irqsave(&iface->lock, flags);
251 bfin_twi_handle_interrupt(iface);
252 if (iface->result == 0) {
253 iface->timeout_count--;
254 if (iface->timeout_count > 0) {
255 iface->timeout_timer.expires = jiffies + POLL_TIMEOUT;
256 add_timer(&iface->timeout_timer);
259 complete(&iface->complete);
262 spin_unlock_irqrestore(&iface->lock, flags);
266 * Generic i2c master transfer entrypoint
268 static int bfin_twi_master_xfer(struct i2c_adapter *adap,
269 struct i2c_msg *msgs, int num)
271 struct bfin_twi_iface *iface = adap->algo_data;
272 struct i2c_msg *pmsg;
275 if (!(bfin_read_TWI_CONTROL() & TWI_ENA))
278 while (bfin_read_TWI_MASTER_STAT() & BUSBUSY) {
283 iface->msg_num = num;
287 if (pmsg->flags & I2C_M_TEN) {
288 dev_err(&adap->dev, "10 bits addr not supported!\n");
292 iface->cur_mode = TWI_I2C_MODE_REPEAT;
293 iface->manual_stop = 0;
294 iface->transPtr = pmsg->buf;
295 iface->writeNum = iface->readNum = pmsg->len;
297 iface->timeout_count = 10;
298 /* Set Transmit device address */
299 bfin_write_TWI_MASTER_ADDR(pmsg->addr);
301 /* FIFO Initiation. Data in FIFO should be
302 * discarded before start a new operation.
304 bfin_write_TWI_FIFO_CTL(0x3);
306 bfin_write_TWI_FIFO_CTL(0);
309 if (pmsg->flags & I2C_M_RD)
310 iface->read_write = I2C_SMBUS_READ;
312 iface->read_write = I2C_SMBUS_WRITE;
313 /* Transmit first data */
314 if (iface->writeNum > 0) {
315 bfin_write_TWI_XMT_DATA8(*(iface->transPtr++));
322 bfin_write_TWI_INT_STAT(MERR | MCOMP | XMTSERV | RCVSERV);
324 /* Interrupt mask . Enable XMT, RCV interrupt */
325 bfin_write_TWI_INT_MASK(MCOMP | MERR | RCVSERV | XMTSERV);
328 if (pmsg->len <= 255)
329 bfin_write_TWI_MASTER_CTL(pmsg->len << 6);
331 bfin_write_TWI_MASTER_CTL(0xff << 6);
332 iface->manual_stop = 1;
335 iface->timeout_timer.expires = jiffies + POLL_TIMEOUT;
336 add_timer(&iface->timeout_timer);
339 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() | MEN |
340 ((iface->read_write == I2C_SMBUS_READ) ? MDIR : 0) |
341 ((CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ > 100) ? FAST : 0));
344 wait_for_completion(&iface->complete);
355 * SMBus type transfer entrypoint
358 int bfin_twi_smbus_xfer(struct i2c_adapter *adap, u16 addr,
359 unsigned short flags, char read_write,
360 u8 command, int size, union i2c_smbus_data *data)
362 struct bfin_twi_iface *iface = adap->algo_data;
365 if (!(bfin_read_TWI_CONTROL() & TWI_ENA))
368 while (bfin_read_TWI_MASTER_STAT() & BUSBUSY) {
375 /* Prepare datas & select mode */
377 case I2C_SMBUS_QUICK:
378 iface->transPtr = NULL;
379 iface->cur_mode = TWI_I2C_MODE_STANDARD;
383 iface->transPtr = NULL;
385 if (read_write == I2C_SMBUS_READ)
389 iface->transPtr = &data->byte;
391 iface->cur_mode = TWI_I2C_MODE_STANDARD;
393 case I2C_SMBUS_BYTE_DATA:
394 if (read_write == I2C_SMBUS_READ) {
396 iface->cur_mode = TWI_I2C_MODE_COMBINED;
399 iface->cur_mode = TWI_I2C_MODE_STANDARDSUB;
401 iface->transPtr = &data->byte;
403 case I2C_SMBUS_WORD_DATA:
404 if (read_write == I2C_SMBUS_READ) {
406 iface->cur_mode = TWI_I2C_MODE_COMBINED;
409 iface->cur_mode = TWI_I2C_MODE_STANDARDSUB;
411 iface->transPtr = (u8 *)&data->word;
413 case I2C_SMBUS_PROC_CALL:
416 iface->cur_mode = TWI_I2C_MODE_COMBINED;
417 iface->transPtr = (u8 *)&data->word;
419 case I2C_SMBUS_BLOCK_DATA:
420 if (read_write == I2C_SMBUS_READ) {
422 iface->cur_mode = TWI_I2C_MODE_COMBINED;
424 iface->writeNum = data->block[0] + 1;
425 iface->cur_mode = TWI_I2C_MODE_STANDARDSUB;
427 iface->transPtr = data->block;
434 iface->manual_stop = 0;
435 iface->read_write = read_write;
436 iface->command = command;
437 iface->timeout_count = 10;
439 /* FIFO Initiation. Data in FIFO should be discarded before
440 * start a new operation.
442 bfin_write_TWI_FIFO_CTL(0x3);
444 bfin_write_TWI_FIFO_CTL(0);
447 bfin_write_TWI_INT_STAT(MERR|MCOMP|XMTSERV|RCVSERV);
449 /* Set Transmit device address */
450 bfin_write_TWI_MASTER_ADDR(addr);
453 iface->timeout_timer.expires = jiffies + POLL_TIMEOUT;
454 add_timer(&iface->timeout_timer);
456 switch (iface->cur_mode) {
457 case TWI_I2C_MODE_STANDARDSUB:
458 bfin_write_TWI_XMT_DATA8(iface->command);
459 bfin_write_TWI_INT_MASK(MCOMP | MERR |
460 ((iface->read_write == I2C_SMBUS_READ) ?
464 if (iface->writeNum + 1 <= 255)
465 bfin_write_TWI_MASTER_CTL((iface->writeNum + 1) << 6);
467 bfin_write_TWI_MASTER_CTL(0xff << 6);
468 iface->manual_stop = 1;
471 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() | MEN |
472 ((CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ>100) ? FAST : 0));
474 case TWI_I2C_MODE_COMBINED:
475 bfin_write_TWI_XMT_DATA8(iface->command);
476 bfin_write_TWI_INT_MASK(MCOMP | MERR | RCVSERV | XMTSERV);
479 if (iface->writeNum > 0)
480 bfin_write_TWI_MASTER_CTL((iface->writeNum + 1) << 6);
482 bfin_write_TWI_MASTER_CTL(0x1 << 6);
484 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() | MEN |
485 ((CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ>100) ? FAST : 0));
488 bfin_write_TWI_MASTER_CTL(0);
489 if (size != I2C_SMBUS_QUICK) {
490 /* Don't access xmit data register when this is a
493 if (iface->read_write != I2C_SMBUS_READ) {
494 if (iface->writeNum > 0) {
495 bfin_write_TWI_XMT_DATA8(*(iface->transPtr++));
496 if (iface->writeNum <= 255)
497 bfin_write_TWI_MASTER_CTL(iface->writeNum << 6);
499 bfin_write_TWI_MASTER_CTL(0xff << 6);
500 iface->manual_stop = 1;
504 bfin_write_TWI_XMT_DATA8(iface->command);
505 bfin_write_TWI_MASTER_CTL(1 << 6);
508 if (iface->readNum > 0 && iface->readNum <= 255)
509 bfin_write_TWI_MASTER_CTL(iface->readNum << 6);
510 else if (iface->readNum > 255) {
511 bfin_write_TWI_MASTER_CTL(0xff << 6);
512 iface->manual_stop = 1;
514 del_timer(&iface->timeout_timer);
519 bfin_write_TWI_INT_MASK(MCOMP | MERR |
520 ((iface->read_write == I2C_SMBUS_READ) ?
525 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() | MEN |
526 ((iface->read_write == I2C_SMBUS_READ) ? MDIR : 0) |
527 ((CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ > 100) ? FAST : 0));
532 wait_for_completion(&iface->complete);
534 rc = (iface->result >= 0) ? 0 : -1;
540 * Return what the adapter supports
542 static u32 bfin_twi_functionality(struct i2c_adapter *adap)
544 return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
545 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
546 I2C_FUNC_SMBUS_BLOCK_DATA | I2C_FUNC_SMBUS_PROC_CALL |
551 static struct i2c_algorithm bfin_twi_algorithm = {
552 .master_xfer = bfin_twi_master_xfer,
553 .smbus_xfer = bfin_twi_smbus_xfer,
554 .functionality = bfin_twi_functionality,
558 static int i2c_bfin_twi_suspend(struct platform_device *dev, pm_message_t state)
560 /* struct bfin_twi_iface *iface = platform_get_drvdata(dev);*/
563 bfin_write_TWI_CONTROL(bfin_read_TWI_CONTROL() & ~TWI_ENA);
569 static int i2c_bfin_twi_resume(struct platform_device *dev)
571 /* struct bfin_twi_iface *iface = platform_get_drvdata(dev);*/
574 bfin_write_TWI_CONTROL(bfin_read_TWI_CONTROL() | TWI_ENA);
580 static int i2c_bfin_twi_probe(struct platform_device *dev)
582 struct bfin_twi_iface *iface = &twi_iface;
583 struct i2c_adapter *p_adap;
586 spin_lock_init(&(iface->lock));
587 init_completion(&(iface->complete));
588 iface->irq = IRQ_TWI;
590 init_timer(&(iface->timeout_timer));
591 iface->timeout_timer.function = bfin_twi_timeout;
592 iface->timeout_timer.data = (unsigned long)iface;
594 p_adap = &iface->adap;
595 p_adap->id = I2C_HW_BLACKFIN;
596 p_adap->nr = dev->id;
597 strlcpy(p_adap->name, dev->name, sizeof(p_adap->name));
598 p_adap->algo = &bfin_twi_algorithm;
599 p_adap->algo_data = iface;
600 p_adap->class = I2C_CLASS_ALL;
601 p_adap->dev.parent = &dev->dev;
603 rc = request_irq(iface->irq, bfin_twi_interrupt_entry,
604 IRQF_DISABLED, dev->name, iface);
606 dev_err(&(p_adap->dev), "i2c-bfin-twi: can't get IRQ %d !\n",
611 /* Set TWI internal clock as 10MHz */
612 bfin_write_TWI_CONTROL(((get_sclk() / 1024 / 1024 + 5) / 10) & 0x7F);
614 /* Set Twi interface clock as specified */
615 bfin_write_TWI_CLKDIV((( 5*1024 / CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ )
616 << 8) | (( 5*1024 / CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ )
620 bfin_write_TWI_CONTROL(bfin_read_TWI_CONTROL() | TWI_ENA);
623 rc = i2c_add_numbered_adapter(p_adap);
625 free_irq(iface->irq, iface);
627 platform_set_drvdata(dev, iface);
632 static int i2c_bfin_twi_remove(struct platform_device *pdev)
634 struct bfin_twi_iface *iface = platform_get_drvdata(pdev);
636 platform_set_drvdata(pdev, NULL);
638 i2c_del_adapter(&(iface->adap));
639 free_irq(iface->irq, iface);
644 static struct platform_driver i2c_bfin_twi_driver = {
645 .probe = i2c_bfin_twi_probe,
646 .remove = i2c_bfin_twi_remove,
647 .suspend = i2c_bfin_twi_suspend,
648 .resume = i2c_bfin_twi_resume,
650 .name = "i2c-bfin-twi",
651 .owner = THIS_MODULE,
655 static int __init i2c_bfin_twi_init(void)
657 pr_info("I2C: Blackfin I2C TWI driver\n");
659 return platform_driver_register(&i2c_bfin_twi_driver);
662 static void __exit i2c_bfin_twi_exit(void)
664 platform_driver_unregister(&i2c_bfin_twi_driver);
667 MODULE_AUTHOR("Sonic Zhang <sonic.zhang@analog.com>");
668 MODULE_DESCRIPTION("I2C-Bus adapter routines for Blackfin TWI");
669 MODULE_LICENSE("GPL");
671 module_init(i2c_bfin_twi_init);
672 module_exit(i2c_bfin_twi_exit);