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
32 #define COLOR_UNKNOWN_EXT_EVENT COLOR_WHITE_BG
34 static void print_status(uint8_t status)
36 packet_print_error("Status", status);
39 static void print_module(uint8_t module)
85 print_field("Module: %s (0x%2.2x)", str, module);
88 static void null_cmd(const void *data, uint8_t size)
92 static void status_rsp(const void *data, uint8_t size)
94 uint8_t status = get_u8(data);
99 static void reset_cmd(const void *data, uint8_t size)
101 uint8_t reset_type = get_u8(data);
102 uint8_t patch_enable = get_u8(data + 1);
103 uint8_t ddc_reload = get_u8(data + 2);
104 uint8_t boot_option = get_u8(data + 3);
105 uint32_t boot_addr = get_le32(data + 4);
108 switch (reset_type) {
110 str = "Soft software reset";
113 str = "Hard software reset";
120 print_field("Reset type: %s (0x%2.2x)", str, reset_type);
122 switch (patch_enable) {
124 str = "Do not enable";
134 print_field("Patch vectors: %s (0x%2.2x)", str, patch_enable);
136 switch (ddc_reload) {
138 str = "Do not reload";
141 str = "Reload from OTP";
148 print_field("DDC parameters: %s (0x%2.2x)", str, ddc_reload);
150 switch (boot_option) {
152 str = "Current image";
155 str = "Specified address";
162 print_field("Boot option: %s (0x%2.2x)", str, boot_option);
163 print_field("Boot address: 0x%8.8x", boot_addr);
166 struct intel_version_tlv {
172 static void print_version_tlv_u32(const struct intel_version_tlv *tlv,
175 print_field("%s(%u): 0x%8.8x", type_str, tlv->type, get_le32(tlv->val));
178 static void print_version_tlv_u16(const struct intel_version_tlv *tlv,
181 print_field("%s(%u): 0x%4.4x", type_str, tlv->type, get_le16(tlv->val));
184 static void print_version_tlv_u8(const struct intel_version_tlv *tlv,
187 print_field("%s(%u): 0x%2.2x", type_str, tlv->type, get_u8(tlv->val));
190 static void print_version_tlv_enabled(const struct intel_version_tlv *tlv,
193 print_field("%s(%u): %s(%u)", type_str, tlv->type,
194 tlv->val[0] ? "Enabled" : "Disabled",
198 static void print_version_tlv_img_type(const struct intel_version_tlv *tlv,
203 switch (get_u8(tlv->val)) {
214 print_field("%s(%u): %s(0x%2.2x)", type_str, tlv->type, str,
218 static void print_version_tlv_timestamp(const struct intel_version_tlv *tlv,
221 print_field("%s(%u): %u-%u", type_str, tlv->type,
222 tlv->val[1], tlv->val[0]);
225 static void print_version_tlv_min_fw(const struct intel_version_tlv *tlv,
228 print_field("%s(%u): %u-%u.%u", type_str, tlv->type,
229 tlv->val[0], tlv->val[1], 2000 + tlv->val[2]);
232 static void print_version_tlv_otp_bdaddr(const struct intel_version_tlv *tlv,
235 packet_print_addr(type_str, tlv->val, 0x00);
238 static void print_version_tlv_unknown(const struct intel_version_tlv *tlv,
241 print_field("%s(%u): ", type_str, tlv->type);
242 packet_hexdump(tlv->val, tlv->len);
245 static void print_version_tlv_mfg(const struct intel_version_tlv *tlv,
248 uint16_t mfg_id = get_le16(tlv->val);
250 print_field("%s(%u): %s (%u)", type_str, tlv->type,
251 bt_compidtostr(mfg_id), mfg_id);
254 static const struct intel_version_tlv_desc {
257 void (*func)(const struct intel_version_tlv *tlv, char *type_str);
258 } intel_version_tlv_table[] = {
259 { 16, "CNVi TOP", print_version_tlv_u32 },
260 { 17, "CNVr TOP", print_version_tlv_u32 },
261 { 18, "CNVi BT", print_version_tlv_u32 },
262 { 19, "CNVr BT", print_version_tlv_u32 },
263 { 20, "CNVi OTP", print_version_tlv_u16 },
264 { 21, "CNVr OTP", print_version_tlv_u16 },
265 { 22, "Device Rev ID", print_version_tlv_u16 },
266 { 23, "USB VID", print_version_tlv_u16 },
267 { 24, "USB PID", print_version_tlv_u16 },
268 { 25, "PCIE VID", print_version_tlv_u16 },
269 { 26, "PCIe DID", print_version_tlv_u16 },
270 { 27, "PCIe Subsystem ID", print_version_tlv_u16 },
271 { 28, "Image Type", print_version_tlv_img_type },
272 { 29, "Time Stamp", print_version_tlv_timestamp },
273 { 30, "Build Type", print_version_tlv_u8 },
274 { 31, "Build Num", print_version_tlv_u32 },
275 { 32, "FW Build Product", print_version_tlv_u8 },
276 { 33, "FW Build HW", print_version_tlv_u8 },
277 { 34, "FW Build Step", print_version_tlv_u8 },
278 { 35, "BT Spec", print_version_tlv_u8 },
279 { 36, "Manufacturer", print_version_tlv_mfg },
280 { 37, "HCI Revision", print_version_tlv_u16 },
281 { 38, "LMP SubVersion", print_version_tlv_u16 },
282 { 39, "OTP Patch Version", print_version_tlv_u8 },
283 { 40, "Secure Boot", print_version_tlv_enabled },
284 { 41, "Key From Header", print_version_tlv_enabled },
285 { 42, "OTP Lock", print_version_tlv_enabled },
286 { 43, "API Lock", print_version_tlv_enabled },
287 { 44, "Debug Lock", print_version_tlv_enabled },
288 { 45, "Minimum FW", print_version_tlv_min_fw },
289 { 46, "Limited CCE", print_version_tlv_enabled },
290 { 47, "SBE Type", print_version_tlv_u8 },
291 { 48, "OTP BDADDR", print_version_tlv_otp_bdaddr },
292 { 49, "Unlocked State", print_version_tlv_enabled },
296 static void read_version_tlv_rsp(const void *data, uint8_t size)
298 uint8_t status = get_u8(data);
300 print_status(status);
302 /* Consume the status */
307 const struct intel_version_tlv *tlv = data;
308 const struct intel_version_tlv_desc *desc = NULL;
311 for (i = 0; intel_version_tlv_table[i].type > 0; i++) {
312 if (intel_version_tlv_table[i].type == tlv->type) {
313 desc = &intel_version_tlv_table[i];
319 desc->func(tlv, desc->type_str);
321 print_version_tlv_unknown(tlv, "Unknown Type");
323 data += sizeof(*tlv) + tlv->len;
324 size -= sizeof(*tlv) + tlv->len;
328 static void read_version_rsp(const void *data, uint8_t size)
330 uint8_t status = get_u8(data);
331 uint8_t hw_platform = get_u8(data + 1);
332 uint8_t hw_variant = get_u8(data + 2);
333 uint8_t hw_revision = get_u8(data + 3);
334 uint8_t fw_variant = get_u8(data + 4);
335 uint8_t fw_revision = get_u8(data + 5);
336 uint8_t fw_build_nn = get_u8(data + 6);
337 uint8_t fw_build_cw = get_u8(data + 7);
338 uint8_t fw_build_yy = get_u8(data + 8);
339 uint8_t fw_patch = get_u8(data + 9);
341 /* There are two different formats of the response for the
342 * HCI_Intel_Read_version command depends on the command parameters
343 * If the size is fixed to 10 and hw_platform is 0x37, then it is the
344 * legacy format, otherwise use the tlv based format.
346 if (size != 10 && hw_platform != 0x37) {
347 read_version_tlv_rsp(data, size);
351 print_status(status);
352 print_field("Hardware platform: 0x%2.2x", hw_platform);
353 print_field("Hardware variant: 0x%2.2x", hw_variant);
354 print_field("Hardware revision: %u.%u", hw_revision >> 4,
356 print_field("Firmware variant: 0x%2.2x", fw_variant);
357 print_field("Firmware revision: %u.%u", fw_revision >> 4,
360 print_field("Firmware build: %u-%u.%u", fw_build_nn,
361 fw_build_cw, 2000 + fw_build_yy);
362 print_field("Firmware patch: %u", fw_patch);
365 static void read_version_cmd(const void *data, uint8_t size)
370 /* This is the legacy read version command format and no further action
376 print_field("Requested Type:");
379 const struct intel_version_tlv_desc *desc = NULL;
384 /* Get all supported types */
386 str = "All Supported Types";
388 for (i = 0; intel_version_tlv_table[i].type > 0; i++) {
389 if (intel_version_tlv_table[i].type == type) {
390 desc = &intel_version_tlv_table[i];
396 str = desc->type_str;
398 str = "Unknown Type";
401 print_field(" %s(0x%2.2x)", str, type);
403 data += sizeof(type);
404 size -= sizeof(type);
408 static void set_uart_baudrate_cmd(const void *data, uint8_t size)
410 uint8_t baudrate = get_u8(data);
439 str = "1843200 Baud";
442 str = "3250000 baud";
445 str = "2000000 baud";
448 str = "3000000 baud";
451 str = "3714286 baud";
454 str = "4333333 baud";
457 str = "6500000 baud";
464 print_field("Baudrate: %s (0x%2.2x)", str, baudrate);
467 static void secure_send_cmd(const void *data, uint8_t size)
469 uint8_t type = get_u8(data);
490 print_field("Type: %s fragment (0x%2.2x)", str, type);
492 packet_hexdump(data + 1, size - 1);
495 static void manufacturer_mode_cmd(const void *data, uint8_t size)
497 uint8_t mode = get_u8(data);
498 uint8_t reset = get_u8(data + 1);
513 print_field("Mode switch: %s (0x%2.2x)", str, mode);
520 str = "Reset and deactivate patches";
523 str = "Reset and activate patches";
530 print_field("Reset behavior: %s (0x%2.2x)", str, reset);
533 static void write_bd_data_cmd(const void *data, uint8_t size)
537 packet_print_addr("Address", data, 0x00);
538 packet_hexdump(data + 6, 6);
540 memcpy(features, data + 12, 8);
541 packet_print_features_lmp(features, 0);
543 memcpy(features, data + 20, 1);
544 memset(features + 1, 0, 7);
545 packet_print_features_ll(features);
547 packet_hexdump(data + 21, size - 21);
550 static void read_bd_data_rsp(const void *data, uint8_t size)
552 uint8_t status = get_u8(data);
554 print_status(status);
555 packet_print_addr("Address", data + 1, 0x00);
556 packet_hexdump(data + 7, size - 7);
559 static void write_bd_address_cmd(const void *data, uint8_t size)
561 packet_print_addr("Address", data, 0x00);
564 static void act_deact_traces_cmd(const void *data, uint8_t size)
566 uint8_t tx = get_u8(data);
567 uint8_t tx_arq = get_u8(data + 1);
568 uint8_t rx = get_u8(data + 2);
570 print_field("Transmit traces: 0x%2.2x", tx);
571 print_field("Transmit ARQ: 0x%2.2x", tx_arq);
572 print_field("Receive traces: 0x%2.2x", rx);
575 static void stimulate_exception_cmd(const void *data, uint8_t size)
577 uint8_t type = get_u8(data);
582 str = "Fatal Exception";
585 str = "Debug Exception";
592 print_field("Type: %s (0x%2.2x)", str, type);
595 static const struct {
600 { 1, "SCO Rejected via LMP" },
601 { 2, "PTT Switch Notification" },
602 { 7, "Scan Status" },
603 { 9, "Debug Exception" },
604 { 10, "Fatal Exception" },
605 { 11, "System Exception" },
606 { 13, "LE Link Established" },
607 { 14, "FW Trace String" },
611 static void set_event_mask_cmd(const void *data, uint8_t size)
613 const uint8_t *events_array = data;
614 uint64_t mask, events = 0;
617 for (i = 0; i < 8; i++)
618 events |= ((uint64_t) events_array[i]) << (i * 8);
620 print_field("Mask: 0x%16.16" PRIx64, events);
624 for (i = 0; events_table[i].str; i++) {
625 if (events & (((uint64_t) 1) << events_table[i].bit)) {
626 print_field(" %s", events_table[i].str);
627 mask &= ~(((uint64_t) 1) << events_table[i].bit);
632 print_text(COLOR_UNKNOWN_EVENT_MASK, " Unknown mask "
633 "(0x%16.16" PRIx64 ")", mask);
636 static void ddc_config_write_cmd(const void *data, uint8_t size)
639 uint8_t param_len = get_u8(data);
640 uint16_t param_id = get_le16(data + 1);
642 print_field("Identifier: 0x%4.4x", param_id);
643 packet_hexdump(data + 3, param_len - 2);
645 data += param_len + 1;
646 size -= param_len + 1;
650 static void ddc_config_write_rsp(const void *data, uint8_t size)
652 uint8_t status = get_u8(data);
653 uint16_t param_id = get_le16(data + 1);
655 print_status(status);
656 print_field("Identifier: 0x%4.4x", param_id);
659 static void memory_write_cmd(const void *data, uint8_t size)
661 uint32_t addr = get_le32(data);
662 uint8_t mode = get_u8(data + 4);
663 uint8_t length = get_u8(data + 5);
666 print_field("Address: 0x%8.8x", addr);
673 str = "Half word access";
683 print_field("Mode: %s (0x%2.2x)", str, mode);
684 print_field("Length: %u", length);
686 packet_hexdump(data + 6, size - 6);
689 static void read_supported_features_cmd(const void *data, uint8_t size)
691 uint8_t page = get_u8(data);
693 print_field("Page: 0x%2.2x", page);
696 static void read_supported_features_rsp(const void *data, uint8_t size)
698 uint8_t status = get_u8(data);
699 uint8_t page = get_u8(data + 1);
700 uint8_t max_pages = get_u8(data + 2);
702 print_status(status);
703 print_field("Page: 0x%2.2x", page);
704 print_field("Max Pages: 0x%2.2x", max_pages);
705 print_field("Supported Features:");
706 packet_hexdump(data + 3, size - 3);
709 static const struct vendor_ocf vendor_ocf_table[] = {
712 status_rsp, 1, true },
713 { 0x002, "No Operation" },
714 { 0x005, "Read Version",
715 read_version_cmd, 0, false,
716 read_version_rsp, 1, false },
717 { 0x006, "Set UART Baudrate",
718 set_uart_baudrate_cmd, 1, true,
719 status_rsp, 1, true },
720 { 0x007, "Enable LPM" },
721 { 0x008, "PCM Write Configuration" },
722 { 0x009, "Secure Send",
723 secure_send_cmd, 1, false,
724 status_rsp, 1, true },
725 { 0x00d, "Read Secure Boot Params",
727 { 0x00e, "Write Secure Boot Params" },
729 { 0x010, "Change UART Baudrate" },
730 { 0x011, "Manufacturer Mode",
731 manufacturer_mode_cmd, 2, true,
732 status_rsp, 1, true },
733 { 0x012, "Read Link RSSI" },
734 { 0x022, "Get Exception Info" },
735 { 0x024, "Clear Exception Info" },
736 { 0x02f, "Write BD Data",
737 write_bd_data_cmd, 6, false },
738 { 0x030, "Read BD Data",
740 read_bd_data_rsp, 7, false },
741 { 0x031, "Write BD Address",
742 write_bd_address_cmd, 6, true,
743 status_rsp, 1, true },
744 { 0x032, "Flow Specification" },
745 { 0x034, "Read Secure ID" },
746 { 0x038, "Set Synchronous USB Interface Type" },
747 { 0x039, "Config Synchronous Interface" },
748 { 0x03f, "SW RF Kill",
750 status_rsp, 1, true },
751 { 0x043, "Activate Deactivate Traces",
752 act_deact_traces_cmd, 3, true },
753 { 0x04d, "Stimulate Exception",
754 stimulate_exception_cmd, 1, true,
755 status_rsp, 1, true },
756 { 0x050, "Read HW Version" },
757 { 0x052, "Set Event Mask",
758 set_event_mask_cmd, 8, true,
759 status_rsp, 1, true },
760 { 0x053, "Config_Link_Controller" },
761 { 0x089, "DDC Write" },
762 { 0x08a, "DDC Read" },
763 { 0x08b, "DDC Config Write",
764 ddc_config_write_cmd, 3, false,
765 ddc_config_write_rsp, 3, true },
766 { 0x08c, "DDC Config Read" },
767 { 0x08d, "Memory Read" },
768 { 0x08e, "Memory Write",
769 memory_write_cmd, 6, false,
770 status_rsp, 1, true },
771 { 0x0a6, "Read Supported Features",
772 read_supported_features_cmd, 1, true,
773 read_supported_features_rsp, 19, true },
778 const struct vendor_ocf *intel_vendor_ocf(uint16_t ocf)
782 for (i = 0; vendor_ocf_table[i].str; i++) {
783 if (vendor_ocf_table[i].ocf == ocf)
784 return &vendor_ocf_table[i];
790 static void startup_evt(const void *data, uint8_t size)
794 static void fatal_exception_evt(const void *data, uint8_t size)
796 uint16_t line = get_le16(data);
797 uint8_t module = get_u8(data + 2);
798 uint8_t reason = get_u8(data + 3);
800 print_field("Line: %u", line);
801 print_module(module);
802 print_field("Reason: 0x%2.2x", reason);
805 static void bootup_evt(const void *data, uint8_t size)
807 uint8_t zero = get_u8(data);
808 uint8_t num_packets = get_u8(data + 1);
809 uint8_t source = get_u8(data + 2);
810 uint8_t reset_type = get_u8(data + 3);
811 uint8_t reset_reason = get_u8(data + 4);
812 uint8_t ddc_status = get_u8(data + 5);
815 print_field("Zero: 0x%2.2x", zero);
816 print_field("Number of packets: %d", num_packets);
823 str = "Operational firmware";
826 str = "Self test firmware";
833 print_field("Source: %s (0x%2.2x)", str, source);
835 switch (reset_type) {
837 str = "Hardware reset";
840 str = "Soft watchdog reset";
843 str = "Soft software reset";
846 str = "Hard watchdog reset";
849 str = "Hard software reset";
856 print_field("Reset type: %s (0x%2.2x)", str, reset_type);
858 switch (reset_reason) {
863 str = "Reset command";
866 str = "Intel reset command";
872 str = "Fatal exception";
875 str = "System exception";
885 print_field("Reset reason: %s (0x%2.2x)", str, reset_reason);
887 switch (ddc_status) {
889 str = "Firmware default";
892 str = "Firmware default plus OTP";
895 str = "Persistent RAM";
905 print_field("DDC status: %s (0x%2.2x)", str, ddc_status);
908 static void default_bd_data_evt(const void *data, uint8_t size)
910 uint8_t mem_status = get_u8(data);
913 switch (mem_status) {
915 str = "Invalid manufacturing data";
922 print_field("Memory status: %s (0x%2.2x)", str, mem_status);
925 static void secure_send_commands_result_evt(const void *data, uint8_t size)
927 uint8_t result = get_u8(data);
928 uint16_t opcode = get_le16(data + 1);
929 uint16_t ogf = cmd_opcode_ogf(opcode);
930 uint16_t ocf = cmd_opcode_ocf(opcode);
931 uint8_t status = get_u8(data + 3);
939 str = "General failure";
942 str = "Hardware failure";
945 str = "Signature verification failed";
948 str = "Parsing error of command buffer";
951 str = "Command execution failure";
954 str = "Command parameters error";
957 str = "Command missing";
964 print_field("Result: %s (0x%2.2x)", str, result);
965 print_field("Opcode: 0x%4.4x (0x%2.2x|0x%4.4x)", opcode, ogf, ocf);
966 print_status(status);
969 static void debug_exception_evt(const void *data, uint8_t size)
971 uint16_t line = get_le16(data);
972 uint8_t module = get_u8(data + 2);
973 uint8_t reason = get_u8(data + 3);
975 print_field("Line: %u", line);
976 print_module(module);
977 print_field("Reason: 0x%2.2x", reason);
980 static void le_link_established_evt(const void *data, uint8_t size)
982 uint16_t handle = get_le16(data);
983 uint32_t access_addr = get_le32(data + 10);
985 print_field("Handle: %u", handle);
987 packet_hexdump(data + 2, 8);
989 print_field("Access address: 0x%8.8x", access_addr);
991 packet_hexdump(data + 14, size - 14);
994 static void scan_status_evt(const void *data, uint8_t size)
996 uint8_t enable = get_u8(data);
998 print_field("Inquiry scan: %s",
999 (enable & 0x01) ? "Enabled" : "Disabled");
1000 print_field("Page scan: %s",
1001 (enable & 0x02) ? "Enabled" : "Disabled");
1004 print_text(COLOR_UNKNOWN_SCAN_STATUS,
1005 " Unknown status (0x%2.2x)", enable & 0xfc);
1009 static void act_deact_traces_complete_evt(const void *data, uint8_t size)
1011 uint8_t status = get_u8(data);
1013 print_status(status);
1016 static void lmp_pdu_trace_evt(const void *data, uint8_t size)
1018 uint8_t type, len, id;
1019 uint16_t handle, count;
1023 type = get_u8(data);
1024 handle = get_le16(data + 1);
1050 print_field("Type: %s (0x%2.2x)", str, type);
1051 print_field("Handle: %u", handle);
1056 clock = get_le32(data + 4 + len);
1058 packet_hexdump(data + 3, 1);
1059 lmp_packet(data + 4, len, false);
1060 print_field("Clock: 0x%8.8x", clock);
1064 clock = get_le32(data + 4 + len);
1065 id = get_u8(data + 4 + len + 4);
1067 packet_hexdump(data + 3, 1);
1068 lmp_packet(data + 4, len, false);
1069 print_field("Clock: 0x%8.8x", clock);
1070 print_field("ID: 0x%2.2x", id);
1073 clock = get_le32(data + 3);
1074 id = get_u8(data + 3 + 4);
1076 print_field("Clock: 0x%8.8x", clock);
1077 print_field("ID: 0x%2.2x", id);
1081 count = get_le16(data + 3);
1083 print_field("Count: 0x%4.4x", count);
1084 packet_hexdump(data + 3 + 2 + 1, 2);
1085 llcp_packet(data + 8, len, false);
1089 count = get_le16(data + 3);
1090 id = get_u8(data + 3 + 2);
1092 print_field("Count: 0x%4.4x", count);
1093 print_field("ID: 0x%2.2x", id);
1094 packet_hexdump(data + 3 + 2 + 1, 2);
1095 llcp_packet(data + 8, len, false);
1098 count = get_le16(data + 3);
1099 id = get_u8(data + 3 + 2);
1101 print_field("Count: 0x%4.4x", count);
1102 print_field("ID: 0x%2.2x", id);
1105 packet_hexdump(data + 3, size - 3);
1110 static void write_bd_data_complete_evt(const void *data, uint8_t size)
1112 uint8_t status = get_u8(data);
1114 print_status(status);
1117 static void sco_rejected_via_lmp_evt(const void *data, uint8_t size)
1119 uint8_t reason = get_u8(data + 6);
1121 packet_print_addr("Address", data, 0x00);
1122 packet_print_error("Reason", reason);
1125 static void ptt_switch_notification_evt(const void *data, uint8_t size)
1127 uint16_t handle = get_le16(data);
1128 uint8_t table = get_u8(data + 2);
1131 print_field("Handle: %u", handle);
1138 str = "Enhanced data rate";
1145 print_field("Packet type table: %s (0x%2.2x)", str, table);
1148 static void system_exception_evt(const void *data, uint8_t size)
1150 uint8_t type = get_u8(data);
1155 str = "No Exception";
1158 str = "Undefined Instruction";
1161 str = "Prefetch abort";
1171 print_field("Type: %s (0x%2.2x)", str, type);
1173 packet_hexdump(data + 1, size - 1);
1176 static const struct vendor_evt vendor_evt_table[] = {
1178 startup_evt, 0, true },
1179 { 0x01, "Fatal Exception",
1180 fatal_exception_evt, 4, true },
1182 bootup_evt, 6, true },
1183 { 0x05, "Default BD Data",
1184 default_bd_data_evt, 1, true },
1185 { 0x06, "Secure Send Commands Result",
1186 secure_send_commands_result_evt, 4, true },
1187 { 0x08, "Debug Exception",
1188 debug_exception_evt, 4, true },
1189 { 0x0f, "LE Link Established",
1190 le_link_established_evt, 26, true },
1191 { 0x11, "Scan Status",
1192 scan_status_evt, 1, true },
1193 { 0x16, "Activate Deactivate Traces Complete",
1194 act_deact_traces_complete_evt, 1, true },
1195 { 0x17, "LMP PDU Trace",
1196 lmp_pdu_trace_evt, 3, false },
1197 { 0x19, "Write BD Data Complete",
1198 write_bd_data_complete_evt, 1, true },
1199 { 0x25, "SCO Rejected via LMP",
1200 sco_rejected_via_lmp_evt, 7, true },
1201 { 0x26, "PTT Switch Notification",
1202 ptt_switch_notification_evt, 3, true },
1203 { 0x29, "System Exception",
1204 system_exception_evt, 133, true },
1205 { 0x2c, "FW Trace String" },
1206 { 0x2e, "FW Trace Binary" },
1211 * An Intel telemetry subevent is of the TLV format.
1212 * - Type: takes 1 byte. This is the subevent_id.
1213 * - Length: takes 1 byte.
1214 * - Value: takes |Length| bytes.
1217 uint8_t subevent_id;
1222 #define TLV_SIZE(tlv) (*((const uint8_t *) tlv + 1) + 2 * sizeof(uint8_t))
1223 #define NEXT_TLV(tlv) (const struct intel_tlv *) \
1224 ((const uint8_t *) tlv + TLV_SIZE(tlv))
1226 static void ext_evt_type(const struct intel_tlv *tlv)
1228 uint8_t evt_type = get_u8(tlv->value);
1233 str = "System Exception";
1236 str = "Fatal Exception";
1239 str = "Debug Exception";
1242 str = "Connection Event for BR/EDR Link Type";
1245 str = "Disconnection Event";
1248 str = "Audio Link Quality Report Type";
1251 str = "Stats for BR/EDR Link Type";
1254 print_text(COLOR_UNKNOWN_EXT_EVENT,
1255 "Unknown extended telemetry event type (0x%2.2x)",
1257 packet_hexdump((const void *) tlv,
1258 tlv->length + 2 * sizeof(uint8_t));
1262 print_field("Extended event type (0x%2.2x): %s (0x%2.2x)",
1263 tlv->subevent_id, str, evt_type);
1266 static void ext_acl_evt_conn_handle(const struct intel_tlv *tlv)
1268 uint16_t conn_handle = get_le16(tlv->value);
1270 print_field("ACL connection handle (0x%2.2x): 0x%4.4x",
1271 tlv->subevent_id, conn_handle);
1274 static void ext_acl_evt_hec_errors(const struct intel_tlv *tlv)
1276 uint32_t num = get_le32(tlv->value);
1278 print_field("Rx HEC errors (0x%2.2x): %d", tlv->subevent_id, num);
1281 static void ext_acl_evt_crc_errors(const struct intel_tlv *tlv)
1283 uint32_t num = get_le32(tlv->value);
1285 print_field("Rx CRC errors (0x%2.2x): %d", tlv->subevent_id, num);
1288 static void ext_acl_evt_num_pkt_from_host(const struct intel_tlv *tlv)
1290 uint32_t num = get_le32(tlv->value);
1292 print_field("Packets from host (0x%2.2x): %d",
1293 tlv->subevent_id, num);
1296 static void ext_acl_evt_num_tx_pkt_to_air(const struct intel_tlv *tlv)
1298 uint32_t num = get_le32(tlv->value);
1300 print_field("Tx packets (0x%2.2x): %d", tlv->subevent_id, num);
1303 static void ext_acl_evt_num_tx_pkt_retry(const struct intel_tlv *tlv)
1306 uint32_t num = get_le32(tlv->value);
1308 switch (tlv->subevent_id) {
1310 subevent_str = "Tx packets 0 retries";
1313 subevent_str = "Tx packets 1 retries";
1316 subevent_str = "Tx packets 2 retries";
1319 subevent_str = "Tx packets 3 retries";
1322 subevent_str = "Tx packets 4 retries and more";
1325 subevent_str = "Unknown";
1329 print_field("%s (0x%2.2x): %d", subevent_str, tlv->subevent_id, num);
1332 static void ext_acl_evt_num_tx_pkt_type(const struct intel_tlv *tlv)
1334 char *packet_type_str;
1335 uint32_t num = get_le32(tlv->value);
1337 switch (tlv->subevent_id) {
1339 packet_type_str = "DH1";
1342 packet_type_str = "DH3";
1345 packet_type_str = "DH5";
1348 packet_type_str = "2DH1";
1351 packet_type_str = "2DH3";
1354 packet_type_str = "2DH5";
1357 packet_type_str = "3DH1";
1360 packet_type_str = "3DH3";
1363 packet_type_str = "3DH5";
1366 packet_type_str = "Unknown";
1370 print_field("Tx %s packets (0x%2.2x): %d",
1371 packet_type_str, tlv->subevent_id, num);
1374 static void ext_acl_evt_num_rx_pkt_from_air(const struct intel_tlv *tlv)
1376 uint32_t num = get_le32(tlv->value);
1378 print_field("Rx packets (0x%2.2x): %d",
1379 tlv->subevent_id, num);
1382 static void ext_acl_evt_link_throughput(const struct intel_tlv *tlv)
1384 uint32_t num = get_le32(tlv->value);
1386 print_field("ACL link throughput (KBps) (0x%2.2x): %d",
1387 tlv->subevent_id, num);
1390 static void ext_acl_evt_max_packet_latency(const struct intel_tlv *tlv)
1392 uint32_t num = get_le32(tlv->value);
1394 print_field("ACL max packet latency (ms) (0x%2.2x): %d",
1395 tlv->subevent_id, num);
1398 static void ext_acl_evt_avg_packet_latency(const struct intel_tlv *tlv)
1400 uint32_t num = get_le32(tlv->value);
1402 print_field("ACL avg packet latency (ms) (0x%2.2x): %d",
1403 tlv->subevent_id, num);
1406 static void ext_sco_evt_conn_handle(const struct intel_tlv *tlv)
1408 uint16_t conn_handle = get_le16(tlv->value);
1410 print_field("SCO/eSCO connection handle (0x%2.2x): 0x%4.4x",
1411 tlv->subevent_id, conn_handle);
1414 static void ext_sco_evt_num_rx_pkt_from_air(const struct intel_tlv *tlv)
1416 uint32_t num = get_le32(tlv->value);
1418 print_field("Packets from host (0x%2.2x): %d", tlv->subevent_id, num);
1421 static void ext_sco_evt_num_tx_pkt_to_air(const struct intel_tlv *tlv)
1423 uint32_t num = get_le32(tlv->value);
1425 print_field("Tx packets (0x%2.2x): %d", tlv->subevent_id, num);
1428 static void ext_sco_evt_num_rx_payloads_lost(const struct intel_tlv *tlv)
1430 uint32_t num = get_le32(tlv->value);
1432 print_field("Rx payload lost (0x%2.2x): %d", tlv->subevent_id, num);
1435 static void ext_sco_evt_num_tx_payloads_lost(const struct intel_tlv *tlv)
1438 uint32_t num = get_le32(tlv->value);
1440 print_field("Tx payload lost (0x%2.2x): %d", tlv->subevent_id, num);
1443 static void slots_errors(const struct intel_tlv *tlv, const char *type_str)
1445 /* The subevent has 5 slots where each slot is of the uint32_t type. */
1447 const uint8_t *data = tlv->value;
1450 if (tlv->length != 5 * sizeof(uint32_t)) {
1451 print_text(COLOR_UNKNOWN_EXT_EVENT,
1452 " Invalid subevent length (%d)", tlv->length);
1456 for (i = 0; i < 5; i++) {
1457 num[i] = get_le32(data);
1458 data += sizeof(uint32_t);
1461 print_field("%s (0x%2.2x): %d %d %d %d %d", type_str, tlv->subevent_id,
1462 num[0], num[1], num[2], num[3], num[4]);
1465 static void ext_sco_evt_num_no_sync_errors(const struct intel_tlv *tlv)
1467 slots_errors(tlv, "Rx No SYNC errors");
1470 static void ext_sco_evt_num_hec_errors(const struct intel_tlv *tlv)
1472 slots_errors(tlv, "Rx HEC errors");
1475 static void ext_sco_evt_num_crc_errors(const struct intel_tlv *tlv)
1477 slots_errors(tlv, "Rx CRC errors");
1480 static void ext_sco_evt_num_naks(const struct intel_tlv *tlv)
1482 slots_errors(tlv, "Rx NAK errors");
1485 static void ext_sco_evt_num_failed_tx_by_wifi(const struct intel_tlv *tlv)
1487 slots_errors(tlv, "Failed Tx due to Wifi coex");
1490 static void ext_sco_evt_num_failed_rx_by_wifi(const struct intel_tlv *tlv)
1492 slots_errors(tlv, "Failed Rx due to Wifi coex");
1495 static void ext_sco_evt_samples_inserted(const struct intel_tlv *tlv)
1497 uint32_t num = get_le32(tlv->value);
1499 print_field("Late samples inserted based on CDC (0x%2.2x): %d",
1500 tlv->subevent_id, num);
1503 static void ext_sco_evt_samples_dropped(const struct intel_tlv *tlv)
1505 uint32_t num = get_le32(tlv->value);
1507 print_field("Samples dropped (0x%2.2x): %d", tlv->subevent_id, num);
1510 static void ext_sco_evt_mute_samples(const struct intel_tlv *tlv)
1512 uint32_t num = get_le32(tlv->value);
1514 print_field("Mute samples sent at initial connection (0x%2.2x): %d",
1515 tlv->subevent_id, num);
1518 static void ext_sco_evt_plc_injection_data(const struct intel_tlv *tlv)
1520 uint32_t num = get_le32(tlv->value);
1522 print_field("PLC injection data (0x%2.2x): %d", tlv->subevent_id, num);
1525 static const struct intel_ext_subevent {
1526 uint8_t subevent_id;
1528 void (*func)(const struct intel_tlv *tlv);
1529 } intel_ext_subevent_table[] = {
1530 { 0x01, 1, ext_evt_type },
1532 /* ACL audio link quality subevents */
1533 { 0x4a, 2, ext_acl_evt_conn_handle },
1534 { 0x4b, 4, ext_acl_evt_hec_errors },
1535 { 0x4c, 4, ext_acl_evt_crc_errors },
1536 { 0x4d, 4, ext_acl_evt_num_pkt_from_host },
1537 { 0x4e, 4, ext_acl_evt_num_tx_pkt_to_air },
1538 { 0x4f, 4, ext_acl_evt_num_tx_pkt_retry },
1539 { 0x50, 4, ext_acl_evt_num_tx_pkt_retry },
1540 { 0x51, 4, ext_acl_evt_num_tx_pkt_retry },
1541 { 0x52, 4, ext_acl_evt_num_tx_pkt_retry },
1542 { 0x53, 4, ext_acl_evt_num_tx_pkt_retry },
1543 { 0x54, 4, ext_acl_evt_num_tx_pkt_type },
1544 { 0x55, 4, ext_acl_evt_num_tx_pkt_type },
1545 { 0x56, 4, ext_acl_evt_num_tx_pkt_type },
1546 { 0x57, 4, ext_acl_evt_num_tx_pkt_type },
1547 { 0x58, 4, ext_acl_evt_num_tx_pkt_type },
1548 { 0x59, 4, ext_acl_evt_num_tx_pkt_type },
1549 { 0x5a, 4, ext_acl_evt_num_tx_pkt_type },
1550 { 0x5b, 4, ext_acl_evt_num_tx_pkt_type },
1551 { 0x5c, 4, ext_acl_evt_num_tx_pkt_type },
1552 { 0x5d, 4, ext_acl_evt_num_rx_pkt_from_air },
1553 { 0x5e, 4, ext_acl_evt_link_throughput },
1554 { 0x5f, 4, ext_acl_evt_max_packet_latency },
1555 { 0x60, 4, ext_acl_evt_avg_packet_latency },
1557 /* SCO/eSCO audio link quality subevents */
1558 { 0x6a, 2, ext_sco_evt_conn_handle },
1559 { 0x6b, 4, ext_sco_evt_num_rx_pkt_from_air },
1560 { 0x6c, 4, ext_sco_evt_num_tx_pkt_to_air },
1561 { 0x6d, 4, ext_sco_evt_num_rx_payloads_lost },
1562 { 0x6e, 4, ext_sco_evt_num_tx_payloads_lost },
1563 { 0x6f, 20, ext_sco_evt_num_no_sync_errors },
1564 { 0x70, 20, ext_sco_evt_num_hec_errors },
1565 { 0x71, 20, ext_sco_evt_num_crc_errors },
1566 { 0x72, 20, ext_sco_evt_num_naks },
1567 { 0x73, 20, ext_sco_evt_num_failed_tx_by_wifi },
1568 { 0x74, 20, ext_sco_evt_num_failed_rx_by_wifi },
1569 { 0x75, 4, ext_sco_evt_samples_inserted },
1570 { 0x76, 4, ext_sco_evt_samples_dropped },
1571 { 0x77, 4, ext_sco_evt_mute_samples },
1572 { 0x78, 4, ext_sco_evt_plc_injection_data },
1578 static const struct intel_tlv *process_ext_subevent(const struct intel_tlv *tlv,
1579 const struct intel_tlv *last_tlv)
1581 const struct intel_tlv *next_tlv = NEXT_TLV(tlv);
1582 const struct intel_ext_subevent *subevent = NULL;
1585 for (i = 0; intel_ext_subevent_table[i].length > 0; i++) {
1586 if (intel_ext_subevent_table[i].subevent_id ==
1588 subevent = &intel_ext_subevent_table[i];
1594 print_text(COLOR_UNKNOWN_EXT_EVENT,
1595 "Unknown extended subevent 0x%2.2x",
1600 if (tlv->length != subevent->length) {
1601 print_text(COLOR_ERROR, "Invalid length %d of subevent 0x%2.2x",
1602 tlv->length, tlv->subevent_id);
1606 if (next_tlv > last_tlv) {
1607 print_text(COLOR_ERROR, "Subevent exceeds the buffer size.");
1611 subevent->func(tlv);
1616 static void intel_vendor_ext_evt(const void *data, uint8_t size)
1618 /* The data pointer points to a number of tlv.*/
1619 const struct intel_tlv *tlv = data;
1620 const struct intel_tlv *last_tlv = data + size;
1622 /* Process every tlv subevent until reaching last_tlv.
1623 * The decoding process terminates normally when tlv == last_tlv.
1625 while (tlv && tlv < last_tlv)
1626 tlv = process_ext_subevent(tlv, last_tlv);
1628 /* If an error occurs in decoding the subevents, hexdump the packet. */
1630 packet_hexdump(data, size);
1633 /* Vendor extended events with a vendor prefix. */
1634 static const struct vendor_evt vendor_prefix_evt_table[] = {
1635 { 0x03, "Extended Telemetry", intel_vendor_ext_evt },
1639 const uint8_t intel_vendor_prefix[] = {0x87, 0x80};
1640 #define INTEL_VENDOR_PREFIX_SIZE sizeof(intel_vendor_prefix)
1643 * The vendor event with Intel vendor prefix.
1644 * Its format looks like
1645 * 0xff <length> <vendor_prefix> <subopcode> <data>
1646 * where Intel's <vendor_prefix> is 0x8780.
1648 * When <subopcode> == 0x03, it is a telemetry event; and
1649 * <data> is a number of tlv data.
1651 struct vendor_prefix_evt {
1652 uint8_t prefix_data[INTEL_VENDOR_PREFIX_SIZE];
1656 static const struct vendor_evt *intel_vendor_prefix_evt(const void *data,
1660 const struct vendor_prefix_evt *vnd = data;
1661 char prefix_string[INTEL_VENDOR_PREFIX_SIZE * 2 + 1] = { 0 };
1663 /* Check if the vendor prefix matches. */
1664 for (i = 0; i < INTEL_VENDOR_PREFIX_SIZE; i++) {
1665 if (vnd->prefix_data[i] != intel_vendor_prefix[i])
1667 sprintf(prefix_string + i * 2, "%02x", vnd->prefix_data[i]);
1669 print_field("Vendor Prefix (0x%s)", prefix_string);
1672 * Handle the vendor event with a vendor prefix.
1673 * 0xff <length> <vendor_prefix> <subopcode> <data>
1674 * This loop checks whether the <subopcode> exists in the
1675 * vendor_prefix_evt_table.
1677 for (i = 0; vendor_prefix_evt_table[i].str; i++) {
1678 if (vendor_prefix_evt_table[i].evt == vnd->subopcode) {
1679 *consumed_size = sizeof(struct vendor_prefix_evt);
1680 return &vendor_prefix_evt_table[i];
1687 const struct vendor_evt *intel_vendor_evt(const void *data, int *consumed_size)
1689 uint8_t evt = *((const uint8_t *) data);
1693 * Handle the vendor event without a vendor prefix.
1694 * 0xff <length> <evt> <data>
1695 * This loop checks whether the <evt> exists in the vendor_evt_table.
1697 for (i = 0; vendor_evt_table[i].str; i++) {
1698 if (vendor_evt_table[i].evt == evt)
1699 return &vendor_evt_table[i];
1703 * It is not a regular event. Check whether it is a vendor extended
1704 * event that comes with a vendor prefix followed by a subopcode.
1706 return intel_vendor_prefix_evt(data, consumed_size);