xref: /freebsd/usr.sbin/bluetooth/hccontrol/hccontrol.8 (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
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: hccontrol.8,v 1.6 2003/08/06 21:26:38 max Exp $
26.\" $FreeBSD$
27.\"
28.Dd June 14, 2002
29.Dt HCCONTROL 8
30.Os
31.Sh NAME
32.Nm hccontrol
33.Nd HCI configuration utility
34.Sh SYNOPSIS
35.Nm
36.Op Fl hN
37.Fl n Ar HCI_node_name
38.Ar command
39.Op Ar parameters ...
40.Sh DESCRIPTION
41The
42.Nm
43utility connects to the specified Netgraph node of type
44.Dv HCI
45and attempts to send specified command to the HCI Netgraph node or to the
46associated Bluetooth device.
47The
48.Nm
49utility will print results to the standard output and error messages to
50the standard error.
51.Pp
52The options are as follows:
53.Bl -tag -width indent
54.It Fl h
55Display usage message and exit.
56.It Fl N
57Show Bluetooth addresses as numbers.
58Normally
59.Nm
60attempts to resolve Bluetooth addresses, and display them symbolically.
61.It Fl n Ar HCI_node_name
62Connect to the specified HCI Netgraph node.
63.It Ar command
64One of the supported commands (see below).
65Special command
66.Cm help
67can be used to obtain the list of all supported commands.
68To get more information about specific command use
69.Cm help Ar command .
70.It Ar parameters
71One or more optional space separated command parameters.
72.El
73.Sh COMMANDS
74The currently supported HCI commands in
75.Nm
76are:
77.Pp
78.Bl -tag -offset indent -compact
79.It Cm Inquiry
80.It Cm Create_Connection
81.It Cm Disconnect
82.It Cm Add_SCO_Connection
83.It Cm Change_Connection_Packet_Type
84.It Cm Remote_Name_Request
85.It Cm Read_Remote_Supported_Features
86.It Cm Read_Remote_Version_Information
87.It Cm Read_Clock_Offset
88.It Cm Role_Discovery
89.It Cm Switch_Role
90.It Cm Read_Link_Policy_Settings
91.It Cm Write_Link_Policy_Settings
92.It Cm Reset
93.It Cm Read_Pin_Type
94.It Cm Write_Pin_Type
95.It Cm Read_Stored_Link_Key
96.It Cm Write_Stored_Link_Key
97.It Cm Delete_Stored_Link_Key
98.It Cm Change_Local_Name
99.It Cm Read_Local_Name
100.It Cm Read_Connection_Accept_Timeout
101.It Cm Write_Connection_Accept_Timeout
102.It Cm Read_Page_Timeout
103.It Cm Write_Page_Timeout
104.It Cm Read_Scan_Enable
105.It Cm Write_Scan_Enable
106.It Cm Read_Page_Scan_Activity
107.It Cm Write_Page_Scan_Activity
108.It Cm Read_Inquiry_Scan_Activity
109.It Cm Write_Inquiry_Scan_Activity
110.It Cm Read_Authentication_Enable
111.It Cm Write_Authentication_Enable
112.It Cm Read_Encryption_Mode
113.It Cm Write_Encryption_Mode
114.It Cm Read_Class_Of_Device
115.It Cm Write_Class_Of_Device
116.It Cm Read_Voice_Settings
117.It Cm Write_Voice_Settings
118.It Cm Read_Number_Broadcast_Retransmissions
119.It Cm Write_Number_Broadcast_Retransmissions
120.It Cm Read_Hold_Mode_Activity
121.It Cm Write_Hold_Mode_Activity
122.It Cm Read_SCO_Flow_Control_Enable
123.It Cm Write_SCO_Flow_Control_Enable
124.It Cm Read_Link_Supervision_Timeout
125.It Cm Write_Link_Supervision_Timeout
126.It Cm Read_Page_Scan_Period_Mode
127.It Cm Write_Page_Scan_Period_Mode
128.It Cm Read_Page_Scan_Mode
129.It Cm Write_Page_Scan_Mode
130.It Cm Read_Local_Version_Information
131.It Cm Read_Local_Supported_Features
132.It Cm Read_Buffer_Size
133.It Cm Read_Country_Code
134.It Cm Read_BD_ADDR
135.It Cm Read_Failed_Contact_Counter
136.It Cm Reset_Failed_Contact_Counter
137.It Cm Get_Link_Quality
138.It Cm Read_RSSI
139.El
140.Pp
141The currently supported node commands in
142.Nm
143are:
144.Pp
145.Bl -tag -offset indent -compact
146.It Cm Read_Node_State
147.It Cm Initialize
148.It Cm Read_Debug_Level
149.It Cm Write_Debug_Level
150.It Cm Read_Node_Buffer_Size
151.It Cm Read_Node_BD_ADDR
152.It Cm Read_Node_Features
153.It Cm Read_Node_Stat
154.It Cm Reset_Node_Stat
155.It Cm Flush_Neighbor_Cache
156.It Cm Read_Neighbor_Cache
157.It Cm Read_Connection_List
158.It Cm Read_Node_Link_Policy_Settings_Mask
159.It Cm Write_Node_Link_Policy_Settings_Mask
160.It Cm Read_Node_Packet_Mask
161.It Cm Write_Node_Packet_Mask
162.It Cm Read_Node_Role_Switch
163.It Cm Write_Node_Role_Switch
164.El
165.Sh BUGS
166Most likely.
167Please report if found.
168.Sh DIAGNOSTICS
169.Ex -std
170.Sh SEE ALSO
171.Xr netgraph 3 ,
172.Xr netgraph 4 ,
173.Xr ng_hci 4 ,
174.Xr hcseriald 8
175.Sh AUTHORS
176.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
177