xref: /dflybsd-src/share/man/man4/iic.4 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\" Copyright (c) 1998, Nicolas Souchu
286d7f5d3SJohn Marino.\" All rights reserved.
386d7f5d3SJohn Marino.\"
486d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
586d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
686d7f5d3SJohn Marino.\" are met:
786d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
886d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
986d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
1086d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
1186d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
1286d7f5d3SJohn Marino.\"
1386d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1486d7f5d3SJohn Marino.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1586d7f5d3SJohn Marino.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1686d7f5d3SJohn Marino.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1786d7f5d3SJohn Marino.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1886d7f5d3SJohn Marino.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
1986d7f5d3SJohn Marino.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2086d7f5d3SJohn Marino.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2186d7f5d3SJohn Marino.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2286d7f5d3SJohn Marino.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2386d7f5d3SJohn Marino.\" SUCH DAMAGE.
2486d7f5d3SJohn Marino.\"
2586d7f5d3SJohn Marino.\" $FreeBSD: src/share/man/man4/iic.4,v 1.6.2.3 2001/08/17 13:08:38 ru Exp $
2686d7f5d3SJohn Marino.\" $DragonFly: src/share/man/man4/iic.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
2786d7f5d3SJohn Marino.\"
2886d7f5d3SJohn Marino.Dd October 25, 1998
2986d7f5d3SJohn Marino.Dt IIC 4
3086d7f5d3SJohn Marino.Os
3186d7f5d3SJohn Marino.Sh NAME
3286d7f5d3SJohn Marino.Nm iic
3386d7f5d3SJohn Marino.Nd I2C generic i/o device driver
3486d7f5d3SJohn Marino.Sh SYNOPSIS
3586d7f5d3SJohn Marino.Cd "device iic"
3686d7f5d3SJohn Marino.Sh DESCRIPTION
3786d7f5d3SJohn MarinoThe
3886d7f5d3SJohn Marino.Em iic
3986d7f5d3SJohn Marinocharacter device driver provides generic i/o to any
4086d7f5d3SJohn Marino.Xr iicbus 4
4186d7f5d3SJohn Marinoinstance.
4286d7f5d3SJohn MarinoIn order to control I2C devices, use /dev/iic? with the
4386d7f5d3SJohn Marinofollowing ioctls:
4486d7f5d3SJohn Marino.Pp
4586d7f5d3SJohn Marino.Bl -column ".Dv I2CRSTCARD" -compact
4686d7f5d3SJohn Marino.It Em Ioctl Ta Em Description
4786d7f5d3SJohn Marino.It Dv I2CSTART Ta "send start condition to the specified device (with 7-bit address) on the bus"
4886d7f5d3SJohn Marino.It Dv I2CSTOP Ta "send stop condition to the bus"
4986d7f5d3SJohn Marino.It Dv I2CRSTCARD Ta "reset the bus"
5086d7f5d3SJohn Marino.El
5186d7f5d3SJohn Marino.Pp
5286d7f5d3SJohn MarinoYou may also use read/write routines, then I2C start/stop handshake is
5386d7f5d3SJohn Marinomanaged by the iicbus system.
5486d7f5d3SJohn Marino.Sh SEE ALSO
5586d7f5d3SJohn Marino.Xr iicbus 4
5686d7f5d3SJohn Marino.Sh HISTORY
5786d7f5d3SJohn MarinoThe
5886d7f5d3SJohn Marino.Nm
5986d7f5d3SJohn Marinomanual page first appeared in
6086d7f5d3SJohn Marino.Fx 3.0 .
6186d7f5d3SJohn Marino.Sh AUTHORS
6286d7f5d3SJohn MarinoThis
6386d7f5d3SJohn Marinomanual page was written by
6486d7f5d3SJohn Marino.An Nicolas Souchu .
65