diff options
Diffstat (limited to 'share/man/man4/ng_bt3c.4')
-rw-r--r-- | share/man/man4/ng_bt3c.4 | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/share/man/man4/ng_bt3c.4 b/share/man/man4/ng_bt3c.4 new file mode 100644 index 0000000..f651ea9 --- /dev/null +++ b/share/man/man4/ng_bt3c.4 @@ -0,0 +1,136 @@ +.\" ng_bt3c.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: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 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 +.\" 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. +.\" +.\" $Id: ng_bt3c.4,v 1.3 2002/11/12 17:03:58 max Exp $ +.\" $FreeBSD$ +.Dd June 14, 2002 +.Dt NG_BT3C 4 +.Os +.Sh NAME +.Nm BTCCC +.Nd Netgraph node type that is also a 3Com Bluetooth PC card driver +.Sh SYNOPSIS +.In sys/types.h +.In ng_bt3c.h +.Sh DESCRIPTION +The +.Nm BTCCC +node type is both a persistent Netgraph node type and a driver for +3Com Bluetooth PC card (3CRWB6096-HP). 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 card is plugged. +.Pp +In order to use the card one +.Em MUST +download firmware first. Due to copyright issues I will no longer +provide firmware with the driver. The firmware can be obtained +from the Windows driver package that can be downloaded from the 3COM web +site at no charge. The firmware name is BT3CPCC.BIN. To load firmware +info the card use +.Xr bt3cfw 8 . +I'm using original firmware that came with the card on CD-ROM. +.Bd -literal -offset indent +MD5 (BT3CPCC.BIN) = 36170fda56ea9fdbf1702c966f8a97f1 +.Ed +.Pp +For OLDCARD systems the entry in +.Xr pccard.conf 5 +might look like this +.Bd -literal -offset indent +# 3Com 3CRWB60-A Bluetooth PC Card +card "3COM" "3CRWB60-A" "Bluetooth PC Card" + config auto "btccc" ? + insert /usr/sbin/bt3cfw -n $device -f /etc/BT3CPCC.bin +.Ed +.Pp +Do not forget to load module and SIGHUP +.Xr pccardd 8 . +.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. HCI +frames received on +.Dv hook +are transmitted out. No modification to the data is performed in +either direction. +.Sh HOOKS +This node type supports the following hooks: +.Pp +.Bl -tag -width foobar +.It Dv hook +single HCI frame contained in single +.Dv mbuf +structure. +.El +.Sh CONTROL MESSAGES +This node type supports the generic control messages, plus the following: +.Bl -tag -width foo +.It Dv NGM_BT3C_NODE_GET_STATE +Returns current receiving state for the node. +.It Dv NGM_BT3C_NODE_GET_DEBUG +Returns an integer containing the current debug level for the node. +.It Dv NGM_BT3C_NODE_SET_DEBUG +This command takes an integer argument and sets current debug level +for the node. +.It Dv NGM_BT3C_NODE_GET_QLEN +This command takes a parameter that specifies queue number and returns +current length of the queue for the node. +.It Dv NGM_BT3C_NODE_SET_QLEN +This command takes two parameters that specify queue number and and +maximum length of the queue and sets maximum length of the queue for +the node. +.It Dv NGM_BT3C_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 +input (output) errors. +.It Dv NGM_BT3C_NODE_RESET_STAT +Reset all statistic counters to zero. +.It Dv NGM_BT3C_NODE_DOWNLOAD_FIRMWARE +Download card firmware. +.El +.Sh SHUTDOWN +This node shuts down when the corresponding card is un-plugged. +.Sh BUGS +The driver is based on information obrained from Jose Orlando Pereira +<jop@di.uminho.pt> and disassembled W2K driver. +.Sh SEE ALSO +.Xr cardbus 4 , +.Xr pccbb 4 , +.Xr pcic 4 , +.Xr pccardc 8 , +.Xr pccardd 8 , +.Xr pccard.conf 5 , +.Xr netgraph 4 , +.Xr ngctl 8 , +.Xr bt3cfw 8 +.Sh HISTORY +The +.Nm BTCCC +node type was implemented in +.Fx 5.0 . +.Sh AUTHORS +.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com |