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