i2c-tools/i2c-tools-r6110-i2cdetect-clarify-probing.diff

41 lines
1.6 KiB
Diff

Subject: i2cdetect: Clarify the SMBus commands used for probing by default
Upstream: yes, r6110
Clarify the SMBus commands used for probing by default.
---
tools/i2cdetect.8 | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
--- i2c-tools-3.1.0.orig/tools/i2cdetect.8
+++ i2c-tools-3.1.0/tools/i2cdetect.8
@@ -28,6 +28,12 @@ should correspond to one of the busses l
The optional parameters \fIfirst\fR and \fIlast\fR restrict the scanning
range (default: from 0x03 to 0x77).
.PP
+As there is no standard I2C detection command, i2cdetect uses arbitrary
+SMBus commands (namely SMBus quick write and SMBus receive byte) to probe
+for devices. By default, the command used is the one believed to be the
+safest for each address. See options \fI-q\fR and \fI-r\fR to change this
+behavior.
+.PP
i2cdetect can also be used to query the functionalities of an I2C bus
(see option \fB-F\fP.)
@@ -57,14 +63,12 @@ scripts.
Force scanning of non-regular addresses. Not recommended.
.TP
.B "\-q"
-Use SMBus "quick write" commands for probing (by default, the command
-used is the one believed to be the safest for each address).
+Use SMBus "quick write" command for probing.
Not recommended. This is known to corrupt the Atmel AT24RF08 EEPROM
found on many IBM Thinkpad laptops.
.TP
.B "\-r"
-Use SMBus "read byte" commands for probing (by default, the command
-used is the one believed to be the safest for each address).
+Use SMBus "receive byte" command for probing.
Not recommended. This is known to lock SMBus on various write-only
chips (most notably clock chips at address 0x69).
.TP