Skip to content

Commit 1a61bb6

Browse files
szymon-czaprackiszymon-czapracki
committed
nimble/hci: Document vendor specific commands
Commands were not documented. Lack of the descriptions could led to some ambiguous interpretations.
1 parent 6dbb085 commit 1a61bb6

File tree

1 file changed

+338
-0
lines changed

1 file changed

+338
-0
lines changed

‎nimble/include/nimble/hci_vendor.md

Lines changed: 338 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,338 @@
1+
*********Nimble Vendor Supported Commands
2+
3+
+--------------+
4+
| OGF = 0x003F |
5+
+--------------+
6+
7+
8+
***Read Static Address Command
9+
===========================
10+
11+
*Read Device Random Static Address
12+
13+
+----------------------------+--------+--------------------+--------------------+
14+
| Command | OCF | Command | Return |
15+
| | | Parameters | Parameters |
16+
+----------------------------+--------_+--------------------+--------------------+
17+
| Read_Random_Static_Address | 0x0001 | |+ Static Address |
18+
+----------------------------+--------+--------------------+--------------------+
19+
20+
Static Address:
21+
+----------------------------+-----------------------------+
22+
| Value | Description |
23+
+----------------------------+-----------------------------+
24+
| 0xXXXXXXXXXXXX | Address |
25+
+----------------------------+-----------------------------+
26+
6 octets
27+
28+
***Set Default Transmit Power
29+
==========================
30+
31+
*Set default transmit power. Selected TX power is returned.
32+
Setting 0xFF restores controller setting to default.
33+
34+
+----------------------------+--------+--------------------+---------------------+
35+
| Command | OCF | Command | Return |
36+
| | | Parameters | Parameters |
37+
+----------------------------+--------_+--------------------+---------------------+
38+
| Set_Transmit_Power | 0x0002 |+ Tx_Power_ |+ **Selected_Tx_Power |
39+
+----------------------------+--------+--------------------+---------------------+
40+
41+
Tx_Power
42+
+----------------------------+-----------------------------+
43+
| Value | Description |
44+
+----------------------------+-----------------------------+
45+
| 0xXX | Desired TX Power |
46+
+----------------------------+-----------------------------+
47+
1 octet
48+
49+
Selected_Tx_Power
50+
+----------------------------+------------------------------+
51+
| Value | Description |
52+
+----------------------------+------------------------------+
53+
| 0xXX | Controller Selected TX power |
54+
+----------------------------+------------------------------+
55+
1 octet
56+
57+
58+
***Configure Connection Strict Scheduling
59+
======================================
60+
61+
*******Configure Connection Strict Scheduling
62+
63+
+----------------------------+--------+--------------------+--------------------+
64+
| Command | OCF | Command | Return |
65+
| | | Parameters | Parameters |
66+
+----------------------------+--------_+--------------------+--------------------+
67+
| CSS_Configure | 0x0003 |+ Slot_In_Microsec_ | |
68+
| | |+ Number_Of_Slots | |
69+
+----------------------------+--------+--------------------+--------------------+
70+
71+
Slot_In_Microsec
72+
+----------------------------+-----------------------------+
73+
| Value | Description |
74+
+----------------------------+-----------------------------+
75+
| 0xXXXXXX | Slot duration in msec |
76+
+----------------------------+-----------------------------+
77+
4 octets
78+
79+
Number_Of_Slots
80+
+----------------------------+-----------------------------+
81+
| Value | Description |
82+
+----------------------------+-----------------------------+
83+
| 0xXXXXXX | Number of period slots |
84+
+----------------------------+-----------------------------+
85+
4 octets
86+
87+
88+
***Connection strict scheduling enable
89+
===================================
90+
91+
*Enable/Disable Connection Strict Scheduling
92+
93+
+----------------------------+--------+--------------------+--------------------+
94+
| Command | OCF | Command | Return |
95+
| | | Parameters | Parameters |
96+
+----------------------------+--------_+--------------------+--------------------+
97+
| Enable_CSS | 0x0004 |+ Enable/Disable | |
98+
+----------------------------+--------+--------------------+--------------------+
99+
100+
Enable/Disable
101+
+----------------------------+-----------------------------+
102+
| Value | Description |
103+
+----------------------------+-----------------------------+
104+
| 0xXX | Enable/Disable CSS |
105+
+----------------------------+-----------------------------+
106+
1 octet
107+
108+
109+
***Connection Strict Scheduling - Select Next Slot
110+
===============================================
111+
112+
*CSS select next slot
113+
114+
+----------------------------+--------+--------------------+--------------------+
115+
| Command | OCF | Command | Return |
116+
| | | Parameters | Parameters |
117+
+----------------------------+--------+--------------------+--------------------+
118+
| Set_Next_CSS_Slot | 0x0005 |+ Next_Slot_Idx | |
119+
+----------------------------+--------+--------------------+--------------------+
120+
121+
Next_Slot_Idx
122+
+----------------------------+-----------------------------+
123+
| Value | Description |
124+
+----------------------------+-----------------------------+
125+
| 0xXXXX | Next Slot ID |
126+
+----------------------------+-----------------------------+
127+
2 octets
128+
129+
130+
***Connection Strict Scheduling - Select Slot For Specific Connection
131+
==================================================================
132+
133+
*CSS set next slot for specific connection
134+
135+
+----------------------------+--------+--------------------+--------------------+
136+
| Command | OCF | Command | Return |
137+
| | | Parameters | Parameters |
138+
+----------------------------+--------_+--------------------+--------------------+
139+
| CSS_Set_Connection_Slot | 0x0006 |+ Connection_Handle_ | |
140+
| | |+ Slot_Idx | |
141+
+----------------------------+--------+--------------------+--------------------+
142+
143+
Connection_Handle
144+
+----------------------------+-----------------------------+
145+
| Value | Description |
146+
+----------------------------+-----------------------------+
147+
| 0xXXXX | Connection Handle |
148+
+----------------------------+-----------------------------+
149+
2 octets
150+
151+
Slot_Idx
152+
+----------------------------+-----------------------------+
153+
| Value | Description |
154+
+----------------------------+-----------------------------+
155+
| 0xXXXX | Slot ID |
156+
+----------------------------+-----------------------------+
157+
2 octets
158+
159+
160+
***Connection Strict Scheduling - Read Connection Slot
161+
===================================================
162+
163+
*CSS read current connection slot
164+
165+
+----------------------------+--------+--------------------+--------------------+
166+
| Command | OCF | Command | Return |
167+
| | | Parameters | Parameters |
168+
+----------------------------+--------_+--------------------+--------------------+
169+
| CSS_Read_Connection_Slot | 0x0007 |+ Connection_Handle_ |+ Connection_Handle |
170+
| | | |+ Slot_Idx |
171+
+----------------------------+--------+--------------------+--------------------+
172+
173+
Connection_Handle
174+
+----------------------------+-----------------------------+
175+
| Value | Description |
176+
+----------------------------+-----------------------------+
177+
| 0xXXXX | Connection Handle |
178+
+----------------------------+-----------------------------+
179+
2 octets
180+
181+
Connection_Handle
182+
+----------------------------+-----------------------------+
183+
| Value | Description |
184+
+----------------------------+-----------------------------+
185+
| 0xXXXX | Connection Handle |
186+
+----------------------------+-----------------------------+
187+
2 octets
188+
189+
Slot_Idx
190+
+----------------------------+-----------------------------+
191+
| Value | Description |
192+
+----------------------------+-----------------------------+
193+
| 0xXXXX | Slot ID |
194+
+----------------------------+-----------------------------+
195+
2 octets
196+
197+
198+
***Set Data Length
199+
===============
200+
201+
+----------------------------+--------+--------------------+--------------------+
202+
| Command | OCF | Command | Return |
203+
| | | Parameters | Parameters |
204+
+----------------------------+--------_+--------------------+--------------------+
205+
| Set Data Length | 0x0008 |+ Connection_Handle_ |+ Connection_Handle |
206+
| | |+ Tx_Octets | |
207+
| | |+ Tx_Time | |
208+
| | |+ Rx_Octets | |
209+
| | |+ Rx_Time | |
210+
+----------------------------+--------+--------------------+--------------------+
211+
212+
Connection_Handle
213+
+----------------------------+-----------------------------+
214+
| Value | Description |
215+
+----------------------------+-----------------------------+
216+
| 0xXXXX | Connection Handle |
217+
+----------------------------+-----------------------------+
218+
2 octets
219+
220+
Tx_Octets
221+
+----------------------------+-----------------------------+
222+
| Value | Description |
223+
+----------------------------+-----------------------------+
224+
| 0xXXXX | Transmit octets |
225+
+----------------------------+-----------------------------+
226+
2 octets
227+
228+
Tx_Time
229+
+----------------------------+-----------------------------+
230+
| Value | Description |
231+
+----------------------------+-----------------------------+
232+
| 0xXXXX | Transmission time |
233+
+----------------------------+-----------------------------+
234+
2 octets
235+
236+
Rx_Octets
237+
+----------------------------+-----------------------------+
238+
| Value | Description |
239+
+----------------------------+-----------------------------+
240+
| 0xXXXX | Receiver octets |
241+
+----------------------------+-----------------------------+
242+
2 octets
243+
244+
Rx_Time
245+
+----------------------------+-----------------------------+
246+
| Value | Description |
247+
+----------------------------+-----------------------------+
248+
| 0xXXXX | Receiver time |
249+
+----------------------------+-----------------------------+
250+
2 octets
251+
252+
Connection_Handle
253+
+----------------------------+-----------------------------+
254+
| Value | Description |
255+
+----------------------------+-----------------------------+
256+
| 0xXXXX | Connection Handle |
257+
+----------------------------+-----------------------------+
258+
2 octets
259+
260+
261+
***Set Antenna Location
262+
====================
263+
264+
+----------------------------+--------+--------------------+--------------------+
265+
| Command | OCF | Command | Return |
266+
| | | Parameters | Parameters |
267+
+----------------------------+--------_+--------------------+--------------------+
268+
| Set Antenna Location | 0x0009 |+ Antenna_Location | |
269+
+----------------------------+--------+--------------------+--------------------+
270+
271+
Rx_Time
272+
+----------------------------+-----------------------------+
273+
| Value | Description |
274+
+----------------------------+-----------------------------+
275+
| 0xXX | Antenna location |
276+
+----------------------------+-----------------------------+
277+
1 ocet
278+
279+
280+
***Set Local Identity Resolving Key
281+
================================
282+
283+
*Set own address type & identity resolving key
284+
285+
+----------------------------+--------+--------------------+--------------------+
286+
| Command | OCF | Command | Return |
287+
| | | Parameters | Parameters |
288+
+----------------------------+--------_+--------------------+--------------------+
289+
| Set Local IRK | 0x000A |+ Own_Addr_Type | |
290+
| | |+ IRK | |
291+
+----------------------------+--------+--------------------+--------------------+
292+
293+
Rx_Time
294+
+----------------------------+-----------------------------+
295+
| Value | Description |
296+
+----------------------------+-----------------------------+
297+
| 0xXX | Device Address Type |
298+
+----------------------------+-----------------------------+
299+
1 ocet
300+
301+
IRK
302+
+------------------------------------+-----------------------------+
303+
| Value | Description |
304+
+------------------------------------+-----------------------------+
305+
| 0xXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX | Identity Resolving Key |
306+
+------------------------------------+-----------------------------+
307+
16 ocets
308+
309+
310+
***Set Scan Configuration
311+
======================
312+
313+
+----------------------------+--------+--------------------+--------------------+
314+
| Command | OCF | Command | Return |
315+
| | | Parameters | Parameters |
316+
+----------------------------+--------_+--------------------+--------------------+
317+
| Set Scan Configuration | 0x000B |+ Flags | |
318+
| | |+ Rssi_Treshlod | |
319+
+----------------------------+--------+--------------------+--------------------+
320+
321+
Flags
322+
+----------------------------+-----------------------------+
323+
| Value | Description |
324+
+----------------------------+-----------------------------+
325+
| 0x00000001 | No legacy advertising |
326+
| 0x00000002 | No extended advertising |
327+
+----------------------------+-----------------------------+
328+
4 octets
329+
330+
Rssi_Treshold
331+
+----------------------------+-----------------------------+
332+
| Value | Description |
333+
+----------------------------+-----------------------------+
334+
| 0xXX | RSSI treshold value |
335+
+----------------------------+-----------------------------+
336+
1 octet
337+
338+

0 commit comments

Comments
 (0)