xref: /openbsd/share/man/man4/onewire.4 (revision cecf84d4)
1.\"	$OpenBSD: onewire.4,v 1.10 2013/07/16 16:05:49 schwarze 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: July 16 2013 $
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.Cd "onewire* at ioc?      " Pq sgi
27.Cd "onewire* at xheart?   " Pq sgi
28.Pp
29.Cd "option ONEWIREVERBOSE"
30.Sh DESCRIPTION
311-Wire bus was originally developed by Dallas Semiconductor for connecting
32integrated circuits.
33It is commonly used for connecting devices such as electronic keys, EEPROMs,
34temperature sensors, real-time clocks, security chips, etc.
35.Pp
36The
37.Nm
38driver provides a uniform programming interface layer between
391-Wire master controllers and various 1-Wire slave devices.
40Each 1-Wire master controller attaches a
41.Nm
42framework; several slave devices can then be attached to the
43.Nm
44bus.
45.Pp
46The driver supports plugging and unplugging slave devices on the fly.
47.Sh SUPPORTED MASTERS
48.Bl -tag -width 11n -offset ind -compact
49.It Xr gpioow 4
501-Wire bus bit-banging through GPIO pin
51.It Xr ioc 4
52IOC3 generic workstation I/O device
53.It Xr uow 4
54Maxim/Dallas DS2490 USB 1-Wire adapter
55.It Xr xheart 4
56Octane core system widget
57.El
58.Sh SUPPORTED SLAVES
59.Bl -tag -width 11n -offset ind -compact
60.It Xr owctr 4
611-Wire counter device
62.It Xr owid 4
631-Wire ID device
64.It Xr owmac 4
651-Wire Ethernet address
66.It Xr owsbm 4
671-Wire smart battery monitor device
68.It Xr owserial 4
691-Wire serial number
70.It Xr owtemp 4
711-Wire temperature device
72.El
73.Sh SEE ALSO
74.Xr intro 4
75.Sh HISTORY
76The
77.Nm
78driver first appeared in
79.Ox 4.0 .
80.Sh AUTHORS
81.An -nosplit
82The
83.Nm
84driver was written by
85.An Alexander Yurchenko Aq Mt grange@openbsd.org .
86