bluez/tools/hciattach.1

.TH HCIATTACH 1 "Jan 22 2002" BlueZ "Linux System Administration"
.SH NAME
hciattach \- attach serial devices via UART HCI to BlueZ stack
.SH SYNOPSIS
.B hciattach
.RB [\| \-b \|]
.RB [\| \-n \|]
.RB [\| \-p \|]
.RB [\| \-t
.IR timeout \|]
.RB [\| \-s
.IR speed \|]
.RB [\| \-l \|]
.RB [\| \-r \|]
.I tty
.IR type \||\| id
.I speed
.I flow
.I bdaddr
.SH DESCRIPTION
.LP
Hciattach is used to attach a serial UART to the Bluetooth stack as HCI
transport interface.
.SH OPTIONS
.TP
.B \-b
Send break.
.TP
.B \-n
Don't detach from controlling terminal.
.TP
.B \-p
Print the PID when detaching.
.TP
.BI \-t " timeout"
Specify an initialization timeout.  (Default is 5 seconds.)
.TP
.BI \-s " speed"
Specify an initial speed instead of the hardware default.
.TP
.B \-l
List all available configurations.
.TP
.B \-r
Set the HCI device into raw mode (the kernel and bluetoothd will ignore it).
.TP
.I tty
This specifies the serial device to attach. A leading
.B /dev
can be omitted. Examples:
.B /dev/ttyS1
.B ttyS2
.TP
.IR type \||\| id
The
.I type
or
.I id
of the Bluetooth device that is to be attached, i.e. vendor or other device
specific identifier. Currently supported types are
.RS
.TP
.B type
.B description
.TP
.B any
Unspecified HCI_UART interface, no vendor specific options
.TP
.B ericsson
Ericsson based modules
.TP
.B digi
Digianswer based cards
.TP
.B xircom
Xircom PCMCIA cards: Credit Card Adapter and Real Port Adapter
.TP
.B csr
CSR Casira serial adapter or BrainBoxes serial dongle (BL642)
.TP
.B bboxes
BrainBoxes PCMCIA card (BL620)
.TP
.B swave
Silicon Wave kits
.TP
.B bcsp
Serial adapters using CSR chips with BCSP serial protocol
.TP
.B ath3k
Atheros AR300x based serial Bluetooth device
.TP
.B intel
Intel Bluetooth device
.RE

Supported IDs are (manufacturer id, product id)
.RS
.TP
.B 0x0105, 0x080a
Xircom PCMCIA cards: Credit Card Adapter and Real Port Adapter
.TP
.B 0x0160, 0x0002
BrainBoxes PCMCIA card (BL620)
.RE

.TP
.I speed
The
.I speed
specifies the UART speed to use. Baudrates higher than 115.200bps require
vendor specific initializations that are not implemented for all types of
devices. In general the following speeds are supported:

.B 9600, 19200, 38400, 57600, 115200, 230400, 460800, 921600

Supported vendor devices are automatically initialised to their respective
best settings.
.TP
.I flow
If the keyword
.I flow
is appended to the list of options then hardware flow control is forced on
the serial link (
.B CRTSCTS
). All above mentioned device types have
.B flow
set by default. To force no flow control use
.B noflow
instead.
.TP
.I sleep
Enables hardware specific power management feature. If
.I sleep
is appended to the list of options then this feature is enabled. To disable
this feature use
.B nosleep
instead.
All above mentioned device types have
.B nosleep
set by default.

Note: This option will only be valid for hardware which support
hardware specific power management enable option from host.
.TP
.I bdaddr
The
.I bdaddr
specifies the Bluetooth Address to use.  Some devices (like the STLC2500)
do not store the Bluetooth address in hardware memory.  Instead it must
be uploaded during the initialization process.  If this argument
is specified, then the address will be used to initialize the device.
Otherwise, a default address will be used.

.SH AUTHORS
Written by Maxim Krasnyansky <maxk@qualcomm.com>
.PP
Manual page by Nils Faerber <nils@kernelconcepts.de>
build: Move all programs to be installed into bin directory 2012-12-09 18:03:46 +08:00			`.TH HCIATTACH 1 "Jan 22 2002" BlueZ "Linux System Administration"`
Initial revision 2002-03-09 05:12:35 +08:00			`.SH NAME`
			`hciattach \- attach serial devices via UART HCI to BlueZ stack`
			`.SH SYNOPSIS`
			`.B hciattach`
Add missing hciattach command line switches to the manual page This patch adds some previously undocumented command line switches to the hciattach manual page. 2010-07-10 04:18:12 +08:00			`.RB [\\| \-b \\|]`
Update manual pages 2006-06-02 02:36:20 +08:00			`.RB [\\| \-n \\|]`
			`.RB [\\| \-p \\|]`
remove trailing whitespaces in manpages 2009-06-27 23:01:40 +08:00			`.RB [\\| \-t`
Update manual pages 2006-06-02 02:36:20 +08:00			`.IR timeout \\|]`
Add missing hciattach command line switches to the manual page This patch adds some previously undocumented command line switches to the hciattach manual page. 2010-07-10 04:18:12 +08:00			`.RB [\\| \-s`
			`.IR speed \\|]`
			`.RB [\\| \-l \\|]`
Add hciattach support for initializing a device into raw mode This patch adds a -r switch to hciattach that can be used to initialize a device into raw mode. This is accomplished with the help of the new HCIUARTSETFLAGS ioctl. 2010-07-12 22:38:29 +08:00			`.RB [\\| \-r \\|]`
Initial revision 2002-03-09 05:12:35 +08:00			`.I tty`
Update manual pages 2006-06-02 02:36:20 +08:00			`.IR type \\|\|\\| id`
Initial revision 2002-03-09 05:12:35 +08:00			`.I speed`
			`.I flow`
Add support for STLC2500 address and baud rate settings 2007-04-26 07:09:02 +08:00			`.I bdaddr`
Initial revision 2002-03-09 05:12:35 +08:00			`.SH DESCRIPTION`
			`.LP`
			`Hciattach is used to attach a serial UART to the Bluetooth stack as HCI`
			`transport interface.`
			`.SH OPTIONS`
			`.TP`
Add missing hciattach command line switches to the manual page This patch adds some previously undocumented command line switches to the hciattach manual page. 2010-07-10 04:18:12 +08:00			`.B \-b`
			`Send break.`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B \-n`
describe optional arguments 2003-02-12 20:34:16 +08:00			`Don't detach from controlling terminal.`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B \-p`
describe optional arguments 2003-02-12 20:34:16 +08:00			`Print the PID when detaching.`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.BI \-t " timeout"`
describe optional arguments 2003-02-12 20:34:16 +08:00			`Specify an initialization timeout. (Default is 5 seconds.)`
			`.TP`
Add missing hciattach command line switches to the manual page This patch adds some previously undocumented command line switches to the hciattach manual page. 2010-07-10 04:18:12 +08:00			`.BI \-s " speed"`
			`Specify an initial speed instead of the hardware default.`
			`.TP`
			`.B \-l`
			`List all available configurations.`
			`.TP`
Add hciattach support for initializing a device into raw mode This patch adds a -r switch to hciattach that can be used to initialize a device into raw mode. This is accomplished with the help of the new HCIUARTSETFLAGS ioctl. 2010-07-12 22:38:29 +08:00			`.B \-r`
			`Set the HCI device into raw mode (the kernel and bluetoothd will ignore it).`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.I tty`
Initial revision 2002-03-09 05:12:35 +08:00			`This specifies the serial device to attach. A leading`
			`.B /dev`
			`can be omitted. Examples:`
			`.B /dev/ttyS1`
			`.B ttyS2`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.IR type \\|\|\\| id`
Initial revision 2002-03-09 05:12:35 +08:00			`The`
Update manual pages 2006-06-02 02:36:20 +08:00			`.I type`
Initial revision 2002-03-09 05:12:35 +08:00			`or`
Update manual pages 2006-06-02 02:36:20 +08:00			`.I id`
Initial revision 2002-03-09 05:12:35 +08:00			`of the Bluetooth device that is to be attached, i.e. vendor or other device`
			`specific identifier. Currently supported types are`
			`.RS`
			`.TP`
			`.B type`
			`.B description`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B any`
Initial revision 2002-03-09 05:12:35 +08:00			`Unspecified HCI_UART interface, no vendor specific options`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B ericsson`
Initial revision 2002-03-09 05:12:35 +08:00			`Ericsson based modules`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B digi`
Initial revision 2002-03-09 05:12:35 +08:00			`Digianswer based cards`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B xircom`
Initial revision 2002-03-09 05:12:35 +08:00			`Xircom PCMCIA cards: Credit Card Adapter and Real Port Adapter`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B csr`
Initial revision 2002-03-09 05:12:35 +08:00			`CSR Casira serial adapter or BrainBoxes serial dongle (BL642)`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B bboxes`
Initial revision 2002-03-09 05:12:35 +08:00			`BrainBoxes PCMCIA card (BL620)`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B swave`
Initial revision 2002-03-09 05:12:35 +08:00			`Silicon Wave kits`
Add new manpages and update the old ones 2002-11-16 09:44:53 +08:00			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B bcsp`
Add new manpages and update the old ones 2002-11-16 09:44:53 +08:00			`Serial adapters using CSR chips with BCSP serial protocol`
Add host level support for Atheros AR300x device This patch implements support for the Atheros AR300x Bluetooth chip in hciattach. It supports configuration download and power management configure feature. 2010-08-18 17:29:28 +08:00			`.TP`
			`.B ath3k`
			`Atheros AR300x based serial Bluetooth device`
hciattach: Add support for Intel Bluetooth device This patch enables the Intel Bluetooth device (UART sku) over the H4 protocol. It is responsible for bring up the device into known state by configuring the baudrate and applying the patches, if required. 2012-05-16 01:23:29 +08:00			`.TP`
			`.B intel`
			`Intel Bluetooth device`
Initial revision 2002-03-09 05:12:35 +08:00			`.RE`

			`Supported IDs are (manufacturer id, product id)`
			`.RS`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B 0x0105, 0x080a`
Initial revision 2002-03-09 05:12:35 +08:00			`Xircom PCMCIA cards: Credit Card Adapter and Real Port Adapter`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.B 0x0160, 0x0002`
Initial revision 2002-03-09 05:12:35 +08:00			`BrainBoxes PCMCIA card (BL620)`
			`.RE`

			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.I speed`
Initial revision 2002-03-09 05:12:35 +08:00			`The`
Update manual pages 2006-06-02 02:36:20 +08:00			`.I speed`
Initial revision 2002-03-09 05:12:35 +08:00			`specifies the UART speed to use. Baudrates higher than 115.200bps require`
			`vendor specific initializations that are not implemented for all types of`
			`devices. In general the following speeds are supported:`

			`.B 9600, 19200, 38400, 57600, 115200, 230400, 460800, 921600`

			`Supported vendor devices are automatically initialised to their respective`
			`best settings.`
			`.TP`
Update manual pages 2006-06-02 02:36:20 +08:00			`.I flow`
Initial revision 2002-03-09 05:12:35 +08:00			`If the keyword`
Update manual pages 2006-06-02 02:36:20 +08:00			`.I flow`
Initial revision 2002-03-09 05:12:35 +08:00			`is appended to the list of options then hardware flow control is forced on`
			`the serial link (`
			`.B CRTSCTS`
			`). All above mentioned device types have`
			`.B flow`
			`set by default. To force no flow control use`
			`.B noflow`
			`instead.`
Bluetooth: Option to enable power management from host This provides a new option for hciattach to enable hardware specific power management from host. This option by default will be disabled for existing devices 2010-08-13 14:36:47 +08:00			`.TP`
			`.I sleep`
			`Enables hardware specific power management feature. If`
			`.I sleep`
			`is appended to the list of options then this feature is enabled. To disable`
			`this feature use`
			`.B nosleep`
			`instead.`
			`All above mentioned device types have`
			`.B nosleep`
			`set by default.`
Initial revision 2002-03-09 05:12:35 +08:00
Bluetooth: Option to enable power management from host This provides a new option for hciattach to enable hardware specific power management from host. This option by default will be disabled for existing devices 2010-08-13 14:36:47 +08:00			`Note: This option will only be valid for hardware which support`
			`hardware specific power management enable option from host.`
Add support for STLC2500 address and baud rate settings 2007-04-26 07:09:02 +08:00			`.TP`
			`.I bdaddr`
remove trailing whitespaces in manpages 2009-06-27 23:01:40 +08:00			`The`
Add support for STLC2500 address and baud rate settings 2007-04-26 07:09:02 +08:00			`.I bdaddr`
remove trailing whitespaces in manpages 2009-06-27 23:01:40 +08:00			`specifies the Bluetooth Address to use. Some devices (like the STLC2500)`
			`do not store the Bluetooth address in hardware memory. Instead it must`
Add support for STLC2500 address and baud rate settings 2007-04-26 07:09:02 +08:00			`be uploaded during the initialization process. If this argument`
			`is specified, then the address will be used to initialize the device.`
			`Otherwise, a default address will be used.`

Initial revision 2002-03-09 05:12:35 +08:00			`.SH AUTHORS`
			`Written by Maxim Krasnyansky <maxk@qualcomm.com>`
			`.PP`
describe optional arguments 2003-02-12 20:34:16 +08:00			`Manual page by Nils Faerber <nils@kernelconcepts.de>`