aboutsummaryrefslogtreecommitdiff
path: root/doc/mgmt-api.txt
blob: 613b7fca39e2d998093d8b5e78134e0bbbfe4cf5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
Bluetooth Management API
*************************

Copyright (C) 2008-2009  Marcel Holtmann <marcel@holtmann.org>


Packet Structures
=================

	Commands:

	0       4       8      12      16      202     24      28    31
	+-------------------------------+-----------------------------+
	|  Command Code                 |  Parameter Total Length     |
        +-------------------------------+-----------------------------+
	|                                                             |

	Events:

	0       4       8      12      16      202     24      28    31
	+-------------------------------+-----------------------------+
	|  Event Code                   |  Parameter Total Length     |
        +-------------------------------+-----------------------------+
	|                                                             |


Read Management Version Information Command
===========================================

	Command Code:		0x0001
	Command Parameters:
	Return Parameters:	Version (1 Octets)
				Revision (2 Octets)


Read Management Supported Features Command
==========================================

	Command Code:		0x0002
	Command Parameters:
	Return Parameters:	Features (8 Octets)

		Feature Bit 0:	Controller Support
		Feature Bit 1:	Tracing Support


Read Controller Index List Command
==================================

	Command Code:		0x0003
	Command Parameters:
	Return Paramters:	Num_Controllers (2 Octets)
				Controller_Index[i] (2 Octets)


Read Controller Information Command
===================================

	Command Code:		0x0004
	Command Parameters:	Controller_Index (2 Octets)
	Return Parameters:	Controller_Index (2 Octets)
				Controller_Type (1 Octet)
				Powered (1 octet)
				Connectable (1 octet)
				Discoverable (1 octet)
				Pairable (1 octed)
				Security_Mode (1 octed)
				BD_ADDR (6 Octets)
				Device_Class (3 octets)
				Supported_Features (8 Octets)
				Manufacturer (2 Octets)
				HCI_Version (1 Octet)
				HCI_Revision (2 Octets)

		Controller_Type:0x00 Reserved
				0x01 Bluetooth (BR/EDR)
				0x02 802.11 (AMP)


Set Powered Command
===================

	Command Code:		0x0005
	Command Parameters:	Controller_Index (2 Octets)
				Powered (1 Octet)
	Return Paramters:	Controller_Index (2 Octets)
				Powered (1 Octet)


Set Discoverable Command
========================

	Command Code:		0x0006
	Command Parameters:	Controller_Index (2 Octets)
				Discoverable (1 Octet)
	Return Paramters:	Controller_Index (2 Octets)
				Discoverable (1 Octet)


Set Connectable Command
=======================

	Command Code:		0x0007
	Command Parameters:	Controller_Index (2 Octets)
				Connectable (1 Octet)
	Return Paramters:	Controller_Index (2 Octets)
				Connectable (1 Octet)


Set Pairable Command
====================

	Command Code:		0x0008
	Command Parameters:	Controller_Index (2 Octets)
				Pairable (1 Octet)
	Return Paramters:	Controller_Index (2 Octets)
				Pairable (1 Octet)

Add UUID Command
================

	Command Code:		0x0009
	Command Parameters:	Controller_Index (2 Octets)
				UUID (16 Octets)
				SVC_Hint (1 octet)
	Return Paramters:	Controller_Index (2 Octets)


Remove UUID Command
===================

	Command Code:		0x000A
	Command Parameters:	Controller_Index (2 Octets)
				UUID (16 Octets)
	Return Paramters:	Controller_Index (2 Octets)


Set Device Class
================

	Command Code:		0x000B
	Command Parameters:	Controller_Index (2 Octets)
				Major_Class (1 octet)
				Minor_Class (1 octed)
	Return Paramters:	Controller_Index (2 Octets)


Set Service Cache Command
=========================

	Command Code:		0x000C
	Command Parameters:	Controller_Index (2 Octets)
				Enable (1 octet)
	Return Paramters:	Controller_Index (2 Octets)


Load Keys Command
=================

	Command Code:		0x000D
	Command Parameters:	Controller_Index (2 Octets)
				Debug_Keys (1 Octet)
				Key_Count (2 Octets)
				Key1 {
					Address (6 Octets)
					Type (1 Octet)
					Value (16 Octets)
					PIN_Length (1 Octet)
				}
				Key2 { }
				...
	Return Paramters:	Controller_Index (2 Octets)


Remove Key Command
==================

	Command Code:		0x000E
	Command Parameters:	Controller_Index (2 Octets)
				Address (6 Octets)
				Disconnect (1 Octet)
	Return Paramters:	Controller_Index (2 Octets)


Disconnect Command
==================

	Command Code:		0x000F
	Command Parameters:	Controller_Index (2 Octets)
				Address (6 Octets)
	Return Paramters:	Controller_Index (2 Octets)
				Address (6 Octets)

Get Connections Command
=======================

	Command Code:		0x0010
	Command Parameters:	Controller_Index (2 Octets)
	Return Paramters:	Controller_Index (2 Octets)
				Connection_Count (2 Octets)
				Address1 (6 Octets)
				Address2 (6 Octets)
				...



Read Tracing Buffer Size Command
================================

	Command Code:		<not yet assigned>
	Command Parameters:
	Return Parameters:	Status (1 Octet)
				Buffer_Size (2 Octets)

		Buffer Size in Kilobytes


Write Tracing Buffer Size Command
=================================

	Command Code:		<not yet assigned>
	Command Parameters:	Buffer_Size (2 Octets)
	Return Parameters:	Status (1 Octet)

		Buffer Size in Kilobytes


Read Controller Tracing Filter Command
=======================================

	Command Code:		<not yet assigned>
	Command Parameters:	Controller_Index (2 Octects)
	Return Parameters:	Status (1 Octet)
				Controller_Index (2 Octets)
				Tracing_Enable (1 Octect)
				Num_Filters (2 Octect)
				Protocol_UUID[i] (16 Octets)
				Protocol_Identifier[i] (16 Octets)

		Tracing_Enable:	0x00 Tracing disabled
				0x01 Command and Event tracing
				0x02 Command, Event and ACL tracing
				0x03 Command, Event, ACL and SCO tracing


Write Controller Tracing Filter Command
=======================================

	Command Code:		<not yet assigned>
	Command Parameters:	Controller_Index (2 Octects)
				Tracing_Enable (1 Octect)
				Num_Filters (2 Octect)
				Protocol_UUID[i] (16 Octets)
				Protocol_Identifier[i] (16 Octets)
	Return Paramters:	Status (1 Octet)
				Controller_Index (2 Octets)


Command Complete Event
======================

Event Code		0x0001
Event Parameters	Command_Opcode (2 Octets)
			Return_Parameters


Command Status Event
====================

Event Code		0x0002
Event Parameters	Status (1 Octet)
			Command_Opcode (2 Octets)


Controller Error Event
======================

Event Code		0x0003
Event Parameters	Error_Code (1 Octet)


Index Added Event
=================

Event Code		0x0004
Event Parameters	Controller_Index (2 Octets)


Index Removed Event
===================

Event Code		0x0005
Event Parameters	Controller_Index (2 Octets)

Controller Powered Event
========================

Event Code		0x0006
Event Parameters	Controller_Index (2 Octets)
			Powered (1 Octet)

Controller Discoverable Event
=============================

Event Code		0x0007
Event Parameters	Controller_Index (2 Octets)
			Discoverable (1 Octet)

Controller Connectable Event
============================

Event Code		0x0008
Event Parameters	Controller_Index (2 Octets)
			Connectable (1 Octet)

Controller Pairable Event
=========================

Event Code		0x0009
Event Parameters	Controller_Index (2 Octets)
			Pairable (1 Octet)

New Key Event
=============

Event Code		0x000A
Event Parameters	Controller_Index (2 Octets)
			Key {
				Address (6 Octets)
				Type (1 Octet)
				Value (16 Octets)
				PIN_Length (1 Octet)
			}
			Old_Key_Type (1 Octet)

Device Connected Event
======================

Event Code		0x000B
Event Parameters	Controller_Index (2 Octets)
			Address (6 Octets)

Device Disconnected Event
=========================

Event Code		0x000C
Event Parameters	Controller_Index (2 Octets)
			Address (6 Octets)

Connect Failed Event
====================

Event Code		0x000D
Event Parameters	Controller_Index (2 Octets)
			Address (6 Octets)
			Status (1 Octet)