Initialize Tizen 2.3
[framework/connectivity/bluez.git] / mobile / tools / hciattach.8
1 .TH HCIATTACH 8 "Jan 22 2002" BlueZ "Linux System Administration"
2 .SH NAME
3 hciattach \- attach serial devices via UART HCI to BlueZ stack
4 .SH SYNOPSIS
5 .B hciattach
6 .RB [\| \-b \|]
7 .RB [\| \-n \|]
8 .RB [\| \-p \|]
9 .RB [\| \-t
10 .IR timeout \|]
11 .RB [\| \-s
12 .IR speed \|]
13 .RB [\| \-l \|]
14 .RB [\| \-r \|]
15 .I tty
16 .IR type \||\| id
17 .I speed
18 .I flow
19 .I bdaddr
20 .SH DESCRIPTION
21 .LP
22 Hciattach is used to attach a serial UART to the Bluetooth stack as HCI
23 transport interface.
24 .SH OPTIONS
25 .TP
26 .B \-b
27 Send break.
28 .TP
29 .B \-n
30 Don't detach from controlling terminal.
31 .TP
32 .B \-p
33 Print the PID when detaching.
34 .TP
35 .BI \-t " timeout"
36 Specify an initialization timeout.  (Default is 5 seconds.)
37 .TP
38 .BI \-s " speed"
39 Specify an initial speed instead of the hardware default.
40 .TP
41 .B \-l
42 List all available configurations.
43 .TP
44 .B \-r
45 Set the HCI device into raw mode (the kernel and bluetoothd will ignore it).
46 .TP
47 .I tty
48 This specifies the serial device to attach. A leading
49 .B /dev
50 can be omitted. Examples:
51 .B /dev/ttyS1
52 .B ttyS2
53 .TP
54 .IR type \||\| id
55 The
56 .I type
57 or
58 .I id
59 of the Bluetooth device that is to be attached, i.e. vendor or other device
60 specific identifier. Currently supported types are
61 .RS
62 .TP
63 .B type
64 .B description
65 .TP
66 .B any
67 Unspecified HCI_UART interface, no vendor specific options
68 .TP
69 .B ericsson
70 Ericsson based modules
71 .TP
72 .B digi
73 Digianswer based cards
74 .TP
75 .B xircom
76 Xircom PCMCIA cards: Credit Card Adapter and Real Port Adapter
77 .TP
78 .B csr
79 CSR Casira serial adapter or BrainBoxes serial dongle (BL642)
80 .TP
81 .B bboxes
82 BrainBoxes PCMCIA card (BL620)
83 .TP
84 .B swave
85 Silicon Wave kits
86 .TP
87 .B bcsp
88 Serial adapters using CSR chips with BCSP serial protocol
89 .TP
90 .B ath3k
91 Atheros AR300x based serial Bluetooth device
92 .TP
93 .B intel
94 Intel Bluetooth device
95 .RE
96
97 Supported IDs are (manufacturer id, product id)
98 .RS
99 .TP
100 .B 0x0105, 0x080a
101 Xircom PCMCIA cards: Credit Card Adapter and Real Port Adapter
102 .TP
103 .B 0x0160, 0x0002
104 BrainBoxes PCMCIA card (BL620)
105 .RE
106
107 .TP
108 .I speed
109 The
110 .I speed
111 specifies the UART speed to use. Baudrates higher than 115.200bps require
112 vendor specific initializations that are not implemented for all types of
113 devices. In general the following speeds are supported:
114
115 .B 9600, 19200, 38400, 57600, 115200, 230400, 460800, 921600
116
117 Supported vendor devices are automatically initialised to their respective
118 best settings.
119 .TP
120 .I flow
121 If the keyword
122 .I flow
123 is appended to the list of options then hardware flow control is forced on
124 the serial link (
125 .B CRTSCTS
126 ). All above mentioned device types have
127 .B flow
128 set by default. To force no flow control use
129 .B noflow
130 instead.
131 .TP
132 .I sleep
133 Enables hardware specific power management feature. If
134 .I sleep
135 is appended to the list of options then this feature is enabled. To disable
136 this feature use
137 .B nosleep
138 instead.
139 All above mentioned device types have
140 .B nosleep
141 set by default.
142
143 Note: This option will only be valid for hardware which support
144 hardware specific power management enable option from host.
145 .TP
146 .I bdaddr
147 The
148 .I bdaddr
149 specifies the Bluetooth Address to use.  Some devices (like the STLC2500)
150 do not store the Bluetooth address in hardware memory.  Instead it must
151 be uploaded during the initialization process.  If this argument
152 is specified, then the address will be used to initialize the device.
153 Otherwise, a default address will be used.
154
155 .SH AUTHORS
156 Written by Maxim Krasnyansky <maxk@qualcomm.com>
157 .PP
158 Manual page by Nils Faerber <nils@kernelconcepts.de>