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 * @param transmit_bandwidth 8000(64kbps) 330 * @param receive_bandwidth 8000(64kbps) 331 * @param max_latency >= 7ms for eSCO, 0xFFFF do not care 332 * @param voice_settings e.g. CVSD, Input Coding: Linear, Input Data Format: 2’s complement, data 16bit: 00011000000 == 0x60 333 * @param retransmission_effort e.g. 0xFF do not care 334 * @param packet_type at least EV3 for eSCO 335 */ 336 const hci_cmd_t hci_setup_synchronous_connection = { 337 OPCODE(OGF_LINK_CONTROL, 0x0028), "H442212" 338 }; 339 340 /** 341 * @param bd_addr 342 * @param transmit_bandwidth 343 * @param receive_bandwidth 344 * @param max_latency 345 * @param voice_settings 346 * @param retransmission_effort 347 * @param packet_type 348 */ 349 const hci_cmd_t hci_accept_synchronous_connection = { 350 OPCODE(OGF_LINK_CONTROL, 0x0029), "B442212" 351 }; 352 353 /** 354 * @param bd_addr 355 * @param IO_capability 356 * @param OOB_data_present 357 * @param authentication_requirements 358 */ 359 const hci_cmd_t hci_io_capability_request_reply = { 360 OPCODE(OGF_LINK_CONTROL, 0x2b), "B111" 361 }; 362 363 /** 364 * @param bd_addr 365 */ 366 const hci_cmd_t hci_user_confirmation_request_reply = { 367 OPCODE(OGF_LINK_CONTROL, 0x2c), "B" 368 }; 369 370 /** 371 * @param bd_addr 372 */ 373 const hci_cmd_t hci_user_confirmation_request_negative_reply = { 374 OPCODE(OGF_LINK_CONTROL, 0x2d), "B" 375 }; 376 377 /** 378 * @param bd_addr 379 * @param numeric_value 380 */ 381 const hci_cmd_t hci_user_passkey_request_reply = { 382 OPCODE(OGF_LINK_CONTROL, 0x2e), "B4" 383 }; 384 385 /** 386 * @param bd_addr 387 */ 388 const hci_cmd_t hci_user_passkey_request_negative_reply = { 389 OPCODE(OGF_LINK_CONTROL, 0x2f), "B" 390 }; 391 392 /** 393 * @param bd_addr 394 * @param c Simple Pairing Hash C 395 * @param r Simple Pairing Randomizer R 396 */ 397 const hci_cmd_t hci_remote_oob_data_request_reply = { 398 OPCODE(OGF_LINK_CONTROL, 0x30), "BPP" 399 }; 400 401 /** 402 * @param bd_addr 403 */ 404 const hci_cmd_t hci_remote_oob_data_request_negative_reply = { 405 OPCODE(OGF_LINK_CONTROL, 0x33), "B" 406 }; 407 408 /** 409 * @param bd_addr 410 * @param reason (Part D, Error codes) 411 */ 412 const hci_cmd_t hci_io_capability_request_negative_reply = { 413 OPCODE(OGF_LINK_CONTROL, 0x34), "B1" 414 }; 415 416 /** 417 * @param handle 418 * @param transmit_bandwidth 419 * @param receive_bandwidth 420 * @param transmit_coding_format_type 421 * @param transmit_coding_format_company 422 * @param transmit_coding_format_codec 423 * @param receive_coding_format_type 424 * @param receive_coding_format_company 425 * @param receive_coding_format_codec 426 * @param transmit_coding_frame_size 427 * @param receive_coding_frame_size 428 * @param input_bandwidth 429 * @param output_bandwidth 430 * @param input_coding_format_type 431 * @param input_coding_format_company 432 * @param input_coding_format_codec 433 * @param output_coding_format_type 434 * @param output_coding_format_company 435 * @param output_coding_format_codec 436 * @param input_coded_data_size 437 * @param outupt_coded_data_size 438 * @param input_pcm_data_format 439 * @param output_pcm_data_format 440 * @param input_pcm_sample_payload_msb_position 441 * @param output_pcm_sample_payload_msb_position 442 * @param input_data_path 443 * @param output_data_path 444 * @param input_transport_unit_size 445 * @param output_transport_unit_size 446 * @param max_latency 447 * @param packet_type 448 * @param retransmission_effort 449 */ 450 const hci_cmd_t hci_enhanced_setup_synchronous_connection = { 451 OPCODE(OGF_LINK_CONTROL, 0x3d), "H4412212222441221222211111111221" 452 }; 453 454 /** 455 * @param bd_addr 456 * @param transmit_bandwidth 457 * @param receive_bandwidth 458 * @param transmit_coding_format_type 459 * @param transmit_coding_format_company 460 * @param transmit_coding_format_codec 461 * @param receive_coding_format_type 462 * @param receive_coding_format_company 463 * @param receive_coding_format_codec 464 * @param transmit_coding_frame_size 465 * @param receive_coding_frame_size 466 * @param input_bandwidth 467 * @param output_bandwidth 468 * @param input_coding_format_type 469 * @param input_coding_format_company 470 * @param input_coding_format_codec 471 * @param output_coding_format_type 472 * @param output_coding_format_company 473 * @param output_coding_format_codec 474 * @param input_coded_data_size 475 * @param outupt_coded_data_size 476 * @param input_pcm_data_format 477 * @param output_pcm_data_format 478 * @param input_pcm_sample_payload_msb_position 479 * @param output_pcm_sample_payload_msb_position 480 * @param input_data_path 481 * @param output_data_path 482 * @param input_transport_unit_size 483 * @param output_transport_unit_size 484 * @param max_latency 485 * @param packet_type 486 * @param retransmission_effort 487 */ 488 const hci_cmd_t hci_enhanced_accept_synchronous_connection = { 489 OPCODE(OGF_LINK_CONTROL, 0x3e), "B4412212222441221222211111111221" 490 }; 491 492 /** 493 * Link Policy Commands 494 */ 495 496 /** 497 * @param handle 498 * @param sniff_max_interval 499 * @param sniff_min_interval 500 * @param sniff_attempt 501 * @param sniff_timeout 502 */ 503 const hci_cmd_t hci_sniff_mode = { 504 OPCODE(OGF_LINK_POLICY, 0x03), "H2222" 505 }; 506 507 /** 508 * @param handle 509 * @param flags 510 * @param service_type 511 * @param token_rate (bytes/s) 512 * @param peak_bandwith (bytes/s) 513 * @param latency (us) 514 * @param delay_variation (us) 515 */ 516 const hci_cmd_t hci_qos_setup = { 517 OPCODE(OGF_LINK_POLICY, 0x07), "H114444" 518 }; 519 520 /** 521 * @param handle 522 */ 523 const hci_cmd_t hci_role_discovery = { 524 OPCODE(OGF_LINK_POLICY, 0x09), "H" 525 }; 526 527 /** 528 * @param bd_addr 529 * @param role (0=master,1=slave) 530 */ 531 const hci_cmd_t hci_switch_role_command= { 532 OPCODE(OGF_LINK_POLICY, 0x0b), "B1" 533 }; 534 535 /** 536 * @param handle 537 */ 538 const hci_cmd_t hci_read_link_policy_settings = { 539 OPCODE(OGF_LINK_POLICY, 0x0c), "H" 540 }; 541 542 /** 543 * @param handle 544 * @param settings 545 */ 546 const hci_cmd_t hci_write_link_policy_settings = { 547 OPCODE(OGF_LINK_POLICY, 0x0d), "H2" 548 }; 549 550 551 /** 552 * Controller & Baseband Commands 553 */ 554 555 /** 556 * @param event_mask_lover_octets 557 * @param event_mask_higher_octets 558 */ 559 const hci_cmd_t hci_set_event_mask = { 560 OPCODE(OGF_CONTROLLER_BASEBAND, 0x01), "44" 561 }; 562 563 /** 564 */ 565 const hci_cmd_t hci_reset = { 566 OPCODE(OGF_CONTROLLER_BASEBAND, 0x03), "" 567 }; 568 569 /** 570 * @param handle 571 */ 572 const hci_cmd_t hci_flush = { 573 OPCODE(OGF_CONTROLLER_BASEBAND, 0x09), "H" 574 }; 575 576 /** 577 * @param bd_addr 578 * @param delete_all_flags 579 */ 580 const hci_cmd_t hci_delete_stored_link_key = { 581 OPCODE(OGF_CONTROLLER_BASEBAND, 0x12), "B1" 582 }; 583 584 #ifdef ENABLE_CLASSIC 585 /** 586 * @param local_name (UTF-8, Null Terminated, max 248 octets) 587 */ 588 const hci_cmd_t hci_write_local_name = { 589 OPCODE(OGF_CONTROLLER_BASEBAND, 0x13), "N" 590 }; 591 #endif 592 593 /** 594 */ 595 const hci_cmd_t hci_read_local_name = { 596 OPCODE(OGF_CONTROLLER_BASEBAND, 0x14), "" 597 }; 598 599 /** 600 * @param page_timeout (* 0.625 ms) 601 */ 602 const hci_cmd_t hci_write_page_timeout = { 603 OPCODE(OGF_CONTROLLER_BASEBAND, 0x18), "2" 604 }; 605 606 /** 607 * @param scan_enable (no, inq, page, inq+page) 608 */ 609 const hci_cmd_t hci_write_scan_enable = { 610 OPCODE(OGF_CONTROLLER_BASEBAND, 0x1A), "1" 611 }; 612 613 /** 614 * @param authentication_enable 615 */ 616 const hci_cmd_t hci_write_authentication_enable = { 617 OPCODE(OGF_CONTROLLER_BASEBAND, 0x20), "1" 618 }; 619 620 /** 621 * @param class_of_device 622 */ 623 const hci_cmd_t hci_write_class_of_device = { 624 OPCODE(OGF_CONTROLLER_BASEBAND, 0x24), "3" 625 }; 626 627 /** 628 */ 629 const hci_cmd_t hci_read_num_broadcast_retransmissions = { 630 OPCODE(OGF_CONTROLLER_BASEBAND, 0x29), "" 631 }; 632 633 /** 634 * @param num_broadcast_retransmissions (e.g. 0 for a single broadcast) 635 */ 636 const hci_cmd_t hci_write_num_broadcast_retransmissions = { 637 OPCODE(OGF_CONTROLLER_BASEBAND, 0x2a), "1" 638 }; 639 640 /** 641 * @param synchronous_flow_control_enable - if yes, num completed packet everts are sent for SCO packets 642 */ 643 const hci_cmd_t hci_write_synchronous_flow_control_enable = { 644 OPCODE(OGF_CONTROLLER_BASEBAND, 0x2f), "1" 645 }; 646 647 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 648 649 /** 650 * @param flow_control_enable - 0: off, 1: ACL only, 2: SCO only, 3: ACL + SCO 651 */ 652 const hci_cmd_t hci_set_controller_to_host_flow_control = { 653 OPCODE(OGF_CONTROLLER_BASEBAND, 0x31), "1" 654 }; 655 656 /** 657 * @param host_acl_data_packet_length 658 * @param host_synchronous_data_packet_length 659 * @param host_total_num_acl_data_packets 660 * @param host_total_num_synchronous_data_packets 661 */ 662 const hci_cmd_t hci_host_buffer_size = { 663 OPCODE(OGF_CONTROLLER_BASEBAND, 0x33), "2122" 664 }; 665 666 #if 0 667 // 668 // command sent manually sent by hci_host_num_completed_packets 669 // 670 /** 671 * @note only single handle supported by BTstack command generator 672 * @param number_of_handles must be 1 673 * @param connection_handle 674 * @param host_num_of_completed_packets for the given connection handle 675 */ 676 const hci_cmd_t hci_host_number_of_completed_packets = { 677 OPCODE(OGF_CONTROLLER_BASEBAND, 0x35), "1H2" 678 }; 679 #endif 680 681 #endif 682 683 /** 684 * @param handle 685 */ 686 const hci_cmd_t hci_read_link_supervision_timeout = { 687 OPCODE(OGF_CONTROLLER_BASEBAND, 0x36), "H" 688 }; 689 690 /** 691 * @param handle 692 * @param timeout (0x0001 - 0xFFFF Time -> Range: 0.625ms - 40.9 sec) 693 */ 694 const hci_cmd_t hci_write_link_supervision_timeout = { 695 OPCODE(OGF_CONTROLLER_BASEBAND, 0x37), "H2" 696 }; 697 698 /** 699 * @param inquiry_mode (0x00 = standard, 0x01 = with RSSI, 0x02 = extended) 700 */ 701 const hci_cmd_t hci_write_inquiry_mode = { 702 OPCODE(OGF_CONTROLLER_BASEBAND, 0x45), "1" 703 }; 704 705 /** 706 * @param fec_required 707 * @param exstended_inquiry_response 708 */ 709 const hci_cmd_t hci_write_extended_inquiry_response = { 710 OPCODE(OGF_CONTROLLER_BASEBAND, 0x52), "1E" 711 }; 712 713 /** 714 * @param mode (0 = off, 1 = on) 715 */ 716 const hci_cmd_t hci_write_simple_pairing_mode = { 717 OPCODE(OGF_CONTROLLER_BASEBAND, 0x56), "1" 718 }; 719 720 /** 721 */ 722 const hci_cmd_t hci_read_local_oob_data = { 723 OPCODE(OGF_CONTROLLER_BASEBAND, 0x57), "" 724 // return status, C, R 725 }; 726 727 /** 728 * @param mode (0 = off, 1 = on) 729 */ 730 const hci_cmd_t hci_write_default_erroneous_data_reporting = { 731 OPCODE(OGF_CONTROLLER_BASEBAND, 0x5B), "1" 732 }; 733 734 /** 735 */ 736 const hci_cmd_t hci_read_le_host_supported = { 737 OPCODE(OGF_CONTROLLER_BASEBAND, 0x6c), "" 738 // return: status, le supported host, simultaneous le host 739 }; 740 741 /** 742 * @param le_supported_host 743 * @param simultaneous_le_host 744 */ 745 const hci_cmd_t hci_write_le_host_supported = { 746 OPCODE(OGF_CONTROLLER_BASEBAND, 0x6d), "11" 747 // return: status 748 }; 749 750 /** 751 */ 752 const hci_cmd_t hci_read_local_extended_ob_data = { 753 OPCODE(OGF_CONTROLLER_BASEBAND, 0x7d), "" 754 // return status, C_192, R_192, R_256, C_256 755 }; 756 757 758 /** 759 * Testing Commands 760 */ 761 762 763 /** 764 */ 765 const hci_cmd_t hci_read_loopback_mode = { 766 OPCODE(OGF_TESTING, 0x01), "" 767 // return: status, loopback mode (0 = off, 1 = local loopback, 2 = remote loopback) 768 }; 769 770 /** 771 * @param loopback_mode 772 */ 773 const hci_cmd_t hci_write_loopback_mode = { 774 OPCODE(OGF_TESTING, 0x02), "1" 775 // return: status 776 }; 777 778 /** 779 */ 780 const hci_cmd_t hci_enable_device_under_test_mode = { 781 OPCODE(OGF_TESTING, 0x03), "" 782 // return: status 783 }; 784 785 /** 786 * @param simple_pairing_debug_mode 787 */ 788 const hci_cmd_t hci_write_simple_pairing_debug_mode = { 789 OPCODE(OGF_TESTING, 0x04), "1" 790 // return: status 791 }; 792 793 /** 794 * @param handle 795 * @param dm1_acl_u_mode 796 * @param esco_loopback_mode 797 */ 798 const hci_cmd_t hci_write_secure_connections_test_mode = { 799 OPCODE(OGF_TESTING, 0x0a), "H11" 800 // return: status 801 }; 802 803 804 /** 805 * Informational Parameters 806 */ 807 808 const hci_cmd_t hci_read_local_version_information = { 809 OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x01), "" 810 }; 811 const hci_cmd_t hci_read_local_supported_commands = { 812 OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x02), "" 813 }; 814 const hci_cmd_t hci_read_local_supported_features = { 815 OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x03), "" 816 }; 817 const hci_cmd_t hci_read_buffer_size = { 818 OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x05), "" 819 }; 820 const hci_cmd_t hci_read_bd_addr = { 821 OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x09), "" 822 }; 823 824 /** 825 * Status Paramters 826 */ 827 828 /** 829 * @param handle 830 */ 831 const hci_cmd_t hci_read_rssi = { 832 OPCODE(OGF_STATUS_PARAMETERS, 0x05), "H" 833 // no params 834 }; 835 836 837 838 #ifdef ENABLE_BLE 839 /** 840 * Low Energy Commands 841 */ 842 843 /** 844 * @param event_mask_lower_octets 845 * @param event_mask_higher_octets 846 */ 847 const hci_cmd_t hci_le_set_event_mask = { 848 OPCODE(OGF_LE_CONTROLLER, 0x01), "44" 849 // return: status 850 }; 851 852 const hci_cmd_t hci_le_read_buffer_size = { 853 OPCODE(OGF_LE_CONTROLLER, 0x02), "" 854 // return: status, le acl data packet len (16), total num le acl data packets(8) 855 }; 856 const hci_cmd_t hci_le_read_supported_features = { 857 OPCODE(OGF_LE_CONTROLLER, 0x03), "" 858 // return: LE_Features See [Vol 6] Part B, Section 4.6 859 }; 860 861 /** 862 * @param random_bd_addr 863 */ 864 const hci_cmd_t hci_le_set_random_address = { 865 OPCODE(OGF_LE_CONTROLLER, 0x05), "B" 866 // return: status 867 }; 868 869 /** 870 * @param advertising_interval_min ([0x0020,0x4000], default: 0x0800, unit: 0.625 msec) 871 * @param advertising_interval_max ([0x0020,0x4000], default: 0x0800, unit: 0.625 msec) 872 * @param advertising_type (enum from 0: ADV_IND, ADC_DIRECT_IND, ADV_SCAN_IND, ADV_NONCONN_IND) 873 * @param own_address_type (enum from 0: public device address, random device address) 874 * @param direct_address_type () 875 * @param direct_address (public or random address of device to be connecteed) 876 * @param advertising_channel_map (flags: chan_37(1), chan_38(2), chan_39(4)) 877 * @param advertising_filter_policy (enum from 0: scan any conn any, scan whitelist, con any, scan any conn whitelist, scan whitelist, con whitelist) 878 */ 879 const hci_cmd_t hci_le_set_advertising_parameters = { 880 OPCODE(OGF_LE_CONTROLLER, 0x06), "22111B11" 881 // return: status 882 }; 883 884 const hci_cmd_t hci_le_read_advertising_channel_tx_power = { 885 OPCODE(OGF_LE_CONTROLLER, 0x07), "" 886 // return: status, level [-20,10] signed int (8), units dBm 887 }; 888 889 /** 890 * @param advertising_data_length 891 * @param advertising_data (31 bytes) 892 */ 893 const hci_cmd_t hci_le_set_advertising_data= { 894 OPCODE(OGF_LE_CONTROLLER, 0x08), "1A" 895 // return: status 896 }; 897 898 /** 899 * @param scan_response_data_length 900 * @param scan_response_data (31 bytes) 901 */ 902 const hci_cmd_t hci_le_set_scan_response_data= { 903 OPCODE(OGF_LE_CONTROLLER, 0x09), "1A" 904 // return: status 905 }; 906 907 /** 908 * @param advertise_enable (off: 0, on: 1) 909 */ 910 const hci_cmd_t hci_le_set_advertise_enable = { 911 OPCODE(OGF_LE_CONTROLLER, 0x0a), "1" 912 // return: status 913 }; 914 915 /** 916 * @param le_scan_type (passive (0), active (1)) 917 * @param le_scan_interval ([0x0004,0x4000], unit: 0.625 msec) 918 * @param le_scan_window ([0x0004,0x4000], unit: 0.625 msec) 919 * @param own_address_type (public (0), random (1)) 920 * @param scanning_filter_policy (any (0), only whitelist (1)) 921 */ 922 const hci_cmd_t hci_le_set_scan_parameters = { 923 OPCODE(OGF_LE_CONTROLLER, 0x0b), "12211" 924 // return: status 925 }; 926 927 /** 928 * @param le_scan_enable (disabled (0), enabled (1)) 929 * @param filter_duplices (disabled (0), enabled (1)) 930 */ 931 const hci_cmd_t hci_le_set_scan_enable = { 932 OPCODE(OGF_LE_CONTROLLER, 0x0c), "11" 933 // return: status 934 }; 935 936 /** 937 * @param le_scan_interval ([0x0004, 0x4000], unit: 0.625 msec) 938 * @param le_scan_window ([0x0004, 0x4000], unit: 0.625 msec) 939 * @param initiator_filter_policy (peer address type + peer address (0), whitelist (1)) 940 * @param peer_address_type (public (0), random (1)) 941 * @param peer_address 942 * @param own_address_type (public (0), random (1)) 943 * @param conn_interval_min ([0x0006, 0x0c80], unit: 1.25 msec) 944 * @param conn_interval_max ([0x0006, 0x0c80], unit: 1.25 msec) 945 * @param conn_latency (number of connection events [0x0000, 0x01f4]) 946 * @param supervision_timeout ([0x000a, 0x0c80], unit: 10 msec) 947 * @param minimum_CE_length ([0x0000, 0xffff], unit: 0.625 msec) 948 * @param maximum_CE_length ([0x0000, 0xffff], unit: 0.625 msec) 949 */ 950 const hci_cmd_t hci_le_create_connection= { 951 OPCODE(OGF_LE_CONTROLLER, 0x0d), "2211B1222222" 952 // return: none -> le create connection complete event 953 }; 954 955 const hci_cmd_t hci_le_create_connection_cancel = { 956 OPCODE(OGF_LE_CONTROLLER, 0x0e), "" 957 // return: status 958 }; 959 960 const hci_cmd_t hci_le_read_white_list_size = { 961 OPCODE(OGF_LE_CONTROLLER, 0x0f), "" 962 // return: status, number of entries in controller whitelist 963 }; 964 965 const hci_cmd_t hci_le_clear_white_list = { 966 OPCODE(OGF_LE_CONTROLLER, 0x10), "" 967 // return: status 968 }; 969 970 /** 971 * @param address_type (public (0), random (1)) 972 * @param bd_addr 973 */ 974 const hci_cmd_t hci_le_add_device_to_white_list = { 975 OPCODE(OGF_LE_CONTROLLER, 0x11), "1B" 976 // return: status 977 }; 978 979 /** 980 * @param address_type (public (0), random (1)) 981 * @param bd_addr 982 */ 983 const hci_cmd_t hci_le_remove_device_from_white_list = { 984 OPCODE(OGF_LE_CONTROLLER, 0x12), "1B" 985 // return: status 986 }; 987 988 /** 989 * @param conn_handle 990 * @param conn_interval_min ([0x0006,0x0c80], unit: 1.25 msec) 991 * @param conn_interval_max ([0x0006,0x0c80], unit: 1.25 msec) 992 * @param conn_latency ([0x0000,0x03e8], number of connection events) 993 * @param supervision_timeout ([0x000a,0x0c80], unit: 10 msec) 994 * @param minimum_CE_length ([0x0000,0xffff], unit: 0.625 msec) 995 * @param maximum_CE_length ([0x0000,0xffff], unit: 0.625 msec) 996 */ 997 const hci_cmd_t hci_le_connection_update = { 998 OPCODE(OGF_LE_CONTROLLER, 0x13), "H222222" 999 // return: none -> le connection update complete event 1000 }; 1001 1002 /** 1003 * @param channel_map_lower_32bits 1004 * @param channel_map_higher_5bits 1005 */ 1006 const hci_cmd_t hci_le_set_host_channel_classification = { 1007 OPCODE(OGF_LE_CONTROLLER, 0x14), "41" 1008 // return: status 1009 }; 1010 1011 /** 1012 * @param conn_handle 1013 */ 1014 const hci_cmd_t hci_le_read_channel_map = { 1015 OPCODE(OGF_LE_CONTROLLER, 0x15), "H" 1016 // return: status, connection handle, channel map (5 bytes, 37 used) 1017 }; 1018 1019 /** 1020 * @param conn_handle 1021 */ 1022 const hci_cmd_t hci_le_read_remote_used_features = { 1023 OPCODE(OGF_LE_CONTROLLER, 0x16), "H" 1024 // return: none -> le read remote used features complete event 1025 }; 1026 1027 /** 1028 * @param key ((128) for AES-128) 1029 * @param plain_text (128) 1030 */ 1031 const hci_cmd_t hci_le_encrypt = { 1032 OPCODE(OGF_LE_CONTROLLER, 0x17), "PP" 1033 // return: status, encrypted data (128) 1034 }; 1035 1036 const hci_cmd_t hci_le_rand = { 1037 OPCODE(OGF_LE_CONTROLLER, 0x18), "" 1038 // return: status, random number (64) 1039 }; 1040 1041 /** 1042 * @param conn_handle 1043 * @param random_number_lower_32bits 1044 * @param random_number_higher_32bits 1045 * @param encryption_diversifier (16) 1046 * @param long_term_key (128) 1047 */ 1048 const hci_cmd_t hci_le_start_encryption = { 1049 OPCODE(OGF_LE_CONTROLLER, 0x19), "H442P" 1050 // return: none -> encryption changed or encryption key refresh complete event 1051 }; 1052 1053 /** 1054 * @param connection_handle 1055 * @param long_term_key (128) 1056 */ 1057 const hci_cmd_t hci_le_long_term_key_request_reply = { 1058 OPCODE(OGF_LE_CONTROLLER, 0x1a), "HP" 1059 // return: status, connection handle 1060 }; 1061 1062 /** 1063 * @param conn_handle 1064 */ 1065 const hci_cmd_t hci_le_long_term_key_negative_reply = { 1066 OPCODE(OGF_LE_CONTROLLER, 0x1b), "H" 1067 // return: status, connection handle 1068 }; 1069 1070 /** 1071 * @param conn_handle 1072 */ 1073 const hci_cmd_t hci_le_read_supported_states = { 1074 OPCODE(OGF_LE_CONTROLLER, 0x1c), "H" 1075 // return: status, LE states (64) 1076 }; 1077 1078 /** 1079 * @param rx_frequency ([0x00 0x27], frequency (MHz): 2420 + N*2) 1080 */ 1081 const hci_cmd_t hci_le_receiver_test = { 1082 OPCODE(OGF_LE_CONTROLLER, 0x1d), "1" 1083 // return: status 1084 }; 1085 1086 /** 1087 * @param tx_frequency ([0x00 0x27], frequency (MHz): 2420 + N*2) 1088 * @param test_payload_lengh ([0x00,0x25]) 1089 * @param packet_payload ([0,7] different patterns) 1090 */ 1091 const hci_cmd_t hci_le_transmitter_test = { 1092 OPCODE(OGF_LE_CONTROLLER, 0x1e), "111" 1093 // return: status 1094 }; 1095 1096 /** 1097 * @param end_test_cmd 1098 */ 1099 const hci_cmd_t hci_le_test_end = { 1100 OPCODE(OGF_LE_CONTROLLER, 0x1f), "1" 1101 // return: status, number of packets (8) 1102 }; 1103 1104 /** 1105 * @param con_handle 1106 * @param tx_octets 1107 * @param tx_time 1108 */ 1109 const hci_cmd_t hci_le_set_data_length = { 1110 OPCODE(OGF_LE_CONTROLLER, 0x22), "H22" 1111 // return: status, connection handle 1112 }; 1113 1114 1115 /** 1116 */ 1117 const hci_cmd_t hci_le_read_suggested_default_data_length = { 1118 OPCODE(OGF_LE_CONTROLLER, 0x23), "" 1119 // return: status, suggested max tx octets, suggested max tx time 1120 }; 1121 1122 /** 1123 * @param suggested_max_tx_octets 1124 * @param suggested_max_tx_time 1125 */ 1126 const hci_cmd_t hci_le_write_suggested_default_data_length = { 1127 OPCODE(OGF_LE_CONTROLLER, 0x24), "22" 1128 // return: status 1129 }; 1130 1131 /** 1132 */ 1133 const hci_cmd_t hci_le_read_local_p256_public_key = { 1134 OPCODE(OGF_LE_CONTROLLER, 0x25), "" 1135 // LE Read Local P-256 Public Key Complete is generated on completion 1136 }; 1137 1138 /** 1139 * @param public key 1140 * @param private key 1141 */ 1142 const hci_cmd_t hci_le_generate_dhkey = { 1143 OPCODE(OGF_LE_CONTROLLER, 0x26), "QQ" 1144 // LE Generate DHKey Complete is generated on completion 1145 }; 1146 1147 /** 1148 */ 1149 const hci_cmd_t hci_le_read_maximum_data_length = { 1150 OPCODE(OGF_LE_CONTROLLER, 0x2F), "" 1151 // return: status, supported max tx octets, supported max tx time, supported max rx octets, supported max rx time 1152 }; 1153 1154 #endif 1155 1156 // Broadcom / Cypress specific HCI commands 1157 1158 /** 1159 * @brief Configure SCO Routing (BCM) 1160 * @param sco_routing is 0 for PCM, 1 for Transport, 2 for Codec and 3 for I2S 1161 * @param pcm_interface_rate is 0 for 128KBps, 1 for 256 KBps, 2 for 512KBps, 3 for 1024KBps, and 4 for 2048Kbps 1162 * @param frame_type is 0 for short and 1 for long 1163 * @param sync_mode is 0 for slave and 1 for master 1164 * @param clock_mode is 0 for slabe and 1 for master 1165 */ 1166 const hci_cmd_t hci_bcm_write_sco_pcm_int = { 1167 OPCODE(0x3f, 0x1c), "11111" 1168 // return: status 1169 }; 1170