diff options
author | julian <julian@FreeBSD.org> | 2003-05-10 21:44:42 +0000 |
---|---|---|
committer | julian <julian@FreeBSD.org> | 2003-05-10 21:44:42 +0000 |
commit | dc5734d94b071df224b65d45b95d9ae7c5d563ab (patch) | |
tree | ed7d8caf163274b56933e0b801c52beb10b3260d /share/man/man4/ng_h4.4 | |
parent | 9e09746efa5431d5af0baf849575917d37cfdb76 (diff) | |
download | FreeBSD-src-dc5734d94b071df224b65d45b95d9ae7c5d563ab.zip FreeBSD-src-dc5734d94b071df224b65d45b95d9ae7c5d563ab.tar.gz |
Part one of undating the bluetooth code to the newest version
Submitted by: Maksim Yevmenkin <m_evmenkin@yahoo.com>
Approved by: re@
Diffstat (limited to 'share/man/man4/ng_h4.4')
-rw-r--r-- | share/man/man4/ng_h4.4 | 55 |
1 files changed, 26 insertions, 29 deletions
diff --git a/share/man/man4/ng_h4.4 b/share/man/man4/ng_h4.4 index 606e272..1ab486f 100644 --- a/share/man/man4/ng_h4.4 +++ b/share/man/man4/ng_h4.4 @@ -1,6 +1,8 @@ +.\" ng_h4.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: @@ -9,7 +11,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 @@ -21,15 +23,15 @@ .\" 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_h4.4,v 1.1 2002/11/24 19:37:54 max Exp $ .\" $FreeBSD$ -.\" .Dd June 14, 2002 .Dt NG_H4 4 .Os .Sh NAME -.Nm ng_h4 -.Nd Netgraph node type that is also an H4 line discipline +.Nm h4 +.Nd Netgraph node type that is also a H4 line discipline .Sh SYNOPSIS .In sys/types.h .In sys/ttycom.h @@ -37,22 +39,20 @@ .In netgraph/ng_h4.h .Sh DESCRIPTION The -.Nm h4 -node type is both a persistent Netgraph node type and a H4 line -discipline. -It implements a Bluetooth HCI UART transport layer as -per chapter H4 of the Bluetooth Specification Book v1.1. -A new node is created when the corresponding line discipline, +.Nm +node type is both a persistent Netgraph node type and a H4 line +discipline. It implements a Bluetooth HCI UART transport layer as +per chapter H4 of the Bluetooth Specification Book v1.1. A new +node is created when the corresponding line discipline, .Dv H4DISC , is registered on a tty device (see .Xr tty 4 ) . .Pp The node has a single hook called .Dv hook . -Incoming bytes received on the tty device are re-assembled into -HCI frames (according to the length). -Full HCI frames are sent out on the hook. -HCI frames received on +Incoming bytes received on the tty device are re-assembled into +HCI frames (according to the length). Full HCI frames are sent out on +the hook. HCI frames received on .Dv hook are transmitted out on the tty device. No modification to the data is performed in either direction. @@ -65,22 +65,22 @@ Information about the node is available via the netgraph command .Dv NGIOCGINFO . This command returns a -.Vt "struct nodeinfo" +.Dv "struct nodeinfo" similar to the .Dv NGM_NODEINFO -.Xr netgraph 4 -control message. +netgraph control message. .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width indent +.Pp +.Bl -tag -width foobar .It Dv hook single HCI frame contained in single -.Vt mbuf +.Dv mbuf structure. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NGM_H4_NODE_RESET Reset the node. .It Dv NGM_H4_NODE_GET_STATE @@ -96,8 +96,8 @@ Returns current length of outgoing queue for the node. This command takes an integer argument and sets maximum length of outgoing queue for the node. .It Dv NGM_H4_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_H4_NODE_RESET_STAT Reset all statistic counters to zero. @@ -106,10 +106,7 @@ Reset all statistic counters to zero. This node shuts down when the corresponding device is closed (or the line discipline is uninstalled on the device). .Sh BUGS -This node still uses -.Xr spltty 9 -to lock tty layer. -This is wrong. +This node still uses spltty() to lock tty layer. This is wrong. .Sh SEE ALSO .Xr ioctl 2 , .Xr netgraph 4 , @@ -117,7 +114,7 @@ This is wrong. .Xr ngctl 8 .Sh HISTORY The -.Nm h4 +.Nm node type was implemented in .Fx 5.0 . .Sh AUTHORS |