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 DEPRECATION NOTICE
  38 This driver is scheduled for removal prior to the release of
  39 .Fx 13.0
  40 .Sh DESCRIPTION
  41 The
  42 .Nm btccc
  43 node type is both a persistent Netgraph node type and a driver for the
  44 3Com Bluetooth PC card (3CRWB6096-HP).
  45 It implements a Bluetooth HCI
  46 UART transport layer as per chapter H4 of the Bluetooth Specification
  47 Book v1.1.
  48 A new node is created when the card is plugged.
  49 .Pp
  50 In order to use the card one
  51 .Em MUST
  52 download the firmware first.
  53 Due to copyright issues the firmware cannot be provided with this driver.
  54 The firmware can be obtained
  55 from the Windows driver package that can be downloaded from the 3Com web
  56 site at no charge.
  57 The firmware name is
  58 .Pa BT3CPCC.BIN .
  59 To load the firmware into the card, use
  60 .Xr bt3cfw 8 .
  61 I am using the original firmware that came with the card on CD-ROM.
  62 .Pp
  63 .Dl "MD5 (BT3CPCC.BIN) = 36170fda56ea9fdbf1702c966f8a97f1"
  64 .Pp
  65 The node has a single hook called
  66 .Dv hook .
  67 Incoming bytes received on the device are re-assembled into HCI frames
  68 (according to the length).
  69 Full HCI frames are sent out on the hook.
  70 HCI frames received on
  71 .Dv hook
  72 are transmitted out.
  73 No modification to the data is performed in either direction.
  74 .Sh HARDWARE
  75 The
  76 .Nm
  77 driver provides support for the 3Com/HP 3CRWB6096-A PCCARD bluetooth adapter.
  78 .Sh HOOKS
  79 This node type supports the following hooks:
  80 .Bl -tag -width ".Va hook"
  81 .It Va hook
  82 single HCI frame contained in single
  83 .Vt mbuf
  84 structure.
  85 .El
  86 .Sh CONTROL MESSAGES
  87 This node type supports the generic control messages, plus the following:
  88 .Bl -tag -width foo
  89 .It Dv NGM_BT3C_NODE_GET_STATE Pq Ic get_state
  90 Returns the current receiving state for the node.
  91 .It Dv NGM_BT3C_NODE_SET_DEBUG Pq Ic set_debug
  92 This command takes an integer argument and sets the current debug level
  93 for the node.
  94 .It Dv NGM_BT3C_NODE_GET_DEBUG Pq Ic get_debug
  95 Returns an integer containing the current debug level for the node.
  96 .It Dv NGM_BT3C_NODE_GET_QLEN Pq Ic get_qlen
  97 This command takes a parameter that specifies queue number and returns
  98 the current length of the queue for the node.
  99 .It Dv NGM_BT3C_NODE_SET_QLEN Pq Ic set_qlen
 100 This command takes two parameters that specify the queue number and
 101 the maximum length of the queue and sets the maximum length of the queue for
 102 the node.
 103 .It Dv NGM_BT3C_NODE_GET_STAT Pq Ic get_stat
 104 Returns various statistic information for the node, such as: number of
 105 bytes (frames) sent, number of bytes (frames) received and number of
 106 input (output) errors.
 107 .It Dv NGM_BT3C_NODE_RESET_STAT Pq Ic reset_stat
 108 Reset all statistic counters to zero.
 109 .It Dv NGM_BT3C_NODE_DOWNLOAD_FIRMWARE
 110 Download card firmware.
 111 .El
 112 .Sh SHUTDOWN
 113 This node shuts down when the corresponding card is un-plugged.
 114 .Sh SEE ALSO
 115 .Xr cardbus 4 ,
 116 .Xr netgraph 4 ,
 117 .Xr pccbb 4 ,
 118 .Xr pcic 4 ,
 119 .Xr pccard.conf 5 ,
 120 .Xr bt3cfw 8 ,
 121 .Xr ngctl 8
 122 .Sh HISTORY
 123 The
 124 .Nm btccc
 125 node type was implemented in
 126 .Fx 5.0 .
 127 .Sh AUTHORS
 128 .An Maksim Yevmenkin Aq Mt m_evmenkin@yahoo.com
 129 .Sh BUGS
 130 The driver is based on information obtained from
 131 .An Jose Orlando Pereira Aq Mt jop@di.uminho.pt
 132 and disassembled the W2K driver.