summaryrefslogtreecommitdiffstats
path: root/share/man/man4/ng_ubt.4
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2002-12-13 10:38:42 +0000
committerru <ru@FreeBSD.org>2002-12-13 10:38:42 +0000
commitc5a591f1addd844e34f85e260a14445753c82b9b (patch)
treecb6338b3b8398db49027108065a718bc0137bb17 /share/man/man4/ng_ubt.4
parent81e4753c41446e473eb1cf548cafc6114cfaf8fb (diff)
downloadFreeBSD-src-c5a591f1addd844e34f85e260a14445753c82b9b.zip
FreeBSD-src-c5a591f1addd844e34f85e260a14445753c82b9b.tar.gz
mdoc(7) police: markup overhaul.
Diffstat (limited to 'share/man/man4/ng_ubt.4')
-rw-r--r--share/man/man4/ng_ubt.458
1 files changed, 29 insertions, 29 deletions
diff --git a/share/man/man4/ng_ubt.4 b/share/man/man4/ng_ubt.4
index 648d27b..e2eee3a 100644
--- a/share/man/man4/ng_ubt.4
+++ b/share/man/man4/ng_ubt.4
@@ -1,8 +1,6 @@
-.\" ng_ubt.4
-.\"
.\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin@yahoo.com>
.\" All rights reserved.
-.\"
+.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
@@ -11,7 +9,7 @@
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
-.\"
+.\"
.\" 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
@@ -23,47 +21,49 @@
.\" 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.
-.\"
-.\" $Id: ng_ubt.4,v 1.2 2002/11/12 17:20:16 max Exp $
+.\"
.\" $FreeBSD$
+.\"
.Dd June 14, 2002
.Dt NG_UBT 4
.Os
.Sh NAME
-.Nm ubt
+.Nm ng_ubt
.Nd Netgraph node type that is also a driver for Bluetooth USB devices
.Sh SYNOPSIS
.In sys/types.h
.In ng_ubt.h
.Sh DESCRIPTION
The
-.Nm
+.Nm ubt
node type is both a persistent Netgraph node type and a driver for
-Bluetooth USB devices. It implements a Bluetooth USB transport layer
-as per chapter H2 of the Bluetooth Specification Book v1.1. A new
-node is created when supported USB device is plugged.
+Bluetooth USB devices.
+It implements a Bluetooth USB transport layer
+as per chapter H2 of the Bluetooth Specification Book v1.1.
+A new node is created when supported USB device is plugged.
.Pp
The node has a single hook called
.Dv hook .
Incoming bytes received on the device are re-assembled into HCI frames
-(according to the length). Full HCI frames are sent out on the hook. The node
-will add HCI frame indicator if device did not send it. HCI frames received
-on
+(according to the length).
+Full HCI frames are sent out on the hook.
+The node will add HCI frame indicator if device did not send it.
+HCI frames received on
.Dv hook
-are transmitted out. The node will drop HCI frame indicator unless device
-requires it to be present.
+are transmitted out.
+The node will drop HCI frame indicator unless device
+requires it to be present.
.Sh HOOKS
This node type supports the following hooks:
-.Pp
-.Bl -tag -width foobar
+.Bl -tag -width indent
.It Dv hook
single HCI frame contained in single
-.Dv mbuf
+.Vt mbuf
structure.
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width foo
+.Bl -tag -width indent
.It Dv NGM_UBT_NODE_GET_DEBUG
Returns an integer containing the current debug level for the node.
.It Dv NGM_UBT_NODE_SET_DEBUG
@@ -73,11 +73,11 @@ for the node.
This command takes a parameter that specifies queue number and returns
current maximal length of the queue for the node.
.It Dv NGM_UBT_NODE_SET_QLEN
-This command takes two parameters that specify queue number and maximum
+This command takes two parameters that specify queue number and maximum
length of the queue and sets maximal length of the queue for the node.
.It Dv NGM_UBT_NODE_GET_STAT
-Returns various statistic information for the node, such as: number of
-bytes (frames) sent, number of bytes (frames) received and number of
+Returns various statistic information for the node, such as: number of
+bytes (frames) sent, number of bytes (frames) received and number of
input (output) errors.
.It Dv NGM_UBT_NODE_RESET_STAT
Reset all statistic counters to zero.
@@ -85,17 +85,17 @@ Reset all statistic counters to zero.
.Sh SHUTDOWN
This node shuts down when the corresponding USB device is un-plugged.
.Sh BUGS
-Isochronous USB transfers are probably broken. It means that USB device
-probably will not be able to transfer SCO data (voice). Driver does not
-support firmware upgrade procedure. USB interrupt transfers are
-implemented as bulk-in transfers (not really a bug).
+Isochronous USB transfers are probably broken.
+It means that USB device probably will not be able to transfer SCO data (voice).
+Driver does not support firmware upgrade procedure.
+USB interrupt transfers are implemented as bulk-in transfers (not really a bug).
.Sh SEE ALSO
-.Xr usb 4 ,
.Xr netgraph 4 ,
+.Xr usb 4 ,
.Xr ngctl 8
.Sh HISTORY
The
-.Nm
+.Nm ubt
node type was implemented in
.Fx 5.0 .
.Sh AUTHORS
OpenPOWER on IntegriCloud