xref: /freebsd/share/man/man9/owll.9 (revision ae1f3df43466466a21c7da0df93ecb58a3e53d74)
1*ae1f3df4SWarner Losh.\"
2*ae1f3df4SWarner Losh.\" Copyright (c) 2015 M. Warner Losh
3*ae1f3df4SWarner Losh.\" All rights reserved.
4*ae1f3df4SWarner Losh.\"
5*ae1f3df4SWarner Losh.\" Redistribution and use in source and binary forms, with or without
6*ae1f3df4SWarner Losh.\" modification, are permitted provided that the following conditions
7*ae1f3df4SWarner Losh.\" are met:
8*ae1f3df4SWarner Losh.\" 1. Redistributions of source code must retain the above copyright
9*ae1f3df4SWarner Losh.\"    notice, this list of conditions and the following disclaimer.
10*ae1f3df4SWarner Losh.\" 2. The name of the author may not be used to endorse or promote products
11*ae1f3df4SWarner Losh.\"    derived from this software without specific prior written permission.
12*ae1f3df4SWarner Losh.\"
13*ae1f3df4SWarner Losh.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*ae1f3df4SWarner Losh.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*ae1f3df4SWarner Losh.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*ae1f3df4SWarner Losh.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*ae1f3df4SWarner Losh.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*ae1f3df4SWarner Losh.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*ae1f3df4SWarner Losh.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*ae1f3df4SWarner Losh.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*ae1f3df4SWarner Losh.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*ae1f3df4SWarner Losh.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*ae1f3df4SWarner Losh.\" SUCH DAMAGE.
24*ae1f3df4SWarner Losh.\"
25*ae1f3df4SWarner Losh.\" $FreeBSD$
26*ae1f3df4SWarner Losh.\"
27*ae1f3df4SWarner Losh.Dd July 20, 2015
28*ae1f3df4SWarner Losh.Dt OWLL 9
29*ae1f3df4SWarner Losh.Os
30*ae1f3df4SWarner Losh.Sh NAME
31*ae1f3df4SWarner Losh.Nm owll
32*ae1f3df4SWarner Losh.Nm OWLL_WRITE_ONE,
33*ae1f3df4SWarner Losh.Nm OWLL_WRITE_ZERO,
34*ae1f3df4SWarner Losh.Nm OWLL_READ_DATA,
35*ae1f3df4SWarner Losh.Nm OWLL_REASET_AND_PRESENCE
36*ae1f3df4SWarner Losh.Nd Dallas Semiconductor 1-Wire Link Layer Interface
37*ae1f3df4SWarner Losh.Sh SYNOPSIS
38*ae1f3df4SWarner Losh.Ft int
39*ae1f3df4SWarner Losh.Fn OWLL_WRITE_ONE "device_t lldev" "struct ow_timing *timing"
40*ae1f3df4SWarner Losh.Ft int
41*ae1f3df4SWarner Losh.Fn OWLL_WRITE_ZERO "device_t lldev" "struct ow_timing *timing"
42*ae1f3df4SWarner Losh.Ft int
43*ae1f3df4SWarner Losh.Fn OWLL_READ_DATA "device_t lldev" "struct ow_timing *timing" "int *bit"
44*ae1f3df4SWarner Losh.Ft int
45*ae1f3df4SWarner Losh.Fn OWLL_RESET_AND_PRESENCE "device_t lldev" "struct ow_timing *timing" "int *bit"
46*ae1f3df4SWarner Losh.Sh DESCRIPTION
47*ae1f3df4SWarner LoshThe
48*ae1f3df4SWarner Losh.Nm
49*ae1f3df4SWarner Loshinterface provides access to the link layer of the Dallas
50*ae1f3df4SWarner LoshSemiconductor 1-Wire from upper layers of the protocol.
51*ae1f3df4SWarner Losh.Pp
52*ae1f3df4SWarner Losh.Fn OWLL_WRITE_ONE
53*ae1f3df4SWarner Loshand
54*ae1f3df4SWarner Losh.Fn OWLL_WRITE_ZERO
55*ae1f3df4SWarner Loshwrites a one bitor a zero bit respectively on the 1-Wire bus.
56*ae1f3df4SWarner Losh.Pp
57*ae1f3df4SWarner Losh.Fn OWLL_READ_DATA
58*ae1f3df4SWarner Loshreads one bit from the 1-Wire bus.
59*ae1f3df4SWarner LoshThis is often referred to as a
60*ae1f3df4SWarner Losh.Dq Read Time Slot
61*ae1f3df4SWarner Loshin the 1-Wire device data sheets.
62*ae1f3df4SWarner Losh.Pp
63*ae1f3df4SWarner LoshThe
64*ae1f3df4SWarner Losh.Fn OWLL_RESET_AND_PRESENCE
65*ae1f3df4SWarner Loshfunction starts a reset sequence and detects if any device(s) are
66*ae1f3df4SWarner Loshpresent on the bus.
67*ae1f3df4SWarner LoshThis is the beginning of all 1-Wire transactions.
68*ae1f3df4SWarner Losh.Sh NOTES
69*ae1f3df4SWarner LoshThis interface is intended to be used only by the
70*ae1f3df4SWarner Losh.Xr ow 4
71*ae1f3df4SWarner Loshdevice to talk to the low-level bus.
72*ae1f3df4SWarner LoshBy convention, the device that implements this interface is called
73*ae1f3df4SWarner Losh.Xr owc 4 .
74*ae1f3df4SWarner LoshOnly devices that implement
75*ae1f3df4SWarner Losh.Xr own 9
76*ae1f3df4SWarner Loshshould call these interfaces.
77*ae1f3df4SWarner Losh.Sh SEE ALSO
78*ae1f3df4SWarner Losh.Xr ow 4 ,
79*ae1f3df4SWarner Losh.Xr owc 4 ,
80*ae1f3df4SWarner Losh.Xr own 9
81*ae1f3df4SWarner Losh.Sh LEGAL
82*ae1f3df4SWarner Losh.Tn 1-Wire
83*ae1f3df4SWarner Loshis a registered trademark of Maxim Integrated Products, Inc.
84*ae1f3df4SWarner Losh.Sh HISTORY
85*ae1f3df4SWarner LoshThe
86*ae1f3df4SWarner Losh.Nm
87*ae1f3df4SWarner Loshdriver first appeared in
88*ae1f3df4SWarner Losh.Fx 11.0 .
89*ae1f3df4SWarner Losh.Sh AUTHORS
90*ae1f3df4SWarner LoshThe
91*ae1f3df4SWarner Losh.Nm
92*ae1f3df4SWarner Loshdevice driver and this manual page were written by
93*ae1f3df4SWarner Losh.An Warner Losh .
94