share/man/man4/iic.4

   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: src/share/man/man4/iic.4,v 1.6.2.3 2001/08/17 13:08:38 ru Exp $
  26 .\" $DragonFly: src/share/man/man4/iic.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
  27 .\"
  28 .Dd October 25, 1998
  29 .Dt IIC 4
  30 .Os
  31 .Sh NAME
  32 .Nm iic
  33 .Nd I2C generic i/o device driver
  34 .Sh SYNOPSIS
  35 .Cd "device iic"
  36 .Sh DESCRIPTION
  37 The
  38 .Em iic
  39 character device driver provides generic i/o to any
  40 .Xr iicbus 4
  41 instance.
  42 In order to control I2C devices, use /dev/iic? with the
  43 following ioctls:
  44 .Pp
  45 .Bl -column ".Dv I2CRSTCARD" -compact
  46 .It Em Ioctl Ta Em Description
  47 .It Dv I2CSTART Ta "send start condition to the specified device (with 7-bit address) on the bus"
  48 .It Dv I2CSTOP Ta "send stop condition to the bus"
  49 .It Dv I2CRSTCARD Ta "reset the bus"
  50 .El
  51 .Pp
  52 You may also use read/write routines, then I2C start/stop handshake is
  53 managed by the iicbus system.
  54 .Sh SEE ALSO
  55 .Xr iicbus 4
  56 .Sh HISTORY
  57 The
  58 .Nm
  59 manual page first appeared in
  60 .Fx 3.0 .
  61 .Sh AUTHORS
  62 This
  63 manual page was written by
  64 .An Nicolas Souchu .