1 // SPDX-License-Identifier: LGPL-2.1-or-later
4 * BlueZ - Bluetooth protocol stack for Linux
6 * Copyright (C) 2011-2014 Intel Corporation
7 * Copyright (C) 2002-2010 Marcel Holtmann <marcel@holtmann.org>
19 #include "lib/bluetooth.h"
22 #include "src/shared/util.h"
30 #define COLOR_UNKNOWN_EVENT_MASK COLOR_WHITE_BG
31 #define COLOR_UNKNOWN_SCAN_STATUS COLOR_WHITE_BG
33 static void print_status(uint8_t status)
35 packet_print_error("Status", status);
38 static void print_module(uint8_t module)
84 print_field("Module: %s (0x%2.2x)", str, module);
87 static void null_cmd(const void *data, uint8_t size)
91 static void status_rsp(const void *data, uint8_t size)
93 uint8_t status = get_u8(data);
98 static void reset_cmd(const void *data, uint8_t size)
100 uint8_t reset_type = get_u8(data);
101 uint8_t patch_enable = get_u8(data + 1);
102 uint8_t ddc_reload = get_u8(data + 2);
103 uint8_t boot_option = get_u8(data + 3);
104 uint32_t boot_addr = get_le32(data + 4);
107 switch (reset_type) {
109 str = "Soft software reset";
112 str = "Hard software reset";
119 print_field("Reset type: %s (0x%2.2x)", str, reset_type);
121 switch (patch_enable) {
123 str = "Do not enable";
133 print_field("Patch vectors: %s (0x%2.2x)", str, patch_enable);
135 switch (ddc_reload) {
137 str = "Do not reload";
140 str = "Reload from OTP";
147 print_field("DDC parameters: %s (0x%2.2x)", str, ddc_reload);
149 switch (boot_option) {
151 str = "Current image";
154 str = "Specified address";
161 print_field("Boot option: %s (0x%2.2x)", str, boot_option);
162 print_field("Boot address: 0x%8.8x", boot_addr);
165 static void read_version_rsp(const void *data, uint8_t size)
167 uint8_t status = get_u8(data);
168 uint8_t hw_platform = get_u8(data + 1);
169 uint8_t hw_variant = get_u8(data + 2);
170 uint8_t hw_revision = get_u8(data + 3);
171 uint8_t fw_variant = get_u8(data + 4);
172 uint8_t fw_revision = get_u8(data + 5);
173 uint8_t fw_build_nn = get_u8(data + 6);
174 uint8_t fw_build_cw = get_u8(data + 7);
175 uint8_t fw_build_yy = get_u8(data + 8);
176 uint8_t fw_patch = get_u8(data + 9);
178 print_status(status);
179 print_field("Hardware platform: 0x%2.2x", hw_platform);
180 print_field("Hardware variant: 0x%2.2x", hw_variant);
181 print_field("Hardware revision: %u.%u", hw_revision >> 4,
183 print_field("Firmware variant: 0x%2.2x", fw_variant);
184 print_field("Firmware revision: %u.%u", fw_revision >> 4,
187 print_field("Firmware build: %u-%u.%u", fw_build_nn,
188 fw_build_cw, 2000 + fw_build_yy);
189 print_field("Firmware patch: %u", fw_patch);
192 static void set_uart_baudrate_cmd(const void *data, uint8_t size)
194 uint8_t baudrate = get_u8(data);
223 str = "1843200 Baud";
226 str = "3250000 baud";
229 str = "2000000 baud";
232 str = "3000000 baud";
235 str = "3714286 baud";
238 str = "4333333 baud";
241 str = "6500000 baud";
248 print_field("Baudrate: %s (0x%2.2x)", str, baudrate);
251 static void secure_send_cmd(const void *data, uint8_t size)
253 uint8_t type = get_u8(data);
274 print_field("Type: %s fragment (0x%2.2x)", str, type);
276 packet_hexdump(data + 1, size - 1);
279 static void manufacturer_mode_cmd(const void *data, uint8_t size)
281 uint8_t mode = get_u8(data);
282 uint8_t reset = get_u8(data + 1);
297 print_field("Mode switch: %s (0x%2.2x)", str, mode);
304 str = "Reset and deactivate patches";
307 str = "Reset and activate patches";
314 print_field("Reset behavior: %s (0x%2.2x)", str, reset);
317 static void write_bd_data_cmd(const void *data, uint8_t size)
321 packet_print_addr("Address", data, false);
322 packet_hexdump(data + 6, 6);
324 memcpy(features, data + 12, 8);
325 packet_print_features_lmp(features, 0);
327 memcpy(features, data + 20, 1);
328 memset(features + 1, 0, 7);
329 packet_print_features_ll(features);
331 packet_hexdump(data + 21, size - 21);
334 static void read_bd_data_rsp(const void *data, uint8_t size)
336 uint8_t status = get_u8(data);
338 print_status(status);
339 packet_print_addr("Address", data + 1, false);
340 packet_hexdump(data + 7, size - 7);
343 static void write_bd_address_cmd(const void *data, uint8_t size)
345 packet_print_addr("Address", data, false);
348 static void act_deact_traces_cmd(const void *data, uint8_t size)
350 uint8_t tx = get_u8(data);
351 uint8_t tx_arq = get_u8(data + 1);
352 uint8_t rx = get_u8(data + 2);
354 print_field("Transmit traces: 0x%2.2x", tx);
355 print_field("Transmit ARQ: 0x%2.2x", tx_arq);
356 print_field("Receive traces: 0x%2.2x", rx);
359 static void stimulate_exception_cmd(const void *data, uint8_t size)
361 uint8_t type = get_u8(data);
366 str = "Fatal Exception";
369 str = "Debug Exception";
376 print_field("Type: %s (0x%2.2x)", str, type);
379 static const struct {
384 { 1, "SCO Rejected via LMP" },
385 { 2, "PTT Switch Notification" },
386 { 7, "Scan Status" },
387 { 9, "Debug Exception" },
388 { 10, "Fatal Exception" },
389 { 11, "System Exception" },
390 { 13, "LE Link Established" },
391 { 14, "FW Trace String" },
395 static void set_event_mask_cmd(const void *data, uint8_t size)
397 const uint8_t *events_array = data;
398 uint64_t mask, events = 0;
401 for (i = 0; i < 8; i++)
402 events |= ((uint64_t) events_array[i]) << (i * 8);
404 print_field("Mask: 0x%16.16" PRIx64, events);
408 for (i = 0; events_table[i].str; i++) {
409 if (events & (((uint64_t) 1) << events_table[i].bit)) {
410 print_field(" %s", events_table[i].str);
411 mask &= ~(((uint64_t) 1) << events_table[i].bit);
416 print_text(COLOR_UNKNOWN_EVENT_MASK, " Unknown mask "
417 "(0x%16.16" PRIx64 ")", mask);
420 static void ddc_config_write_cmd(const void *data, uint8_t size)
423 uint8_t param_len = get_u8(data);
424 uint16_t param_id = get_le16(data + 1);
426 print_field("Identifier: 0x%4.4x", param_id);
427 packet_hexdump(data + 3, param_len - 2);
429 data += param_len + 1;
430 size -= param_len + 1;
434 static void ddc_config_write_rsp(const void *data, uint8_t size)
436 uint8_t status = get_u8(data);
437 uint16_t param_id = get_le16(data + 1);
439 print_status(status);
440 print_field("Identifier: 0x%4.4x", param_id);
443 static void memory_write_cmd(const void *data, uint8_t size)
445 uint32_t addr = get_le32(data);
446 uint8_t mode = get_u8(data + 4);
447 uint8_t length = get_u8(data + 5);
450 print_field("Address: 0x%8.8x", addr);
457 str = "Half word access";
467 print_field("Mode: %s (0x%2.2x)", str, mode);
468 print_field("Length: %u", length);
470 packet_hexdump(data + 6, size - 6);
473 static void read_supported_features_cmd(const void *data, uint8_t size)
475 uint8_t page = get_u8(data);
477 print_field("Page: 0x%2.2x", page);
480 static void read_supported_features_rsp(const void *data, uint8_t size)
482 uint8_t status = get_u8(data);
483 uint8_t page = get_u8(data + 1);
484 uint8_t max_pages = get_u8(data + 2);
486 print_status(status);
487 print_field("Page: 0x%2.2x", page);
488 print_field("Max Pages: 0x%2.2x", max_pages);
489 print_field("Supported Features:");
490 packet_hexdump(data + 3, size - 3);
493 static const struct vendor_ocf vendor_ocf_table[] = {
496 status_rsp, 1, true },
497 { 0x002, "No Operation" },
498 { 0x005, "Read Version",
500 read_version_rsp, 10, true },
501 { 0x006, "Set UART Baudrate",
502 set_uart_baudrate_cmd, 1, true,
503 status_rsp, 1, true },
504 { 0x007, "Enable LPM" },
505 { 0x008, "PCM Write Configuration" },
506 { 0x009, "Secure Send",
507 secure_send_cmd, 1, false,
508 status_rsp, 1, true },
509 { 0x00d, "Read Secure Boot Params",
511 { 0x00e, "Write Secure Boot Params" },
513 { 0x010, "Change UART Baudrate" },
514 { 0x011, "Manufacturer Mode",
515 manufacturer_mode_cmd, 2, true,
516 status_rsp, 1, true },
517 { 0x012, "Read Link RSSI" },
518 { 0x022, "Get Exception Info" },
519 { 0x024, "Clear Exception Info" },
520 { 0x02f, "Write BD Data",
521 write_bd_data_cmd, 6, false },
522 { 0x030, "Read BD Data",
524 read_bd_data_rsp, 7, false },
525 { 0x031, "Write BD Address",
526 write_bd_address_cmd, 6, true,
527 status_rsp, 1, true },
528 { 0x032, "Flow Specification" },
529 { 0x034, "Read Secure ID" },
530 { 0x038, "Set Synchronous USB Interface Type" },
531 { 0x039, "Config Synchronous Interface" },
532 { 0x03f, "SW RF Kill",
534 status_rsp, 1, true },
535 { 0x043, "Activate Deactivate Traces",
536 act_deact_traces_cmd, 3, true },
537 { 0x04d, "Stimulate Exception",
538 stimulate_exception_cmd, 1, true,
539 status_rsp, 1, true },
540 { 0x050, "Read HW Version" },
541 { 0x052, "Set Event Mask",
542 set_event_mask_cmd, 8, true,
543 status_rsp, 1, true },
544 { 0x053, "Config_Link_Controller" },
545 { 0x089, "DDC Write" },
546 { 0x08a, "DDC Read" },
547 { 0x08b, "DDC Config Write",
548 ddc_config_write_cmd, 3, false,
549 ddc_config_write_rsp, 3, true },
550 { 0x08c, "DDC Config Read" },
551 { 0x08d, "Memory Read" },
552 { 0x08e, "Memory Write",
553 memory_write_cmd, 6, false,
554 status_rsp, 1, true },
555 { 0x0a6, "Read Supported Features",
556 read_supported_features_cmd, 1, true,
557 read_supported_features_rsp, 19, true },
562 const struct vendor_ocf *intel_vendor_ocf(uint16_t ocf)
566 for (i = 0; vendor_ocf_table[i].str; i++) {
567 if (vendor_ocf_table[i].ocf == ocf)
568 return &vendor_ocf_table[i];
574 static void startup_evt(const void *data, uint8_t size)
578 static void fatal_exception_evt(const void *data, uint8_t size)
580 uint16_t line = get_le16(data);
581 uint8_t module = get_u8(data + 2);
582 uint8_t reason = get_u8(data + 3);
584 print_field("Line: %u", line);
585 print_module(module);
586 print_field("Reason: 0x%2.2x", reason);
589 static void bootup_evt(const void *data, uint8_t size)
591 uint8_t zero = get_u8(data);
592 uint8_t num_packets = get_u8(data + 1);
593 uint8_t source = get_u8(data + 2);
594 uint8_t reset_type = get_u8(data + 3);
595 uint8_t reset_reason = get_u8(data + 4);
596 uint8_t ddc_status = get_u8(data + 5);
599 print_field("Zero: 0x%2.2x", zero);
600 print_field("Number of packets: %d", num_packets);
607 str = "Operational firmware";
610 str = "Self test firmware";
617 print_field("Source: %s (0x%2.2x)", str, source);
619 switch (reset_type) {
621 str = "Hardware reset";
624 str = "Soft watchdog reset";
627 str = "Soft software reset";
630 str = "Hard watchdog reset";
633 str = "Hard software reset";
640 print_field("Reset type: %s (0x%2.2x)", str, reset_type);
642 switch (reset_reason) {
647 str = "Reset command";
650 str = "Intel reset command";
656 str = "Fatal exception";
659 str = "System exception";
669 print_field("Reset reason: %s (0x%2.2x)", str, reset_reason);
671 switch (ddc_status) {
673 str = "Firmware default";
676 str = "Firmware default plus OTP";
679 str = "Persistent RAM";
689 print_field("DDC status: %s (0x%2.2x)", str, ddc_status);
692 static void default_bd_data_evt(const void *data, uint8_t size)
694 uint8_t mem_status = get_u8(data);
697 switch (mem_status) {
699 str = "Invalid manufacturing data";
706 print_field("Memory status: %s (0x%2.2x)", str, mem_status);
709 static void secure_send_commands_result_evt(const void *data, uint8_t size)
711 uint8_t result = get_u8(data);
712 uint16_t opcode = get_le16(data + 1);
713 uint16_t ogf = cmd_opcode_ogf(opcode);
714 uint16_t ocf = cmd_opcode_ocf(opcode);
715 uint8_t status = get_u8(data + 3);
723 str = "General failure";
726 str = "Hardware failure";
729 str = "Signature verification failed";
732 str = "Parsing error of command buffer";
735 str = "Command execution failure";
738 str = "Command parameters error";
741 str = "Command missing";
748 print_field("Result: %s (0x%2.2x)", str, result);
749 print_field("Opcode: 0x%4.4x (0x%2.2x|0x%4.4x)", opcode, ogf, ocf);
750 print_status(status);
753 static void debug_exception_evt(const void *data, uint8_t size)
755 uint16_t line = get_le16(data);
756 uint8_t module = get_u8(data + 2);
757 uint8_t reason = get_u8(data + 3);
759 print_field("Line: %u", line);
760 print_module(module);
761 print_field("Reason: 0x%2.2x", reason);
764 static void le_link_established_evt(const void *data, uint8_t size)
766 uint16_t handle = get_le16(data);
767 uint32_t access_addr = get_le32(data + 10);
769 print_field("Handle: %u", handle);
771 packet_hexdump(data + 2, 8);
773 print_field("Access address: 0x%8.8x", access_addr);
775 packet_hexdump(data + 14, size - 14);
778 static void scan_status_evt(const void *data, uint8_t size)
780 uint8_t enable = get_u8(data);
782 print_field("Inquiry scan: %s",
783 (enable & 0x01) ? "Enabled" : "Disabled");
784 print_field("Page scan: %s",
785 (enable & 0x02) ? "Enabled" : "Disabled");
788 print_text(COLOR_UNKNOWN_SCAN_STATUS,
789 " Unknown status (0x%2.2x)", enable & 0xfc);
793 static void act_deact_traces_complete_evt(const void *data, uint8_t size)
795 uint8_t status = get_u8(data);
797 print_status(status);
800 static void lmp_pdu_trace_evt(const void *data, uint8_t size)
802 uint8_t type, len, id;
803 uint16_t handle, count;
808 handle = get_le16(data + 1);
834 print_field("Type: %s (0x%2.2x)", str, type);
835 print_field("Handle: %u", handle);
840 clock = get_le32(data + 4 + len);
842 packet_hexdump(data + 3, 1);
843 lmp_packet(data + 4, len, false);
844 print_field("Clock: 0x%8.8x", clock);
848 clock = get_le32(data + 4 + len);
849 id = get_u8(data + 4 + len + 4);
851 packet_hexdump(data + 3, 1);
852 lmp_packet(data + 4, len, false);
853 print_field("Clock: 0x%8.8x", clock);
854 print_field("ID: 0x%2.2x", id);
857 clock = get_le32(data + 3);
858 id = get_u8(data + 3 + 4);
860 print_field("Clock: 0x%8.8x", clock);
861 print_field("ID: 0x%2.2x", id);
865 count = get_le16(data + 3);
867 print_field("Count: 0x%4.4x", count);
868 packet_hexdump(data + 3 + 2 + 1, 2);
869 llcp_packet(data + 8, len, false);
873 count = get_le16(data + 3);
874 id = get_u8(data + 3 + 2);
876 print_field("Count: 0x%4.4x", count);
877 print_field("ID: 0x%2.2x", id);
878 packet_hexdump(data + 3 + 2 + 1, 2);
879 llcp_packet(data + 8, len, false);
882 count = get_le16(data + 3);
883 id = get_u8(data + 3 + 2);
885 print_field("Count: 0x%4.4x", count);
886 print_field("ID: 0x%2.2x", id);
889 packet_hexdump(data + 3, size - 3);
894 static void write_bd_data_complete_evt(const void *data, uint8_t size)
896 uint8_t status = get_u8(data);
898 print_status(status);
901 static void sco_rejected_via_lmp_evt(const void *data, uint8_t size)
903 uint8_t reason = get_u8(data + 6);
905 packet_print_addr("Address", data, false);
906 packet_print_error("Reason", reason);
909 static void ptt_switch_notification_evt(const void *data, uint8_t size)
911 uint16_t handle = get_le16(data);
912 uint8_t table = get_u8(data + 2);
915 print_field("Handle: %u", handle);
922 str = "Enhanced data rate";
929 print_field("Packet type table: %s (0x%2.2x)", str, table);
932 static void system_exception_evt(const void *data, uint8_t size)
934 uint8_t type = get_u8(data);
939 str = "No Exception";
942 str = "Undefined Instruction";
945 str = "Prefetch abort";
955 print_field("Type: %s (0x%2.2x)", str, type);
957 packet_hexdump(data + 1, size - 1);
960 static const struct vendor_evt vendor_evt_table[] = {
962 startup_evt, 0, true },
963 { 0x01, "Fatal Exception",
964 fatal_exception_evt, 4, true },
966 bootup_evt, 6, true },
967 { 0x05, "Default BD Data",
968 default_bd_data_evt, 1, true },
969 { 0x06, "Secure Send Commands Result",
970 secure_send_commands_result_evt, 4, true },
971 { 0x08, "Debug Exception",
972 debug_exception_evt, 4, true },
973 { 0x0f, "LE Link Established",
974 le_link_established_evt, 26, true },
975 { 0x11, "Scan Status",
976 scan_status_evt, 1, true },
977 { 0x16, "Activate Deactivate Traces Complete",
978 act_deact_traces_complete_evt, 1, true },
979 { 0x17, "LMP PDU Trace",
980 lmp_pdu_trace_evt, 3, false },
981 { 0x19, "Write BD Data Complete",
982 write_bd_data_complete_evt, 1, true },
983 { 0x25, "SCO Rejected via LMP",
984 sco_rejected_via_lmp_evt, 7, true },
985 { 0x26, "PTT Switch Notification",
986 ptt_switch_notification_evt, 3, true },
987 { 0x29, "System Exception",
988 system_exception_evt, 133, true },
989 { 0x2c, "FW Trace String" },
990 { 0x2e, "FW Trace Binary" },
994 const struct vendor_evt *intel_vendor_evt(uint8_t evt)
998 for (i = 0; vendor_evt_table[i].str; i++) {
999 if (vendor_evt_table[i].evt == evt)
1000 return &vendor_evt_table[i];