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(uint16_t index, const void *data, uint8_t size)
92 static void status_rsp(uint16_t index, const void *data, uint8_t size)
94 uint8_t status = get_u8(data);
99 static void reset_cmd(uint16_t index, 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(uint16_t index, 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(uint16_t index, 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(uint16_t index, const void *data,
411 uint8_t baudrate = get_u8(data);
440 str = "1843200 Baud";
443 str = "3250000 baud";
446 str = "2000000 baud";
449 str = "3000000 baud";
452 str = "3714286 baud";
455 str = "4333333 baud";
458 str = "6500000 baud";
465 print_field("Baudrate: %s (0x%2.2x)", str, baudrate);
468 static void secure_send_cmd(uint16_t index, const void *data, uint8_t size)
470 uint8_t type = get_u8(data);
491 print_field("Type: %s fragment (0x%2.2x)", str, type);
493 packet_hexdump(data + 1, size - 1);
496 static void manufacturer_mode_cmd(uint16_t index, const void *data,
499 uint8_t mode = get_u8(data);
500 uint8_t reset = get_u8(data + 1);
515 print_field("Mode switch: %s (0x%2.2x)", str, mode);
522 str = "Reset and deactivate patches";
525 str = "Reset and activate patches";
532 print_field("Reset behavior: %s (0x%2.2x)", str, reset);
535 static void write_bd_data_cmd(uint16_t index, const void *data, uint8_t size)
539 packet_print_addr("Address", data, 0x00);
540 packet_hexdump(data + 6, 6);
542 memcpy(features, data + 12, 8);
543 packet_print_features_lmp(features, 0);
545 memcpy(features, data + 20, 1);
546 memset(features + 1, 0, 7);
547 packet_print_features_ll(features);
549 packet_hexdump(data + 21, size - 21);
552 static void read_bd_data_rsp(uint16_t index, const void *data, uint8_t size)
554 uint8_t status = get_u8(data);
556 print_status(status);
557 packet_print_addr("Address", data + 1, 0x00);
558 packet_hexdump(data + 7, size - 7);
561 static void write_bd_address_cmd(uint16_t index, const void *data, uint8_t size)
563 packet_print_addr("Address", data, 0x00);
566 static void act_deact_traces_cmd(uint16_t index, const void *data, uint8_t size)
568 uint8_t tx = get_u8(data);
569 uint8_t tx_arq = get_u8(data + 1);
570 uint8_t rx = get_u8(data + 2);
572 print_field("Transmit traces: 0x%2.2x", tx);
573 print_field("Transmit ARQ: 0x%2.2x", tx_arq);
574 print_field("Receive traces: 0x%2.2x", rx);
577 static void stimulate_exception_cmd(uint16_t index, const void *data,
580 uint8_t type = get_u8(data);
585 str = "Fatal Exception";
588 str = "Debug Exception";
595 print_field("Type: %s (0x%2.2x)", str, type);
598 static const struct {
603 { 1, "SCO Rejected via LMP" },
604 { 2, "PTT Switch Notification" },
605 { 7, "Scan Status" },
606 { 9, "Debug Exception" },
607 { 10, "Fatal Exception" },
608 { 11, "System Exception" },
609 { 13, "LE Link Established" },
610 { 14, "FW Trace String" },
614 static void set_event_mask_cmd(uint16_t index, const void *data, uint8_t size)
616 const uint8_t *events_array = data;
617 uint64_t mask, events = 0;
620 for (i = 0; i < 8; i++)
621 events |= ((uint64_t) events_array[i]) << (i * 8);
623 print_field("Mask: 0x%16.16" PRIx64, events);
627 for (i = 0; events_table[i].str; i++) {
628 if (events & (((uint64_t) 1) << events_table[i].bit)) {
629 print_field(" %s", events_table[i].str);
630 mask &= ~(((uint64_t) 1) << events_table[i].bit);
635 print_text(COLOR_UNKNOWN_EVENT_MASK, " Unknown mask "
636 "(0x%16.16" PRIx64 ")", mask);
639 static void ddc_config_write_cmd(uint16_t index, const void *data, uint8_t size)
642 uint8_t param_len = get_u8(data);
643 uint16_t param_id = get_le16(data + 1);
645 print_field("Identifier: 0x%4.4x", param_id);
646 packet_hexdump(data + 3, param_len - 2);
648 data += param_len + 1;
649 size -= param_len + 1;
653 static void ddc_config_write_rsp(uint16_t index, const void *data, uint8_t size)
655 uint8_t status = get_u8(data);
656 uint16_t param_id = get_le16(data + 1);
658 print_status(status);
659 print_field("Identifier: 0x%4.4x", param_id);
662 static void memory_write_cmd(uint16_t index, const void *data, uint8_t size)
664 uint32_t addr = get_le32(data);
665 uint8_t mode = get_u8(data + 4);
666 uint8_t length = get_u8(data + 5);
669 print_field("Address: 0x%8.8x", addr);
676 str = "Half word access";
686 print_field("Mode: %s (0x%2.2x)", str, mode);
687 print_field("Length: %u", length);
689 packet_hexdump(data + 6, size - 6);
692 static void read_supported_features_cmd(uint16_t index, const void *data,
695 uint8_t page = get_u8(data);
697 print_field("Page: 0x%2.2x", page);
700 static void read_supported_features_rsp(uint16_t index, const void *data,
703 uint8_t status = get_u8(data);
704 uint8_t page = get_u8(data + 1);
705 uint8_t max_pages = get_u8(data + 2);
707 print_status(status);
708 print_field("Page: 0x%2.2x", page);
709 print_field("Max Pages: 0x%2.2x", max_pages);
710 print_field("Supported Features:");
711 packet_hexdump(data + 3, size - 3);
714 static const struct vendor_ocf vendor_ocf_table[] = {
717 status_rsp, 1, true },
718 { 0x002, "No Operation" },
719 { 0x005, "Read Version",
720 read_version_cmd, 0, false,
721 read_version_rsp, 1, false },
722 { 0x006, "Set UART Baudrate",
723 set_uart_baudrate_cmd, 1, true,
724 status_rsp, 1, true },
725 { 0x007, "Enable LPM" },
726 { 0x008, "PCM Write Configuration" },
727 { 0x009, "Secure Send",
728 secure_send_cmd, 1, false,
729 status_rsp, 1, true },
730 { 0x00d, "Read Secure Boot Params",
732 { 0x00e, "Write Secure Boot Params" },
734 { 0x010, "Change UART Baudrate" },
735 { 0x011, "Manufacturer Mode",
736 manufacturer_mode_cmd, 2, true,
737 status_rsp, 1, true },
738 { 0x012, "Read Link RSSI" },
739 { 0x022, "Get Exception Info" },
740 { 0x024, "Clear Exception Info" },
741 { 0x02f, "Write BD Data",
742 write_bd_data_cmd, 6, false },
743 { 0x030, "Read BD Data",
745 read_bd_data_rsp, 7, false },
746 { 0x031, "Write BD Address",
747 write_bd_address_cmd, 6, true,
748 status_rsp, 1, true },
749 { 0x032, "Flow Specification" },
750 { 0x034, "Read Secure ID" },
751 { 0x038, "Set Synchronous USB Interface Type" },
752 { 0x039, "Config Synchronous Interface" },
753 { 0x03f, "SW RF Kill",
755 status_rsp, 1, true },
756 { 0x043, "Activate Deactivate Traces",
757 act_deact_traces_cmd, 3, true },
758 { 0x04d, "Stimulate Exception",
759 stimulate_exception_cmd, 1, true,
760 status_rsp, 1, true },
761 { 0x050, "Read HW Version" },
762 { 0x052, "Set Event Mask",
763 set_event_mask_cmd, 8, true,
764 status_rsp, 1, true },
765 { 0x053, "Config_Link_Controller" },
766 { 0x089, "DDC Write" },
767 { 0x08a, "DDC Read" },
768 { 0x08b, "DDC Config Write",
769 ddc_config_write_cmd, 3, false,
770 ddc_config_write_rsp, 3, true },
771 { 0x08c, "DDC Config Read" },
772 { 0x08d, "Memory Read" },
773 { 0x08e, "Memory Write",
774 memory_write_cmd, 6, false,
775 status_rsp, 1, true },
776 { 0x0a6, "Read Supported Features",
777 read_supported_features_cmd, 1, true,
778 read_supported_features_rsp, 19, true },
783 const struct vendor_ocf *intel_vendor_ocf(uint16_t ocf)
787 for (i = 0; vendor_ocf_table[i].str; i++) {
788 if (vendor_ocf_table[i].ocf == ocf)
789 return &vendor_ocf_table[i];
795 static void startup_evt(uint16_t index, const void *data, uint8_t size)
799 static void fatal_exception_evt(uint16_t index, const void *data, uint8_t size)
801 uint16_t line = get_le16(data);
802 uint8_t module = get_u8(data + 2);
803 uint8_t reason = get_u8(data + 3);
805 print_field("Line: %u", line);
806 print_module(module);
807 print_field("Reason: 0x%2.2x", reason);
810 static void bootup_evt(uint16_t index, const void *data, uint8_t size)
812 uint8_t zero = get_u8(data);
813 uint8_t num_packets = get_u8(data + 1);
814 uint8_t source = get_u8(data + 2);
815 uint8_t reset_type = get_u8(data + 3);
816 uint8_t reset_reason = get_u8(data + 4);
817 uint8_t ddc_status = get_u8(data + 5);
820 print_field("Zero: 0x%2.2x", zero);
821 print_field("Number of packets: %d", num_packets);
828 str = "Operational firmware";
831 str = "Self test firmware";
838 print_field("Source: %s (0x%2.2x)", str, source);
840 switch (reset_type) {
842 str = "Hardware reset";
845 str = "Soft watchdog reset";
848 str = "Soft software reset";
851 str = "Hard watchdog reset";
854 str = "Hard software reset";
861 print_field("Reset type: %s (0x%2.2x)", str, reset_type);
863 switch (reset_reason) {
868 str = "Reset command";
871 str = "Intel reset command";
877 str = "Fatal exception";
880 str = "System exception";
890 print_field("Reset reason: %s (0x%2.2x)", str, reset_reason);
892 switch (ddc_status) {
894 str = "Firmware default";
897 str = "Firmware default plus OTP";
900 str = "Persistent RAM";
910 print_field("DDC status: %s (0x%2.2x)", str, ddc_status);
913 static void default_bd_data_evt(uint16_t index, const void *data, uint8_t size)
915 uint8_t mem_status = get_u8(data);
918 switch (mem_status) {
920 str = "Invalid manufacturing data";
927 print_field("Memory status: %s (0x%2.2x)", str, mem_status);
930 static void secure_send_commands_result_evt(uint16_t index, const void *data,
933 uint8_t result = get_u8(data);
934 uint16_t opcode = get_le16(data + 1);
935 uint16_t ogf = cmd_opcode_ogf(opcode);
936 uint16_t ocf = cmd_opcode_ocf(opcode);
937 uint8_t status = get_u8(data + 3);
945 str = "General failure";
948 str = "Hardware failure";
951 str = "Signature verification failed";
954 str = "Parsing error of command buffer";
957 str = "Command execution failure";
960 str = "Command parameters error";
963 str = "Command missing";
970 print_field("Result: %s (0x%2.2x)", str, result);
971 print_field("Opcode: 0x%4.4x (0x%2.2x|0x%4.4x)", opcode, ogf, ocf);
972 print_status(status);
975 static void debug_exception_evt(uint16_t index, const void *data, uint8_t size)
977 uint16_t line = get_le16(data);
978 uint8_t module = get_u8(data + 2);
979 uint8_t reason = get_u8(data + 3);
981 print_field("Line: %u", line);
982 print_module(module);
983 print_field("Reason: 0x%2.2x", reason);
986 static void le_link_established_evt(uint16_t index, const void *data,
989 uint16_t handle = get_le16(data);
990 uint32_t access_addr = get_le32(data + 10);
992 print_field("Handle: %u", handle);
994 packet_hexdump(data + 2, 8);
996 print_field("Access address: 0x%8.8x", access_addr);
998 packet_hexdump(data + 14, size - 14);
1001 static void scan_status_evt(uint16_t index, const void *data, uint8_t size)
1003 uint8_t enable = get_u8(data);
1005 print_field("Inquiry scan: %s",
1006 (enable & 0x01) ? "Enabled" : "Disabled");
1007 print_field("Page scan: %s",
1008 (enable & 0x02) ? "Enabled" : "Disabled");
1011 print_text(COLOR_UNKNOWN_SCAN_STATUS,
1012 " Unknown status (0x%2.2x)", enable & 0xfc);
1016 static void act_deact_traces_complete_evt(uint16_t index, const void *data,
1019 uint8_t status = get_u8(data);
1021 print_status(status);
1024 static void lmp_pdu_trace_evt(uint16_t index, const void *data, uint8_t size)
1026 uint8_t type, len, id;
1027 uint16_t handle, count;
1031 type = get_u8(data);
1032 handle = get_le16(data + 1);
1058 print_field("Type: %s (0x%2.2x)", str, type);
1059 print_field("Handle: %u", handle);
1064 clock = get_le32(data + 4 + len);
1066 packet_hexdump(data + 3, 1);
1067 lmp_packet(data + 4, len, false);
1068 print_field("Clock: 0x%8.8x", clock);
1072 clock = get_le32(data + 4 + len);
1073 id = get_u8(data + 4 + len + 4);
1075 packet_hexdump(data + 3, 1);
1076 lmp_packet(data + 4, len, false);
1077 print_field("Clock: 0x%8.8x", clock);
1078 print_field("ID: 0x%2.2x", id);
1081 clock = get_le32(data + 3);
1082 id = get_u8(data + 3 + 4);
1084 print_field("Clock: 0x%8.8x", clock);
1085 print_field("ID: 0x%2.2x", id);
1089 count = get_le16(data + 3);
1091 print_field("Count: 0x%4.4x", count);
1092 packet_hexdump(data + 3 + 2 + 1, 2);
1093 llcp_packet(data + 8, len, false);
1097 count = get_le16(data + 3);
1098 id = get_u8(data + 3 + 2);
1100 print_field("Count: 0x%4.4x", count);
1101 print_field("ID: 0x%2.2x", id);
1102 packet_hexdump(data + 3 + 2 + 1, 2);
1103 llcp_packet(data + 8, len, false);
1106 count = get_le16(data + 3);
1107 id = get_u8(data + 3 + 2);
1109 print_field("Count: 0x%4.4x", count);
1110 print_field("ID: 0x%2.2x", id);
1113 packet_hexdump(data + 3, size - 3);
1118 static void write_bd_data_complete_evt(uint16_t index, const void *data,
1121 uint8_t status = get_u8(data);
1123 print_status(status);
1126 static void sco_rejected_via_lmp_evt(uint16_t index, const void *data,
1129 uint8_t reason = get_u8(data + 6);
1131 packet_print_addr("Address", data, 0x00);
1132 packet_print_error("Reason", reason);
1135 static void ptt_switch_notification_evt(uint16_t index, const void *data,
1138 uint16_t handle = get_le16(data);
1139 uint8_t table = get_u8(data + 2);
1142 print_field("Handle: %u", handle);
1149 str = "Enhanced data rate";
1156 print_field("Packet type table: %s (0x%2.2x)", str, table);
1159 static void system_exception_evt(uint16_t index, const void *data, uint8_t size)
1161 uint8_t type = get_u8(data);
1166 str = "No Exception";
1169 str = "Undefined Instruction";
1172 str = "Prefetch abort";
1182 print_field("Type: %s (0x%2.2x)", str, type);
1184 packet_hexdump(data + 1, size - 1);
1187 static const struct vendor_evt vendor_evt_table[] = {
1189 startup_evt, 0, true },
1190 { 0x01, "Fatal Exception",
1191 fatal_exception_evt, 4, true },
1193 bootup_evt, 6, true },
1194 { 0x05, "Default BD Data",
1195 default_bd_data_evt, 1, true },
1196 { 0x06, "Secure Send Commands Result",
1197 secure_send_commands_result_evt, 4, true },
1198 { 0x08, "Debug Exception",
1199 debug_exception_evt, 4, true },
1200 { 0x0f, "LE Link Established",
1201 le_link_established_evt, 26, true },
1202 { 0x11, "Scan Status",
1203 scan_status_evt, 1, true },
1204 { 0x16, "Activate Deactivate Traces Complete",
1205 act_deact_traces_complete_evt, 1, true },
1206 { 0x17, "LMP PDU Trace",
1207 lmp_pdu_trace_evt, 3, false },
1208 { 0x19, "Write BD Data Complete",
1209 write_bd_data_complete_evt, 1, true },
1210 { 0x25, "SCO Rejected via LMP",
1211 sco_rejected_via_lmp_evt, 7, true },
1212 { 0x26, "PTT Switch Notification",
1213 ptt_switch_notification_evt, 3, true },
1214 { 0x29, "System Exception",
1215 system_exception_evt, 133, true },
1216 { 0x2c, "FW Trace String" },
1217 { 0x2e, "FW Trace Binary" },
1222 * An Intel telemetry subevent is of the TLV format.
1223 * - Type: takes 1 byte. This is the subevent_id.
1224 * - Length: takes 1 byte.
1225 * - Value: takes |Length| bytes.
1228 uint8_t subevent_id;
1233 #define TLV_SIZE(tlv) (*((const uint8_t *) tlv + 1) + 2 * sizeof(uint8_t))
1234 #define NEXT_TLV(tlv) (const struct intel_tlv *) \
1235 ((const uint8_t *) tlv + TLV_SIZE(tlv))
1237 static void ext_evt_type(const struct intel_tlv *tlv)
1239 uint8_t evt_type = get_u8(tlv->value);
1244 str = "System Exception";
1247 str = "Fatal Exception";
1250 str = "Debug Exception";
1253 str = "Connection Event for BR/EDR Link Type";
1256 str = "Disconnection Event";
1259 str = "Audio Link Quality Report Type";
1262 str = "Stats for BR/EDR Link Type";
1265 print_text(COLOR_UNKNOWN_EXT_EVENT,
1266 "Unknown extended telemetry event type (0x%2.2x)",
1268 packet_hexdump((const void *) tlv,
1269 tlv->length + 2 * sizeof(uint8_t));
1273 print_field("Extended event type (0x%2.2x): %s (0x%2.2x)",
1274 tlv->subevent_id, str, evt_type);
1277 static void ext_acl_evt_conn_handle(const struct intel_tlv *tlv)
1279 uint16_t conn_handle = get_le16(tlv->value);
1281 print_field("ACL connection handle (0x%2.2x): 0x%4.4x",
1282 tlv->subevent_id, conn_handle);
1285 static void ext_acl_evt_hec_errors(const struct intel_tlv *tlv)
1287 uint32_t num = get_le32(tlv->value);
1289 print_field("Rx HEC errors (0x%2.2x): %d", tlv->subevent_id, num);
1292 static void ext_acl_evt_crc_errors(const struct intel_tlv *tlv)
1294 uint32_t num = get_le32(tlv->value);
1296 print_field("Rx CRC errors (0x%2.2x): %d", tlv->subevent_id, num);
1299 static void ext_acl_evt_num_pkt_from_host(const struct intel_tlv *tlv)
1301 uint32_t num = get_le32(tlv->value);
1303 print_field("Packets from host (0x%2.2x): %d",
1304 tlv->subevent_id, num);
1307 static void ext_acl_evt_num_tx_pkt_to_air(const struct intel_tlv *tlv)
1309 uint32_t num = get_le32(tlv->value);
1311 print_field("Tx packets (0x%2.2x): %d", tlv->subevent_id, num);
1314 static void ext_acl_evt_num_tx_pkt_retry(const struct intel_tlv *tlv)
1317 uint32_t num = get_le32(tlv->value);
1319 switch (tlv->subevent_id) {
1321 subevent_str = "Tx packets 0 retries";
1324 subevent_str = "Tx packets 1 retries";
1327 subevent_str = "Tx packets 2 retries";
1330 subevent_str = "Tx packets 3 retries";
1333 subevent_str = "Tx packets 4 retries and more";
1336 subevent_str = "Unknown";
1340 print_field("%s (0x%2.2x): %d", subevent_str, tlv->subevent_id, num);
1343 static void ext_acl_evt_num_tx_pkt_type(const struct intel_tlv *tlv)
1345 char *packet_type_str;
1346 uint32_t num = get_le32(tlv->value);
1348 switch (tlv->subevent_id) {
1350 packet_type_str = "DH1";
1353 packet_type_str = "DH3";
1356 packet_type_str = "DH5";
1359 packet_type_str = "2DH1";
1362 packet_type_str = "2DH3";
1365 packet_type_str = "2DH5";
1368 packet_type_str = "3DH1";
1371 packet_type_str = "3DH3";
1374 packet_type_str = "3DH5";
1377 packet_type_str = "Unknown";
1381 print_field("Tx %s packets (0x%2.2x): %d",
1382 packet_type_str, tlv->subevent_id, num);
1385 static void ext_acl_evt_num_rx_pkt_from_air(const struct intel_tlv *tlv)
1387 uint32_t num = get_le32(tlv->value);
1389 print_field("Rx packets (0x%2.2x): %d",
1390 tlv->subevent_id, num);
1393 static void ext_acl_evt_link_throughput(const struct intel_tlv *tlv)
1395 uint32_t num = get_le32(tlv->value);
1397 print_field("ACL link throughput (KBps) (0x%2.2x): %d",
1398 tlv->subevent_id, num);
1401 static void ext_acl_evt_max_packet_latency(const struct intel_tlv *tlv)
1403 uint32_t num = get_le32(tlv->value);
1405 print_field("ACL max packet latency (ms) (0x%2.2x): %d",
1406 tlv->subevent_id, num);
1409 static void ext_acl_evt_avg_packet_latency(const struct intel_tlv *tlv)
1411 uint32_t num = get_le32(tlv->value);
1413 print_field("ACL avg packet latency (ms) (0x%2.2x): %d",
1414 tlv->subevent_id, num);
1417 static void ext_sco_evt_conn_handle(const struct intel_tlv *tlv)
1419 uint16_t conn_handle = get_le16(tlv->value);
1421 print_field("SCO/eSCO connection handle (0x%2.2x): 0x%4.4x",
1422 tlv->subevent_id, conn_handle);
1425 static void ext_sco_evt_num_rx_pkt_from_air(const struct intel_tlv *tlv)
1427 uint32_t num = get_le32(tlv->value);
1429 print_field("Packets from host (0x%2.2x): %d", tlv->subevent_id, num);
1432 static void ext_sco_evt_num_tx_pkt_to_air(const struct intel_tlv *tlv)
1434 uint32_t num = get_le32(tlv->value);
1436 print_field("Tx packets (0x%2.2x): %d", tlv->subevent_id, num);
1439 static void ext_sco_evt_num_rx_payloads_lost(const struct intel_tlv *tlv)
1441 uint32_t num = get_le32(tlv->value);
1443 print_field("Rx payload lost (0x%2.2x): %d", tlv->subevent_id, num);
1446 static void ext_sco_evt_num_tx_payloads_lost(const struct intel_tlv *tlv)
1449 uint32_t num = get_le32(tlv->value);
1451 print_field("Tx payload lost (0x%2.2x): %d", tlv->subevent_id, num);
1454 static void slots_errors(const struct intel_tlv *tlv, const char *type_str)
1456 /* The subevent has 5 slots where each slot is of the uint32_t type. */
1458 const uint8_t *data = tlv->value;
1461 if (tlv->length != 5 * sizeof(uint32_t)) {
1462 print_text(COLOR_UNKNOWN_EXT_EVENT,
1463 " Invalid subevent length (%d)", tlv->length);
1467 for (i = 0; i < 5; i++) {
1468 num[i] = get_le32(data);
1469 data += sizeof(uint32_t);
1472 print_field("%s (0x%2.2x): %d %d %d %d %d", type_str, tlv->subevent_id,
1473 num[0], num[1], num[2], num[3], num[4]);
1476 static void ext_sco_evt_num_no_sync_errors(const struct intel_tlv *tlv)
1478 slots_errors(tlv, "Rx No SYNC errors");
1481 static void ext_sco_evt_num_hec_errors(const struct intel_tlv *tlv)
1483 slots_errors(tlv, "Rx HEC errors");
1486 static void ext_sco_evt_num_crc_errors(const struct intel_tlv *tlv)
1488 slots_errors(tlv, "Rx CRC errors");
1491 static void ext_sco_evt_num_naks(const struct intel_tlv *tlv)
1493 slots_errors(tlv, "Rx NAK errors");
1496 static void ext_sco_evt_num_failed_tx_by_wifi(const struct intel_tlv *tlv)
1498 slots_errors(tlv, "Failed Tx due to Wifi coex");
1501 static void ext_sco_evt_num_failed_rx_by_wifi(const struct intel_tlv *tlv)
1503 slots_errors(tlv, "Failed Rx due to Wifi coex");
1506 static void ext_sco_evt_samples_inserted(const struct intel_tlv *tlv)
1508 uint32_t num = get_le32(tlv->value);
1510 print_field("Late samples inserted based on CDC (0x%2.2x): %d",
1511 tlv->subevent_id, num);
1514 static void ext_sco_evt_samples_dropped(const struct intel_tlv *tlv)
1516 uint32_t num = get_le32(tlv->value);
1518 print_field("Samples dropped (0x%2.2x): %d", tlv->subevent_id, num);
1521 static void ext_sco_evt_mute_samples(const struct intel_tlv *tlv)
1523 uint32_t num = get_le32(tlv->value);
1525 print_field("Mute samples sent at initial connection (0x%2.2x): %d",
1526 tlv->subevent_id, num);
1529 static void ext_sco_evt_plc_injection_data(const struct intel_tlv *tlv)
1531 uint32_t num = get_le32(tlv->value);
1533 print_field("PLC injection data (0x%2.2x): %d", tlv->subevent_id, num);
1536 static const struct intel_ext_subevent {
1537 uint8_t subevent_id;
1539 void (*func)(const struct intel_tlv *tlv);
1540 } intel_ext_subevent_table[] = {
1541 { 0x01, 1, ext_evt_type },
1543 /* ACL audio link quality subevents */
1544 { 0x4a, 2, ext_acl_evt_conn_handle },
1545 { 0x4b, 4, ext_acl_evt_hec_errors },
1546 { 0x4c, 4, ext_acl_evt_crc_errors },
1547 { 0x4d, 4, ext_acl_evt_num_pkt_from_host },
1548 { 0x4e, 4, ext_acl_evt_num_tx_pkt_to_air },
1549 { 0x4f, 4, ext_acl_evt_num_tx_pkt_retry },
1550 { 0x50, 4, ext_acl_evt_num_tx_pkt_retry },
1551 { 0x51, 4, ext_acl_evt_num_tx_pkt_retry },
1552 { 0x52, 4, ext_acl_evt_num_tx_pkt_retry },
1553 { 0x53, 4, ext_acl_evt_num_tx_pkt_retry },
1554 { 0x54, 4, ext_acl_evt_num_tx_pkt_type },
1555 { 0x55, 4, ext_acl_evt_num_tx_pkt_type },
1556 { 0x56, 4, ext_acl_evt_num_tx_pkt_type },
1557 { 0x57, 4, ext_acl_evt_num_tx_pkt_type },
1558 { 0x58, 4, ext_acl_evt_num_tx_pkt_type },
1559 { 0x59, 4, ext_acl_evt_num_tx_pkt_type },
1560 { 0x5a, 4, ext_acl_evt_num_tx_pkt_type },
1561 { 0x5b, 4, ext_acl_evt_num_tx_pkt_type },
1562 { 0x5c, 4, ext_acl_evt_num_tx_pkt_type },
1563 { 0x5d, 4, ext_acl_evt_num_rx_pkt_from_air },
1564 { 0x5e, 4, ext_acl_evt_link_throughput },
1565 { 0x5f, 4, ext_acl_evt_max_packet_latency },
1566 { 0x60, 4, ext_acl_evt_avg_packet_latency },
1568 /* SCO/eSCO audio link quality subevents */
1569 { 0x6a, 2, ext_sco_evt_conn_handle },
1570 { 0x6b, 4, ext_sco_evt_num_rx_pkt_from_air },
1571 { 0x6c, 4, ext_sco_evt_num_tx_pkt_to_air },
1572 { 0x6d, 4, ext_sco_evt_num_rx_payloads_lost },
1573 { 0x6e, 4, ext_sco_evt_num_tx_payloads_lost },
1574 { 0x6f, 20, ext_sco_evt_num_no_sync_errors },
1575 { 0x70, 20, ext_sco_evt_num_hec_errors },
1576 { 0x71, 20, ext_sco_evt_num_crc_errors },
1577 { 0x72, 20, ext_sco_evt_num_naks },
1578 { 0x73, 20, ext_sco_evt_num_failed_tx_by_wifi },
1579 { 0x74, 20, ext_sco_evt_num_failed_rx_by_wifi },
1580 { 0x75, 4, ext_sco_evt_samples_inserted },
1581 { 0x76, 4, ext_sco_evt_samples_dropped },
1582 { 0x77, 4, ext_sco_evt_mute_samples },
1583 { 0x78, 4, ext_sco_evt_plc_injection_data },
1589 static const struct intel_tlv *process_ext_subevent(const struct intel_tlv *tlv,
1590 const struct intel_tlv *last_tlv)
1592 const struct intel_tlv *next_tlv = NEXT_TLV(tlv);
1593 const struct intel_ext_subevent *subevent = NULL;
1596 for (i = 0; intel_ext_subevent_table[i].length > 0; i++) {
1597 if (intel_ext_subevent_table[i].subevent_id ==
1599 subevent = &intel_ext_subevent_table[i];
1605 print_text(COLOR_UNKNOWN_EXT_EVENT,
1606 "Unknown extended subevent 0x%2.2x",
1611 if (tlv->length != subevent->length) {
1612 print_text(COLOR_ERROR, "Invalid length %d of subevent 0x%2.2x",
1613 tlv->length, tlv->subevent_id);
1617 if (next_tlv > last_tlv) {
1618 print_text(COLOR_ERROR, "Subevent exceeds the buffer size.");
1622 subevent->func(tlv);
1627 static void intel_vendor_ext_evt(uint16_t index, const void *data, uint8_t size)
1629 /* The data pointer points to a number of tlv.*/
1630 const struct intel_tlv *tlv = data;
1631 const struct intel_tlv *last_tlv = data + size;
1633 /* Process every tlv subevent until reaching last_tlv.
1634 * The decoding process terminates normally when tlv == last_tlv.
1636 while (tlv && tlv < last_tlv)
1637 tlv = process_ext_subevent(tlv, last_tlv);
1639 /* If an error occurs in decoding the subevents, hexdump the packet. */
1641 packet_hexdump(data, size);
1644 /* Vendor extended events with a vendor prefix. */
1645 static const struct vendor_evt vendor_prefix_evt_table[] = {
1646 { 0x03, "Extended Telemetry", intel_vendor_ext_evt },
1650 const uint8_t intel_vendor_prefix[] = {0x87, 0x80};
1651 #define INTEL_VENDOR_PREFIX_SIZE sizeof(intel_vendor_prefix)
1654 * The vendor event with Intel vendor prefix.
1655 * Its format looks like
1656 * 0xff <length> <vendor_prefix> <subopcode> <data>
1657 * where Intel's <vendor_prefix> is 0x8780.
1659 * When <subopcode> == 0x03, it is a telemetry event; and
1660 * <data> is a number of tlv data.
1662 struct vendor_prefix_evt {
1663 uint8_t prefix_data[INTEL_VENDOR_PREFIX_SIZE];
1667 static const struct vendor_evt *intel_vendor_prefix_evt(const void *data,
1671 const struct vendor_prefix_evt *vnd = data;
1672 char prefix_string[INTEL_VENDOR_PREFIX_SIZE * 2 + 1] = { 0 };
1674 /* Check if the vendor prefix matches. */
1675 for (i = 0; i < INTEL_VENDOR_PREFIX_SIZE; i++) {
1676 if (vnd->prefix_data[i] != intel_vendor_prefix[i])
1678 sprintf(prefix_string + i * 2, "%02x", vnd->prefix_data[i]);
1680 print_field("Vendor Prefix (0x%s)", prefix_string);
1683 * Handle the vendor event with a vendor prefix.
1684 * 0xff <length> <vendor_prefix> <subopcode> <data>
1685 * This loop checks whether the <subopcode> exists in the
1686 * vendor_prefix_evt_table.
1688 for (i = 0; vendor_prefix_evt_table[i].str; i++) {
1689 if (vendor_prefix_evt_table[i].evt == vnd->subopcode) {
1690 *consumed_size = sizeof(struct vendor_prefix_evt);
1691 return &vendor_prefix_evt_table[i];
1698 const struct vendor_evt *intel_vendor_evt(const void *data, int *consumed_size)
1700 uint8_t evt = *((const uint8_t *) data);
1704 * Handle the vendor event without a vendor prefix.
1705 * 0xff <length> <evt> <data>
1706 * This loop checks whether the <evt> exists in the vendor_evt_table.
1708 for (i = 0; vendor_evt_table[i].str; i++) {
1709 if (vendor_evt_table[i].evt == evt)
1710 return &vendor_evt_table[i];
1714 * It is not a regular event. Check whether it is a vendor extended
1715 * event that comes with a vendor prefix followed by a subopcode.
1717 return intel_vendor_prefix_evt(data, consumed_size);