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