xref: /netbsd-src/usr.sbin/i2cscan/i2cscan.8 (revision c38e7cc395b1472a774ff828e46123de44c628e9)
1.\"	$NetBSD: i2cscan.8,v 1.6 2015/11/26 23:29:05 wiz Exp $
2.\"
3.\" Copyright (c) 2011, 2013 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Thomas Klausner.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd November 26, 2015
31.Dt I2CSCAN 8
32.Os
33.Sh NAME
34.Nm i2cscan
35.Nd scan an IIC bus for devices
36.Sh SYNOPSIS
37.Nm
38.Op Fl r
39.Ar i2cdev
40.Sh DESCRIPTION
41The
42.Nm
43utility scans the Inter-Integrated Circuit bus
44.Pq Xr iic 4
45specified by
46.Ar i2cdev
47to determine which addresses respond.
48.Pp
49.Ar i2cdev
50can be specified with or without the
51.Pa /dev
52prefix.
53For example,
54.Pa /dev/iic0
55or
56.Pa iic0 .
57.Pp
58Available options:
59.Bl -tag -width Ds
60.It Fl r
61scan using 1 byte reads instead of quick writes.
62.El
63.Pp
64.Em WARNING !
65Using this utility can access some devices in such a
66manner as to leave them in an unstable or unusable state.
67It can also lock up the entire
68.Xr iic 4
69bus.
70Don't use this utility unless you know what you're doing and can
71accept all sorts of unforeseen consequences.
72.Sh EXIT STATUS
73.Ex -std i2cscan
74.Sh EXAMPLES
75Scan the first IIC bus found on the system for devices:
76.Pp
77.Dl "i2cscan /dev/iic0"
78.Sh SEE ALSO
79.Xr iic 4
80