xref: /netbsd-src/share/man/man4/onewire.4 (revision b0b5c5e7a727554345f0d858291c16bce2b97535)
1.\"	$NetBSD: onewire.4,v 1.6 2025/01/23 19:26:29 brad 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
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 14n -offset ind -compact
47.It Xr ds2482ow 4
48I2C to 1-Wire bridge
49.It Xr gpioow 4
501-Wire bus bit-banging through GPIO pin
51.El
52.Sh SUPPORTED SLAVES
53.Bl -tag -width 14n -offset ind -compact
54.It Xr ds28e17iic 4
551-Wire to IIC bridge
56.It Xr owtemp 4
57temperature family type device
58.El
59.Sh SEE ALSO
60.Xr intro 4
61.Sh HISTORY
62The
63.Nm
64driver first appeared in
65.Ox 4.0
66and
67.Nx 4.0 .
68.Sh AUTHORS
69.An -nosplit
70The
71.Nm
72driver was written by
73.An Alexander Yurchenko Aq Mt grange@openbsd.org
74and ported to
75.Nx
76by
77.An Jeff Rizzo Aq Mt riz@NetBSD.org .
78