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