diff options
author | khali <khali@7894878c-1315-0410-8ee3-d5d059ff63e0> | 2014-02-20 10:02:54 +0000 |
---|---|---|
committer | khali <khali@7894878c-1315-0410-8ee3-d5d059ff63e0> | 2014-02-20 10:02:54 +0000 |
commit | 4024e28f095da8b894687f0bdfe440a6b28164c0 (patch) | |
tree | f293490092e94e9abe0bae4f5a08e354879bcb3a | |
parent | a0cf87c0aa29eca896a8c6dd5bf2c6ee4f8f9001 (diff) | |
download | i2c-tools-4024e28f095da8b894687f0bdfe440a6b28164c0.tar.gz |
Manual pages for eeprog, eeprom and eepromer, contributed by Jaromir
Capik.
git-svn-id: http://lm-sensors.org/svn/i2c-tools/branches/i2c-tools-3.1@6234 7894878c-1315-0410-8ee3-d5d059ff63e0
-rw-r--r-- | CHANGES | 3 | ||||
-rw-r--r-- | eepromer/eeprog.8 | 103 | ||||
-rw-r--r-- | eepromer/eeprom.8 | 64 | ||||
-rw-r--r-- | eepromer/eepromer.8 | 61 |
4 files changed, 231 insertions, 0 deletions
@@ -16,6 +16,9 @@ SVN HEAD Encode "degrees" to HTML degree symbol Add a manual page decode-vaio: Add a manual page + eeprog: Add a manual page + eeprom: Add a manual page + eepromer: Add a manual page i2cdetect: Clarify the SMBus commands used for probing by default i2c-dev.h: Minimize differences with kernel flavor i2c-stub-from-dump: Be more tolerant on input dump format diff --git a/eepromer/eeprog.8 b/eepromer/eeprog.8 new file mode 100644 index 0000000..6257cc5 --- /dev/null +++ b/eepromer/eeprog.8 @@ -0,0 +1,103 @@ +.\" +.\" eeprog.8 - manpage for the i2c-tools/eeprog utility +.\" Copyright (C) 2013 Jaromir Capik +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License along +.\" with this program; if not, write to the Free Software Foundation, Inc., +.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.TH eeprog "8" "Jul 2013" "i2c-tools" "System Administration" +.SH NAME +eeprog \- reads and writes 24Cxx EEPROMs connected to I2C serial bus +.SH SYNOPSIS +.B eeprog +[-fqxdh] [-16|-8] [-r addr[:count]|-w addr] <device> <i2c-addr> +.SH DESCRIPTION +.B eeprog +uses the SMBus protocol used by most of the recent chipsets. +.SH NOTE +Don't forget to load your i2c chipset and the i2c-dev drivers. +.P +The following environment variables could be set instead of the command line arguments: +.P + EEPROG_DEV device +.br + EEPROG_I2C_ADDR i2c-addr +.SH PARAMETERS +.I Address modes +.TP +.B \-8 +Use 8bit address mode for 24c0x...24C16 [default] +.TP +.B \-16 +Use 16bit address mode for 24c32...24C256 +.TP +.I Actions +.TP +.B \-r addr[:count] +Read +.B count +(1 if omitted) bytes from +.B addr +and print them to the standard output +.TP +.B \-w addr +Write input (stdin) at address +.B addr +of the EEPROM +.TP +.B \-h +Print this help +.TP +.I Options +.TP +.B \-x +Set hex output mode +.TP +.B \-d +Dummy mode, display what *would* have been done +.TP +.B \-f +Disable warnings and don't ask confirmation +.TP +.B \-q +Quiet mode +.TP +.I Bus +.TP +.B device +Device file representing the I2C bus (eg. /dev/i2c-0) +.TP +.B i2c-addr +I2C bus address of the EEPROM (eg. 0x3A) +.SH EXAMPLES +Read 64 bytes from the EEPROM at address 0x54 on bus 0 starting at address 123 (decimal) +.P +.B eeprog +/dev/i2c-0 0x54 -r 123:64 +.P +Print the hex codes of the first 32 bytes read from bus 1 at address 0x22 +.P +.B eeprog +/dev/i2c-1 0x51 -x -r 0x22:0x20 +.P +Write the current timestamp at address 0x200 of the EEPROM on bus 0 at address 0x33 +.P + date | +.B eeprog +/dev/i2c-0 0x33 -w 0x200 +.SH SEE ALSO +.BR eeprom (8), +.BR eepromer (8) +.SH AUTHOR +Stefano Barbato diff --git a/eepromer/eeprom.8 b/eepromer/eeprom.8 new file mode 100644 index 0000000..0489590 --- /dev/null +++ b/eepromer/eeprom.8 @@ -0,0 +1,64 @@ +.\" +.\" eeprom.8 - manpage for the i2c-tools/eeprom utility +.\" Copyright (C) 2013 Jaromir Capik +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License along +.\" with this program; if not, write to the Free Software Foundation, Inc., +.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.TH eeprom "8" "Jul 2013" "i2c-tools" "System Administration" +.SH NAME +eeprom \- reads and writes 24Cxx EEPROMs connected to I2C serial bus +.SH SYNOPSIS +.B eeprom +[-d dev] [-a addr] [-p pgs] [-w] [-y] [-f file] +.SH DESCRIPTION +.B eeprom +can be used for reading from / writing to I2C EEPROMs like the popular +24C16, 24C08, 24C04, etc. +In contrast to +.B eeprommer +which supports 24C256-type EEPROMs, +this tool works with 1-byte addresses! +.SH NOTES +Don't forget to load your i2c chipset and the i2c-dev drivers. +.P +Pages/addresses: + EEPROMs with more than 256 bytes appear as if they + were several EEPROMs with consecutive addresses on the bus + so we might as well address several separate EEPROMs with + increasing addresses +.SH PARAMETERS +.TP +.B dev +device (default /dev/i2c-0) +.TP +.B addr +base address of EEPROM (default 0xA0) +.TP +.B pgs +number of pages to read (default 8) +.TP +.B \-w +write to EEPROM (default is reading!) +.TP +.B \-y +suppress warning when writing (default is to warn!) +.TP +.B \-f file +copy EEPROM contents to/from file (default for read is test only; for write is all zeros) +.SH SEE ALSO +.BR eeprog (8), +.BR eepromer (8) +.SH AUTHOR +Christian Vogel diff --git a/eepromer/eepromer.8 b/eepromer/eepromer.8 new file mode 100644 index 0000000..c3f3239 --- /dev/null +++ b/eepromer/eepromer.8 @@ -0,0 +1,61 @@ +.\" +.\" eeprom.8 - manpage for the i2c-tools/eeprom utility +.\" Copyright (C) 2013 Jaromir Capik +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License along +.\" with this program; if not, write to the Free Software Foundation, Inc., +.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.TH eepromer "8" "Jul 2013" "i2c-tools" "System Administration" +.SH NAME +eepromer \- reads and writes 24Cxx EEPROMs connected to I2C serial bus +.SH SYNOPSIS +.B eepromer +[-r|-w|-e|-p] -f <device> <i2c-addr> +.SH DESCRIPTION +The EEPROM must be a large EEPROM which uses a 2-byte address +field (24C32 or larger). It will NOT WORK on small EEPROMs +(24C01 - 24C16) such as those used on SDRAM DIMMs. +.SH NOTES +Don't forget to load your i2c chipset and the i2c-dev drivers. +.P +Tested only on 24C256. +.P +.SH PARAMETERS +.TP +.I Actions +.TP +.B \-r +Read +.TP +.B \-w +Write +.TP +.B \-e +Erase +.TP +.B \-p +Print header +.TP +.I Bus +.TP +.B \-f device +Device file representing the I2C bus (eg. /dev/i2c-0) +.TP +.B i2c-addr +I2C bus address of the EEPROM (eg. 0x3A) +.SH SEE ALSO +.BR eeprog (8), +.BR eeprom (8) +.SH AUTHOR +Daniel Smolik |