Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/owc.4
- This file was added.
.\" | |||||
.\" Copyright (c) 2015 M. Warner Losh | |||||
.\" All rights reserved. | |||||
.\" | |||||
.\" Redistribution and use in source and binary forms, with or without | |||||
.\" modification, are permitted provided that the following conditions | |||||
.\" are met: | |||||
.\" 1. Redistributions of source code must retain the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer. | |||||
.\" 2. The name of the author may not be used to endorse or promote products | |||||
.\" derived from this software without specific prior written permission. | |||||
.\" | |||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |||||
.\" SUCH DAMAGE. | |||||
.\" | |||||
.\" $FreeBSD$ | |||||
.\" | |||||
.Dd July 20, 2015 | |||||
.Dt OWC 4 | |||||
.Os | |||||
.Sh NAME | |||||
.Nm owc | |||||
.Nd Dallas Semiconductor 1-Wire Controller | |||||
.Sh SYNOPSIS | |||||
.Cd device owc | |||||
.Sh DESCRIPTION | |||||
The | |||||
.Nm | |||||
wblock: Remove "the":
module implements Dallas Semiconductor 1-wire signaling. | |||||
module implements Dallas Semiconductor 1-Wire signaling. | |||||
It attaches the | |||||
.Xr ow 4 | |||||
driver 1-Wire bus protocol. | |||||
The | |||||
Done Inline ActionsNot sure what this sentence is about. Maybe: Also: wblock: Not sure what this sentence is about. Maybe:
"This driver is only a controller..."
Also… | |||||
.Nm | |||||
Done Inline Actionss/gpio/GPIO/ Unless this is a reference to gpio(4), which would be .Xr gpio 4 wblock: s/gpio/GPIO/
Unless this is a reference to gpio(4), which would be
.Xr gpio 4 | |||||
device implements the Link Layer of the 1-Wire bus protocol stack. | |||||
Done Inline Actions"the" is not needed. wblock: "the" is not needed. | |||||
.Pp | |||||
Done Inline ActionsBut "the" is needed here: wblock: But "the" is needed here:
s/strong/the strong/ | |||||
Not Done Inline ActionsPhabricator might be helping, but this shows "The only a controller" now. Should be "The only controller"? wblock: Phabricator might be helping, but this shows "The only a controller" now. Should be "The only… | |||||
Not Done Inline ActionsTypo: wblock: Typo:
s/Big/Bit/ | |||||
Bit banging a pin on a | |||||
Not Done Inline ActionsSuggestion: use "with" rather than "via" ("via" implies travel: "I got there via Highway 8" or a transfer medium: "Electricity travels via a conductor.") pins on a GPIO bus with wblock: Suggestion: use "with" rather than "via" ("via" implies travel: "I got there via Highway 8" or… | |||||
.Xr gpiobus 4 | |||||
is the only supported controller. | |||||
Both standard and overdrive transfer timings are implemented. | |||||
Strong pull-up functionality needed to support parasitic mode is not | |||||
implemented. | |||||
.Sh SEE ALSO | |||||
.Xr gpiobus 4 , | |||||
.Xr ow 4 , | |||||
.Xr ow_temp 4 , | |||||
.Xr owll 9 , | |||||
.Xr own 9 | |||||
.Sh LEGAL | |||||
.Tn 1-Wire | |||||
is a registered trademark of Maxim Integrated Products, Inc. | |||||
.Sh HISTORY | |||||
The | |||||
.Nm | |||||
Done Inline Actionss/gpio/GPIO/ (or .Xr gpio 4 as above) wblock: s/gpio/GPIO/ (or .Xr gpio 4 as above)
s/may/can/ ("may" implies permission) | |||||
driver first appeared in | |||||
.Fx 11.0 . | |||||
.Sh AUTHORS | |||||
The | |||||
.Nm | |||||
Not Done Inline ActionsShould be either "GPIO" or .Xr gpio 4 wblock: Should be either "GPIO" or .Xr gpio 4 | |||||
device driver and this manual page were written by | |||||
.An Warner Losh . | |||||
.Sh CAVEATS | |||||
The gpio driver implements timing by busy waiting, which can cause a | |||||
high load on slower systems. | |||||
.Sh BUGS | |||||
Overdrive mode has not actually been tested. |
Remove "the":
module implements Dallas Semiconductor 1-wire signaling.