summaryrefslogtreecommitdiff
path: root/commandline/man/vusb-i2cdetect.1
blob: e43b2681e66d667906ee9001ca8df99772dd6451 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
.Dd Jule 28, 2013
.Dt VUSB-I2CDETECT 1
.Os
.
.
.Sh NAME
.
.Nm vusb-i2cdetect
.Nd detect I2C devices
.
.
.Sh SYNOPSIS
.
.Nm
.
.
.Sh VERSION
.
This manual documents
.Nm
UNRELEASED
.
.
.Sh DESCRIPTION
.
.Nm
scans a vusb-i2c bus for connected devices and prints a result table to its
standard output. A
.Qq --
entry means no device responded, while a hexadecimal address means there is
a device acknowledging that address.
.
.Pp
.
In detail, for each I2C address between 0x00 and 0x7f (even the special ones),
the following is done:

.Bl -bullet
.
.It
the bus is reset (START condition)
.
.It
an address (with the read byte set) is transmitted
.
.It
the transmission is terminated without reading any data (STOP condition)
.
.El

If SDA is pulled low in the ACK cycle of the address transmission, it is
considered to be a device listening for that address. If
.Nm
reports devices on all checked addresses, this may indicate a stuck SDA line,
either caused by a hardware bug or a malfunctioning I2C device.
.
.Sh AUTHOR
.
Copyright (C) 2013 by Daniel Friesel
.Aq derf@finalrewind.org
.
.Sh LICENSE
.
to be determined (BSD-ish)