share/man/man4/ng_bt3c.4

   1 .\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin@yahoo.com>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $Id: ng_bt3c.4,v 1.3 2003/09/14 23:28:51 max Exp $
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd December 17, 2004
  29 .Dt NG_BT3C 4
  30 .Os
  31 .Sh NAME
  32 .Nm ng_bt3c
  33 .Nd Netgraph node type that is also a 3Com Bluetooth PC card driver
  34 .Sh SYNOPSIS
  35 .In sys/types.h
  36 .In netgraph/bluetooth/include/ng_bt3c.h
  37 .Sh DESCRIPTION
  38 The
  39 .Nm btccc
  40 node type is both a persistent Netgraph node type and a driver for the
  41 3Com Bluetooth PC card (3CRWB6096-HP).
  42 It implements a Bluetooth HCI
  43 UART transport layer as per chapter H4 of the Bluetooth Specification
  44 Book v1.1.
  45 A new node is created when the card is plugged.
  46 .Pp
  47 In order to use the card one
  48 .Em MUST
  49 download the firmware first.
  50 Due to copyright issues the firmware cannot be provided with this driver.
  51 The firmware can be obtained
  52 from the Windows driver package that can be downloaded from the 3Com web
  53 site at no charge.
  54 The firmware name is
  55 .Pa BT3CPCC.BIN .
  56 To load the firmware into the card, use
  57 .Xr bt3cfw 8 .
  58 I am using the original firmware that came with the card on CD-ROM.
  59 .Pp
  60 .Dl "MD5 (BT3CPCC.BIN) = 36170fda56ea9fdbf1702c966f8a97f1"
  61 .Pp
  62 The node has a single hook called
  63 .Dv hook .
  64 Incoming bytes received on the device are re-assembled into HCI frames
  65 (according to the length).
  66 Full HCI frames are sent out on the hook.
  67 HCI frames received on
  68 .Dv hook
  69 are transmitted out.
  70 No modification to the data is performed in either direction.
  71 .Sh HARDWARE
  72 The
  73 .Nm
  74 driver provides support for the 3Com/HP 3CRWB6096-A PCCARD bluetooth adapter.
  75 .Sh HOOKS
  76 This node type supports the following hooks:
  77 .Bl -tag -width indent
  78 .It Dv hook
  79 single HCI frame contained in single
  80 .Vt mbuf
  81 structure.
  82 .El
  83 .Sh CONTROL MESSAGES
  84 This node type supports the generic control messages, plus the following:
  85 .Bl -tag -width indent
  86 .It Dv NGM_BT3C_NODE_GET_STATE
  87 Returns the current receiving state for the node.
  88 .It Dv NGM_BT3C_NODE_GET_DEBUG
  89 Returns an integer containing the current debug level for the node.
  90 .It Dv NGM_BT3C_NODE_SET_DEBUG
  91 This command takes an integer argument and sets the current debug level
  92 for the node.
  93 .It Dv NGM_BT3C_NODE_GET_QLEN
  94 This command takes a parameter that specifies queue number and returns
  95 the current length of the queue for the node.
  96 .It Dv NGM_BT3C_NODE_SET_QLEN
  97 This command takes two parameters that specify the queue number and
  98 the maximum length of the queue and sets the maximum length of the queue for
  99 the node.
 100 .It Dv NGM_BT3C_NODE_GET_STAT
 101 Returns various statistic information for the node, such as: number of
 102 bytes (frames) sent, number of bytes (frames) received and number of
 103 input (output) errors.
 104 .It Dv NGM_BT3C_NODE_RESET_STAT
 105 Reset all statistic counters to zero.
 106 .It Dv NGM_BT3C_NODE_DOWNLOAD_FIRMWARE
 107 Download card firmware.
 108 .El
 109 .Sh SHUTDOWN
 110 This node shuts down when the corresponding card is un-plugged.
 111 .Sh SEE ALSO
 112 .Xr cardbus 4 ,
 113 .Xr netgraph 4 ,
 114 .Xr pccbb 4 ,
 115 .Xr pcic 4 ,
 116 .Xr pccard.conf 5 ,
 117 .Xr bt3cfw 8 ,
 118 .Xr ngctl 8
 119 .Sh HISTORY
 120 The
 121 .Nm btccc
 122 node type was implemented in
 123 .Fx 5.0 .
 124 .Sh AUTHORS
 125 .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
 126 .Sh BUGS
 127 The driver is based on information obtained from
 128 .An Jose Orlando Pereira Aq jop@di.uminho.pt
 129 and disassembled the W2K driver.