[2/7] i2cget: Document the support of I2C block reads

Message ID 20210608172923.0d3f9296@endymion
State New
Headers show
Series
  • Rework block read support among i2cget and i2cdump
Related show

Commit Message

Jean Delvare June 8, 2021, 3:29 p.m.
Mention I2C block read support in the i2cget(8) manual page, together
with an example.

Signed-off-by: Jean Delvare <jdelvare@suse.de>
---
 tools/i2cget.8 |   20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

Patch

--- i2c-tools.orig/tools/i2cget.8	2021-06-08 16:49:54.910097286 +0200
+++ i2c-tools/tools/i2cget.8	2021-06-08 16:56:26.416459188 +0200
@@ -1,4 +1,4 @@ 
-.TH I2CGET 8 "October 2017"
+.TH I2CGET 8 "June 2021"
 .SH "NAME"
 i2cget \- read from I2C/SMBus chip registers
 
@@ -9,7 +9,7 @@  i2cget \- read from I2C/SMBus chip regis
 .RB [ -a ]
 .I i2cbus
 .I chip-address
-.RI [ "data-address " [ mode ]]
+.RI [ "data-address " [ "mode " [ length ]]]
 .br
 .B i2cget
 .B -V
@@ -49,9 +49,11 @@  an integer between 0x00 and 0xFF. If omi
 will be read (if that makes sense for the considered chip).
 .PP
 The \fImode\fR parameter, if specified, is one of the letters \fBb\fP,
-\fBw\fP or \fBc\fP, corresponding to a read byte data, a read word data or a
-write byte/read byte transaction, respectively. A \fBp\fP can also be appended
-to the \fImode\fR parameter to enable PEC. If the \fImode\fR parameter is omitted,
+\fBw\fP, \fBc\fP, or \fBi\fP, corresponding to a read byte data, a read
+word data, a write byte/read byte, or a read I2C block transaction,
+respectively. A \fBp\fP can also be appended to the \fImode\fR parameter to
+enable PEC, except for I2C block transactions. If the \fImode\fR
+parameter is omitted,
 i2cget defaults to a read byte data transaction, unless \fIdata-address\fR is
 also omitted, in which case the default (and only valid) transaction is a
 single read byte.
@@ -112,6 +114,14 @@  concerns raised above still stand, howev
 equivalent, so this is the only way to read data from a large EEPROM if your
 master isn't fully I2C capable. With a fully I2C capable master, you would
 use \fIi2ctransfer\fR to achieve the same in a safe and faster way.
+.PP
+Read the first 8 bytes of an EEPROM device at 7-bit address 0x50
+on bus 4 (i2c-4):
+.nf
+.RS
+# i2cget -y 4 0x50 0x00 i 8
+.RE
+.fi
 
 .SH BUGS
 To report bugs or send fixes, please write to the Linux I2C mailing list