1 /* -------------------------------------------------------------------------
2 * i2c-algo-bit.c i2c driver algorithms for bit-shift adapters
3 * -------------------------------------------------------------------------
4 * Copyright (C) 1995-2000 Simon G. Vogl
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 * ------------------------------------------------------------------------- */
21 /* With some changes from Frodo Looijaard <frodol@dds.nl>, Kyösti Mälkki
22 <kmalkki@cc.hut.fi> and Jean Delvare <khali@linux-fr.org> */
24 #include <linux/kernel.h>
25 #include <linux/module.h>
26 #include <linux/delay.h>
27 #include <linux/init.h>
28 #include <linux/errno.h>
29 #include <linux/sched.h>
30 #include <linux/i2c.h>
31 #include <linux/i2c-algo-bit.h>
34 /* ----- global defines ----------------------------------------------- */
37 #define bit_dbg(level, dev, format, args...) \
39 if (i2c_debug >= level) \
40 dev_dbg(dev, format, ##args); \
43 #define bit_dbg(level, dev, format, args...) \
47 /* ----- global variables --------------------------------------------- */
49 static int bit_test; /* see if the line-setting functions work */
50 module_param(bit_test, bool, 0);
51 MODULE_PARM_DESC(bit_test, "Test the lines of the bus to see if it is stuck");
54 static int i2c_debug = 1;
55 module_param(i2c_debug, int, S_IRUGO | S_IWUSR);
56 MODULE_PARM_DESC(i2c_debug,
57 "debug level - 0 off; 1 normal; 2 verbose; 3 very verbose");
60 /* --- setting states on the bus with the right timing: --------------- */
62 #define setsda(adap, val) adap->setsda(adap->data, val)
63 #define setscl(adap, val) adap->setscl(adap->data, val)
64 #define getsda(adap) adap->getsda(adap->data)
65 #define getscl(adap) adap->getscl(adap->data)
67 static inline void sdalo(struct i2c_algo_bit_data *adap)
70 udelay((adap->udelay + 1) / 2);
73 static inline void sdahi(struct i2c_algo_bit_data *adap)
76 udelay((adap->udelay + 1) / 2);
79 static inline void scllo(struct i2c_algo_bit_data *adap)
82 udelay(adap->udelay / 2);
86 * Raise scl line, and do checking for delays. This is necessary for slower
89 static int sclhi(struct i2c_algo_bit_data *adap)
95 /* Not all adapters have scl sense line... */
100 while (!getscl(adap)) {
101 /* This hw knows how to read the clock line, so we wait
102 * until it actually gets high. This is safer as some
103 * chips may hold it low ("clock stretching") while they
104 * are processing data internally.
106 if (time_after(jiffies, start + adap->timeout))
111 if (jiffies != start && i2c_debug >= 3)
112 pr_debug("i2c-algo-bit: needed %ld jiffies for SCL to go "
113 "high\n", jiffies - start);
117 udelay(adap->udelay);
122 /* --- other auxiliary functions -------------------------------------- */
123 static void i2c_start(struct i2c_algo_bit_data *adap)
125 /* assert: scl, sda are high */
127 udelay(adap->udelay);
131 static void i2c_repstart(struct i2c_algo_bit_data *adap)
133 /* assert: scl is low */
137 udelay(adap->udelay);
142 static void i2c_stop(struct i2c_algo_bit_data *adap)
144 /* assert: scl is low */
148 udelay(adap->udelay);
153 /* send a byte without start cond., look for arbitration,
154 check ackn. from slave */
156 * 1 if the device acknowledged
157 * 0 if the device did not ack
158 * -ETIMEDOUT if an error occurred (while raising the scl line)
160 static int i2c_outb(struct i2c_adapter *i2c_adap, unsigned char c)
165 struct i2c_algo_bit_data *adap = i2c_adap->algo_data;
167 /* assert: scl is low */
168 for (i = 7; i >= 0; i--) {
171 udelay((adap->udelay + 1) / 2);
172 if (sclhi(adap) < 0) { /* timed out */
173 bit_dbg(1, &i2c_adap->dev, "i2c_outb: 0x%02x, "
174 "timeout at bit #%d\n", (int)c, i);
177 /* FIXME do arbitration here:
178 * if (sb && !getsda(adap)) -> ouch! Get out of here.
180 * Report a unique code, so higher level code can retry
181 * the whole (combined) message and *NOT* issue STOP.
186 if (sclhi(adap) < 0) { /* timeout */
187 bit_dbg(1, &i2c_adap->dev, "i2c_outb: 0x%02x, "
188 "timeout at ack\n", (int)c);
192 /* read ack: SDA should be pulled down by slave, or it may
193 * NAK (usually to report problems with the data we wrote).
195 ack = !getsda(adap); /* ack: sda is pulled low -> success */
196 bit_dbg(2, &i2c_adap->dev, "i2c_outb: 0x%02x %s\n", (int)c,
201 /* assert: scl is low (sda undef) */
205 static int i2c_inb(struct i2c_adapter *i2c_adap)
207 /* read byte via i2c port, without start/stop sequence */
208 /* acknowledge is sent in i2c_read. */
210 unsigned char indata = 0;
211 struct i2c_algo_bit_data *adap = i2c_adap->algo_data;
213 /* assert: scl is low */
215 for (i = 0; i < 8; i++) {
216 if (sclhi(adap) < 0) { /* timeout */
217 bit_dbg(1, &i2c_adap->dev, "i2c_inb: timeout at bit "
225 udelay(i == 7 ? adap->udelay / 2 : adap->udelay);
227 /* assert: scl is low */
232 * Sanity check for the adapter hardware - check the reaction of
233 * the bus lines only if it seems to be idle.
235 static int test_bus(struct i2c_algo_bit_data *adap, char *name)
239 if (adap->getscl == NULL)
240 pr_info("%s: Testing SDA only, SCL is not readable\n", name);
243 scl = (adap->getscl == NULL) ? 1 : getscl(adap);
245 printk(KERN_WARNING "%s: bus seems to be busy\n", name);
251 scl = (adap->getscl == NULL) ? 1 : getscl(adap);
253 printk(KERN_WARNING "%s: SDA stuck high!\n", name);
257 printk(KERN_WARNING "%s: SCL unexpected low "
258 "while pulling SDA low!\n", name);
264 scl = (adap->getscl == NULL) ? 1 : getscl(adap);
266 printk(KERN_WARNING "%s: SDA stuck low!\n", name);
270 printk(KERN_WARNING "%s: SCL unexpected low "
271 "while pulling SDA high!\n", name);
277 scl = (adap->getscl == NULL) ? 0 : getscl(adap);
279 printk(KERN_WARNING "%s: SCL stuck high!\n", name);
283 printk(KERN_WARNING "%s: SDA unexpected low "
284 "while pulling SCL low!\n", name);
290 scl = (adap->getscl == NULL) ? 1 : getscl(adap);
292 printk(KERN_WARNING "%s: SCL stuck low!\n", name);
296 printk(KERN_WARNING "%s: SDA unexpected low "
297 "while pulling SCL high!\n", name);
300 pr_info("%s: Test OK\n", name);
308 /* ----- Utility functions
311 /* try_address tries to contact a chip for a number of
312 * times before it gives up.
315 * 0 chip did not answer
316 * -x transmission error
318 static int try_address(struct i2c_adapter *i2c_adap,
319 unsigned char addr, int retries)
321 struct i2c_algo_bit_data *adap = i2c_adap->algo_data;
324 for (i = 0; i <= retries; i++) {
325 ret = i2c_outb(i2c_adap, addr);
326 if (ret == 1 || i == retries)
328 bit_dbg(3, &i2c_adap->dev, "emitting stop condition\n");
330 udelay(adap->udelay);
332 bit_dbg(3, &i2c_adap->dev, "emitting start condition\n");
336 bit_dbg(1, &i2c_adap->dev, "Used %d tries to %s client at "
337 "0x%02x: %s\n", i + 1,
338 addr & 1 ? "read from" : "write to", addr >> 1,
339 ret == 1 ? "success" : "failed, timeout?");
343 static int sendbytes(struct i2c_adapter *i2c_adap, struct i2c_msg *msg)
345 const unsigned char *temp = msg->buf;
346 int count = msg->len;
347 unsigned short nak_ok = msg->flags & I2C_M_IGNORE_NAK;
352 retval = i2c_outb(i2c_adap, *temp);
354 /* OK/ACK; or ignored NAK */
355 if ((retval > 0) || (nak_ok && (retval == 0))) {
360 /* A slave NAKing the master means the slave didn't like
361 * something about the data it saw. For example, maybe
362 * the SMBus PEC was wrong.
364 } else if (retval == 0) {
365 dev_err(&i2c_adap->dev, "sendbytes: NAK bailout, addr is 0x%x.\n", msg->addr);
368 /* Timeout; or (someday) lost arbitration
370 * FIXME Lost ARB implies retrying the transaction from
371 * the first message, after the "winning" master issues
372 * its STOP. As a rule, upper layer code has no reason
373 * to know or care about this ... it is *NOT* an error.
376 dev_err(&i2c_adap->dev, "sendbytes: error %d, addr is 0x%x.\n",
384 static int acknak(struct i2c_adapter *i2c_adap, int is_ack)
386 struct i2c_algo_bit_data *adap = i2c_adap->algo_data;
388 /* assert: sda is high */
389 if (is_ack) /* send ack */
391 udelay((adap->udelay + 1) / 2);
392 if (sclhi(adap) < 0) { /* timeout */
393 dev_err(&i2c_adap->dev, "readbytes: ack/nak timeout\n");
400 static int readbytes(struct i2c_adapter *i2c_adap, struct i2c_msg *msg)
403 int rdcount = 0; /* counts bytes read */
404 unsigned char *temp = msg->buf;
405 int count = msg->len;
406 const unsigned flags = msg->flags;
409 inval = i2c_inb(i2c_adap);
413 } else { /* read timed out */
420 /* Some SMBus transactions require that we receive the
421 transaction length as the first read byte. */
422 if (rdcount == 1 && (flags & I2C_M_RECV_LEN)) {
423 if (inval <= 0 || inval > I2C_SMBUS_BLOCK_MAX) {
424 if (!(flags & I2C_M_NO_RD_ACK))
426 dev_err(&i2c_adap->dev, "readbytes: invalid "
427 "block length (%d)\n", inval);
430 /* The original count value accounts for the extra
431 bytes, that is, either 1 for a regular transaction,
432 or 2 for a PEC transaction. */
437 bit_dbg(2, &i2c_adap->dev, "readbytes: 0x%02x %s\n",
439 (flags & I2C_M_NO_RD_ACK)
441 : (count ? "A" : "NA"));
443 if (!(flags & I2C_M_NO_RD_ACK)) {
444 inval = acknak(i2c_adap, count);
452 /* doAddress initiates the transfer by generating the start condition (in
453 * try_address) and transmits the address in the necessary format to handle
454 * reads, writes as well as 10bit-addresses.
456 * 0 everything went okay, the chip ack'ed, or IGNORE_NAK flag was set
457 * -x an error occurred (like: -EREMOTEIO if the device did not answer, or
458 * -ETIMEDOUT, for example if the lines are stuck...)
460 static int bit_doAddress(struct i2c_adapter *i2c_adap, struct i2c_msg *msg)
462 unsigned short flags = msg->flags;
463 unsigned short nak_ok = msg->flags & I2C_M_IGNORE_NAK;
464 struct i2c_algo_bit_data *adap = i2c_adap->algo_data;
469 retries = nak_ok ? 0 : i2c_adap->retries;
471 if (flags & I2C_M_TEN) {
472 /* a ten bit address */
473 addr = 0xf0 | ((msg->addr >> 7) & 0x03);
474 bit_dbg(2, &i2c_adap->dev, "addr0: %d\n", addr);
475 /* try extended address code...*/
476 ret = try_address(i2c_adap, addr, retries);
477 if ((ret != 1) && !nak_ok) {
478 dev_err(&i2c_adap->dev,
479 "died at extended address code\n");
482 /* the remaining 8 bit address */
483 ret = i2c_outb(i2c_adap, msg->addr & 0x7f);
484 if ((ret != 1) && !nak_ok) {
485 /* the chip did not ack / xmission error occurred */
486 dev_err(&i2c_adap->dev, "died at 2nd address code\n");
489 if (flags & I2C_M_RD) {
490 bit_dbg(3, &i2c_adap->dev, "emitting repeated "
491 "start condition\n");
493 /* okay, now switch into reading mode */
495 ret = try_address(i2c_adap, addr, retries);
496 if ((ret != 1) && !nak_ok) {
497 dev_err(&i2c_adap->dev,
498 "died at repeated address code\n");
502 } else { /* normal 7bit address */
503 addr = msg->addr << 1;
504 if (flags & I2C_M_RD)
506 if (flags & I2C_M_REV_DIR_ADDR)
508 ret = try_address(i2c_adap, addr, retries);
509 if ((ret != 1) && !nak_ok)
516 static int bit_xfer(struct i2c_adapter *i2c_adap,
517 struct i2c_msg msgs[], int num)
519 struct i2c_msg *pmsg;
520 struct i2c_algo_bit_data *adap = i2c_adap->algo_data;
522 unsigned short nak_ok;
524 if (adap->pre_xfer) {
525 ret = adap->pre_xfer(i2c_adap);
530 bit_dbg(3, &i2c_adap->dev, "emitting start condition\n");
531 adap->udelay = 500 * 1000/msgs[0].scl_rate + 1;
533 for (i = 0; i < num; i++) {
535 nak_ok = pmsg->flags & I2C_M_IGNORE_NAK;
536 if (!(pmsg->flags & I2C_M_NOSTART)) {
538 bit_dbg(3, &i2c_adap->dev, "emitting "
539 "repeated start condition\n");
542 ret = bit_doAddress(i2c_adap, pmsg);
543 if ((ret != 0) && !nak_ok) {
544 bit_dbg(1, &i2c_adap->dev, "NAK from "
545 "device addr 0x%02x msg #%d\n",
550 if (pmsg->flags & I2C_M_RD) {
551 /* read bytes into buffer*/
552 ret = readbytes(i2c_adap, pmsg);
554 bit_dbg(2, &i2c_adap->dev, "read %d byte%s\n",
555 ret, ret == 1 ? "" : "s");
556 if (ret < pmsg->len) {
562 /* write bytes from buffer */
563 ret = sendbytes(i2c_adap, pmsg);
565 bit_dbg(2, &i2c_adap->dev, "wrote %d byte%s\n",
566 ret, ret == 1 ? "" : "s");
567 if (ret < pmsg->len) {
577 bit_dbg(3, &i2c_adap->dev, "emitting stop condition\n");
581 adap->post_xfer(i2c_adap);
585 static u32 bit_func(struct i2c_adapter *adap)
587 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
588 I2C_FUNC_SMBUS_READ_BLOCK_DATA |
589 I2C_FUNC_SMBUS_BLOCK_PROC_CALL |
590 I2C_FUNC_10BIT_ADDR | I2C_FUNC_PROTOCOL_MANGLING;
594 /* -----exported algorithm data: ------------------------------------- */
596 static const struct i2c_algorithm i2c_bit_algo = {
597 .master_xfer = bit_xfer,
598 .functionality = bit_func,
602 * registering functions to load algorithms at runtime
604 static int i2c_bit_prepare_bus(struct i2c_adapter *adap)
606 struct i2c_algo_bit_data *bit_adap = adap->algo_data;
609 int ret = test_bus(bit_adap, adap->name);
614 /* register new adapter to i2c module... */
615 adap->algo = &i2c_bit_algo;
621 int i2c_bit_add_bus(struct i2c_adapter *adap)
625 err = i2c_bit_prepare_bus(adap);
629 return i2c_add_adapter(adap);
631 EXPORT_SYMBOL(i2c_bit_add_bus);
633 int i2c_bit_add_numbered_bus(struct i2c_adapter *adap)
637 err = i2c_bit_prepare_bus(adap);
641 return i2c_add_numbered_adapter(adap);
643 EXPORT_SYMBOL(i2c_bit_add_numbered_bus);
645 MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
646 MODULE_DESCRIPTION("I2C-Bus bit-banging algorithm");
647 MODULE_LICENSE("GPL");