xref: /freebsd/share/man/man4/iic.4 (revision e4e9813eb92cd7c4d4b819a8fbed5cbd3d92f5d8)
1.\" Copyright (c) 1998, Nicolas Souchu
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd October 25, 1998
28.Dt IIC 4
29.Os
30.Sh NAME
31.Nm iic
32.Nd I2C generic i/o device driver
33.Sh SYNOPSIS
34.Cd "device iic"
35.Sh DESCRIPTION
36The
37.Em iic
38character device driver provides generic i/o to any
39.Xr iicbus 4
40instance.
41In order to control I2C devices, use
42.Pa /dev/iic?
43with the
44following ioctls:
45.Pp
46.Bl -column "I2CRSTCARD" -compact
47.It Em Ioctl Ta Em Description
48.It Sy I2CSTART Ta "send start condition to the specified device (with 7-bit address) on the bus"
49.It Sy I2CSTOP Ta "send stop condition to the bus"
50.It Sy I2CRSTCARD Ta "reset the bus"
51.El
52.Pp
53You may also use read/write routines, then I2C start/stop handshake is
54managed by the iicbus system.
55.Sh SEE ALSO
56.Xr iicbus 4
57.Sh HISTORY
58The
59.Nm
60manual page first appeared in
61.Fx 3.0 .
62.Sh AUTHORS
63This
64manual page was written by
65.An Nicolas Souchu .
66