diff --git a/usr.sbin/i2c/i2c.c b/usr.sbin/i2c/i2c.c index c862666fc9a7..588aad8592ee 100644 --- a/usr.sbin/i2c/i2c.c +++ b/usr.sbin/i2c/i2c.c @@ -1,761 +1,761 @@ /*- * SPDX-License-Identifier: BSD-2-Clause-FreeBSD * * Copyright (C) 2008-2009 Semihalf, Michal Hajduk and Bartlomiej Sieka * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #include __FBSDID("$FreeBSD$"); #include #include #include #include #include #include #include #include #include #include #include #include #define I2C_DEV "/dev/iic0" #define I2C_MODE_NOTSET 0 #define I2C_MODE_NONE 1 #define I2C_MODE_STOP_START 2 #define I2C_MODE_REPEATED_START 3 #define I2C_MODE_TRANSFER 4 struct options { const char *width; int count; int verbose; int addr_set; int binary; int scan; int skip; int reset; int mode; char dir; uint32_t addr; uint32_t off; uint8_t off_buf[2]; size_t off_len; }; struct skip_range { int start; int end; }; __dead2 static void usage(const char *msg) { if (msg != NULL) fprintf(stderr, "%s\n", msg); fprintf(stderr, "usage: %s -a addr [-f device] [-d [r|w]] [-o offset] " - "[-w [0|8|16]] [-c count] [-m [tr|ss|rs|no]] [-b] [-v]\n", + "[-w [0|8|16|16LE|16BE]] [-c count] [-m [tr|ss|rs|no]] [-b] [-v]\n", getprogname()); fprintf(stderr, " %s -s [-f device] [-n skip_addr] -v\n", getprogname()); fprintf(stderr, " %s -r [-f device] -v\n", getprogname()); exit(EX_USAGE); } static struct skip_range skip_get_range(char *skip_addr) { struct skip_range addr_range; char *token; addr_range.start = 0; addr_range.end = 0; token = strsep(&skip_addr, ".."); if (token) { addr_range.start = strtoul(token, 0, 16); token = strsep(&skip_addr, ".."); if ((token != NULL) && !atoi(token)) { token = strsep(&skip_addr, ".."); if (token) addr_range.end = strtoul(token, 0, 16); } } return (addr_range); } /* Parse the string to get hex 7 bits addresses */ static int skip_get_tokens(char *skip_addr, int *sk_addr, int max_index) { char *token; int i; for (i = 0; i < max_index; i++) { token = strsep(&skip_addr, ":"); if (token == NULL) break; sk_addr[i] = strtoul(token, 0, 16); } return (i); } static int scan_bus(const char *dev, int fd, int skip, char *skip_addr) { struct iiccmd cmd; struct iic_msg rdmsg; struct iic_rdwr_data rdwrdata; struct skip_range addr_range = { 0, 0 }; int *tokens = NULL, error, i, idx = 0, j; int len = 0, do_skip = 0, no_range = 1, num_found = 0, use_read_xfer = 0; uint8_t rdbyte; if (skip) { assert(skip_addr != NULL); len = strlen(skip_addr); if (strstr(skip_addr, "..") != NULL) { addr_range = skip_get_range(skip_addr); no_range = 0; } else { tokens = (int *)malloc((len / 2 + 1) * sizeof(int)); if (tokens == NULL) { fprintf(stderr, "Error allocating tokens " "buffer\n"); error = -1; goto out; } idx = skip_get_tokens(skip_addr, tokens, len / 2 + 1); } if (!no_range && (addr_range.start > addr_range.end)) { fprintf(stderr, "Skip address out of range\n"); error = -1; goto out; } } printf("Scanning I2C devices on %s: ", dev); start_over: if (use_read_xfer) { fprintf(stderr, "Hardware may not support START/STOP scanning; " "trying less-reliable read method.\n"); } for (i = 1; i < 127; i++) { if (skip && ( addr_range.start < addr_range.end)) { if (i >= addr_range.start && i <= addr_range.end) continue; } else if (skip && no_range) { assert (tokens != NULL); for (j = 0; j < idx; j++) { if (tokens[j] == i) { do_skip = 1; break; } } } if (do_skip) { do_skip = 0; continue; } cmd.slave = i << 1; cmd.last = 1; cmd.count = 0; error = ioctl(fd, I2CRSTCARD, &cmd); if (error) { fprintf(stderr, "Controller reset failed\n"); goto out; } if (use_read_xfer) { rdmsg.buf = &rdbyte; rdmsg.len = 1; rdmsg.flags = IIC_M_RD; rdmsg.slave = i << 1; rdwrdata.msgs = &rdmsg; rdwrdata.nmsgs = 1; error = ioctl(fd, I2CRDWR, &rdwrdata); } else { cmd.slave = i << 1; cmd.last = 1; error = ioctl(fd, I2CSTART, &cmd); if (errno == ENODEV || errno == EOPNOTSUPP) { /* If START not supported try reading. */ use_read_xfer = 1; goto start_over; } (void)ioctl(fd, I2CSTOP); } if (error == 0) { ++num_found; printf("%02x ", i); } } /* * If we found nothing, maybe START is not supported and returns a * generic error code such as EIO or ENXIO, so try again using reads. */ if (num_found == 0) { if (!use_read_xfer) { use_read_xfer = 1; goto start_over; } printf(""); } printf("\n"); error = ioctl(fd, I2CRSTCARD, &cmd); out: if (skip && no_range) free(tokens); else assert(tokens == NULL); if (error) { fprintf(stderr, "Error scanning I2C controller (%s): %s\n", dev, strerror(errno)); return (EX_NOINPUT); } else return (EX_OK); } static int reset_bus(const char *dev, int fd) { struct iiccmd cmd; int error; printf("Resetting I2C controller on %s: ", dev); error = ioctl(fd, I2CRSTCARD, &cmd); if (error) { printf("error: %s\n", strerror(errno)); return (EX_IOERR); } else { printf("OK\n"); return (EX_OK); } } static const char * encode_offset(const char *width, unsigned address, uint8_t *dst, size_t *len) { if (!strcmp(width, "0")) { *len = 0; return (NULL); } if (!strcmp(width, "8")) { if (address > 0xff) return ("Invalid 8-bit address\n"); *dst = address; *len = 1; return (NULL); } if (address > 0xffff) return ("Invalid 16-bit address\n"); if (!strcmp(width, "16LE") || !strcmp(width, "16")) { le16enc(dst, address); *len = 2; return (NULL); } if (!strcmp(width, "16BE")) { be16enc(dst, address); *len = 2; return (NULL); } return ("Invalid offset width, must be: 0|8|16|16LE|16BE\n"); } static const char * write_offset(int fd, struct options i2c_opt, struct iiccmd *cmd) { int error; if (i2c_opt.off_len > 0) { cmd->count = i2c_opt.off_len; cmd->buf = i2c_opt.off_buf; error = ioctl(fd, I2CWRITE, cmd); if (error == -1) return ("ioctl: error writing offset\n"); } return (NULL); } static int i2c_write(int fd, struct options i2c_opt, char *i2c_buf) { struct iiccmd cmd; int error; char *buf; const char *err_msg; cmd.slave = i2c_opt.addr; error = ioctl(fd, I2CSTART, &cmd); if (error == -1) { err_msg = "ioctl: error sending start condition"; goto err1; } switch(i2c_opt.mode) { case I2C_MODE_STOP_START: err_msg = write_offset(fd, i2c_opt, &cmd); if (err_msg != NULL) goto err1; error = ioctl(fd, I2CSTOP); if (error == -1) { err_msg = "ioctl: error sending stop condition"; goto err2; } cmd.slave = i2c_opt.addr; error = ioctl(fd, I2CSTART, &cmd); if (error == -1) { err_msg = "ioctl: error sending start condition"; goto err1; } /* * Write the data */ cmd.count = i2c_opt.count; cmd.buf = i2c_buf; cmd.last = 0; error = ioctl(fd, I2CWRITE, &cmd); if (error == -1) { err_msg = "ioctl: error writing"; goto err1; } break; case I2C_MODE_REPEATED_START: err_msg = write_offset(fd, i2c_opt, &cmd); if (err_msg != NULL) goto err1; cmd.slave = i2c_opt.addr; error = ioctl(fd, I2CRPTSTART, &cmd); if (error == -1) { err_msg = "ioctl: error sending repeated start " "condition"; goto err1; } /* * Write the data */ cmd.count = i2c_opt.count; cmd.buf = i2c_buf; cmd.last = 0; error = ioctl(fd, I2CWRITE, &cmd); if (error == -1) { err_msg = "ioctl: error writing"; goto err1; } break; case I2C_MODE_NONE: /* fall through */ default: buf = malloc(i2c_opt.off_len + i2c_opt.count); if (buf == NULL) { err_msg = "error: data malloc"; goto err1; } memcpy(buf, i2c_opt.off_buf, i2c_opt.off_len); memcpy(buf + i2c_opt.off_len, i2c_buf, i2c_opt.count); /* * Write offset and data */ cmd.count = i2c_opt.off_len + i2c_opt.count; cmd.buf = buf; cmd.last = 0; error = ioctl(fd, I2CWRITE, &cmd); free(buf); if (error == -1) { err_msg = "ioctl: error writing"; goto err1; } break; } error = ioctl(fd, I2CSTOP); if (error == -1) { err_msg = "ioctl: error sending stop condition"; goto err2; } return (0); err1: error = ioctl(fd, I2CSTOP); if (error == -1) fprintf(stderr, "error sending stop condition\n"); err2: if (err_msg) fprintf(stderr, "%s\n", err_msg); return (1); } static int i2c_read(int fd, struct options i2c_opt, char *i2c_buf) { struct iiccmd cmd; int error; char data = 0; const char *err_msg; bzero(&cmd, sizeof(cmd)); if (i2c_opt.off_len) { cmd.slave = i2c_opt.addr; cmd.count = 1; cmd.last = 0; cmd.buf = &data; error = ioctl(fd, I2CSTART, &cmd); if (error == -1) { err_msg = "ioctl: error sending start condition"; goto err1; } err_msg = write_offset(fd, i2c_opt, &cmd); if (err_msg != NULL) goto err1; if (i2c_opt.mode == I2C_MODE_STOP_START) { error = ioctl(fd, I2CSTOP); if (error == -1) { err_msg = "error sending stop condition"; goto err2; } } } cmd.slave = i2c_opt.addr | 1; cmd.count = 1; cmd.last = 0; cmd.buf = &data; if (i2c_opt.mode == I2C_MODE_STOP_START || i2c_opt.off_len == 0) { error = ioctl(fd, I2CSTART, &cmd); if (error == -1) { err_msg = "ioctl: error sending start condition"; goto err2; } } else if (i2c_opt.mode == I2C_MODE_REPEATED_START) { error = ioctl(fd, I2CRPTSTART, &cmd); if (error == -1) { err_msg = "ioctl: error sending repeated start " "condition"; goto err1; } } cmd.count = i2c_opt.count; cmd.buf = i2c_buf; cmd.last = 1; error = ioctl(fd, I2CREAD, &cmd); if (error == -1) { err_msg = "ioctl: error while reading"; goto err1; } error = ioctl(fd, I2CSTOP); if (error == -1) { err_msg = "error sending stop condtion\n"; goto err2; } return (0); err1: error = ioctl(fd, I2CSTOP); if (error == -1) fprintf(stderr, "error sending stop condition\n"); err2: if (err_msg) fprintf(stderr, "%s\n", err_msg); return (1); } /* * i2c_rdwr_transfer() - use I2CRDWR to conduct a complete i2c transfer. * * Some i2c hardware is unable to provide direct control over START, REPEAT- * START, and STOP operations. Such hardware can only perform a complete * START--STOP or START--REPEAT-START--STOP sequence as a * single operation. The driver framework refers to this sequence as a * "transfer" so we call it "transfer mode". We assemble either one or two * iic_msg structures to describe the IO operations, and hand them off to the * driver to be handled as a single transfer. */ static int i2c_rdwr_transfer(int fd, struct options i2c_opt, char *i2c_buf) { struct iic_msg msgs[2], *msgp = msgs; struct iic_rdwr_data xfer; int flag = 0; if (i2c_opt.off_len) { msgp->flags = IIC_M_WR | IIC_M_NOSTOP; msgp->slave = i2c_opt.addr; msgp->buf = i2c_opt.off_buf; msgp->len = i2c_opt.off_len; msgp++; flag = IIC_M_NOSTART; } /* * If the transfer direction is write and we did a write of the offset * above, then we need to elide the start; this transfer is just more * writing that follows the one started above. For a read, we always do * a start; if we did an offset write above it'll be a repeat-start * because of the NOSTOP flag used above. */ if (i2c_opt.dir == 'w') msgp->flags = IIC_M_WR | flag; else msgp->flags = IIC_M_RD; msgp->slave = i2c_opt.addr; msgp->len = i2c_opt.count; msgp->buf = i2c_buf; msgp++; xfer.msgs = msgs; xfer.nmsgs = msgp - msgs; if (ioctl(fd, I2CRDWR, &xfer) == -1 ) err(1, "ioctl(I2CRDWR) failed"); return (0); } static int access_bus(int fd, struct options i2c_opt) { char *i2c_buf; int error, chunk_size = 16, i, ch; i2c_buf = malloc(i2c_opt.count); if (i2c_buf == NULL) err(1, "data malloc"); /* * For a write, read the data to be written to the chip from stdin. */ if (i2c_opt.dir == 'w') { if (i2c_opt.verbose && !i2c_opt.binary) fprintf(stderr, "Enter %d bytes of data: ", i2c_opt.count); for (i = 0; i < i2c_opt.count; i++) { ch = getchar(); if (ch == EOF) { free(i2c_buf); err(1, "not enough data, exiting\n"); } i2c_buf[i] = ch; } } if (i2c_opt.mode == I2C_MODE_TRANSFER) error = i2c_rdwr_transfer(fd, i2c_opt, i2c_buf); else if (i2c_opt.dir == 'w') error = i2c_write(fd, i2c_opt, i2c_buf); else error = i2c_read(fd, i2c_opt, i2c_buf); if (error == 0) { if (i2c_opt.dir == 'r' && i2c_opt.binary) { (void)fwrite(i2c_buf, 1, i2c_opt.count, stdout); } else if (i2c_opt.verbose || i2c_opt.dir == 'r') { if (i2c_opt.verbose) fprintf(stderr, "\nData %s (hex):\n", i2c_opt.dir == 'r' ? "read" : "written"); for (i = 0; i < i2c_opt.count; i++) { fprintf (stderr, "%02hhx ", i2c_buf[i]); if ((i % chunk_size) == chunk_size - 1) fprintf(stderr, "\n"); } if ((i % chunk_size) != 0) fprintf(stderr, "\n"); } } free(i2c_buf); return (error); } int main(int argc, char** argv) { struct options i2c_opt; char *skip_addr = NULL; const char *dev, *err_msg; int fd, error, ch; errno = 0; dev = I2C_DEV; /* Default values */ i2c_opt.addr_set = 0; i2c_opt.off = 0; i2c_opt.verbose = 0; i2c_opt.dir = 'r'; /* direction = read */ i2c_opt.width = "8"; i2c_opt.count = 1; i2c_opt.binary = 0; /* ASCII text output */ i2c_opt.scan = 0; /* no bus scan */ i2c_opt.skip = 0; /* scan all addresses */ i2c_opt.reset = 0; /* no bus reset */ i2c_opt.mode = I2C_MODE_NOTSET; while ((ch = getopt(argc, argv, "a:f:d:o:w:c:m:n:sbvrh")) != -1) { switch(ch) { case 'a': i2c_opt.addr = (strtoul(optarg, 0, 16) << 1); if (i2c_opt.addr == 0 && errno == EINVAL) usage("Bad -a argument (hex)"); i2c_opt.addr_set = 1; break; case 'f': dev = optarg; break; case 'd': i2c_opt.dir = optarg[0]; break; case 'o': i2c_opt.off = strtoul(optarg, 0, 16); if (i2c_opt.off == 0 && errno == EINVAL) usage("Bad -o argument (hex)"); break; case 'w': i2c_opt.width = optarg; break; case 'c': i2c_opt.count = (strtoul(optarg, 0, 10)); if (i2c_opt.count == 0 && errno == EINVAL) usage("Bad -c argument (decimal)"); break; case 'm': if (!strcmp(optarg, "no")) i2c_opt.mode = I2C_MODE_NONE; else if (!strcmp(optarg, "ss")) i2c_opt.mode = I2C_MODE_STOP_START; else if (!strcmp(optarg, "rs")) i2c_opt.mode = I2C_MODE_REPEATED_START; else if (!strcmp(optarg, "tr")) i2c_opt.mode = I2C_MODE_TRANSFER; else usage("Bad -m argument ([no|ss|rs|tr])"); break; case 'n': i2c_opt.skip = 1; skip_addr = optarg; break; case 's': i2c_opt.scan = 1; break; case 'b': i2c_opt.binary = 1; break; case 'v': i2c_opt.verbose = 1; break; case 'r': i2c_opt.reset = 1; break; case 'h': usage("Help:"); break; default: usage("Bad argument"); } } argc -= optind; argv += optind; if (argc > 0) usage("Too many arguments"); /* Set default mode if option -m is not specified */ if (i2c_opt.mode == I2C_MODE_NOTSET) { if (i2c_opt.dir == 'r') i2c_opt.mode = I2C_MODE_STOP_START; else if (i2c_opt.dir == 'w') i2c_opt.mode = I2C_MODE_NONE; } err_msg = encode_offset(i2c_opt.width, i2c_opt.off, i2c_opt.off_buf, &i2c_opt.off_len); if (err_msg != NULL) { fprintf(stderr, "%s", err_msg); exit(EX_USAGE); } /* Basic sanity check of command line arguments */ if (i2c_opt.scan) { if (i2c_opt.addr_set) usage("-s and -a are incompatible"); } else if (i2c_opt.reset) { if (i2c_opt.addr_set) usage("-r and -a are incompatible"); } if (i2c_opt.verbose) fprintf(stderr, "dev: %s, addr: 0x%x, r/w: %c, " "offset: 0x%02x, width: %s, count: %d\n", dev, i2c_opt.addr >> 1, i2c_opt.dir, i2c_opt.off, i2c_opt.width, i2c_opt.count); fd = open(dev, O_RDWR); if (fd == -1) { fprintf(stderr, "Error opening I2C controller (%s): %s\n", dev, strerror(errno)); return (EX_NOINPUT); } if (i2c_opt.scan) error = scan_bus(dev, fd, i2c_opt.skip, skip_addr); else if (i2c_opt.reset) error = reset_bus(dev, fd); else error = access_bus(fd, i2c_opt); ch = close(fd); assert(ch == 0); return (error); }