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 0x01
43 #define TWI_I2C_MODE_STANDARDSUB 0x02
44 #define TWI_I2C_MODE_COMBINED 0x04
46 struct bfin_twi_iface {
47 struct mutex twi_lock;
59 struct timer_list timeout_timer;
60 struct i2c_adapter adap;
61 struct completion complete;
64 static struct bfin_twi_iface twi_iface;
66 static void bfin_twi_handle_interrupt(struct bfin_twi_iface *iface)
68 unsigned short twi_int_status = bfin_read_TWI_INT_STAT();
69 unsigned short mast_stat = bfin_read_TWI_MASTER_STAT();
71 if (twi_int_status & XMTSERV) {
72 /* Transmit next data */
73 if (iface->writeNum > 0) {
74 bfin_write_TWI_XMT_DATA8(*(iface->transPtr++));
77 /* start receive immediately after complete sending in
80 else if (iface->cur_mode == TWI_I2C_MODE_COMBINED) {
81 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL()
83 } else if (iface->manual_stop)
84 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL()
88 bfin_write_TWI_INT_STAT(XMTSERV);
91 if (twi_int_status & RCVSERV) {
92 if (iface->readNum > 0) {
93 /* Receive next data */
94 *(iface->transPtr) = bfin_read_TWI_RCV_DATA8();
95 if (iface->cur_mode == TWI_I2C_MODE_COMBINED) {
96 /* Change combine mode into sub mode after
99 iface->cur_mode = TWI_I2C_MODE_STANDARDSUB;
100 /* Get read number from first byte in block
103 if (iface->readNum == 1 && iface->manual_stop)
104 iface->readNum = *iface->transPtr + 1;
108 } else if (iface->manual_stop) {
109 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL()
113 /* Clear interrupt source */
114 bfin_write_TWI_INT_STAT(RCVSERV);
117 if (twi_int_status & MERR) {
118 bfin_write_TWI_INT_STAT(MERR);
119 bfin_write_TWI_INT_MASK(0);
120 bfin_write_TWI_MASTER_STAT(0x3e);
121 bfin_write_TWI_MASTER_CTL(0);
124 /* if both err and complete int stats are set, return proper
127 if (twi_int_status & MCOMP) {
128 bfin_write_TWI_INT_STAT(MCOMP);
129 bfin_write_TWI_INT_MASK(0);
130 bfin_write_TWI_MASTER_CTL(0);
132 /* If it is a quick transfer, only address bug no data,
133 * not an err, return 1.
135 if (iface->writeNum == 0 && (mast_stat & BUFRDERR))
137 /* If address not acknowledged return -1,
140 else if (!(mast_stat & ANAK))
143 complete(&iface->complete);
146 if (twi_int_status & MCOMP) {
147 bfin_write_TWI_INT_STAT(MCOMP);
149 if (iface->cur_mode == TWI_I2C_MODE_COMBINED) {
150 if (iface->readNum == 0) {
151 /* set the read number to 1 and ask for manual
152 * stop in block combine mode
155 iface->manual_stop = 1;
156 bfin_write_TWI_MASTER_CTL(
157 bfin_read_TWI_MASTER_CTL()
160 /* set the readd number in other
163 bfin_write_TWI_MASTER_CTL(
164 (bfin_read_TWI_MASTER_CTL() &
166 ( iface->readNum << 6));
168 /* remove restart bit and enable master receive */
169 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() &
171 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() |
176 bfin_write_TWI_INT_MASK(0);
177 bfin_write_TWI_MASTER_CTL(0);
179 complete(&iface->complete);
184 /* Interrupt handler */
185 static irqreturn_t bfin_twi_interrupt_entry(int irq, void *dev_id)
187 struct bfin_twi_iface *iface = dev_id;
190 spin_lock_irqsave(&iface->lock, flags);
191 del_timer(&iface->timeout_timer);
192 bfin_twi_handle_interrupt(iface);
193 spin_unlock_irqrestore(&iface->lock, flags);
197 static void bfin_twi_timeout(unsigned long data)
199 struct bfin_twi_iface *iface = (struct bfin_twi_iface *)data;
202 spin_lock_irqsave(&iface->lock, flags);
203 bfin_twi_handle_interrupt(iface);
204 if (iface->result == 0) {
205 iface->timeout_count--;
206 if (iface->timeout_count > 0) {
207 iface->timeout_timer.expires = jiffies + POLL_TIMEOUT;
208 add_timer(&iface->timeout_timer);
211 complete(&iface->complete);
214 spin_unlock_irqrestore(&iface->lock, flags);
218 * Generic i2c master transfer entrypoint
220 static int bfin_twi_master_xfer(struct i2c_adapter *adap,
221 struct i2c_msg *msgs, int num)
223 struct bfin_twi_iface *iface = adap->algo_data;
224 struct i2c_msg *pmsg;
228 if (!(bfin_read_TWI_CONTROL() & TWI_ENA))
231 mutex_lock(&iface->twi_lock);
233 while (bfin_read_TWI_MASTER_STAT() & BUSBUSY) {
234 mutex_unlock(&iface->twi_lock);
236 mutex_lock(&iface->twi_lock);
240 for (i = 0; rc >= 0 && i < num; i++) {
242 if (pmsg->flags & I2C_M_TEN) {
243 dev_err(&(adap->dev), "i2c-bfin-twi: 10 bits addr "
244 "not supported !\n");
249 iface->cur_mode = TWI_I2C_MODE_STANDARD;
250 iface->manual_stop = 0;
251 iface->transPtr = pmsg->buf;
252 iface->writeNum = iface->readNum = pmsg->len;
254 iface->timeout_count = 10;
255 /* Set Transmit device address */
256 bfin_write_TWI_MASTER_ADDR(pmsg->addr);
258 /* FIFO Initiation. Data in FIFO should be
259 * discarded before start a new operation.
261 bfin_write_TWI_FIFO_CTL(0x3);
263 bfin_write_TWI_FIFO_CTL(0);
266 if (pmsg->flags & I2C_M_RD)
267 iface->read_write = I2C_SMBUS_READ;
269 iface->read_write = I2C_SMBUS_WRITE;
270 /* Transmit first data */
271 if (iface->writeNum > 0) {
272 bfin_write_TWI_XMT_DATA8(*(iface->transPtr++));
279 bfin_write_TWI_INT_STAT(MERR|MCOMP|XMTSERV|RCVSERV);
281 /* Interrupt mask . Enable XMT, RCV interrupt */
282 bfin_write_TWI_INT_MASK(MCOMP | MERR |
283 ((iface->read_write == I2C_SMBUS_READ)?
287 if (pmsg->len > 0 && pmsg->len <= 255)
288 bfin_write_TWI_MASTER_CTL(pmsg->len << 6);
289 else if (pmsg->len > 255) {
290 bfin_write_TWI_MASTER_CTL(0xff << 6);
291 iface->manual_stop = 1;
295 iface->timeout_timer.expires = jiffies + POLL_TIMEOUT;
296 add_timer(&iface->timeout_timer);
299 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() | MEN |
300 ((iface->read_write == I2C_SMBUS_READ) ? MDIR : 0) |
301 ((CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ>100) ? FAST : 0));
304 wait_for_completion(&iface->complete);
314 mutex_unlock(&iface->twi_lock);
320 * SMBus type transfer entrypoint
323 int bfin_twi_smbus_xfer(struct i2c_adapter *adap, u16 addr,
324 unsigned short flags, char read_write,
325 u8 command, int size, union i2c_smbus_data *data)
327 struct bfin_twi_iface *iface = adap->algo_data;
330 if (!(bfin_read_TWI_CONTROL() & TWI_ENA))
333 mutex_lock(&iface->twi_lock);
335 while (bfin_read_TWI_MASTER_STAT() & BUSBUSY) {
336 mutex_unlock(&iface->twi_lock);
338 mutex_lock(&iface->twi_lock);
344 /* Prepare datas & select mode */
346 case I2C_SMBUS_QUICK:
347 iface->transPtr = NULL;
348 iface->cur_mode = TWI_I2C_MODE_STANDARD;
352 iface->transPtr = NULL;
354 if (read_write == I2C_SMBUS_READ)
358 iface->transPtr = &data->byte;
360 iface->cur_mode = TWI_I2C_MODE_STANDARD;
362 case I2C_SMBUS_BYTE_DATA:
363 if (read_write == I2C_SMBUS_READ) {
365 iface->cur_mode = TWI_I2C_MODE_COMBINED;
368 iface->cur_mode = TWI_I2C_MODE_STANDARDSUB;
370 iface->transPtr = &data->byte;
372 case I2C_SMBUS_WORD_DATA:
373 if (read_write == I2C_SMBUS_READ) {
375 iface->cur_mode = TWI_I2C_MODE_COMBINED;
378 iface->cur_mode = TWI_I2C_MODE_STANDARDSUB;
380 iface->transPtr = (u8 *)&data->word;
382 case I2C_SMBUS_PROC_CALL:
385 iface->cur_mode = TWI_I2C_MODE_COMBINED;
386 iface->transPtr = (u8 *)&data->word;
388 case I2C_SMBUS_BLOCK_DATA:
389 if (read_write == I2C_SMBUS_READ) {
391 iface->cur_mode = TWI_I2C_MODE_COMBINED;
393 iface->writeNum = data->block[0] + 1;
394 iface->cur_mode = TWI_I2C_MODE_STANDARDSUB;
396 iface->transPtr = data->block;
403 iface->manual_stop = 0;
404 iface->read_write = read_write;
405 iface->command = command;
406 iface->timeout_count = 10;
408 /* FIFO Initiation. Data in FIFO should be discarded before
409 * start a new operation.
411 bfin_write_TWI_FIFO_CTL(0x3);
413 bfin_write_TWI_FIFO_CTL(0);
416 bfin_write_TWI_INT_STAT(MERR|MCOMP|XMTSERV|RCVSERV);
418 /* Set Transmit device address */
419 bfin_write_TWI_MASTER_ADDR(addr);
422 iface->timeout_timer.expires = jiffies + POLL_TIMEOUT;
423 add_timer(&iface->timeout_timer);
425 switch (iface->cur_mode) {
426 case TWI_I2C_MODE_STANDARDSUB:
427 bfin_write_TWI_XMT_DATA8(iface->command);
428 bfin_write_TWI_INT_MASK(MCOMP | MERR |
429 ((iface->read_write == I2C_SMBUS_READ) ?
433 if (iface->writeNum + 1 <= 255)
434 bfin_write_TWI_MASTER_CTL((iface->writeNum + 1) << 6);
436 bfin_write_TWI_MASTER_CTL(0xff << 6);
437 iface->manual_stop = 1;
440 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() | MEN |
441 ((CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ>100) ? FAST : 0));
443 case TWI_I2C_MODE_COMBINED:
444 bfin_write_TWI_XMT_DATA8(iface->command);
445 bfin_write_TWI_INT_MASK(MCOMP | MERR | RCVSERV | XMTSERV);
448 if (iface->writeNum > 0)
449 bfin_write_TWI_MASTER_CTL((iface->writeNum + 1) << 6);
451 bfin_write_TWI_MASTER_CTL(0x1 << 6);
453 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() | MEN |
454 ((CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ>100) ? FAST : 0));
457 bfin_write_TWI_MASTER_CTL(0);
458 if (size != I2C_SMBUS_QUICK) {
459 /* Don't access xmit data register when this is a
462 if (iface->read_write != I2C_SMBUS_READ) {
463 if (iface->writeNum > 0) {
464 bfin_write_TWI_XMT_DATA8(*(iface->transPtr++));
465 if (iface->writeNum <= 255)
466 bfin_write_TWI_MASTER_CTL(iface->writeNum << 6);
468 bfin_write_TWI_MASTER_CTL(0xff << 6);
469 iface->manual_stop = 1;
473 bfin_write_TWI_XMT_DATA8(iface->command);
474 bfin_write_TWI_MASTER_CTL(1 << 6);
477 if (iface->readNum > 0 && iface->readNum <= 255)
478 bfin_write_TWI_MASTER_CTL(iface->readNum << 6);
479 else if (iface->readNum > 255) {
480 bfin_write_TWI_MASTER_CTL(0xff << 6);
481 iface->manual_stop = 1;
483 del_timer(&iface->timeout_timer);
488 bfin_write_TWI_INT_MASK(MCOMP | MERR |
489 ((iface->read_write == I2C_SMBUS_READ) ?
494 bfin_write_TWI_MASTER_CTL(bfin_read_TWI_MASTER_CTL() | MEN |
495 ((iface->read_write == I2C_SMBUS_READ) ? MDIR : 0) |
496 ((CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ > 100) ? FAST : 0));
501 wait_for_completion(&iface->complete);
503 rc = (iface->result >= 0) ? 0 : -1;
506 mutex_unlock(&iface->twi_lock);
512 * Return what the adapter supports
514 static u32 bfin_twi_functionality(struct i2c_adapter *adap)
516 return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
517 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
518 I2C_FUNC_SMBUS_BLOCK_DATA | I2C_FUNC_SMBUS_PROC_CALL |
523 static struct i2c_algorithm bfin_twi_algorithm = {
524 .master_xfer = bfin_twi_master_xfer,
525 .smbus_xfer = bfin_twi_smbus_xfer,
526 .functionality = bfin_twi_functionality,
530 static int i2c_bfin_twi_suspend(struct platform_device *dev, pm_message_t state)
532 /* struct bfin_twi_iface *iface = platform_get_drvdata(dev);*/
535 bfin_write_TWI_CONTROL(bfin_read_TWI_CONTROL() & ~TWI_ENA);
541 static int i2c_bfin_twi_resume(struct platform_device *dev)
543 /* struct bfin_twi_iface *iface = platform_get_drvdata(dev);*/
546 bfin_write_TWI_CONTROL(bfin_read_TWI_CONTROL() | TWI_ENA);
552 static int i2c_bfin_twi_probe(struct platform_device *dev)
554 struct bfin_twi_iface *iface = &twi_iface;
555 struct i2c_adapter *p_adap;
558 mutex_init(&(iface->twi_lock));
559 spin_lock_init(&(iface->lock));
560 init_completion(&(iface->complete));
561 iface->irq = IRQ_TWI;
563 init_timer(&(iface->timeout_timer));
564 iface->timeout_timer.function = bfin_twi_timeout;
565 iface->timeout_timer.data = (unsigned long)iface;
567 p_adap = &iface->adap;
568 p_adap->id = I2C_HW_BLACKFIN;
569 strlcpy(p_adap->name, dev->name, sizeof(p_adap->name));
570 p_adap->algo = &bfin_twi_algorithm;
571 p_adap->algo_data = iface;
572 p_adap->class = I2C_CLASS_ALL;
573 p_adap->dev.parent = &dev->dev;
575 rc = request_irq(iface->irq, bfin_twi_interrupt_entry,
576 IRQF_DISABLED, dev->name, iface);
578 dev_err(&(p_adap->dev), "i2c-bfin-twi: can't get IRQ %d !\n",
583 /* Set TWI internal clock as 10MHz */
584 bfin_write_TWI_CONTROL(((get_sclk() / 1024 / 1024 + 5) / 10) & 0x7F);
586 /* Set Twi interface clock as specified */
587 bfin_write_TWI_CLKDIV((( 5*1024 / CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ )
588 << 8) | (( 5*1024 / CONFIG_I2C_BLACKFIN_TWI_CLK_KHZ )
592 bfin_write_TWI_CONTROL(bfin_read_TWI_CONTROL() | TWI_ENA);
595 rc = i2c_add_adapter(p_adap);
597 free_irq(iface->irq, iface);
599 platform_set_drvdata(dev, iface);
604 static int i2c_bfin_twi_remove(struct platform_device *pdev)
606 struct bfin_twi_iface *iface = platform_get_drvdata(pdev);
608 platform_set_drvdata(pdev, NULL);
610 i2c_del_adapter(&(iface->adap));
611 free_irq(iface->irq, iface);
616 static struct platform_driver i2c_bfin_twi_driver = {
617 .probe = i2c_bfin_twi_probe,
618 .remove = i2c_bfin_twi_remove,
619 .suspend = i2c_bfin_twi_suspend,
620 .resume = i2c_bfin_twi_resume,
622 .name = "i2c-bfin-twi",
623 .owner = THIS_MODULE,
627 static int __init i2c_bfin_twi_init(void)
629 pr_info("I2C: Blackfin I2C TWI driver\n");
631 return platform_driver_register(&i2c_bfin_twi_driver);
634 static void __exit i2c_bfin_twi_exit(void)
636 platform_driver_unregister(&i2c_bfin_twi_driver);
639 MODULE_AUTHOR("Sonic Zhang <sonic.zhang@analog.com>");
640 MODULE_DESCRIPTION("I2C-Bus adapter routines for Blackfin TWI");
641 MODULE_LICENSE("GPL");
643 module_init(i2c_bfin_twi_init);
644 module_exit(i2c_bfin_twi_exit);