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 "classic/sdp_util.h" 49 #include "hci.h" 50 #include "hci_cmd.h" 51 #include "btstack_debug.h" 52 53 #include <string.h> 54 55 // calculate combined ogf/ocf value 56 #define OPCODE(ogf, ocf) (ocf | ogf << 10) 57 58 /** 59 * construct HCI Command based on template 60 * 61 * Format: 62 * 1,2,3,4: one to four byte value 63 * H: HCI connection handle 64 * B: Bluetooth Baseband Address (BD_ADDR) 65 * D: 8 byte data block 66 * E: Extended Inquiry Result 67 * N: Name up to 248 chars, \0 terminated 68 * P: 16 byte data block. Pairing code, Simple Pairing Hash and Randomizer 69 * A: 31 bytes advertising data 70 * S: Service Record (Data Element Sequence) 71 * Q: 32 byte data block, e.g. for X and Y coordinates of P-256 public key 72 */ 73 uint16_t hci_cmd_create_from_template(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr){ 74 75 hci_cmd_buffer[0] = cmd->opcode & 0xff; 76 hci_cmd_buffer[1] = cmd->opcode >> 8; 77 int pos = 3; 78 79 const char *format = cmd->format; 80 uint16_t word; 81 uint32_t longword; 82 uint8_t * ptr; 83 while (*format) { 84 switch(*format) { 85 case '1': // 8 bit value 86 case '2': // 16 bit value 87 case 'H': // hci_handle 88 word = va_arg(argptr, int); // minimal va_arg is int: 2 bytes on 8+16 bit CPUs 89 hci_cmd_buffer[pos++] = word & 0xff; 90 if (*format == '2') { 91 hci_cmd_buffer[pos++] = word >> 8; 92 } else if (*format == 'H') { 93 // TODO implement opaque client connection handles 94 // pass module handle for now 95 hci_cmd_buffer[pos++] = word >> 8; 96 } 97 break; 98 case '3': 99 case '4': 100 longword = va_arg(argptr, uint32_t); 101 // longword = va_arg(argptr, int); 102 hci_cmd_buffer[pos++] = longword; 103 hci_cmd_buffer[pos++] = longword >> 8; 104 hci_cmd_buffer[pos++] = longword >> 16; 105 if (*format == '4'){ 106 hci_cmd_buffer[pos++] = longword >> 24; 107 } 108 break; 109 case 'B': // bt-addr 110 ptr = va_arg(argptr, uint8_t *); 111 hci_cmd_buffer[pos++] = ptr[5]; 112 hci_cmd_buffer[pos++] = ptr[4]; 113 hci_cmd_buffer[pos++] = ptr[3]; 114 hci_cmd_buffer[pos++] = ptr[2]; 115 hci_cmd_buffer[pos++] = ptr[1]; 116 hci_cmd_buffer[pos++] = ptr[0]; 117 break; 118 case 'D': // 8 byte data block 119 ptr = va_arg(argptr, uint8_t *); 120 memcpy(&hci_cmd_buffer[pos], ptr, 8); 121 pos += 8; 122 break; 123 case 'E': // Extended Inquiry Information 240 octets 124 ptr = va_arg(argptr, uint8_t *); 125 memcpy(&hci_cmd_buffer[pos], ptr, 240); 126 pos += 240; 127 break; 128 case 'N': { // UTF-8 string, null terminated 129 ptr = va_arg(argptr, uint8_t *); 130 uint16_t len = strlen((const char*) ptr); 131 if (len > 248) { 132 len = 248; 133 } 134 memcpy(&hci_cmd_buffer[pos], ptr, len); 135 if (len < 248) { 136 // fill remaining space with zeroes 137 memset(&hci_cmd_buffer[pos+len], 0, 248-len); 138 } 139 pos += 248; 140 break; 141 } 142 case 'P': // 16 byte PIN code or link key 143 ptr = va_arg(argptr, uint8_t *); 144 memcpy(&hci_cmd_buffer[pos], ptr, 16); 145 pos += 16; 146 break; 147 #ifdef ENABLE_BLE 148 case 'A': // 31 bytes advertising data 149 ptr = va_arg(argptr, uint8_t *); 150 memcpy(&hci_cmd_buffer[pos], ptr, 31); 151 pos += 31; 152 break; 153 #endif 154 #ifdef ENABLE_SDP 155 case 'S': { // Service Record (Data Element Sequence) 156 ptr = va_arg(argptr, uint8_t *); 157 uint16_t len = de_get_len(ptr); 158 memcpy(&hci_cmd_buffer[pos], ptr, len); 159 pos += len; 160 break; 161 } 162 #endif 163 #ifdef ENABLE_LE_SECURE_CONNECTIONS 164 case 'Q': 165 ptr = va_arg(argptr, uint8_t *); 166 reverse_bytes(ptr, &hci_cmd_buffer[pos], 32); 167 pos += 32; 168 break; 169 #endif 170 default: 171 break; 172 } 173 format++; 174 }; 175 hci_cmd_buffer[2] = pos - 3; 176 return pos; 177 } 178 179 /** 180 * Link Control Commands 181 */ 182 183 /** 184 * @param lap 185 * @param inquiry_length 186 * @param num_responses 187 */ 188 const hci_cmd_t hci_inquiry = { 189 OPCODE(OGF_LINK_CONTROL, 0x01), "311" 190 }; 191 192 /** 193 */ 194 const hci_cmd_t hci_inquiry_cancel = { 195 OPCODE(OGF_LINK_CONTROL, 0x02), "" 196 }; 197 198 /** 199 * @param bd_addr 200 * @param packet_type 201 * @param page_scan_repetition_mode 202 * @param reserved 203 * @param clock_offset 204 * @param allow_role_switch 205 */ 206 const hci_cmd_t hci_create_connection = { 207 OPCODE(OGF_LINK_CONTROL, 0x05), "B21121" 208 }; 209 210 /** 211 * @param handle 212 * @param reason (0x05, 0x13-0x15, 0x1a, 0x29, see Errors Codes in BT Spec Part D) 213 */ 214 const hci_cmd_t hci_disconnect = { 215 OPCODE(OGF_LINK_CONTROL, 0x06), "H1" 216 }; 217 218 /** 219 * @param bd_addr 220 */ 221 const hci_cmd_t hci_create_connection_cancel = { 222 OPCODE(OGF_LINK_CONTROL, 0x08), "B" 223 }; 224 225 /** 226 * @param bd_addr 227 * @param role (become master, stay slave) 228 */ 229 const hci_cmd_t hci_accept_connection_request = { 230 OPCODE(OGF_LINK_CONTROL, 0x09), "B1" 231 }; 232 233 /** 234 * @param bd_addr 235 * @param reason (e.g. CONNECTION REJECTED DUE TO LIMITED RESOURCES (0x0d)) 236 */ 237 const hci_cmd_t hci_reject_connection_request = { 238 OPCODE(OGF_LINK_CONTROL, 0x0a), "B1" 239 }; 240 241 /** 242 * @param bd_addr 243 * @param link_key 244 */ 245 const hci_cmd_t hci_link_key_request_reply = { 246 OPCODE(OGF_LINK_CONTROL, 0x0b), "BP" 247 }; 248 249 /** 250 * @param bd_addr 251 */ 252 const hci_cmd_t hci_link_key_request_negative_reply = { 253 OPCODE(OGF_LINK_CONTROL, 0x0c), "B" 254 }; 255 256 /** 257 * @param bd_addr 258 * @param pin_length 259 * @param pin (c-string) 260 */ 261 const hci_cmd_t hci_pin_code_request_reply = { 262 OPCODE(OGF_LINK_CONTROL, 0x0d), "B1P" 263 }; 264 265 /** 266 * @param bd_addr 267 */ 268 const hci_cmd_t hci_pin_code_request_negative_reply = { 269 OPCODE(OGF_LINK_CONTROL, 0x0e), "B" 270 }; 271 272 /** 273 * @param handle 274 * @param packet_type 275 */ 276 const hci_cmd_t hci_change_connection_packet_type = { 277 OPCODE(OGF_LINK_CONTROL, 0x0f), "H2" 278 }; 279 280 /** 281 * @param handle 282 */ 283 const hci_cmd_t hci_authentication_requested = { 284 OPCODE(OGF_LINK_CONTROL, 0x11), "H" 285 }; 286 287 /** 288 * @param handle 289 * @param encryption_enable 290 */ 291 const hci_cmd_t hci_set_connection_encryption = { 292 OPCODE(OGF_LINK_CONTROL, 0x13), "H1" 293 }; 294 295 /** 296 * @param handle 297 */ 298 const hci_cmd_t hci_change_connection_link_key = { 299 OPCODE(OGF_LINK_CONTROL, 0x15), "H" 300 }; 301 302 /** 303 * @param bd_addr 304 * @param page_scan_repetition_mode 305 * @param reserved 306 * @param clock_offset 307 */ 308 const hci_cmd_t hci_remote_name_request = { 309 OPCODE(OGF_LINK_CONTROL, 0x19), "B112" 310 }; 311 312 313 /** 314 * @param bd_addr 315 */ 316 const hci_cmd_t hci_remote_name_request_cancel = { 317 OPCODE(OGF_LINK_CONTROL, 0x1A), "B" 318 }; 319 320 /** 321 * @param handle 322 */ 323 const hci_cmd_t hci_read_remote_supported_features_command = { 324 OPCODE(OGF_LINK_CONTROL, 0x1B), "H" 325 }; 326 327 /** 328 * @param handle 329 */ 330 const hci_cmd_t hci_read_remote_version_information = { 331 OPCODE(OGF_LINK_CONTROL, 0x1D), "H" 332 }; 333 334 /** 335 * @param handle 336 * @param transmit_bandwidth 8000(64kbps) 337 * @param receive_bandwidth 8000(64kbps) 338 * @param max_latency >= 7ms for eSCO, 0xFFFF do not care 339 * @param voice_settings e.g. CVSD, Input Coding: Linear, Input Data Format: 2’s complement, data 16bit: 00011000000 == 0x60 340 * @param retransmission_effort e.g. 0xFF do not care 341 * @param packet_type at least EV3 for eSCO 342 */ 343 const hci_cmd_t hci_setup_synchronous_connection = { 344 OPCODE(OGF_LINK_CONTROL, 0x0028), "H442212" 345 }; 346 347 /** 348 * @param bd_addr 349 * @param transmit_bandwidth 350 * @param receive_bandwidth 351 * @param max_latency 352 * @param voice_settings 353 * @param retransmission_effort 354 * @param packet_type 355 */ 356 const hci_cmd_t hci_accept_synchronous_connection = { 357 OPCODE(OGF_LINK_CONTROL, 0x0029), "B442212" 358 }; 359 360 /** 361 * @param bd_addr 362 * @param IO_capability 363 * @param OOB_data_present 364 * @param authentication_requirements 365 */ 366 const hci_cmd_t hci_io_capability_request_reply = { 367 OPCODE(OGF_LINK_CONTROL, 0x2b), "B111" 368 }; 369 370 /** 371 * @param bd_addr 372 */ 373 const hci_cmd_t hci_user_confirmation_request_reply = { 374 OPCODE(OGF_LINK_CONTROL, 0x2c), "B" 375 }; 376 377 /** 378 * @param bd_addr 379 */ 380 const hci_cmd_t hci_user_confirmation_request_negative_reply = { 381 OPCODE(OGF_LINK_CONTROL, 0x2d), "B" 382 }; 383 384 /** 385 * @param bd_addr 386 * @param numeric_value 387 */ 388 const hci_cmd_t hci_user_passkey_request_reply = { 389 OPCODE(OGF_LINK_CONTROL, 0x2e), "B4" 390 }; 391 392 /** 393 * @param bd_addr 394 */ 395 const hci_cmd_t hci_user_passkey_request_negative_reply = { 396 OPCODE(OGF_LINK_CONTROL, 0x2f), "B" 397 }; 398 399 /** 400 * @param bd_addr 401 * @param c Simple Pairing Hash C 402 * @param r Simple Pairing Randomizer R 403 */ 404 const hci_cmd_t hci_remote_oob_data_request_reply = { 405 OPCODE(OGF_LINK_CONTROL, 0x30), "BPP" 406 }; 407 408 /** 409 * @param bd_addr 410 */ 411 const hci_cmd_t hci_remote_oob_data_request_negative_reply = { 412 OPCODE(OGF_LINK_CONTROL, 0x33), "B" 413 }; 414 415 /** 416 * @param bd_addr 417 * @param reason (Part D, Error codes) 418 */ 419 const hci_cmd_t hci_io_capability_request_negative_reply = { 420 OPCODE(OGF_LINK_CONTROL, 0x34), "B1" 421 }; 422 423 /** 424 * @param handle 425 * @param transmit_bandwidth 426 * @param receive_bandwidth 427 * @param transmit_coding_format_type 428 * @param transmit_coding_format_company 429 * @param transmit_coding_format_codec 430 * @param receive_coding_format_type 431 * @param receive_coding_format_company 432 * @param receive_coding_format_codec 433 * @param transmit_coding_frame_size 434 * @param receive_coding_frame_size 435 * @param input_bandwidth 436 * @param output_bandwidth 437 * @param input_coding_format_type 438 * @param input_coding_format_company 439 * @param input_coding_format_codec 440 * @param output_coding_format_type 441 * @param output_coding_format_company 442 * @param output_coding_format_codec 443 * @param input_coded_data_size 444 * @param outupt_coded_data_size 445 * @param input_pcm_data_format 446 * @param output_pcm_data_format 447 * @param input_pcm_sample_payload_msb_position 448 * @param output_pcm_sample_payload_msb_position 449 * @param input_data_path 450 * @param output_data_path 451 * @param input_transport_unit_size 452 * @param output_transport_unit_size 453 * @param max_latency 454 * @param packet_type 455 * @param retransmission_effort 456 */ 457 const hci_cmd_t hci_enhanced_setup_synchronous_connection = { 458 OPCODE(OGF_LINK_CONTROL, 0x3d), "H4412212222441221222211111111221" 459 }; 460 461 /** 462 * @param bd_addr 463 * @param transmit_bandwidth 464 * @param receive_bandwidth 465 * @param transmit_coding_format_type 466 * @param transmit_coding_format_company 467 * @param transmit_coding_format_codec 468 * @param receive_coding_format_type 469 * @param receive_coding_format_company 470 * @param receive_coding_format_codec 471 * @param transmit_coding_frame_size 472 * @param receive_coding_frame_size 473 * @param input_bandwidth 474 * @param output_bandwidth 475 * @param input_coding_format_type 476 * @param input_coding_format_company 477 * @param input_coding_format_codec 478 * @param output_coding_format_type 479 * @param output_coding_format_company 480 * @param output_coding_format_codec 481 * @param input_coded_data_size 482 * @param outupt_coded_data_size 483 * @param input_pcm_data_format 484 * @param output_pcm_data_format 485 * @param input_pcm_sample_payload_msb_position 486 * @param output_pcm_sample_payload_msb_position 487 * @param input_data_path 488 * @param output_data_path 489 * @param input_transport_unit_size 490 * @param output_transport_unit_size 491 * @param max_latency 492 * @param packet_type 493 * @param retransmission_effort 494 */ 495 const hci_cmd_t hci_enhanced_accept_synchronous_connection = { 496 OPCODE(OGF_LINK_CONTROL, 0x3e), "B4412212222441221222211111111221" 497 }; 498 499 /** 500 * Link Policy Commands 501 */ 502 503 /** 504 * @param handle 505 * @param sniff_max_interval 506 * @param sniff_min_interval 507 * @param sniff_attempt 508 * @param sniff_timeout 509 */ 510 const hci_cmd_t hci_sniff_mode = { 511 OPCODE(OGF_LINK_POLICY, 0x03), "H2222" 512 }; 513 514 /** 515 * @param handle 516 */ 517 const hci_cmd_t hci_exit_sniff_mode = { 518 OPCODE(OGF_LINK_POLICY, 0x04), "H" 519 }; 520 521 /** 522 * @param handle 523 * @param flags 524 * @param service_type 525 * @param token_rate (bytes/s) 526 * @param peak_bandwith (bytes/s) 527 * @param latency (us) 528 * @param delay_variation (us) 529 */ 530 const hci_cmd_t hci_qos_setup = { 531 OPCODE(OGF_LINK_POLICY, 0x07), "H114444" 532 }; 533 534 /** 535 * @param handle 536 */ 537 const hci_cmd_t hci_role_discovery = { 538 OPCODE(OGF_LINK_POLICY, 0x09), "H" 539 }; 540 541 /** 542 * @param bd_addr 543 * @param role (0=master,1=slave) 544 */ 545 const hci_cmd_t hci_switch_role_command= { 546 OPCODE(OGF_LINK_POLICY, 0x0b), "B1" 547 }; 548 549 /** 550 * @param handle 551 */ 552 const hci_cmd_t hci_read_link_policy_settings = { 553 OPCODE(OGF_LINK_POLICY, 0x0c), "H" 554 }; 555 556 /** 557 * @param handle 558 * @param settings 559 */ 560 const hci_cmd_t hci_write_link_policy_settings = { 561 OPCODE(OGF_LINK_POLICY, 0x0d), "H2" 562 }; 563 564 /** 565 * @param policy 566 */ 567 const hci_cmd_t hci_write_default_link_policy_setting = { 568 OPCODE(OGF_LINK_POLICY, 0x0F), "2" 569 }; 570 571 572 /** 573 * Controller & Baseband Commands 574 */ 575 576 577 /** 578 * @param event_mask_lover_octets 579 * @param event_mask_higher_octets 580 */ 581 const hci_cmd_t hci_set_event_mask = { 582 OPCODE(OGF_CONTROLLER_BASEBAND, 0x01), "44" 583 }; 584 585 /** 586 */ 587 const hci_cmd_t hci_reset = { 588 OPCODE(OGF_CONTROLLER_BASEBAND, 0x03), "" 589 }; 590 591 /** 592 * @param handle 593 */ 594 const hci_cmd_t hci_flush = { 595 OPCODE(OGF_CONTROLLER_BASEBAND, 0x09), "H" 596 }; 597 598 /** 599 * @param bd_addr 600 * @param delete_all_flags 601 */ 602 const hci_cmd_t hci_delete_stored_link_key = { 603 OPCODE(OGF_CONTROLLER_BASEBAND, 0x12), "B1" 604 }; 605 606 #ifdef ENABLE_CLASSIC 607 /** 608 * @param local_name (UTF-8, Null Terminated, max 248 octets) 609 */ 610 const hci_cmd_t hci_write_local_name = { 611 OPCODE(OGF_CONTROLLER_BASEBAND, 0x13), "N" 612 }; 613 #endif 614 615 /** 616 */ 617 const hci_cmd_t hci_read_local_name = { 618 OPCODE(OGF_CONTROLLER_BASEBAND, 0x14), "" 619 }; 620 621 /** 622 * @param page_timeout (* 0.625 ms) 623 */ 624 const hci_cmd_t hci_write_page_timeout = { 625 OPCODE(OGF_CONTROLLER_BASEBAND, 0x18), "2" 626 }; 627 628 /** 629 * @param scan_enable (no, inq, page, inq+page) 630 */ 631 const hci_cmd_t hci_write_scan_enable = { 632 OPCODE(OGF_CONTROLLER_BASEBAND, 0x1A), "1" 633 }; 634 635 /** 636 * @param authentication_enable 637 */ 638 const hci_cmd_t hci_write_authentication_enable = { 639 OPCODE(OGF_CONTROLLER_BASEBAND, 0x20), "1" 640 }; 641 642 /** 643 * @param class_of_device 644 */ 645 const hci_cmd_t hci_write_class_of_device = { 646 OPCODE(OGF_CONTROLLER_BASEBAND, 0x24), "3" 647 }; 648 649 /** 650 */ 651 const hci_cmd_t hci_read_num_broadcast_retransmissions = { 652 OPCODE(OGF_CONTROLLER_BASEBAND, 0x29), "" 653 }; 654 655 /** 656 * @param num_broadcast_retransmissions (e.g. 0 for a single broadcast) 657 */ 658 const hci_cmd_t hci_write_num_broadcast_retransmissions = { 659 OPCODE(OGF_CONTROLLER_BASEBAND, 0x2a), "1" 660 }; 661 662 /** 663 * @param synchronous_flow_control_enable - if yes, num completed packet everts are sent for SCO packets 664 */ 665 const hci_cmd_t hci_write_synchronous_flow_control_enable = { 666 OPCODE(OGF_CONTROLLER_BASEBAND, 0x2f), "1" 667 }; 668 669 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 670 671 /** 672 * @param flow_control_enable - 0: off, 1: ACL only, 2: SCO only, 3: ACL + SCO 673 */ 674 const hci_cmd_t hci_set_controller_to_host_flow_control = { 675 OPCODE(OGF_CONTROLLER_BASEBAND, 0x31), "1" 676 }; 677 678 /** 679 * @param host_acl_data_packet_length 680 * @param host_synchronous_data_packet_length 681 * @param host_total_num_acl_data_packets 682 * @param host_total_num_synchronous_data_packets 683 */ 684 const hci_cmd_t hci_host_buffer_size = { 685 OPCODE(OGF_CONTROLLER_BASEBAND, 0x33), "2122" 686 }; 687 688 689 #if 0 690 // 691 // command sent manually sent by hci_host_num_completed_packets 692 // 693 /** 694 * @note only single handle supported by BTstack command generator 695 * @param number_of_handles must be 1 696 * @param connection_handle 697 * @param host_num_of_completed_packets for the given connection handle 698 */ 699 const hci_cmd_t hci_host_number_of_completed_packets = { 700 OPCODE(OGF_CONTROLLER_BASEBAND, 0x35), "1H2" 701 }; 702 #endif 703 704 #endif 705 706 /** 707 * @param handle 708 */ 709 const hci_cmd_t hci_read_link_supervision_timeout = { 710 OPCODE(OGF_CONTROLLER_BASEBAND, 0x36), "H" 711 }; 712 713 /** 714 * @param handle 715 * @param timeout (0x0001 - 0xFFFF Time -> Range: 0.625ms - 40.9 sec) 716 */ 717 const hci_cmd_t hci_write_link_supervision_timeout = { 718 OPCODE(OGF_CONTROLLER_BASEBAND, 0x37), "H2" 719 }; 720 721 /** 722 * @param num_current_iac must be 2 723 * @param iac_lap1 724 * @param iac_lap2 725 */ 726 const hci_cmd_t hci_write_current_iac_lap_two_iacs = { 727 OPCODE(OGF_CONTROLLER_BASEBAND, 0x3A), "133" 728 }; 729 730 /** 731 * @param inquiry_mode (0x00 = standard, 0x01 = with RSSI, 0x02 = extended) 732 */ 733 const hci_cmd_t hci_write_inquiry_mode = { 734 OPCODE(OGF_CONTROLLER_BASEBAND, 0x45), "1" 735 }; 736 737 /** 738 * @param fec_required 739 * @param exstended_inquiry_response 740 */ 741 const hci_cmd_t hci_write_extended_inquiry_response = { 742 OPCODE(OGF_CONTROLLER_BASEBAND, 0x52), "1E" 743 }; 744 745 /** 746 * @param mode (0 = off, 1 = on) 747 */ 748 const hci_cmd_t hci_write_simple_pairing_mode = { 749 OPCODE(OGF_CONTROLLER_BASEBAND, 0x56), "1" 750 }; 751 752 /** 753 */ 754 const hci_cmd_t hci_read_local_oob_data = { 755 OPCODE(OGF_CONTROLLER_BASEBAND, 0x57), "" 756 // return status, C, R 757 }; 758 759 /** 760 * @param mode (0 = off, 1 = on) 761 */ 762 const hci_cmd_t hci_write_default_erroneous_data_reporting = { 763 OPCODE(OGF_CONTROLLER_BASEBAND, 0x5B), "1" 764 }; 765 766 /** 767 */ 768 const hci_cmd_t hci_read_le_host_supported = { 769 OPCODE(OGF_CONTROLLER_BASEBAND, 0x6c), "" 770 // return: status, le supported host, simultaneous le host 771 }; 772 773 /** 774 * @param le_supported_host 775 * @param simultaneous_le_host 776 */ 777 const hci_cmd_t hci_write_le_host_supported = { 778 OPCODE(OGF_CONTROLLER_BASEBAND, 0x6d), "11" 779 // return: status 780 }; 781 782 /** 783 */ 784 const hci_cmd_t hci_read_local_extended_ob_data = { 785 OPCODE(OGF_CONTROLLER_BASEBAND, 0x7d), "" 786 // return status, C_192, R_192, R_256, C_256 787 }; 788 789 790 /** 791 * Testing Commands 792 */ 793 794 795 /** 796 */ 797 const hci_cmd_t hci_read_loopback_mode = { 798 OPCODE(OGF_TESTING, 0x01), "" 799 // return: status, loopback mode (0 = off, 1 = local loopback, 2 = remote loopback) 800 }; 801 802 /** 803 * @param loopback_mode 804 */ 805 const hci_cmd_t hci_write_loopback_mode = { 806 OPCODE(OGF_TESTING, 0x02), "1" 807 // return: status 808 }; 809 810 /** 811 */ 812 const hci_cmd_t hci_enable_device_under_test_mode = { 813 OPCODE(OGF_TESTING, 0x03), "" 814 // return: status 815 }; 816 817 /** 818 * @param simple_pairing_debug_mode 819 */ 820 const hci_cmd_t hci_write_simple_pairing_debug_mode = { 821 OPCODE(OGF_TESTING, 0x04), "1" 822 // return: status 823 }; 824 825 /** 826 * @param handle 827 * @param dm1_acl_u_mode 828 * @param esco_loopback_mode 829 */ 830 const hci_cmd_t hci_write_secure_connections_test_mode = { 831 OPCODE(OGF_TESTING, 0x0a), "H11" 832 // return: status 833 }; 834 835 836 /** 837 * Informational Parameters 838 */ 839 840 const hci_cmd_t hci_read_local_version_information = { 841 OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x01), "" 842 }; 843 const hci_cmd_t hci_read_local_supported_commands = { 844 OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x02), "" 845 }; 846 const hci_cmd_t hci_read_local_supported_features = { 847 OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x03), "" 848 }; 849 const hci_cmd_t hci_read_buffer_size = { 850 OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x05), "" 851 }; 852 const hci_cmd_t hci_read_bd_addr = { 853 OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x09), "" 854 }; 855 856 /** 857 * Status Paramters 858 */ 859 860 /** 861 * @param handle 862 */ 863 const hci_cmd_t hci_read_rssi = { 864 OPCODE(OGF_STATUS_PARAMETERS, 0x05), "H" 865 // no params 866 }; 867 868 869 870 #ifdef ENABLE_BLE 871 /** 872 * Low Energy Commands 873 */ 874 875 /** 876 * @param event_mask_lower_octets 877 * @param event_mask_higher_octets 878 */ 879 const hci_cmd_t hci_le_set_event_mask = { 880 OPCODE(OGF_LE_CONTROLLER, 0x01), "44" 881 // return: status 882 }; 883 884 const hci_cmd_t hci_le_read_buffer_size = { 885 OPCODE(OGF_LE_CONTROLLER, 0x02), "" 886 // return: status, le acl data packet len (16), total num le acl data packets(8) 887 }; 888 const hci_cmd_t hci_le_read_supported_features = { 889 OPCODE(OGF_LE_CONTROLLER, 0x03), "" 890 // return: LE_Features See [Vol 6] Part B, Section 4.6 891 }; 892 893 /** 894 * @param random_bd_addr 895 */ 896 const hci_cmd_t hci_le_set_random_address = { 897 OPCODE(OGF_LE_CONTROLLER, 0x05), "B" 898 // return: status 899 }; 900 901 /** 902 * @param advertising_interval_min ([0x0020,0x4000], default: 0x0800, unit: 0.625 msec) 903 * @param advertising_interval_max ([0x0020,0x4000], default: 0x0800, unit: 0.625 msec) 904 * @param advertising_type (enum from 0: ADV_IND, ADC_DIRECT_IND, ADV_SCAN_IND, ADV_NONCONN_IND) 905 * @param own_address_type (enum from 0: public device address, random device address) 906 * @param direct_address_type () 907 * @param direct_address (public or random address of device to be connecteed) 908 * @param advertising_channel_map (flags: chan_37(1), chan_38(2), chan_39(4)) 909 * @param advertising_filter_policy (enum from 0: scan any conn any, scan whitelist, con any, scan any conn whitelist, scan whitelist, con whitelist) 910 */ 911 const hci_cmd_t hci_le_set_advertising_parameters = { 912 OPCODE(OGF_LE_CONTROLLER, 0x06), "22111B11" 913 // return: status 914 }; 915 916 const hci_cmd_t hci_le_read_advertising_channel_tx_power = { 917 OPCODE(OGF_LE_CONTROLLER, 0x07), "" 918 // return: status, level [-20,10] signed int (8), units dBm 919 }; 920 921 /** 922 * @param advertising_data_length 923 * @param advertising_data (31 bytes) 924 */ 925 const hci_cmd_t hci_le_set_advertising_data= { 926 OPCODE(OGF_LE_CONTROLLER, 0x08), "1A" 927 // return: status 928 }; 929 930 /** 931 * @param scan_response_data_length 932 * @param scan_response_data (31 bytes) 933 */ 934 const hci_cmd_t hci_le_set_scan_response_data= { 935 OPCODE(OGF_LE_CONTROLLER, 0x09), "1A" 936 // return: status 937 }; 938 939 /** 940 * @param advertise_enable (off: 0, on: 1) 941 */ 942 const hci_cmd_t hci_le_set_advertise_enable = { 943 OPCODE(OGF_LE_CONTROLLER, 0x0a), "1" 944 // return: status 945 }; 946 947 /** 948 * @param le_scan_type (passive (0), active (1)) 949 * @param le_scan_interval ([0x0004,0x4000], unit: 0.625 msec) 950 * @param le_scan_window ([0x0004,0x4000], unit: 0.625 msec) 951 * @param own_address_type (public (0), random (1)) 952 * @param scanning_filter_policy (any (0), only whitelist (1)) 953 */ 954 const hci_cmd_t hci_le_set_scan_parameters = { 955 OPCODE(OGF_LE_CONTROLLER, 0x0b), "12211" 956 // return: status 957 }; 958 959 /** 960 * @param le_scan_enable (disabled (0), enabled (1)) 961 * @param filter_duplices (disabled (0), enabled (1)) 962 */ 963 const hci_cmd_t hci_le_set_scan_enable = { 964 OPCODE(OGF_LE_CONTROLLER, 0x0c), "11" 965 // return: status 966 }; 967 968 /** 969 * @param le_scan_interval ([0x0004, 0x4000], unit: 0.625 msec) 970 * @param le_scan_window ([0x0004, 0x4000], unit: 0.625 msec) 971 * @param initiator_filter_policy (peer address type + peer address (0), whitelist (1)) 972 * @param peer_address_type (public (0), random (1)) 973 * @param peer_address 974 * @param own_address_type (public (0), random (1)) 975 * @param conn_interval_min ([0x0006, 0x0c80], unit: 1.25 msec) 976 * @param conn_interval_max ([0x0006, 0x0c80], unit: 1.25 msec) 977 * @param conn_latency (number of connection events [0x0000, 0x01f4]) 978 * @param supervision_timeout ([0x000a, 0x0c80], unit: 10 msec) 979 * @param minimum_CE_length ([0x0000, 0xffff], unit: 0.625 msec) 980 * @param maximum_CE_length ([0x0000, 0xffff], unit: 0.625 msec) 981 */ 982 const hci_cmd_t hci_le_create_connection= { 983 OPCODE(OGF_LE_CONTROLLER, 0x0d), "2211B1222222" 984 // return: none -> le create connection complete event 985 }; 986 987 const hci_cmd_t hci_le_create_connection_cancel = { 988 OPCODE(OGF_LE_CONTROLLER, 0x0e), "" 989 // return: status 990 }; 991 992 const hci_cmd_t hci_le_read_white_list_size = { 993 OPCODE(OGF_LE_CONTROLLER, 0x0f), "" 994 // return: status, number of entries in controller whitelist 995 }; 996 997 const hci_cmd_t hci_le_clear_white_list = { 998 OPCODE(OGF_LE_CONTROLLER, 0x10), "" 999 // return: status 1000 }; 1001 1002 /** 1003 * @param address_type (public (0), random (1)) 1004 * @param bd_addr 1005 */ 1006 const hci_cmd_t hci_le_add_device_to_white_list = { 1007 OPCODE(OGF_LE_CONTROLLER, 0x11), "1B" 1008 // return: status 1009 }; 1010 1011 /** 1012 * @param address_type (public (0), random (1)) 1013 * @param bd_addr 1014 */ 1015 const hci_cmd_t hci_le_remove_device_from_white_list = { 1016 OPCODE(OGF_LE_CONTROLLER, 0x12), "1B" 1017 // return: status 1018 }; 1019 1020 /** 1021 * @param conn_handle 1022 * @param conn_interval_min ([0x0006,0x0c80], unit: 1.25 msec) 1023 * @param conn_interval_max ([0x0006,0x0c80], unit: 1.25 msec) 1024 * @param conn_latency ([0x0000,0x03e8], number of connection events) 1025 * @param supervision_timeout ([0x000a,0x0c80], unit: 10 msec) 1026 * @param minimum_CE_length ([0x0000,0xffff], unit: 0.625 msec) 1027 * @param maximum_CE_length ([0x0000,0xffff], unit: 0.625 msec) 1028 */ 1029 const hci_cmd_t hci_le_connection_update = { 1030 OPCODE(OGF_LE_CONTROLLER, 0x13), "H222222" 1031 // return: none -> le connection update complete event 1032 }; 1033 1034 /** 1035 * @param channel_map_lower_32bits 1036 * @param channel_map_higher_5bits 1037 */ 1038 const hci_cmd_t hci_le_set_host_channel_classification = { 1039 OPCODE(OGF_LE_CONTROLLER, 0x14), "41" 1040 // return: status 1041 }; 1042 1043 /** 1044 * @param conn_handle 1045 */ 1046 const hci_cmd_t hci_le_read_channel_map = { 1047 OPCODE(OGF_LE_CONTROLLER, 0x15), "H" 1048 // return: status, connection handle, channel map (5 bytes, 37 used) 1049 }; 1050 1051 /** 1052 * @param conn_handle 1053 */ 1054 const hci_cmd_t hci_le_read_remote_used_features = { 1055 OPCODE(OGF_LE_CONTROLLER, 0x16), "H" 1056 // return: none -> le read remote used features complete event 1057 }; 1058 1059 /** 1060 * @param key ((128) for AES-128) 1061 * @param plain_text (128) 1062 */ 1063 const hci_cmd_t hci_le_encrypt = { 1064 OPCODE(OGF_LE_CONTROLLER, 0x17), "PP" 1065 // return: status, encrypted data (128) 1066 }; 1067 1068 const hci_cmd_t hci_le_rand = { 1069 OPCODE(OGF_LE_CONTROLLER, 0x18), "" 1070 // return: status, random number (64) 1071 }; 1072 1073 /** 1074 * @param conn_handle 1075 * @param random_number_lower_32bits 1076 * @param random_number_higher_32bits 1077 * @param encryption_diversifier (16) 1078 * @param long_term_key (128) 1079 */ 1080 const hci_cmd_t hci_le_start_encryption = { 1081 OPCODE(OGF_LE_CONTROLLER, 0x19), "H442P" 1082 // return: none -> encryption changed or encryption key refresh complete event 1083 }; 1084 1085 /** 1086 * @param connection_handle 1087 * @param long_term_key (128) 1088 */ 1089 const hci_cmd_t hci_le_long_term_key_request_reply = { 1090 OPCODE(OGF_LE_CONTROLLER, 0x1a), "HP" 1091 // return: status, connection handle 1092 }; 1093 1094 /** 1095 * @param conn_handle 1096 */ 1097 const hci_cmd_t hci_le_long_term_key_negative_reply = { 1098 OPCODE(OGF_LE_CONTROLLER, 0x1b), "H" 1099 // return: status, connection handle 1100 }; 1101 1102 /** 1103 * @param conn_handle 1104 */ 1105 const hci_cmd_t hci_le_read_supported_states = { 1106 OPCODE(OGF_LE_CONTROLLER, 0x1c), "H" 1107 // return: status, LE states (64) 1108 }; 1109 1110 /** 1111 * @param rx_frequency ([0x00 0x27], frequency (MHz): 2420 + N*2) 1112 */ 1113 const hci_cmd_t hci_le_receiver_test = { 1114 OPCODE(OGF_LE_CONTROLLER, 0x1d), "1" 1115 // return: status 1116 }; 1117 1118 /** 1119 * @param tx_frequency ([0x00 0x27], frequency (MHz): 2420 + N*2) 1120 * @param test_payload_lengh ([0x00,0x25]) 1121 * @param packet_payload ([0,7] different patterns) 1122 */ 1123 const hci_cmd_t hci_le_transmitter_test = { 1124 OPCODE(OGF_LE_CONTROLLER, 0x1e), "111" 1125 // return: status 1126 }; 1127 1128 /** 1129 * @param end_test_cmd 1130 */ 1131 const hci_cmd_t hci_le_test_end = { 1132 OPCODE(OGF_LE_CONTROLLER, 0x1f), "1" 1133 // return: status, number of packets (8) 1134 }; 1135 1136 /** 1137 * @param conn_handle 1138 * @param conn_interval_min ([0x0006,0x0c80], unit: 1.25 msec) 1139 * @param conn_interval_max ([0x0006,0x0c80], unit: 1.25 msec) 1140 * @param conn_latency ([0x0000,0x03e8], number of connection events) 1141 * @param supervision_timeout ([0x000a,0x0c80], unit: 10 msec) 1142 * @param minimum_CE_length ([0x0000,0xffff], unit: 0.625 msec) 1143 * @param maximum_CE_length ([0x0000,0xffff], unit: 0.625 msec) 1144 */ 1145 const hci_cmd_t hci_le_remote_connection_parameter_request_reply = { 1146 OPCODE(OGF_LE_CONTROLLER, 0x20), "H222222" 1147 // return: status, connection handle 1148 }; 1149 1150 /** 1151 * @param con_handle 1152 * @param reason 1153 */ 1154 const hci_cmd_t hci_le_remote_connection_parameter_request_negative_reply = { 1155 OPCODE(OGF_LE_CONTROLLER, 0x21), "H1" 1156 // return: status, connection handle 1157 }; 1158 1159 /** 1160 * @param con_handle 1161 * @param tx_octets 1162 * @param tx_time 1163 */ 1164 const hci_cmd_t hci_le_set_data_length = { 1165 OPCODE(OGF_LE_CONTROLLER, 0x22), "H22" 1166 // return: status, connection handle 1167 }; 1168 1169 /** 1170 */ 1171 const hci_cmd_t hci_le_read_suggested_default_data_length = { 1172 OPCODE(OGF_LE_CONTROLLER, 0x23), "" 1173 // return: status, suggested max tx octets, suggested max tx time 1174 }; 1175 1176 /** 1177 * @param suggested_max_tx_octets 1178 * @param suggested_max_tx_time 1179 */ 1180 const hci_cmd_t hci_le_write_suggested_default_data_length = { 1181 OPCODE(OGF_LE_CONTROLLER, 0x24), "22" 1182 // return: status 1183 }; 1184 1185 /** 1186 */ 1187 const hci_cmd_t hci_le_read_local_p256_public_key = { 1188 OPCODE(OGF_LE_CONTROLLER, 0x25), "" 1189 // LE Read Local P-256 Public Key Complete is generated on completion 1190 }; 1191 1192 /** 1193 * @param public key 1194 * @param private key 1195 */ 1196 const hci_cmd_t hci_le_generate_dhkey = { 1197 OPCODE(OGF_LE_CONTROLLER, 0x26), "QQ" 1198 // LE Generate DHKey Complete is generated on completion 1199 }; 1200 1201 /** 1202 */ 1203 const hci_cmd_t hci_le_read_maximum_data_length = { 1204 OPCODE(OGF_LE_CONTROLLER, 0x2F), "" 1205 // return: status, supported max tx octets, supported max tx time, supported max rx octets, supported max rx time 1206 }; 1207 1208 /** 1209 * @param con_handle 1210 */ 1211 const hci_cmd_t hci_le_read_phy = { 1212 OPCODE(OGF_LE_CONTROLLER, 0x30), "H" 1213 // return: status, connection handler, tx phy, rx phy 1214 }; 1215 1216 /** 1217 * @param all_phys 1218 * @param tx_phys 1219 * @param rx_phys 1220 */ 1221 const hci_cmd_t hci_le_set_default_phy = { 1222 OPCODE(OGF_LE_CONTROLLER, 0x31), "111" 1223 // return: status 1224 }; 1225 1226 /** 1227 * @param con_handle 1228 * @param all_phys 1229 * @param tx_phys 1230 * @param rx_phys 1231 * @param phy_options 1232 */ 1233 const hci_cmd_t hci_le_set_phy = { 1234 OPCODE(OGF_LE_CONTROLLER, 0x32), "H1111" 1235 // LE PHY Update Complete is generated on completion 1236 }; 1237 1238 1239 #endif 1240 1241 // Broadcom / Cypress specific HCI commands 1242 1243 /** 1244 * @brief Configure SCO Routing (BCM) 1245 * @param sco_routing is 0 for PCM, 1 for Transport, 2 for Codec and 3 for I2S 1246 * @param pcm_interface_rate is 0 for 128KBps, 1 for 256 KBps, 2 for 512KBps, 3 for 1024KBps, and 4 for 2048Kbps 1247 * @param frame_type is 0 for short and 1 for long 1248 * @param sync_mode is 0 for slave and 1 for master 1249 * @param clock_mode is 0 for slabe and 1 for master 1250 */ 1251 const hci_cmd_t hci_bcm_write_sco_pcm_int = { 1252 OPCODE(0x3f, 0x1c), "11111" 1253 // return: status 1254 }; 1255 1256 /** 1257 * @brief Activates selected Sleep Mode 1258 * @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 1259 * @param idle_threshold_host (modes 1,2,5,7) time until considered idle, unit roughly 300 ms 1260 * @param idle_threshold_controller (modes 1-7,9) time until considered idle, unit roughly 300 ms 1261 * @param bt_wake_active_mode (modes 1,2,7) 0 = BT_WAKE line is active high, 1 = BT_WAKE is active low 1262 * @param host_wake_active_mode (modes 1,2,5,7) 0 = HOST_WAKE line is active high, 1 = HOST_WAKE is active low 1263 * @param allow_host_sleep_during_sco (modes 1,2,3,5,7) 1264 * @param combine_sleep_mode_and_lpm (modes 1,2,3,5,7) 1265 * @param enable_tristate_control_of_uart_tx_line (modes 1,2,7) 1266 * @param active_connection_handling_on_suspend (modes 3,5) 1267 * @param resume_timeout (modes 3,5) 1268 * @param enable_break_to_host (mode 12) 1269 * @param pulsed_host_wake (modes 1,12) 1270 */ 1271 const hci_cmd_t hci_bcm_set_sleep_mode = { 1272 OPCODE(0x3f, 0x0027), "111111111111" 1273 }; 1274