xref: /btstack/src/hci_cmd.c (revision b45b7749fd0a3efec18073ae84f893078d0216d0)
1 /*
2  * Copyright (C) 2014 BlueKitchen GmbH
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  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 #define BTSTACK_FILE__ "hci_cmd.c"
39 
40 /*
41  *  hci_cmd.c
42  *
43  *  Created by Matthias Ringwald on 7/23/09.
44  */
45 
46 #include "btstack_config.h"
47 
48 #include "hci.h"
49 #include "hci_cmd.h"
50 #include "btstack_debug.h"
51 
52 #include <string.h>
53 
54 #ifdef ENABLE_SDP
55 #include "classic/sdp_util.h"
56 #endif
57 
58 // calculate combined ogf/ocf value
59 #define OPCODE(ogf, ocf) ((ocf) | ((ogf) << 10))
60 
61 /**
62  * construct HCI Command based on template
63  *
64  * Format:
65  *   1,2,3,4: one to four byte value
66  *   H: HCI connection handle
67  *   B: Bluetooth Baseband Address (BD_ADDR)
68  *   D: 8 byte data block
69  *   E: Extended Inquiry Result
70  *   N: Name up to 248 chars, \0 terminated
71  *   P: 16 byte data block. Pairing code, Simple Pairing Hash and Randomizer
72  *   A: 31 bytes advertising data
73  *   S: Service Record (Data Element Sequence)
74  *   Q: 32 byte data block, e.g. for X and Y coordinates of P-256 public key
75  */
76 uint16_t hci_cmd_create_from_template(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr){
77 
78     hci_cmd_buffer[0] = cmd->opcode & 0xffu;
79     hci_cmd_buffer[1] = cmd->opcode >> 8;
80     int pos = 3;
81 
82     const char *format = cmd->format;
83     uint16_t word;
84     uint32_t longword;
85     uint8_t * ptr;
86     while (*format) {
87         switch(*format) {
88             case '1': //  8 bit value
89             case '2': // 16 bit value
90             case 'H': // hci_handle
91                 word = va_arg(argptr, int);  // minimal va_arg is int: 2 bytes on 8+16 bit CPUs
92                 hci_cmd_buffer[pos++] = word & 0xffu;
93                 if (*format == '2') {
94                     hci_cmd_buffer[pos++] = word >> 8;
95                 } else if (*format == 'H') {
96                     // TODO implement opaque client connection handles
97                     //      pass module handle for now
98                     hci_cmd_buffer[pos++] = word >> 8;
99                 }
100                 break;
101             case '3':
102             case '4':
103                 longword = va_arg(argptr, uint32_t);
104                 // longword = va_arg(argptr, int);
105                 hci_cmd_buffer[pos++] = longword;
106                 hci_cmd_buffer[pos++] = longword >> 8;
107                 hci_cmd_buffer[pos++] = longword >> 16;
108                 if (*format == '4'){
109                     hci_cmd_buffer[pos++] = longword >> 24;
110                 }
111                 break;
112             case 'B': // bt-addr
113                 ptr = va_arg(argptr, uint8_t *);
114                 hci_cmd_buffer[pos++] = ptr[5];
115                 hci_cmd_buffer[pos++] = ptr[4];
116                 hci_cmd_buffer[pos++] = ptr[3];
117                 hci_cmd_buffer[pos++] = ptr[2];
118                 hci_cmd_buffer[pos++] = ptr[1];
119                 hci_cmd_buffer[pos++] = ptr[0];
120                 break;
121             case 'D': // 8 byte data block
122                 ptr = va_arg(argptr, uint8_t *);
123                 (void)memcpy(&hci_cmd_buffer[pos], ptr, 8);
124                 pos += 8;
125                 break;
126             case 'E': // Extended Inquiry Information 240 octets
127                 ptr = va_arg(argptr, uint8_t *);
128                 (void)memcpy(&hci_cmd_buffer[pos], ptr, 240);
129                 pos += 240;
130                 break;
131             case 'N': { // UTF-8 string, null terminated
132                 ptr = va_arg(argptr, uint8_t *);
133                 uint16_t len = strlen((const char*) ptr);
134                 if (len > 248u) {
135                     len = 248;
136                 }
137                 (void)memcpy(&hci_cmd_buffer[pos], ptr, len);
138                 if (len < 248u) {
139                     // fill remaining space with zeroes
140                     memset(&hci_cmd_buffer[pos+len], 0u, 248u-len);
141                 }
142                 pos += 248;
143                 break;
144             }
145             case 'P': // 16 byte PIN code or link key in little endian
146                 ptr = va_arg(argptr, uint8_t *);
147                 (void)memcpy(&hci_cmd_buffer[pos], ptr, 16);
148                 pos += 16;
149                 break;
150 #ifdef ENABLE_BLE
151             case 'A': // 31 bytes advertising data
152                 ptr = va_arg(argptr, uint8_t *);
153                 (void)memcpy(&hci_cmd_buffer[pos], ptr, 31);
154                 pos += 31;
155                 break;
156 #endif
157 #ifdef ENABLE_SDP
158             case 'S': { // Service Record (Data Element Sequence)
159                 ptr = va_arg(argptr, uint8_t *);
160                 uint16_t len = de_get_len(ptr);
161                 (void)memcpy(&hci_cmd_buffer[pos], ptr, len);
162                 pos += len;
163                 break;
164             }
165 #endif
166 #ifdef ENABLE_LE_SECURE_CONNECTIONS
167             case 'Q':
168                 ptr = va_arg(argptr, uint8_t *);
169                 reverse_bytes(ptr, &hci_cmd_buffer[pos], 32);
170                 pos += 32;
171                 break;
172 #endif
173             case 'K':   // 16 byte OOB Data or Link Key in big endian
174                 ptr = va_arg(argptr, uint8_t *);
175                 reverse_bytes(ptr, &hci_cmd_buffer[pos], 16);
176                 pos += 16;
177                 break;
178             default:
179                 break;
180         }
181         format++;
182     };
183     hci_cmd_buffer[2] = pos - 3;
184     return pos;
185 }
186 
187 /**
188  *  Link Control Commands
189  */
190 
191 /**
192  * @param lap
193  * @param inquiry_length
194  * @param num_responses
195  */
196 const hci_cmd_t hci_inquiry = {
197     HCI_OPCODE_HCI_INQUIRY, "311"
198 };
199 
200 /**
201  */
202 const hci_cmd_t hci_inquiry_cancel = {
203     HCI_OPCODE_HCI_INQUIRY_CANCEL, ""
204 };
205 
206 /**
207  * @param bd_addr
208  * @param packet_type
209  * @param page_scan_repetition_mode
210  * @param reserved
211  * @param clock_offset
212  * @param allow_role_switch
213  */
214 const hci_cmd_t hci_create_connection = {
215     HCI_OPCODE_HCI_CREATE_CONNECTION, "B21121"
216 };
217 
218 /**
219  * @param handle
220  * @param reason (0x05, 0x13-0x15, 0x1a, 0x29, see Errors Codes in BT Spec Part D)
221  */
222 const hci_cmd_t hci_disconnect = {
223     HCI_OPCODE_HCI_DISCONNECT, "H1"
224 };
225 
226 /**
227  * @param bd_addr
228  */
229 const hci_cmd_t hci_create_connection_cancel = {
230     HCI_OPCODE_HCI_CREATE_CONNECTION_CANCEL, "B"
231 };
232 
233 /**
234  * @param bd_addr
235  * @param role (become master, stay slave)
236  */
237 const hci_cmd_t hci_accept_connection_request = {
238     HCI_OPCODE_HCI_ACCEPT_CONNECTION_REQUEST, "B1"
239 };
240 
241 /**
242  * @param bd_addr
243  * @param reason (e.g. CONNECTION REJECTED DUE TO LIMITED RESOURCES (0x0d))
244  */
245 const hci_cmd_t hci_reject_connection_request = {
246     HCI_OPCODE_HCI_REJECT_CONNECTION_REQUEST, "B1"
247 };
248 
249 /**
250  * @param bd_addr
251  * @param link_key
252  */
253 const hci_cmd_t hci_link_key_request_reply = {
254     HCI_OPCODE_HCI_LINK_KEY_REQUEST_REPLY, "BP"
255 };
256 
257 /**
258  * @param bd_addr
259  */
260 const hci_cmd_t hci_link_key_request_negative_reply = {
261     HCI_OPCODE_HCI_LINK_KEY_REQUEST_NEGATIVE_REPLY, "B"
262 };
263 
264 /**
265  * @param bd_addr
266  * @param pin_length
267  * @param pin (c-string)
268  */
269 const hci_cmd_t hci_pin_code_request_reply = {
270     HCI_OPCODE_HCI_PIN_CODE_REQUEST_REPLY, "B1P"
271 };
272 
273 /**
274  * @param bd_addr
275  */
276 const hci_cmd_t hci_pin_code_request_negative_reply = {
277     HCI_OPCODE_HCI_PIN_CODE_REQUEST_NEGATIVE_REPLY, "B"
278 };
279 
280 /**
281  * @param handle
282  * @param packet_type
283  */
284 const hci_cmd_t hci_change_connection_packet_type = {
285     HCI_OPCODE_HCI_CHANGE_CONNECTION_PACKET_TYPE, "H2"
286 };
287 
288 /**
289  * @param handle
290  */
291 const hci_cmd_t hci_authentication_requested = {
292     HCI_OPCODE_HCI_AUTHENTICATION_REQUESTED, "H"
293 };
294 
295 /**
296  * @param handle
297  * @param encryption_enable
298  */
299 const hci_cmd_t hci_set_connection_encryption = {
300     HCI_OPCODE_HCI_SET_CONNECTION_ENCRYPTION, "H1"
301 };
302 
303 /**
304  * @param handle
305  */
306 const hci_cmd_t hci_change_connection_link_key = {
307     HCI_OPCODE_HCI_CHANGE_CONNECTION_LINK_KEY, "H"
308 };
309 
310 /**
311  * @param bd_addr
312  * @param page_scan_repetition_mode
313  * @param reserved
314  * @param clock_offset
315  */
316 const hci_cmd_t hci_remote_name_request = {
317     HCI_OPCODE_HCI_REMOTE_NAME_REQUEST, "B112"
318 };
319 
320 
321 /**
322  * @param bd_addr
323  */
324 const hci_cmd_t hci_remote_name_request_cancel = {
325     HCI_OPCODE_HCI_REMOTE_NAME_REQUEST_CANCEL, "B"
326 };
327 
328  /**
329  * @param handle
330  */
331 const hci_cmd_t hci_read_remote_supported_features_command = {
332     HCI_OPCODE_HCI_READ_REMOTE_SUPPORTED_FEATURES_COMMAND, "H"
333 };
334 
335 /**
336 * @param handle
337 */
338 const hci_cmd_t hci_read_remote_extended_features_command = {
339     HCI_OPCODE_HCI_READ_REMOTE_EXTENDED_FEATURES_COMMAND, "H1"
340 };
341 
342 /**
343  * @param handle
344  */
345 const hci_cmd_t hci_read_remote_version_information = {
346     HCI_OPCODE_HCI_READ_REMOTE_VERSION_INFORMATION, "H"
347 };
348 
349 /**
350  * @param handle
351  * @param transmit_bandwidth 8000(64kbps)
352  * @param receive_bandwidth  8000(64kbps)
353  * @param max_latency        >= 7ms for eSCO, 0xFFFF do not care
354  * @param voice_settings     e.g. CVSD, Input Coding: Linear, Input Data Format: 2’s complement, data 16bit: 00011000000 == 0x60
355  * @param retransmission_effort  e.g. 0xFF do not care
356  * @param packet_type        at least EV3 for eSCO
357  */
358 const hci_cmd_t hci_setup_synchronous_connection = {
359     HCI_OPCODE_HCI_SETUP_SYNCHRONOUS_CONNECTION, "H442212"
360 };
361 
362 /**
363  * @param bd_addr
364  * @param transmit_bandwidth
365  * @param receive_bandwidth
366  * @param max_latency
367  * @param voice_settings
368  * @param retransmission_effort
369  * @param packet_type
370  */
371 const hci_cmd_t hci_accept_synchronous_connection = {
372     HCI_OPCODE_HCI_ACCEPT_SYNCHRONOUS_CONNECTION, "B442212"
373 };
374 
375 /**
376  * @param bd_addr
377  * @param IO_capability
378  * @param OOB_data_present
379  * @param authentication_requirements
380  */
381 const hci_cmd_t hci_io_capability_request_reply = {
382     HCI_OPCODE_HCI_IO_CAPABILITY_REQUEST_REPLY, "B111"
383 };
384 
385 /**
386  * @param bd_addr
387  */
388 const hci_cmd_t hci_user_confirmation_request_reply = {
389     HCI_OPCODE_HCI_USER_CONFIRMATION_REQUEST_REPLY, "B"
390 };
391 
392 /**
393  * @param bd_addr
394  */
395 const hci_cmd_t hci_user_confirmation_request_negative_reply = {
396     HCI_OPCODE_HCI_USER_CONFIRMATION_REQUEST_NEGATIVE_REPLY, "B"
397 };
398 
399 /**
400  * @param bd_addr
401  * @param numeric_value
402  */
403 const hci_cmd_t hci_user_passkey_request_reply = {
404     HCI_OPCODE_HCI_USER_PASSKEY_REQUEST_REPLY, "B4"
405 };
406 
407 /**
408  * @param bd_addr
409  */
410 const hci_cmd_t hci_user_passkey_request_negative_reply = {
411     HCI_OPCODE_HCI_USER_PASSKEY_REQUEST_NEGATIVE_REPLY, "B"
412 };
413 
414 /**
415  * @param bd_addr
416  * @param c Simple Pairing Hash C
417  * @param r Simple Pairing Randomizer R
418  */
419 const hci_cmd_t hci_remote_oob_data_request_reply = {
420     HCI_OPCODE_HCI_REMOTE_OOB_DATA_REQUEST_REPLY, "BKK"
421 };
422 
423 /**
424  * @param bd_addr
425  */
426 const hci_cmd_t hci_remote_oob_data_request_negative_reply = {
427     HCI_OPCODE_HCI_REMOTE_OOB_DATA_REQUEST_NEGATIVE_REPLY, "B"
428 };
429 
430 /**
431  * @param bd_addr
432  * @param reason (Part D, Error codes)
433  */
434 const hci_cmd_t hci_io_capability_request_negative_reply = {
435     HCI_OPCODE_HCI_IO_CAPABILITY_REQUEST_NEGATIVE_REPLY, "B1"
436 };
437 
438 /**
439  * @param handle
440  * @param transmit_bandwidth
441  * @param receive_bandwidth
442  * @param transmit_coding_format_type
443  * @param transmit_coding_format_company
444  * @param transmit_coding_format_codec
445  * @param receive_coding_format_type
446  * @param receive_coding_format_company
447  * @param receive_coding_format_codec
448  * @param transmit_coding_frame_size
449  * @param receive_coding_frame_size
450  * @param input_bandwidth
451  * @param output_bandwidth
452  * @param input_coding_format_type
453  * @param input_coding_format_company
454  * @param input_coding_format_codec
455  * @param output_coding_format_type
456  * @param output_coding_format_company
457  * @param output_coding_format_codec
458  * @param input_coded_data_size
459  * @param outupt_coded_data_size
460  * @param input_pcm_data_format
461  * @param output_pcm_data_format
462  * @param input_pcm_sample_payload_msb_position
463  * @param output_pcm_sample_payload_msb_position
464  * @param input_data_path
465  * @param output_data_path
466  * @param input_transport_unit_size
467  * @param output_transport_unit_size
468  * @param max_latency
469  * @param packet_type
470  * @param retransmission_effort
471  */
472 const hci_cmd_t hci_enhanced_setup_synchronous_connection = {
473     HCI_OPCODE_HCI_ENHANCED_SETUP_SYNCHRONOUS_CONNECTION, "H4412212222441221222211111111221"
474 };
475 
476 /**
477  * @param bd_addr
478  * @param transmit_bandwidth
479  * @param receive_bandwidth
480  * @param transmit_coding_format_type
481  * @param transmit_coding_format_company
482  * @param transmit_coding_format_codec
483  * @param receive_coding_format_type
484  * @param receive_coding_format_company
485  * @param receive_coding_format_codec
486  * @param transmit_coding_frame_size
487  * @param receive_coding_frame_size
488  * @param input_bandwidth
489  * @param output_bandwidth
490  * @param input_coding_format_type
491  * @param input_coding_format_company
492  * @param input_coding_format_codec
493  * @param output_coding_format_type
494  * @param output_coding_format_company
495  * @param output_coding_format_codec
496  * @param input_coded_data_size
497  * @param outupt_coded_data_size
498  * @param input_pcm_data_format
499  * @param output_pcm_data_format
500  * @param input_pcm_sample_payload_msb_position
501  * @param output_pcm_sample_payload_msb_position
502  * @param input_data_path
503  * @param output_data_path
504  * @param input_transport_unit_size
505  * @param output_transport_unit_size
506  * @param max_latency
507  * @param packet_type
508  * @param retransmission_effort
509  */
510 const hci_cmd_t hci_enhanced_accept_synchronous_connection = {
511     HCI_OPCODE_HCI_ENHANCED_ACCEPT_SYNCHRONOUS_CONNECTION, "B4412212222441221222211111111221"
512 };
513 
514 /**
515  * @param bd_addr
516  * @param c_192 Simple Pairing Hash C derived from P-192 public key
517  * @param r_192 Simple Pairing Randomizer derived from P-192 public key
518  * @param c_256 Simple Pairing Hash C derived from P-256 public key
519  * @param r_256 Simple Pairing Randomizer derived from P-256 public key
520  */
521 const hci_cmd_t hci_remote_oob_extended_data_request_reply = {
522         HCI_OPCODE_HCI_REMOTE_OOB_EXTENDED_DATA_REQUEST_REPLY, "BKKKK"
523 };
524 
525 /**
526  *  Link Policy Commands
527  */
528 
529 /**
530  * @param handle
531  * @param sniff_max_interval
532  * @param sniff_min_interval
533  * @param sniff_attempt
534  * @param sniff_timeout
535  */
536 const hci_cmd_t hci_sniff_mode = {
537     HCI_OPCODE_HCI_SNIFF_MODE, "H2222"
538 };
539 
540 /**
541  * @param handle
542  */
543 const hci_cmd_t hci_exit_sniff_mode = {
544     HCI_OPCODE_HCI_EXIT_SNIFF_MODE, "H"
545 };
546 
547 /**
548  * @param handle
549  * @param flags
550  * @param service_type
551  * @param token_rate (bytes/s)
552  * @param peak_bandwith (bytes/s)
553  * @param latency (us)
554  * @param delay_variation (us)
555  */
556 const hci_cmd_t hci_qos_setup = {
557     HCI_OPCODE_HCI_QOS_SETUP, "H114444"
558 };
559 
560 /**
561  * @param handle
562  */
563 const hci_cmd_t hci_role_discovery = {
564     HCI_OPCODE_HCI_ROLE_DISCOVERY, "H"
565 };
566 
567 /**
568  * @param bd_addr
569  * @param role (0=master,1=slave)
570  */
571 const hci_cmd_t hci_switch_role_command= {
572     HCI_OPCODE_HCI_SWITCH_ROLE_COMMAND, "B1"
573 };
574 
575 /**
576  * @param handle
577  */
578 const hci_cmd_t hci_read_link_policy_settings = {
579     HCI_OPCODE_HCI_READ_LINK_POLICY_SETTINGS, "H"
580 };
581 
582 /**
583  * @param handle
584  * @param settings
585  */
586 const hci_cmd_t hci_write_link_policy_settings = {
587     HCI_OPCODE_HCI_WRITE_LINK_POLICY_SETTINGS, "H2"
588 };
589 
590 /**
591  * @param handle
592  * @param max_latency
593  * @param min_remote_timeout
594  * @param min_local_timeout
595  */
596 const hci_cmd_t hci_sniff_subrating = {
597         HCI_OPCODE_HCI_SNIFF_SUBRATING, "H222"
598 };
599 
600 /**
601  * @param policy
602  */
603 const hci_cmd_t hci_write_default_link_policy_setting = {
604     HCI_OPCODE_HCI_WRITE_DEFAULT_LINK_POLICY_SETTING, "2"
605 };
606 
607 /**
608  * @param handle
609  * @param unused
610  * @param flow_direction
611  * @param service_type
612  * @param token_rate
613  * @param token_bucket_size
614  * @param peak_bandwidth
615  * @param access_latency
616  */
617 const hci_cmd_t hci_flow_specification = {
618         HCI_OPCODE_HCI_FLOW_SPECIFICATION, "H1114444"
619 };
620 
621 
622 /**
623  *  Controller & Baseband Commands
624  */
625 
626 
627 /**
628  * @param event_mask_lover_octets
629  * @param event_mask_higher_octets
630  */
631 const hci_cmd_t hci_set_event_mask = {
632     HCI_OPCODE_HCI_SET_EVENT_MASK, "44"
633 };
634 
635 /**
636  */
637 const hci_cmd_t hci_reset = {
638     HCI_OPCODE_HCI_RESET, ""
639 };
640 
641 /**
642  * @param handle
643  */
644 const hci_cmd_t hci_flush = {
645     HCI_OPCODE_HCI_FLUSH, "H"
646 };
647 
648 /**
649  * @param handle
650  */
651 const hci_cmd_t hci_read_pin_type = {
652     HCI_OPCODE_HCI_READ_PIN_TYPE, ""
653 };
654 
655 /**
656  * @param handle
657  */
658 const hci_cmd_t hci_write_pin_type = {
659     HCI_OPCODE_HCI_WRITE_PIN_TYPE, "1"
660 };
661 
662 /**
663  * @param bd_addr
664  * @param delete_all_flags
665  */
666 const hci_cmd_t hci_delete_stored_link_key = {
667     HCI_OPCODE_HCI_DELETE_STORED_LINK_KEY, "B1"
668 };
669 
670 #ifdef ENABLE_CLASSIC
671 /**
672  * @param local_name (UTF-8, Null Terminated, max 248 octets)
673  */
674 const hci_cmd_t hci_write_local_name = {
675     HCI_OPCODE_HCI_WRITE_LOCAL_NAME, "N"
676 };
677 #endif
678 
679 /**
680  */
681 const hci_cmd_t hci_read_local_name = {
682     HCI_OPCODE_HCI_READ_LOCAL_NAME, ""
683 };
684 
685 /**
686  */
687 const hci_cmd_t hci_read_page_timeout = {
688     HCI_OPCODE_HCI_READ_PAGE_TIMEOUT, ""
689 };
690 
691 /**
692  * @param page_timeout (* 0.625 ms)
693  */
694 const hci_cmd_t hci_write_page_timeout = {
695     HCI_OPCODE_HCI_WRITE_PAGE_TIMEOUT, "2"
696 };
697 
698 /**
699  * @param scan_enable (no, inq, page, inq+page)
700  */
701 const hci_cmd_t hci_write_scan_enable = {
702     HCI_OPCODE_HCI_WRITE_SCAN_ENABLE, "1"
703 };
704 
705 /**
706  */
707 const hci_cmd_t hci_read_page_scan_activity = {
708     HCI_OPCODE_HCI_READ_PAGE_SCAN_ACTIVITY, ""
709 };
710 
711 /**
712  * @param page_scan_interval (* 0.625 ms)
713  * @param page_scan_window (* 0.625 ms, must be <= page_scan_interval)
714  */
715 const hci_cmd_t hci_write_page_scan_activity = {
716     HCI_OPCODE_HCI_WRITE_PAGE_SCAN_ACTIVITY, "22"
717 };
718 
719 /**
720  */
721 const hci_cmd_t hci_read_inquiry_scan_activity = {
722     HCI_OPCODE_HCI_READ_INQUIRY_SCAN_ACTIVITY, ""
723 };
724 
725 /**
726  * @param inquiry_scan_interval (* 0.625 ms)
727  * @param inquiry_scan_window (* 0.625 ms, must be <= inquiry_scan_interval)
728  */
729 const hci_cmd_t hci_write_inquiry_scan_activity = {
730     HCI_OPCODE_HCI_WRITE_INQUIRY_SCAN_ACTIVITY, "22"
731 };
732 
733 /**
734  * @param authentication_enable
735  */
736 const hci_cmd_t hci_write_authentication_enable = {
737     HCI_OPCODE_HCI_WRITE_AUTHENTICATION_ENABLE, "1"
738 };
739 
740 /**
741  * @param class_of_device
742  */
743 const hci_cmd_t hci_write_class_of_device = {
744     HCI_OPCODE_HCI_WRITE_CLASS_OF_DEVICE, "3"
745 };
746 
747 /**
748  */
749 const hci_cmd_t hci_read_num_broadcast_retransmissions = {
750     HCI_OPCODE_HCI_READ_NUM_BROADCAST_RETRANSMISSIONS, ""
751 };
752 
753 /**
754  * @param num_broadcast_retransmissions (e.g. 0 for a single broadcast)
755  */
756 const hci_cmd_t hci_write_num_broadcast_retransmissions = {
757     HCI_OPCODE_HCI_WRITE_NUM_BROADCAST_RETRANSMISSIONS, "1"
758 };
759 
760 /**
761  * @param connection_handle
762  * @param type 0 = current transmit level, 1 = max transmit level
763  */
764 const hci_cmd_t hci_read_transmit_power_level = {
765     HCI_OPCODE_HCI_READ_TRANSMIT_POWER_LEVEL, "11"
766 };
767 
768 /**
769  * @param synchronous_flow_control_enable - if yes, num completed packet everts are sent for SCO packets
770  */
771 const hci_cmd_t hci_write_synchronous_flow_control_enable = {
772     HCI_OPCODE_HCI_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, "1"
773 };
774 
775 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL
776 
777 /**
778  * @param flow_control_enable - 0: off, 1: ACL only, 2: SCO only, 3: ACL + SCO
779  */
780 const hci_cmd_t hci_set_controller_to_host_flow_control = {
781     HCI_OPCODE_HCI_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, "1"
782 };
783 
784 /**
785  * @param host_acl_data_packet_length
786  * @param host_synchronous_data_packet_length
787  * @param host_total_num_acl_data_packets
788  * @param host_total_num_synchronous_data_packets
789  */
790 const hci_cmd_t hci_host_buffer_size = {
791     HCI_OPCODE_HCI_HOST_BUFFER_SIZE, "2122"
792 };
793 
794 
795 #if 0
796 //
797 // command sent manually sent by hci_host_num_completed_packets
798 //
799 /**
800  * @note only single handle supported by BTstack command generator
801  * @param number_of_handles must be 1
802  * @param connection_handle
803  * @param host_num_of_completed_packets for the given connection handle
804  */
805 const hci_cmd_t hci_host_number_of_completed_packets = {
806     HCI_OPCODE_HCI_HOST_NUMBER_OF_COMPLETED_PACKETS, "1H2"
807 };
808 #endif
809 
810 #endif
811 
812 /**
813  * @param handle
814  */
815 const hci_cmd_t hci_read_link_supervision_timeout = {
816     HCI_OPCODE_HCI_READ_LINK_SUPERVISION_TIMEOUT, "H"
817 };
818 
819 /**
820  * @param handle
821  * @param timeout (0x0001 - 0xFFFF Time -> Range: 0.625ms - 40.9 sec)
822  */
823 const hci_cmd_t hci_write_link_supervision_timeout = {
824     HCI_OPCODE_HCI_WRITE_LINK_SUPERVISION_TIMEOUT, "H2"
825 };
826 
827 /**
828  * @param num_current_iac must be 2
829  * @param iac_lap1
830  * @param iac_lap2
831  */
832 const hci_cmd_t hci_write_current_iac_lap_two_iacs = {
833     HCI_OPCODE_HCI_WRITE_CURRENT_IAC_LAP_TWO_IACS, "133"
834 };
835 
836 /**
837  * @param inquiry_scan_type (0x00 = standard, 0x01 = interlaced)
838  */
839 const hci_cmd_t hci_write_inquiry_scan_type = {
840     HCI_OPCODE_HCI_WRITE_INQUIRY_SCAN_TYPE,  "1"
841 };
842 
843 /**
844  * @param inquiry_mode (0x00 = standard, 0x01 = with RSSI, 0x02 = extended)
845  */
846 const hci_cmd_t hci_write_inquiry_mode = {
847     HCI_OPCODE_HCI_WRITE_INQUIRY_MODE, "1"
848 };
849 
850 /**
851  * @param page_scan_type (0x00 = standard, 0x01 = interlaced)
852  */
853 const hci_cmd_t hci_write_page_scan_type = {
854     HCI_OPCODE_HCI_WRITE_PAGE_SCAN_TYPE, "1"
855 };
856 
857 /**
858  * @param fec_required
859  * @param exstended_inquiry_response
860  */
861 const hci_cmd_t hci_write_extended_inquiry_response = {
862     HCI_OPCODE_HCI_WRITE_EXTENDED_INQUIRY_RESPONSE, "1E"
863 };
864 
865 /**
866  * @param mode (0 = off, 1 = on)
867  */
868 const hci_cmd_t hci_write_simple_pairing_mode = {
869     HCI_OPCODE_HCI_WRITE_SIMPLE_PAIRING_MODE, "1"
870 };
871 
872 /**
873  */
874 const hci_cmd_t hci_read_local_oob_data = {
875     HCI_OPCODE_HCI_READ_LOCAL_OOB_DATA, ""
876     // return status, C, R
877 };
878 
879 /**
880  * @param mode (0 = off, 1 = on)
881  */
882 const hci_cmd_t hci_write_default_erroneous_data_reporting = {
883     HCI_OPCODE_HCI_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, "1"
884 };
885 
886 /**
887  */
888 const hci_cmd_t hci_read_le_host_supported = {
889     HCI_OPCODE_HCI_READ_LE_HOST_SUPPORTED, ""
890     // return: status, le supported host, simultaneous le host
891 };
892 
893 /**
894  * @param le_supported_host
895  * @param simultaneous_le_host
896  */
897 const hci_cmd_t hci_write_le_host_supported = {
898     HCI_OPCODE_HCI_WRITE_LE_HOST_SUPPORTED, "11"
899     // return: status
900 };
901 
902 /**
903  * @param secure_connections_host_support
904  */
905 const hci_cmd_t hci_write_secure_connections_host_support = {
906     HCI_OPCODE_HCI_WRITE_SECURE_CONNECTIONS_HOST_SUPPORT, "1"
907     // return: status
908 };
909 
910 /**
911  */
912 const hci_cmd_t hci_read_local_extended_oob_data = {
913     HCI_OPCODE_HCI_READ_LOCAL_EXTENDED_OOB_DATA, ""
914     // return status, C_192, R_192, R_256, C_256
915 };
916 
917 
918 /**
919  * Testing Commands
920  */
921 
922 
923 /**
924  */
925 const hci_cmd_t hci_read_loopback_mode = {
926     HCI_OPCODE_HCI_READ_LOOPBACK_MODE, ""
927     // return: status, loopback mode (0 = off, 1 = local loopback, 2 = remote loopback)
928 };
929 
930 /**
931  * @param loopback_mode
932  */
933 const hci_cmd_t hci_write_loopback_mode = {
934     HCI_OPCODE_HCI_WRITE_LOOPBACK_MODE, "1"
935     // return: status
936 };
937 
938 /**
939  */
940 const hci_cmd_t hci_enable_device_under_test_mode = {
941     HCI_OPCODE_HCI_ENABLE_DEVICE_UNDER_TEST_MODE, ""
942     // return: status
943 };
944 
945 /**
946  * @param simple_pairing_debug_mode
947  */
948 const hci_cmd_t hci_write_simple_pairing_debug_mode = {
949     HCI_OPCODE_HCI_WRITE_SIMPLE_PAIRING_DEBUG_MODE, "1"
950     // return: status
951 };
952 
953 /**
954  * @param handle
955  * @param dm1_acl_u_mode
956  * @param esco_loopback_mode
957  */
958 const hci_cmd_t hci_write_secure_connections_test_mode = {
959     HCI_OPCODE_HCI_WRITE_SECURE_CONNECTIONS_TEST_MODE, "H11"
960     // return: status
961 };
962 
963 
964 /**
965  * Informational Parameters
966  */
967 
968 const hci_cmd_t hci_read_local_version_information = {
969     HCI_OPCODE_HCI_READ_LOCAL_VERSION_INFORMATION, ""
970 };
971 const hci_cmd_t hci_read_local_supported_commands = {
972     HCI_OPCODE_HCI_READ_LOCAL_SUPPORTED_COMMANDS, ""
973 };
974 const hci_cmd_t hci_read_local_supported_features = {
975     HCI_OPCODE_HCI_READ_LOCAL_SUPPORTED_FEATURES, ""
976 };
977 const hci_cmd_t hci_read_buffer_size = {
978     HCI_OPCODE_HCI_READ_BUFFER_SIZE, ""
979 };
980 const hci_cmd_t hci_read_bd_addr = {
981     HCI_OPCODE_HCI_READ_BD_ADDR, ""
982 };
983 
984 /**
985  * Status Paramters
986  */
987 
988 /**
989  * @param handle
990  */
991 const hci_cmd_t hci_read_rssi = {
992     HCI_OPCODE_HCI_READ_RSSI, "H"
993 };
994 
995 /**
996  * @param handle
997  */
998 const hci_cmd_t hci_read_encryption_key_size = {
999     HCI_OPCODE_HCI_READ_ENCRYPTION_KEY_SIZE, "H"
1000 };
1001 
1002 
1003 #ifdef ENABLE_BLE
1004 /**
1005  * Low Energy Commands
1006  */
1007 
1008 /**
1009  * @param event_mask_lower_octets
1010  * @param event_mask_higher_octets
1011  */
1012 const hci_cmd_t hci_le_set_event_mask = {
1013     HCI_OPCODE_HCI_LE_SET_EVENT_MASK, "44"
1014     // return: status
1015 };
1016 
1017 const hci_cmd_t hci_le_read_buffer_size = {
1018     HCI_OPCODE_HCI_LE_READ_BUFFER_SIZE, ""
1019     // return: status, le acl data packet len (16), total num le acl data packets(8)
1020 };
1021 const hci_cmd_t hci_le_read_supported_features = {
1022     HCI_OPCODE_HCI_LE_READ_SUPPORTED_FEATURES, ""
1023     // return: LE_Features See [Vol 6] Part B, Section 4.6
1024 };
1025 
1026 /**
1027  * @param random_bd_addr
1028  */
1029 const hci_cmd_t hci_le_set_random_address = {
1030     HCI_OPCODE_HCI_LE_SET_RANDOM_ADDRESS, "B"
1031     // return: status
1032 };
1033 
1034 /**
1035  * @param advertising_interval_min ([0x0020,0x4000], default: 0x0800, unit: 0.625 msec)
1036  * @param advertising_interval_max ([0x0020,0x4000], default: 0x0800, unit: 0.625 msec)
1037  * @param advertising_type (enum from 0: ADV_IND, ADC_DIRECT_IND, ADV_SCAN_IND, ADV_NONCONN_IND)
1038  * @param own_address_type (enum from 0: public device address, random device address)
1039  * @param direct_address_type ()
1040  * @param direct_address (public or random address of device to be connecteed)
1041  * @param advertising_channel_map (flags: chan_37(1), chan_38(2), chan_39(4))
1042  * @param advertising_filter_policy (enum from 0: scan any conn any, scan whitelist, con any, scan any conn whitelist, scan whitelist, con whitelist)
1043  */
1044 const hci_cmd_t hci_le_set_advertising_parameters = {
1045     HCI_OPCODE_HCI_LE_SET_ADVERTISING_PARAMETERS, "22111B11"
1046     // return: status
1047 };
1048 
1049 const hci_cmd_t hci_le_read_advertising_channel_tx_power = {
1050     HCI_OPCODE_HCI_LE_READ_ADVERTISING_CHANNEL_TX_POWER, ""
1051     // return: status, level [-20,10] signed int (8), units dBm
1052 };
1053 
1054 /**
1055  * @param advertising_data_length
1056  * @param advertising_data (31 bytes)
1057  */
1058 const hci_cmd_t hci_le_set_advertising_data= {
1059     HCI_OPCODE_HCI_LE_SET_ADVERTISING_DATA, "1A"
1060     // return: status
1061 };
1062 
1063 /**
1064  * @param scan_response_data_length
1065  * @param scan_response_data (31 bytes)
1066  */
1067 const hci_cmd_t hci_le_set_scan_response_data= {
1068     HCI_OPCODE_HCI_LE_SET_SCAN_RESPONSE_DATA, "1A"
1069     // return: status
1070 };
1071 
1072 /**
1073  * @param advertise_enable (off: 0, on: 1)
1074  */
1075 const hci_cmd_t hci_le_set_advertise_enable = {
1076     HCI_OPCODE_HCI_LE_SET_ADVERTISE_ENABLE, "1"
1077     // return: status
1078 };
1079 
1080 /**
1081  * @param le_scan_type (passive (0), active (1))
1082  * @param le_scan_interval ([0x0004,0x4000], unit: 0.625 msec)
1083  * @param le_scan_window   ([0x0004,0x4000], unit: 0.625 msec)
1084  * @param own_address_type (public (0), random (1))
1085  * @param scanning_filter_policy (any (0), only whitelist (1))
1086  */
1087 const hci_cmd_t hci_le_set_scan_parameters = {
1088     HCI_OPCODE_HCI_LE_SET_SCAN_PARAMETERS, "12211"
1089     // return: status
1090 };
1091 
1092 /**
1093  * @param le_scan_enable  (disabled (0), enabled (1))
1094  * @param filter_duplices (disabled (0), enabled (1))
1095  */
1096 const hci_cmd_t hci_le_set_scan_enable = {
1097     HCI_OPCODE_HCI_LE_SET_SCAN_ENABLE, "11"
1098     // return: status
1099 };
1100 
1101 /**
1102  * @param le_scan_interval ([0x0004, 0x4000], unit: 0.625 msec)
1103  * @param le_scan_window ([0x0004, 0x4000], unit: 0.625 msec)
1104  * @param initiator_filter_policy (peer address type + peer address (0), whitelist (1))
1105  * @param peer_address_type (public (0), random (1))
1106  * @param peer_address
1107  * @param own_address_type (public (0), random (1))
1108  * @param conn_interval_min ([0x0006, 0x0c80], unit: 1.25 msec)
1109  * @param conn_interval_max ([0x0006, 0x0c80], unit: 1.25 msec)
1110  * @param conn_latency (number of connection events [0x0000, 0x01f4])
1111  * @param supervision_timeout ([0x000a, 0x0c80], unit: 10 msec)
1112  * @param minimum_CE_length ([0x0000, 0xffff], unit: 0.625 msec)
1113  * @param maximum_CE_length ([0x0000, 0xffff], unit: 0.625 msec)
1114  */
1115 const hci_cmd_t hci_le_create_connection= {
1116     HCI_OPCODE_HCI_LE_CREATE_CONNECTION, "2211B1222222"
1117     // return: none -> le create connection complete event
1118 };
1119 
1120 const hci_cmd_t hci_le_create_connection_cancel = {
1121     HCI_OPCODE_HCI_LE_CREATE_CONNECTION_CANCEL, ""
1122     // return: status
1123 };
1124 
1125 const hci_cmd_t hci_le_read_white_list_size = {
1126     HCI_OPCODE_HCI_LE_READ_WHITE_LIST_SIZE, ""
1127     // return: status, number of entries in controller whitelist
1128 };
1129 
1130 const hci_cmd_t hci_le_clear_white_list = {
1131     HCI_OPCODE_HCI_LE_CLEAR_WHITE_LIST, ""
1132     // return: status
1133 };
1134 
1135 /**
1136  * @param address_type (public (0), random (1))
1137  * @param bd_addr
1138  */
1139 const hci_cmd_t hci_le_add_device_to_white_list = {
1140     HCI_OPCODE_HCI_LE_ADD_DEVICE_TO_WHITE_LIST, "1B"
1141     // return: status
1142 };
1143 
1144 /**
1145  * @param address_type (public (0), random (1))
1146  * @param bd_addr
1147  */
1148 const hci_cmd_t hci_le_remove_device_from_white_list = {
1149     HCI_OPCODE_HCI_LE_REMOVE_DEVICE_FROM_WHITE_LIST, "1B"
1150     // return: status
1151 };
1152 
1153 /**
1154  * @param conn_handle
1155  * @param conn_interval_min ([0x0006,0x0c80], unit: 1.25 msec)
1156  * @param conn_interval_max ([0x0006,0x0c80], unit: 1.25 msec)
1157  * @param conn_latency ([0x0000,0x03e8], number of connection events)
1158  * @param supervision_timeout ([0x000a,0x0c80], unit: 10 msec)
1159  * @param minimum_CE_length ([0x0000,0xffff], unit: 0.625 msec)
1160  * @param maximum_CE_length ([0x0000,0xffff], unit: 0.625 msec)
1161  */
1162 const hci_cmd_t hci_le_connection_update = {
1163     HCI_OPCODE_HCI_LE_CONNECTION_UPDATE, "H222222"
1164     // return: none -> le connection update complete event
1165 };
1166 
1167 /**
1168  * @param channel_map_lower_32bits
1169  * @param channel_map_higher_5bits
1170  */
1171 const hci_cmd_t hci_le_set_host_channel_classification = {
1172     HCI_OPCODE_HCI_LE_SET_HOST_CHANNEL_CLASSIFICATION, "41"
1173     // return: status
1174 };
1175 
1176 /**
1177  * @param conn_handle
1178  */
1179 const hci_cmd_t hci_le_read_channel_map = {
1180     HCI_OPCODE_HCI_LE_READ_CHANNEL_MAP, "H"
1181     // return: status, connection handle, channel map (5 bytes, 37 used)
1182 };
1183 
1184 /**
1185  * @param conn_handle
1186  */
1187 const hci_cmd_t hci_le_read_remote_used_features = {
1188     HCI_OPCODE_HCI_LE_READ_REMOTE_USED_FEATURES, "H"
1189     // return: none -> le read remote used features complete event
1190 };
1191 
1192 /**
1193  * @param key ((128) for AES-128)
1194  * @param plain_text (128)
1195  */
1196 const hci_cmd_t hci_le_encrypt = {
1197     HCI_OPCODE_HCI_LE_ENCRYPT, "PP"
1198     // return: status, encrypted data (128)
1199 };
1200 
1201 const hci_cmd_t hci_le_rand = {
1202     HCI_OPCODE_HCI_LE_RAND, ""
1203     // return: status, random number (64)
1204 };
1205 
1206 /**
1207  * @param conn_handle
1208  * @param random_number_lower_32bits
1209  * @param random_number_higher_32bits
1210  * @param encryption_diversifier (16)
1211  * @param long_term_key (128)
1212  */
1213 const hci_cmd_t hci_le_start_encryption = {
1214     HCI_OPCODE_HCI_LE_START_ENCRYPTION, "H442P"
1215     // return: none -> encryption changed or encryption key refresh complete event
1216 };
1217 
1218 /**
1219  * @param connection_handle
1220  * @param long_term_key (128)
1221  */
1222 const hci_cmd_t hci_le_long_term_key_request_reply = {
1223     HCI_OPCODE_HCI_LE_LONG_TERM_KEY_REQUEST_REPLY, "HP"
1224     // return: status, connection handle
1225 };
1226 
1227 /**
1228  * @param conn_handle
1229  */
1230 const hci_cmd_t hci_le_long_term_key_negative_reply = {
1231     HCI_OPCODE_HCI_LE_LONG_TERM_KEY_NEGATIVE_REPLY, "H"
1232     // return: status, connection handle
1233 };
1234 
1235 /**
1236  * @param conn_handle
1237  */
1238 const hci_cmd_t hci_le_read_supported_states = {
1239     HCI_OPCODE_HCI_LE_READ_SUPPORTED_STATES, "H"
1240     // return: status, LE states (64)
1241 };
1242 
1243 /**
1244  * @param rx_frequency ([0x00 0x27], frequency (MHz): 2420 + N*2)
1245  */
1246 const hci_cmd_t hci_le_receiver_test = {
1247     HCI_OPCODE_HCI_LE_RECEIVER_TEST, "1"
1248     // return: status
1249 };
1250 
1251 /**
1252  * @param tx_frequency ([0x00 0x27], frequency (MHz): 2420 + N*2)
1253  * @param test_payload_lengh ([0x00,0x25])
1254  * @param packet_payload ([0,7] different patterns)
1255  */
1256 const hci_cmd_t hci_le_transmitter_test = {
1257     HCI_OPCODE_HCI_LE_TRANSMITTER_TEST, "111"
1258     // return: status
1259 };
1260 
1261 /**
1262  * @param end_test_cmd
1263  */
1264 const hci_cmd_t hci_le_test_end = {
1265     HCI_OPCODE_HCI_LE_TEST_END, "1"
1266     // return: status, number of packets (8)
1267 };
1268 
1269 /**
1270  * @param conn_handle
1271  * @param conn_interval_min ([0x0006,0x0c80], unit: 1.25 msec)
1272  * @param conn_interval_max ([0x0006,0x0c80], unit: 1.25 msec)
1273  * @param conn_latency ([0x0000,0x03e8], number of connection events)
1274  * @param supervision_timeout ([0x000a,0x0c80], unit: 10 msec)
1275  * @param minimum_CE_length ([0x0000,0xffff], unit: 0.625 msec)
1276  * @param maximum_CE_length ([0x0000,0xffff], unit: 0.625 msec)
1277  */
1278 const hci_cmd_t hci_le_remote_connection_parameter_request_reply = {
1279     HCI_OPCODE_HCI_LE_REMOTE_CONNECTION_PARAMETER_REQUEST_REPLY, "H222222"
1280     // return: status, connection handle
1281 };
1282 
1283 /**
1284  * @param con_handle
1285  * @param reason
1286  */
1287 const hci_cmd_t hci_le_remote_connection_parameter_request_negative_reply = {
1288     HCI_OPCODE_HCI_LE_REMOTE_CONNECTION_PARAMETER_REQUEST_NEGATIVE_REPLY, "H1"
1289     // return: status, connection handle
1290 };
1291 
1292 /**
1293  * @param con_handle
1294  * @param tx_octets
1295  * @param tx_time
1296  */
1297 const hci_cmd_t hci_le_set_data_length = {
1298     HCI_OPCODE_HCI_LE_SET_DATA_LENGTH, "H22"
1299     // return: status, connection handle
1300 };
1301 
1302 /**
1303  */
1304 const hci_cmd_t hci_le_read_suggested_default_data_length = {
1305     HCI_OPCODE_HCI_LE_READ_SUGGESTED_DEFAULT_DATA_LENGTH, ""
1306     // return: status, suggested max tx octets, suggested max tx time
1307 };
1308 
1309 /**
1310  * @param suggested_max_tx_octets
1311  * @param suggested_max_tx_time
1312  */
1313 const hci_cmd_t hci_le_write_suggested_default_data_length = {
1314     HCI_OPCODE_HCI_LE_WRITE_SUGGESTED_DEFAULT_DATA_LENGTH, "22"
1315     // return: status
1316 };
1317 
1318 /**
1319  */
1320 const hci_cmd_t hci_le_read_local_p256_public_key = {
1321     HCI_OPCODE_HCI_LE_READ_LOCAL_P256_PUBLIC_KEY, ""
1322 //  LE Read Local P-256 Public Key Complete is generated on completion
1323 };
1324 
1325 /**
1326  * @param public key
1327  * @param private key
1328  */
1329 const hci_cmd_t hci_le_generate_dhkey = {
1330     HCI_OPCODE_HCI_LE_GENERATE_DHKEY, "QQ"
1331 // LE Generate DHKey Complete is generated on completion
1332 };
1333 
1334 /**
1335  * @param Peer_Identity_Address_Type
1336  * @param Peer_Identity_Address
1337  * @param Peer_IRK
1338  * @param Local_IRK
1339  */
1340 const hci_cmd_t hci_le_add_device_to_resolving_list = {
1341         HCI_OPCODE_HCI_LE_ADD_DEVICE_TO_RESOLVING_LIST, "1BPP"
1342 };
1343 
1344 /**
1345  * @param Peer_Identity_Address_Type
1346  * @param Peer_Identity_Address
1347  */
1348 const hci_cmd_t hci_le_remove_device_from_resolving_list = {
1349         HCI_OPCODE_HCI_LE_REMOVE_DEVICE_FROM_RESOLVING_LIST, "1B"
1350 };
1351 
1352 /**
1353  */
1354 const hci_cmd_t hci_le_clear_resolving_list = {
1355         HCI_OPCODE_HCI_LE_CLEAR_RESOLVING_LIST, ""
1356 };
1357 
1358 /**
1359  */
1360 const hci_cmd_t hci_le_read_resolving_list_size = {
1361         HCI_OPCODE_HCI_LE_READ_RESOLVING_LIST_SIZE, ""
1362 };
1363 
1364 /**
1365  * @param Peer_Identity_Address_Type
1366  * @param Peer_Identity_Address
1367  */
1368 const hci_cmd_t hci_le_read_peer_resolvable_address = {
1369         HCI_OPCODE_HCI_LE_READ_PEER_RESOLVABLE_ADDRESS, ""
1370 };
1371 
1372 /**
1373  * @param Peer_Identity_Address_Type
1374  * @param Peer_Identity_Address
1375  */
1376 const hci_cmd_t hci_le_read_local_resolvable_address = {
1377         HCI_OPCODE_HCI_LE_READ_LOCAL_RESOLVABLE_ADDRESS, ""
1378 };
1379 
1380 /**
1381  * @param Address_Resolution_Enable
1382  */
1383 const hci_cmd_t hci_le_set_address_resolution_enabled= {
1384         HCI_OPCODE_HCI_LE_SET_ADDRESS_RESOLUTION_ENABLED, "1"
1385 };
1386 
1387 /**
1388  * @param RPA_Timeout in seconds, range 0x0001 to 0x0E10, default: 900 s
1389  */
1390 const hci_cmd_t hci_le_set_resolvable_private_address_timeout= {
1391         HCI_OPCODE_HCI_LE_SET_RESOLVABLE_PRIVATE_ADDRESS_TIMEOUT, "2"
1392 };
1393 
1394 /**
1395  */
1396 const hci_cmd_t hci_le_read_maximum_data_length = {
1397     HCI_OPCODE_HCI_LE_READ_MAXIMUM_DATA_LENGTH, ""
1398     // return: status, supported max tx octets, supported max tx time, supported max rx octets, supported max rx time
1399 };
1400 
1401 /**
1402  * @param con_handle
1403  */
1404 const hci_cmd_t hci_le_read_phy = {
1405     HCI_OPCODE_HCI_LE_READ_PHY, "H"
1406     // return: status, connection handler, tx phy, rx phy
1407 };
1408 
1409 /**
1410  * @param all_phys
1411  * @param tx_phys
1412  * @param rx_phys
1413  */
1414 const hci_cmd_t hci_le_set_default_phy = {
1415     HCI_OPCODE_HCI_LE_SET_DEFAULT_PHY, "111"
1416     // return: status
1417 };
1418 
1419 /**
1420  * @param con_handle
1421  * @param all_phys
1422  * @param tx_phys
1423  * @param rx_phys
1424  * @param phy_options
1425  */
1426 const hci_cmd_t hci_le_set_phy = {
1427     HCI_OPCODE_HCI_LE_SET_PHY, "H1111"
1428 // LE PHY Update Complete is generated on completion
1429 };
1430 
1431 
1432 #endif
1433 
1434 // Broadcom / Cypress specific HCI commands
1435 
1436 /**
1437  * @brief Enable Wide-Band Speech / mSBC decoding for PCM
1438  * @param enable_wbs is 0 for disable, 1 for enable
1439  * @param uuid_wbs is 2 for EV2/EV3
1440  */
1441 const hci_cmd_t hci_bcm_enable_wbs = {
1442         HCI_OPCODE_HCI_BCM_ENABLE_WBS, "12"
1443         // return: status
1444 };
1445 
1446 /**
1447  * @brief Configure SCO Routing (BCM)
1448  * @param sco_routing is 0 for PCM, 1 for Transport, 2 for Codec and 3 for I2S
1449  * @param pcm_interface_rate is 0 for 128KBps, 1 for 256 KBps, 2 for 512KBps, 3 for 1024KBps, and 4 for 2048Kbps
1450  * @param frame_type is 0 for short and 1 for long
1451  * @param sync_mode is 0 for slave and 1 for master
1452  * @param clock_mode is 0 for slabe and 1 for master
1453  */
1454 const hci_cmd_t hci_bcm_write_sco_pcm_int = {
1455     HCI_OPCODE_HCI_BCM_WRITE_SCO_PCM_INT, "11111"
1456     // return: status
1457 };
1458 
1459 /**
1460  * @brief Configure the I2S/PCM interface (BCM)
1461  * @param i2s_enable is 0 for off, 1 for on
1462  * @param is_master is 0 for slave, is 1 for master
1463  * @param sample_rate is 0 for 8 kHz, 1 for 16 kHz, 2 for 4 kHz
1464  * @param clock_rate is 0 for 128 kz, 1 for 256 kHz, 2 for 512 khz, 3 for 1024 kHz, 4 for 2048 khz
1465  * @param clock_mode is 0 for slabe and 1 for master
1466  */
1467 const hci_cmd_t hci_bcm_write_i2spcm_interface_param = {
1468         HCI_OPCODE_HCI_BCM_WRITE_I2SPCM_INTERFACE_PARAM, "1111"
1469         // return: status
1470 };
1471 
1472 
1473 /**
1474  * @brief Activates selected Sleep Mode
1475  * @param sleep_mode: 0=no sleep, 1=UART, 2=UART with Messaging, 3=USB, 4=H4IBSS, USB with Host Wake, 6=SDIO, 7=UART CS-N, 8=SPI, 9=H5, 10=H4DS, 12=UART with BREAK
1476  * @param idle_threshold_host (modes 1,2,5,7) time until considered idle, unit roughly 300 ms
1477  * @param idle_threshold_controller (modes 1-7,9) time until considered idle, unit roughly 300 ms
1478  * @param bt_wake_active_mode (modes 1,2,7) 0 = BT_WAKE line is active high, 1 = BT_WAKE is active low
1479  * @param host_wake_active_mode (modes 1,2,5,7) 0 = HOST_WAKE line is active high, 1 = HOST_WAKE is active low
1480  * @param allow_host_sleep_during_sco (modes 1,2,3,5,7)
1481  * @param combine_sleep_mode_and_lpm  (modes 1,2,3,5,7)
1482  * @param enable_tristate_control_of_uart_tx_line (modes 1,2,7)
1483  * @param active_connection_handling_on_suspend (modes 3,5)
1484  * @param resume_timeout (modes 3,5)
1485  * @param enable_break_to_host (mode 12)
1486  * @param pulsed_host_wake (modes 1,12)
1487  */
1488 const hci_cmd_t hci_bcm_set_sleep_mode = {
1489     HCI_OPCODE_HCI_BCM_SET_SLEEP_MODE, "111111111111"
1490 };
1491 
1492 /**
1493  * @brief Set TX Power Table
1494  * @param is_le 0=classic, 1=LE
1495  * @param chip_max_tx_pwr_db chip level max TX power in dBM
1496  */
1497 const hci_cmd_t hci_bcm_write_tx_power_table = {
1498     HCI_OPCODE_HCI_BCM_WRITE_TX_POWER_TABLE, "11"
1499 };
1500 
1501 const hci_cmd_t hci_bcm_set_tx_pwr = {
1502     HCI_OPCODE_HCI_BCM_SET_TX_PWR, "11H"
1503 };
1504 
1505 /**
1506  * @brief This command starts receiving packets using packet transmission parameters such as
1507  *        frequency channel, packet type, and packet length. It is used for Packet RX.
1508  * @see   https://processors.wiki.ti.com/index.php/CC256x_Testing_Guide#Continuous_RX
1509  * @param frequency
1510  * @param ADPLL loop mode
1511  */
1512 const hci_cmd_t hci_ti_drpb_tester_con_rx = {
1513         0xFD17, "11"
1514 };
1515 
1516 /**
1517  *
1518  *
1519  * @brief This command tests the RF transceiver in continuous transmission mode.
1520  *        The transmitter is activated by configuring the transmission parameters such as pattern,
1521  *        modulation, and frequency.
1522  * @see   processors.wiki.ti.com/index.php/CC256x_VS_HCI_Commands#HCI_VS_DRPb_Tester_Con_TX.280xFD84.29
1523  * @param modulation
1524  * @param test_pattern
1525  * @param frequency
1526  * @param power_level
1527  * @param reserved1
1528  * @param reserved2
1529  */
1530 const hci_cmd_t hci_ti_drpb_tester_con_tx = {
1531     0xFD84, "111144"
1532 };
1533 
1534 /**
1535  * @brief This command starts sending/receiving packets using packet transmission parameters such as
1536  *        frequency channel, packet type, and packet length. It is used for Packet TX/RX.
1537  * @see   processors.wiki.ti.com/index.php/CC256x_VS_HCI_Commands#HCI_VS_DRPb_Tester_Packet_TX_RX_.280xFD85.29
1538  * @param frequency_mode
1539  * @param tx_single_frequency
1540  * @param rx_single_frequency
1541  * @param acl_packet_type
1542  * @paarm acl_packet_data_pattern
1543  * @param reserved
1544  * @param power_level
1545  * @param disable_whitening
1546  * @param prbs9_initialization_value
1547  */
1548 const hci_cmd_t hci_ti_drpb_tester_packet_tx_rx = {
1549     0xFD85, "1111112112"
1550 };
1551 
1552 
1553 /**
1554  * @param best effort access percentage
1555  * @param guaranteed access percentage
1556  * @param poll period
1557  * @param slave burst after tx
1558  * @param slave master search count
1559  * @param master burst after tx enable
1560  * @param master burst after rx limit
1561  */
1562 const hci_cmd_t hci_ti_configure_ddip = {
1563         HCI_OPCODE_HCI_TI_VS_CONFIGURE_DDIP, "1111111"
1564 };
1565 
1566 /**
1567  * @brief This command is used to associate the requested ACL handle with Wide Band Speech configuration.
1568  * @param enable 0=disable, 1=enable
1569  * @param a3dp_role (NL5500, WL128x only) 0=source,1=sink
1570  * @param code_upload (NL5500, WL128x only) 0=do not load a3dp code, 1=load a3dp code
1571  * @param reserved for future use
1572  */
1573 const hci_cmd_t hci_ti_avrp_enable = {
1574         0xFD92, "1112"
1575 };
1576 
1577 /**
1578  * @brief This command is used to associate the requested ACL handle with Wide Band Speech configuration.
1579  * @param acl_con_handle
1580  */
1581 const hci_cmd_t hci_ti_wbs_associate = {
1582         0xFD78, "H"
1583 };
1584 
1585 /**
1586  * @brief This command is used to disassociate Wide Band Speech configuration from any ACL handle.
1587  */
1588 const hci_cmd_t hci_ti_wbs_disassociate = {
1589         0xFD79, ""
1590 };
1591 
1592 /**
1593  * @brief This command configures the codec interface parameters and the PCM clock rate, which is relevant when
1594           the Bluetooth core generates the clock. This command must be used by the host to use the PCM
1595           interface.
1596  * @param clock_rate in kHz
1597  * @param clock_direction 0=master/output, 1=slave/input
1598  * @param frame_sync_frequency in Hz
1599  * @param frame_sync_duty_cycle 0=50% (I2S Format), 0x0001-0xffff number of cycles of PCM clock
1600  * @param frame_sync_edge 0=driven/sampled at rising edge, 1=driven/sampled at falling edge of PCM clock
1601  * @param frame_sync_polariy 0=active high, 1=active low
1602  * @param reserved1
1603  * @param channel_1_data_out_size sample size in bits
1604  * @param channel_1_data_out_offset number of PCM clock cycles between rising of frame sync and data start
1605  * @param channel_1_data_out_edge 0=data driven at rising edge, 1=data driven at falling edge of PCM clock
1606  * @param channel_1_data_in_size sample size in bits
1607  * @param channel_1_data_in_offset number of PCM clock cycles between rising of frame sync and data start
1608  * @param channel_1_data_in_edge 0=data sampled at rising edge, 1=data sampled at falling edge of PCM clock
1609  * @param fsync_multiplier this field is only relevant to CC256XB from service pack 0.2 !!! -> use 0x00
1610  * @param channel_2_data_out_size sample size in bits
1611  * @param channel_2_data_out_offset number of PCM clock cycles between rising of frame sync and data start
1612  * @param channel_2_data_out_edge 0=data driven at rising edge, 1=data driven at falling edge of PCM clock
1613  * @param channel_2_data_in_size sample size in bits
1614  * @param channel_2_data_in_offset number of PCM clock cycles between rising of frame sync and data start
1615  * @param channel_2_data_in_edge 0=data sampled at rising edge, 1=data sampled at falling edge of PCM clock
1616  * @param reserved2
1617  *
1618  */
1619 const hci_cmd_t hci_ti_write_codec_config = {
1620         0xFD06, "214211122122112212211"
1621 };
1622 
1623 /**
1624  * @brief This command is used only for internal testing.
1625  * @see   https://processors.wiki.ti.com/index.php/CC256x_Testing_Guide#Continuous_TX
1626  * @param frequency
1627  * @param ADPLL loop mode
1628  */
1629 const hci_cmd_t hci_ti_drpb_enable_rf_calibration = {
1630         0xFD80, "141"
1631 };
1632 
1633 /**
1634  * @brief This command command is only required for the continuous TX test of modulated
1635  * (GFSK, π/4-DQPSK or 8DPSK) signal. This command should be skipped when performing continuous TX test for CW.
1636  * @see   https://processors.wiki.ti.com/index.php/CC256x_Testing_Guide#Continuous_RX
1637  * @param frequency
1638  * @param ADPLL loop mode
1639  */
1640 const hci_cmd_t hci_ti_write_hardware_register = {
1641         0xFF01, "42"
1642 };
1643