root/i2c-tools/trunk/tools/i2cdetect.8

Revision 5195, 2.4 kB (checked in by khali, 7 months ago)

Make it possible to pass the i2c bus by name instead of by number. As
there is no guarantee that i2c bus numbering will stay the same over
time (for example if hardware is added of removed, or simply due to
loading the drivers in a different order), passing the i2c bus by name
is more robust.

The i2c bus names are supposed to be unique. If you request a bus by
name and this name happens to not be unique, then the tools will play
it safe and quit. This is better than writing to the wrong device.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 .TH I2CDETECT 8 "April 2008"
2 .SH NAME
3 i2cdetect \- detect I2C chips
4
5 .SH SYNOPSIS
6 .B i2cdetect
7 .RI [ -y ]
8 .RI [ -a ]
9 .RI [ -q | -r ]
10 .I i2cbus
11 .RI [ "first last" ]
12 .br
13 .B i2cdetect
14 .I -F
15 .I i2cbus
16 .br
17 .B i2cdetect
18 .I -V
19 .br
20 .B i2cdetect
21 .I -l
22
23 .SH DESCRIPTION
24 i2cdetect is a userspace program to scan an I2C bus for devices. It
25 outputs a table with the list of detected devices on the specified bus.
26 \fIi2cbus\fR indicates the number or name of the I2C bus to be scanned, and
27 should correspond to one of the busses listed by \fIi2cdetect -l\fR.
28 The optional parameters \fIfirst\fR and \fIlast\fR restrict the scanning
29 range (default: from 0x03 to 0x77).
30 .PP
31 i2cdetect can also be used to query the functionalities of an I2C bus
32 (see option \fB-F\fP.)
33
34 .SH WARNING
35 This program can confuse your I2C bus, cause data loss and worse!
36
37 .SH INTERPRETING THE OUTPUT
38 Each cell in the output table will contain one of the following symbols:
39 .IP \(bu "\w'\(bu'u+1n"
40 "--". The address was probed but no chip answered.
41 .IP \(bu
42 "UU". Probing was skipped, because this address is currently in use by
43 a driver. This strongly suggests that there is a chip at this address.
44 .IP \(bu
45 An address number in hexadecimal, e.g. "2d" or "4e". A chip
46 was found at this address.
47
48 .SH OPTIONS
49 .TP
50 .B "\-y"
51 Disable interactive mode. By default, i2cdetect will wait for a confirmation
52 from the user before messing with the I2C bus. When this flag is used, it
53 will perform the operation directly. This is mainly meant to be used in
54 scripts.
55 .TP
56 .B "\-a"
57 Force scanning of non-regular addresses. Not recommended.
58 .TP
59 .B "\-q"
60 Use SMBus "quick write" commands for probing (by default, the command
61 used is the one believed to be the safest for each address).
62 Not recommended. This is known to corrupt the Atmel AT24RF08 EEPROM
63 found on many IBM Thinkpad laptops.
64 .TP
65 .B "\-r"
66 Use SMBus "read byte" commands for probing (by default, the command
67 used is the one believed to be the safest for each address).
68 Not recommended. This is known to lock SMBus on various write-only
69 chips (most notably clock chips at address 0x69).
70 .TP
71 .B "\-F"
72 Display the list of functionalities implemented by the adapter and exit.
73 .TP
74 .B "\-V"
75 Display the version and exit.
76 .TP
77 .B "\-l"
78 Output a list of installed busses.
79
80 .SH SEE ALSO
81 i2cdump(8), sensors-detect(8)
82
83 .SH AUTHOR
84 Frodo Looijaard, Mark D. Studebaker and Jean Delvare
85
86 This manual page was originally written by Aurelien Jarno
87 <aurel32@debian.org>, for the Debian GNU/Linux system.
Note: See TracBrowser for help on using the browser.