share/man/man4/onewire.4

   1 .\"     $NetBSD: onewire.4,v 1.2 2006/04/08 23:10:03 wiz Exp $
   2 .\"     $OpenBSD: onewire.4,v 1.2 2006/03/06 10:24:46 grange Exp $
   3 .\"
   4 .\" Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org>
   5 .\"
   6 .\" Permission to use, copy, modify, and distribute this software for any
   7 .\" purpose with or without fee is hereby granted, provided that the above
   8 .\" copyright notice and this permission notice appear in all copies.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17 .\"
  18 .Dd April 4, 2006
  19 .Dt ONEWIRE 4
  20 .Os
  21 .Sh NAME
  22 .Nm onewire
  23 .Nd 1-Wire bus
  24 .Sh SYNOPSIS
  25 .Cd "onewire* at gpioow?"
  26 .Pp
  27 .Cd "option ONEWIREVERBOSE"
  28 .Sh DESCRIPTION
  29 1-Wire bus was originally developed by Dallas Semiconductor for connecting
  30 integrated circuits.
  31 It is commonly used for connecting devices such as electronic keys, EEPROMs,
  32 temperature sensors, real-time clocks, security chips, etc.
  33 .Pp
  34 The
  35 .Nm
  36 driver provides a uniform programming interface layer between
  37 1-Wire master controllers and various 1-Wire slave devices.
  38 Each 1-Wire master controller attaches a
  39 .Nm
  40 framework; several slave devices can then be attached to the
  41 .Nm
  42 bus.
  43 .Pp
  44 The driver supports plugging and unplugging slave devices on the fly.
  45 .Sh SUPPORTED MASTERS
  46 .Bl -tag -width 10n -offset ind -compact
  47 .It Xr gpioow 4
  48 1-Wire bus bit-banging through GPIO pin
  49 .El
  50 .Sh SUPPORTED SLAVES
  51 .Bl -tag -width 10n -offset ind -compact
  52 .\".It Xr owid 4
  53 .\"ID family type device
  54 .It Xr owtemp 4
  55 temperature family type device
  56 .El
  57 .Sh SEE ALSO
  58 .Xr intro 4
  59 .Sh HISTORY
  60 The
  61 .Nm
  62 driver first appeared in
  63 .Ox 4.0
  64 and
  65 .Nx 4.0 .
  66 .Sh AUTHORS
  67 .An -nosplit
  68 The
  69 .Nm
  70 driver was written by
  71 .An Alexander Yurchenko Aq grange@openbsd.org
  72 and ported to
  73 .Nx
  74 by
  75 .An Jeff Rizzo Aq riz@NetBSD.org .