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