share/man/man4/ng_bluetooth.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_bluetooth.4,v 1.3 2003/05/21 19:37:35 max Exp $
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd November 9, 2002
  29 .Dt NG_BLUETOOTH 4
  30 .Os
  31 .Sh NAME
  32 .Nm ng_bluetooth
  33 .Nd placeholder for global Bluetooth variables
  34 .Sh SYNOPSIS
  35 .In sys/types.h
  36 .In netgraph/bluetooth/include/ng_bluetooth.h
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 module is a placeholder for global Bluetooth variables.
  41 All Bluetooth variables can be examined and changed via
  42 .Xr sysctl 8 .
  43 .Ss Bluetooth Variables
  44 Below is the description of default variables.
  45 Each Bluetooth module might add its own variables to the tree.
  46 .Bl -tag -width foo
  47 .It Va net.bluetooth.version
  48 A read-only integer variable that shows the current version of the
  49 Bluetooth stack.
  50 .It Va net.bluetooth.hci.command_timeout
  51 A read-write integer variable that controls the Host Controller Interface
  52 (HCI) command timeout (in seconds), i.e., how long the HCI layer will wait
  53 for the
  54 .Dv Command_Complete
  55 or
  56 .Dv Command_Status
  57 event from a Bluetooth device.
  58 .It Va net.bluetooth.hci.connection_timeout
  59 A read-write integer variable that controls the HCI connection timeout, i.e.\&
  60 how long the HCI layer will wait for the
  61 .Dv Connection_Complete
  62 event.
  63 Normally this should not be required as Bluetooth devices have
  64 connection timeout of their own and will send event back.
  65 This timeout
  66 is required to ensure that no connection will stall in case when the HCI
  67 transport layer is broken.
  68 Be careful when changing this variable.
  69 Make sure you understand what you are doing.
  70 .It Va net.bluetooth.hci.max_neighbor_age
  71 A read-write integer variable that controls time-to-live (in seconds) for
  72 entries in the HCI neighbor cache.
  73 Every time a Bluetooth device performs an
  74 .Dv Inquiry
  75 operation, the results will be put in cache.
  76 Later when a Bluetooth device
  77 establishes a baseband connection, it will try to find the matching entry in
  78 the cache and use it.
  79 This might speed up establishment of the baseband
  80 connection.
  81 .It Va net.bluetooth.l2cap.rtx_timeout
  82 A read-write integer variable that controls the Link Layer Control and
  83 Adaptation Protocol (L2CAP) Retransmission Timeout (RTX) (in seconds).
  84 Every time the L2CAP layer submits a control command, the RTX timeout is set.
  85 The value of the RTX timeout should be greater or equal to the value of
  86 the HCI connection timeout.
  87 Be careful when changing this variable.
  88 Make sure you understand what you are doing.
  89 .It Va net.bluetooth.l2cap.ertx_timeout
  90 A read-write integer variable that controls the L2CAP Extended Retransmission
  91 Timeout (ERTX) (in seconds).
  92 In some cases remote peer may respond with
  93 .Dv PENDING
  94 status to the L2CAP control command.
  95 In this case the L2CAP command timeout is reset to the ERTX timeout value.
  96 The value of the ERTX timeout should be
  97 greater or equal to the value of the RTX timeout.
  98 Be careful when changing this variable.
  99 Make sure you understand what you are doing.
 100 .El
 101 .Sh SEE ALSO
 102 .Xr ng_btsocket 4 ,
 103 .Xr ng_hci 4 ,
 104 .Xr ng_l2cap 4 ,
 105 .Xr sysctl 8
 106 .Sh HISTORY
 107 The
 108 .Nm
 109 module was implemented in
 110 .Fx 5.0 .
 111 .Sh AUTHORS
 112 .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com