NetBSD/usr.sbin/i2cscan/i2cscan.8

67 lines
2.2 KiB
Groff

.\" $NetBSD: i2cscan.8,v 1.3 2013/07/10 15:18:54 tcort Exp $
.\"
.\" Copyright (c) 2011, 2013 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Thomas Klausner.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd July 10, 2013
.Dt I2CSCAN 8
.Os
.Sh NAME
.Nm i2cscan
.Nd scan an IIC bus for devices
.Sh SYNOPSIS
.Nm
.Op Fl r
.Ar i2cdev
.Sh DESCRIPTION
The
.Nm
utility scans the IIC bus
.Pq Xr iic 4
specified by
.Ar i2cdev
to determine which addresses respond.
.Pp
Available options:
.Bl -tag -width Ds
.It Fl r
scan using 1 byte reads instead of quick writes.
.El
.Pp
.Em WARNING !
Using this utility can access some devices in such a
manner as to leave them in an unstable or unusable state.
It can also lock up the entire
.Xr iic 4
bus.
Don't use this utility unless you know what you're doing and can
accept all sorts of unforeseen consequences.
.Sh EXIT STATUS
.Ex -std i2cscan
.Sh SEE ALSO
.Xr iic 4