usr.sbin/btattach/btattach.8

   1 .\" $NetBSD: btattach.8,v 1.2 2009/03/15 10:04:27 joerg Exp $
   2 .\"
   3 .\" Copyright (c) 2007 KIYOHARA Takashi
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  19 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  23 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  24 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25 .\" POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .Dd December 6, 2009
  28 .Dt BTATTACH 8
  29 .Os
  30 .Sh NAME
  31 .Nm btattach
  32 .Nd attach serial lines as Bluetooth HCI interfaces
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl dfop
  36 .Op Fl i Ar speed
  37 .Op Ar type
  38 .Ar tty
  39 .Ar speed
  40 .Sh DESCRIPTION
  41 .Nm
  42 is used to assign a
  43 .Ar tty
  44 line to a Bluetooth Host Controller Interface using the
  45 .Xr btuart 4
  46 or
  47 .Xr bcsp 4
  48 line disciplines, and can optionally initialize the line for a
  49 given device
  50 .Ar type
  51 before activating the line discipline.
  52 .Pp
  53 Supported types are:
  54 .Bl -tag -compact -width ericssonxx -offset indent
  55 .It Cm bcm2035
  56 Broadcom BCM2035
  57 .It Cm bcsp
  58 Generic BCSP (BlueCore Serial Protocol)
  59 .It Cm bgb2xx
  60 Philips BGB2xx module
  61 .It Cm btuart
  62 Generic UART (this is the default)
  63 .It Cm csr
  64 Cambridge Silicon Radio Casira serial adaptor, or
  65 Brainboxes serial dongle (BL642)
  66 .It Cm ericsson
  67 Ericsson based modules
  68 .It Cm digi
  69 Digianswer based cards
  70 .It Cm st
  71 ST Microelectronics minikits based on STLC2410/STLC2415
  72 .It Cm stlc2500
  73 ST Microelectronics minikits based on STLC2500
  74 .It Cm swave
  75 Silicon Wave kits
  76 .It Cm texas
  77 Texas Instruments modules
  78 .It Cm unistone
  79 Infineon UniStone (PBA31308) modules
  80 .El
  81 .Pp
  82 When the line discipline is activated,
  83 .Nm
  84 detaches and sleeps until it receives a
  85 .Dv SIGHUP .
  86 .Pp
  87 The command line options are as follows:
  88 .Bl -tag -width ".Fl i Ar speed"
  89 .It Fl d
  90 debug mode.
  91 print initialization IO and do not detach.
  92 .It Fl f
  93 Enable flow control.
  94 .It Fl i Ar speed
  95 Specify an alternate
  96 .Ar speed
  97 for the Bluetooth module to use during the initialization phase.
  98 .It Fl o
  99 Enable odd parity.
 100 .It Fl p
 101 Enable parity (even parity).
 102 .El
 103 .Pp
 104 Only the super-user may attach a Bluetooth HCI interface.
 105 .Sh FILES
 106 .Bl -tag -compact
 107 .It Pa /var/run/btattach- Ns Bro tty Brc Ns .pid
 108 .El
 109 .Sh SEE ALSO
 110 .Xr bcsp 4 ,
 111 .Xr bluetooth 4 ,
 112 .Xr btuart 4 ,
 113 .Xr btconfig 8
 114 .Sh BUGS
 115 Not all
 116 .Ar type
 117 initializations have been tested.
 118 .Sh HISTORY
 119 The
 120 .Nm
 121 program was written with reference to
 122 .Xr hciattach 8
 123 as provided with the BlueZ tools for Linux and first appeared in
 124 .Nx 5.0 .
 125 .Sh AUTHORS
 126 .An KIYOHARA Takashi Aq kiyohara@kk.iij4u.or.jp
 127 .An Iain Hibbert