xref: /freebsd/usr.sbin/bluetooth/hccontrol/hccontrol.8 (revision 7660b554bc59a07be0431c17e0e33815818baa69)
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.3 2003/04/27 19:45:23 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 h
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 Ar HCI_node_name
57Connect to the specified HCI Netgraph node.
58.It Ar command
59One of the supported commands (see below).
60Special command
61.Cm help
62can be used to obtain the list of all supported commands.
63To get more information about specific command use
64.Cm help Ar command .
65.It Ar parameters
66One or more optional space separated command parameters.
67.El
68.Sh COMMANDS
69The currently supported HCI commands in
70.Nm
71are:
72.Pp
73.Bl -tag -offset indent -compact
74.It Cm Inquiry
75.It Cm Create_Connection
76.It Cm Disconnect
77.It Cm Add_SCO_Connection
78.It Cm Change_Connection_Packet_Type
79.It Cm Remote_Name_Request
80.It Cm Read_Remote_Supported_Features
81.It Cm Read_Remote_Version_Information
82.It Cm Read_Clock_Offset
83.It Cm Role_Discovery
84.It Cm Switch_Role
85.It Cm Read_Link_Policy_Settings
86.It Cm Write_Link_Policy_Settings
87.It Cm Reset
88.It Cm Read_Pin_Type
89.It Cm Write_Pin_Type
90.It Cm Read_Stored_Link_Key
91.It Cm Write_Stored_Link_Key
92.It Cm Delete_Stored_Link_Key
93.It Cm Change_Local_Name
94.It Cm Read_Local_Name
95.It Cm Read_Connection_Accept_Timeout
96.It Cm Write_Connection_Accept_Timeout
97.It Cm Read_Page_Timeout
98.It Cm Write_Page_Timeout
99.It Cm Read_Scan_Enable
100.It Cm Write_Scan_Enable
101.It Cm Read_Page_Scan_Activity
102.It Cm Write_Page_Scan_Activity
103.It Cm Read_Inquiry_Scan_Activity
104.It Cm Write_Inquiry_Scan_Activity
105.It Cm Read_Authentication_Enable
106.It Cm Write_Authentication_Enable
107.It Cm Read_Encryption_Mode
108.It Cm Write_Encryption_Mode
109.It Cm Read_Class_Of_Device
110.It Cm Write_Class_Of_Device
111.It Cm Read_Voice_Settings
112.It Cm Write_Voice_Settings
113.It Cm Read_Number_Broadcast_Retransmissions
114.It Cm Write_Number_Broadcast_Retransmissions
115.It Cm Read_Hold_Mode_Activity
116.It Cm Write_Hold_Mode_Activity
117.It Cm Read_SCO_Flow_Control_Enable
118.It Cm Write_SCO_Flow_Control_Enable
119.It Cm Read_Link_Supervision_Timeout
120.It Cm Write_Link_Supervision_Timeout
121.It Cm Read_Local_Version_Information
122.It Cm Read_Local_Supported_Features
123.It Cm Read_Buffer_Size
124.It Cm Read_Country_Code
125.It Cm Read_BD_ADDR
126.It Cm Read_Failed_Contact_Counter
127.It Cm Reset_Failed_Contact_Counter
128.It Cm Get_Link_Quality
129.It Cm Read_RSSI
130.El
131.Pp
132The currently supported node commands in
133.Nm
134are:
135.Pp
136.Bl -tag -offset indent -compact
137.It Cm Read_Node_State
138.It Cm Initialize
139.It Cm Read_Debug_Level
140.It Cm Write_Debug_Level
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.It Cm Read_Node_Role_Switch
154.It Cm Write_Node_Role_Switch
155.El
156.Sh BUGS
157Most likely.
158Please report if found.
159.Sh DIAGNOSTICS
160.Ex -std
161.Sh SEE ALSO
162.Xr netgraph 3 ,
163.Xr netgraph 4 ,
164.Xr ng_hci 4 ,
165.Xr hcseriald 8
166.Sh AUTHORS
167.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
168