wt/lm-sensors
1
0 Fork 0
mirror of https://github.com/lm-sensors/lm-sensors.git synced 2026-11-02 13:30:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Manual pages for dump tools, originally written by David Z Maze

Browse Source 
for the Debian distribution. Original patch by Aurelien Jarno.


git-svn-id: http://lm-sensors.org/svn/lm-sensors/trunk@2380 7894878c-1315-0410-8ee3-d5d059ff63e0
This commit is contained in:
Jean Delvare committed 2004-03-21 10:28:48 +00:00
1 parent 4f511fe713
commit 45940855fd
4 files changed
+161 -1
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

prog/dump/Module.mk
+6 -1
View File
@@ -21,6 +21,10 @@
MODULE_DIR := prog/dump
PROGDUMPDIR := $(MODULE_DIR)
PROGDUMPMAN8DIR := $(MANDIR)/man8
PROGDUMPMAN8FILES := $(MODULE_DIR)/isadump.8 $(MODULE_DIR)/i2cdump.8 \
$(MODULE_DIR)/i2cset.8
# Regrettably, even 'simply expanded variables' will not put their currently
# defined value verbatim into the command-list of rules...
PROGDUMPTARGETS := $(MODULE_DIR)/isadump $(MODULE_DIR)/i2cdump \
@@ -44,8 +48,9 @@ $(MODULE_DIR)/i2cset: $(MODULE_DIR)/i2cset.ro $(MODULE_DIR)/i2cbusses.ro
$(CC) $(EXLDFLAGS) -o $@ $^
install-prog-dump: all-prog-dump
$(MKDIR) $(DESTDIR)$(SBINDIR)
$(MKDIR) $(DESTDIR)$(SBINDIR) $(DESTDIR)$(PROGDUMPMAN8DIR)
$(INSTALL) -m 755 $(PROGDUMPBININSTALL) $(DESTDIR)$(SBINDIR)
$(INSTALL) -m 644 $(PROGDUMPMAN8FILES) $(DESTDIR)$(PROGDUMPMAN8DIR)
user_install :: install-prog-dump
clean-prog-dump:
prog/dump/i2cdump.8
+51
View File
@@ -0,0 +1,51 @@
.TH I2CDUMP 8 "March 2004"
.SH NAME
i2cdump \- Examine I\u2\dC registers
.SH SYNOPSIS
.B i2cdump
.I i2cbus
.I address
.RI [ mode ]
.RI [ "bank " [ bankreg ]]
.SH DESCRIPTION
i2cdump is a small helper program to examine registers
visible through the I\u2\dC bus.
.SH OPTIONS
At least two options must be provided to i2cdump. \fIi2cbus\fR indicates the
number of the I\u2\dC bus to be scanned. This number should correspond to one
of the busses listed by \fIi2cdetect -l\fR. \fIaddress\fR indicates the
address to be scanned on that bus, and is an integer between 0x00 and 0x7F. The
\fImode\fR parameter, if specified, is one of the letters \fBb\fP, \fBw\fP,
\fBs\fP, or \fBi\fP, corresponding to a read size of a single byte, a 16-bit
word, an SMBus block, an I\u2\dC block, respectively. The \fBc\fP mode is a
little different, it reads all bytes consecutively, and is useful for chips that
have an address auto-increment feature. A \fBp\fP can also be appended to the
\fImode\fR parameter to enable PEC. If the \fImode\fR parameter is omitted,
i2cdump defaults to byte access without PEC.
.PP
The \fIbank\fR and \fIbankreg\fR parameters are useful on the W83781D and
similar chips (at the time of writing, all Winbond and Asus chips).
\fIbank\fR is an integer between 0 and 7, and \fIbankreg\fR is an integer
between 0x00 and 0xFF (default value: 0x4E). The W83781D data sheet has more
information on bank selection.
.SH WARNING
i2cdump can be dangerous if used improperly. On some chips that do not support
read data commands, i2cdump can actually WRITE to the chip. Do not use i2cdump
on random addresses. Anyway, it is of little use unless you have an idea of
what you are looking for and have some general knowledge about hardware
monitoring chips internals.
.SH CONFORMING TO
lm_sensors-2.x
.SH SEE ALSO
isadump(8), i2cset(8)
.SH AUTHOR
This manual page was originally written by David Z Maze <dmaze@debian.org> for
the Debian GNU/Linux system. It was then reviewed by the lm_sensors team and
is now part of the lm_sensors source distribution.
prog/dump/i2cset.8
+48
View File
@@ -0,0 +1,48 @@
.TH I2CSET 8 "March 2004"
.SH "NAME"
i2cset \- Set I\u2\dC registers
.SH SYNOPSIS
.B i2cset
.I i2cbus
.I chip-address
.I data-address
.I value
.RI [ mode ]
.SH DESCRIPTION
i2cset is a small helper program to set registers visible through the I\u2\dC
bus.
.SH OPTIONS
There are four required options to i2cset. \fIi2cbus\fR indicates the number
of the I\u2\dC bus to be scanned. This number should correspond to one of
the busses listed by \fIi2cdetect -l\fR. \fIchip-address\fR specifies the
address of the chip on that bus, and is an integer between 0x00 and 0x7F.
\fIdata-address\fR specifies the address on that chip to write to, and is an
integer between 0x00 and 0xFF. \fIvalue\fR is the value to write to that
location on the chip.
.PP
The \fImode\fR parameter, if specified, is one of the letters \fBb\fP or
\fBw\fP, corresponding to a write size of a single byte or a 16-bit word,
respectively. If the \fImode\fR parameter is omitted, i2cset defaults to byte
mode. The \fIvalue\fR provided must be within range for the specified data
type (0x00-0xFF for bytes, 0x0000-0xFFFF for words).
.SH WARNING
i2cset can be extremely dangerous if used improperly. It can confuse your
I\u2\dC bus, cause data loss, or have more serious side effects. Writing to
a serial EEPROM on a memory DIMM (chip addresses between 0x50 and 0x57) may
DESTROY your memory, leaving your system unbootable! Be extremely careful
using this program.
.SH CONFORMING TO
lm_sensors-2.x
.SH SEE ALSO
i2cdump(8)
.SH AUTHOR
This manual page was originally written by David Z Maze <dmaze@debian.org> for
the Debian GNU/Linux system. It was then reviewed by the lm_sensors team and
is now part of the lm_sensors source distribution.
prog/dump/isadump.8
+56
View File
@@ -0,0 +1,56 @@
.TH ISADUMP 8 "March 2004"
.SH NAME
isadump \- Examine ISA registers
.SH SYNOPSIS
.B isadump
.I addrreg
.I datareg
.RI [ "bank " [ bankreg ]]
(for I\u2\dC-like access)
.br
.B isadump
.BI "-f " address
(for flat address space)
.SH DESCRIPTION
isadump is a small helper program to examine registers visible through the ISA
bus. It is intended to probe any chip that lives on the ISA bus working with an
address register and a data register (I\u2\dC-like access) or a flat 256 bytes
range.
.SH OPTIONS (I\u2\dC-like access mode)
At least two options must be provided to isadump. \fIaddrreg\fR contains the
ISA address of the address register for the chip to probe; \fIdatareg\fR
contains the address of the data register. Both addresses are integers between
0x0000 and 0x3FFF. Usually, if the chip's base address is 0x0nn0, the
address register is at 0x0nn5 and the data register is at 0x0nn6. The most
common base address for hardware monitoring chips is 0x0290.
.PP
The \fIbank\fR and \fIbankreg\fR parameters are useful on the W83781D and
similar chips (at the time of writing, all Winbond and Asus chips).
\fIbank\fR is an integer between 0 and 7, and \fIbankreg\fR is an integer
between 0x00 and 0xFF (default value: 0x4E). The W83781D data sheet has more
information on bank selection.
.SH OPTIONS (flat address space mode)
In flat mode (triggered by the \fB-f\fR flag), only one parameter must be
provided. \fIaddress\fR contains the ISA address of the address register
for the chip to probe; it is an integer between 0x0000 and 0xFFFF.
.SH WARNING
Poking around in ISA data space is extremely dangerous.
Running isadump with random parameters can cause system
crashes, data loss, and worse! Be extremely careful when using
this program.
.SH CONFORMING TO
lm_sensors-2.x
.SH SEE ALSO
i2cdump(8)
.SH AUTHOR
This manual page was originally written by David Z Maze <dmaze@debian.org> for
the Debian GNU/Linux system. It was then reviewed by the lm_sensors team and
is now part of the lm_sensors source distribution.