monitor/intel.c

   1 // SPDX-License-Identifier: LGPL-2.1-or-later
   2 /*
   3  *
   4  *  BlueZ - Bluetooth protocol stack for Linux
   5  *
   6  *  Copyright (C) 2011-2014  Intel Corporation
   7  *  Copyright (C) 2002-2010  Marcel Holtmann <marcel@holtmann.org>
   8  *
   9  *
  10  */
  11
  12 #ifdef HAVE_CONFIG_H
  13 #include <config.h>
  14 #endif
  15
  16 #include <stdio.h>
  17 #include <inttypes.h>
  18
  19 #include "lib/bluetooth.h"
  20 #include "lib/hci.h"
  21
  22 #include "src/shared/util.h"
  23 #include "display.h"
  24 #include "packet.h"
  25 #include "lmp.h"
  26 #include "ll.h"
  27 #include "vendor.h"
  28 #include "intel.h"
  29
  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
  33
  34 static void print_status(uint8_t status)
  35 {
  36         packet_print_error("Status", status);
  37 }
  38
  39 static void print_module(uint8_t module)
  40 {
  41         const char *str;
  42
  43         switch (module) {
  44         case 0x01:
  45                 str = "BC";
  46                 break;
  47         case 0x02:
  48                 str = "HCI";
  49                 break;
  50         case 0x03:
  51                 str = "LLC";
  52                 break;
  53         case 0x04:
  54                 str = "OS";
  55                 break;
  56         case 0x05:
  57                 str = "LM";
  58                 break;
  59         case 0x06:
  60                 str = "SC";
  61                 break;
  62         case 0x07:
  63                 str = "SP";
  64                 break;
  65         case 0x08:
  66                 str = "OSAL";
  67                 break;
  68         case 0x09:
  69                 str = "LC";
  70                 break;
  71         case 0x0a:
  72                 str = "APP";
  73                 break;
  74         case 0x0b:
  75                 str = "TLD";
  76                 break;
  77         case 0xf0:
  78                 str = "Debug";
  79                 break;
  80         default:
  81                 str = "Reserved";
  82                 break;
  83         }
  84
  85         print_field("Module: %s (0x%2.2x)", str, module);
  86 }
  87
  88 static void null_cmd(uint16_t index, const void *data, uint8_t size)
  89 {
  90 }
  91
  92 static void status_rsp(uint16_t index, const void *data, uint8_t size)
  93 {
  94         uint8_t status = get_u8(data);
  95
  96         print_status(status);
  97 }
  98
  99 static void reset_cmd(uint16_t index, const void *data, uint8_t size)
 100 {
 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);
 106         const char *str;
 107
 108         switch (reset_type) {
 109         case 0x00:
 110                 str = "Soft software reset";
 111                 break;
 112         case 0x01:
 113                 str = "Hard software reset";
 114                 break;
 115         default:
 116                 str = "Reserved";
 117                 break;
 118         }
 119
 120         print_field("Reset type: %s (0x%2.2x)", str, reset_type);
 121
 122         switch (patch_enable) {
 123         case 0x00:
 124                 str = "Do not enable";
 125                 break;
 126         case 0x01:
 127                 str = "Enable";
 128                 break;
 129         default:
 130                 str = "Reserved";
 131                 break;
 132         }
 133
 134         print_field("Patch vectors: %s (0x%2.2x)", str, patch_enable);
 135
 136         switch (ddc_reload) {
 137         case 0x00:
 138                 str = "Do not reload";
 139                 break;
 140         case 0x01:
 141                 str = "Reload from OTP";
 142                 break;
 143         default:
 144                 str = "Reserved";
 145                 break;
 146         }
 147
 148         print_field("DDC parameters: %s (0x%2.2x)", str, ddc_reload);
 149
 150         switch (boot_option) {
 151         case 0x00:
 152                 str = "Current image";
 153                 break;
 154         case 0x01:
 155                 str = "Specified address";
 156                 break;
 157         default:
 158                 str = "Reserved";
 159                 break;
 160         }
 161
 162         print_field("Boot option: %s (0x%2.2x)", str, boot_option);
 163         print_field("Boot address: 0x%8.8x", boot_addr);
 164 }
 165
 166 struct intel_version_tlv {
 167         uint8_t type;
 168         uint8_t len;
 169         uint8_t val[];
 170 };
 171
 172 static void print_version_tlv_u32(const struct intel_version_tlv *tlv,
 173                                   char *type_str)
 174 {
 175         print_field("%s(%u): 0x%8.8x", type_str, tlv->type, get_le32(tlv->val));
 176 }
 177
 178 static void print_version_tlv_u16(const struct intel_version_tlv *tlv,
 179                                   char *type_str)
 180 {
 181         print_field("%s(%u): 0x%4.4x", type_str, tlv->type, get_le16(tlv->val));
 182 }
 183
 184 static void print_version_tlv_u8(const struct intel_version_tlv *tlv,
 185                                  char *type_str)
 186 {
 187         print_field("%s(%u): 0x%2.2x", type_str, tlv->type, get_u8(tlv->val));
 188 }
 189
 190 static void print_version_tlv_enabled(const struct intel_version_tlv *tlv,
 191                                       char *type_str)
 192 {
 193         print_field("%s(%u): %s(%u)", type_str, tlv->type,
 194                                         tlv->val[0] ? "Enabled" : "Disabled",
 195                                         tlv->val[0]);
 196 }
 197
 198 static void print_version_tlv_img_type(const struct intel_version_tlv *tlv,
 199                                        char *type_str)
 200 {
 201         const char *str;
 202
 203         switch (get_u8(tlv->val)) {
 204         case 0x01:
 205                 str = "Bootloader";
 206                 break;
 207         case 0x03:
 208                 str = "Firmware";
 209                 break;
 210         default:
 211                 str = "Unknown";
 212                 break;
 213         }
 214         print_field("%s(%u): %s(0x%2.2x)", type_str, tlv->type, str,
 215                                                         get_u8(tlv->val));
 216 }
 217
 218 static void print_version_tlv_timestamp(const struct intel_version_tlv *tlv,
 219                                         char *type_str)
 220 {
 221         print_field("%s(%u): %u-%u", type_str, tlv->type,
 222                                 tlv->val[1], tlv->val[0]);
 223 }
 224
 225 static void print_version_tlv_min_fw(const struct intel_version_tlv *tlv,
 226                                      char *type_str)
 227 {
 228         print_field("%s(%u): %u-%u.%u", type_str, tlv->type,
 229                                 tlv->val[0], tlv->val[1], 2000 + tlv->val[2]);
 230 }
 231
 232 static void print_version_tlv_otp_bdaddr(const struct intel_version_tlv *tlv,
 233                                          char *type_str)
 234 {
 235         packet_print_addr(type_str, tlv->val, 0x00);
 236 }
 237
 238 static void print_version_tlv_unknown(const struct intel_version_tlv *tlv,
 239                                       char *type_str)
 240 {
 241         print_field("%s(%u): ", type_str, tlv->type);
 242         packet_hexdump(tlv->val, tlv->len);
 243 }
 244
 245 static void print_version_tlv_mfg(const struct intel_version_tlv *tlv,
 246                                          char *type_str)
 247 {
 248         uint16_t mfg_id = get_le16(tlv->val);
 249
 250         print_field("%s(%u): %s (%u)", type_str, tlv->type,
 251                                                 bt_compidtostr(mfg_id), mfg_id);
 252 }
 253
 254 static const struct intel_version_tlv_desc {
 255         uint8_t type;
 256         char *type_str;
 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 },
 293         { 0, NULL, NULL },
 294 };
 295
 296 static void read_version_tlv_rsp(const void *data, uint8_t size)
 297 {
 298         uint8_t status = get_u8(data);
 299
 300         print_status(status);
 301
 302         /* Consume the status */
 303         data++;
 304         size--;
 305
 306         while (size > 0) {
 307                 const struct intel_version_tlv *tlv = data;
 308                 const struct intel_version_tlv_desc *desc = NULL;
 309                 int i;
 310
 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];
 314                                 break;
 315                         }
 316                 }
 317
 318                 if (desc)
 319                         desc->func(tlv, desc->type_str);
 320                 else
 321                         print_version_tlv_unknown(tlv, "Unknown Type");
 322
 323                 data += sizeof(*tlv) + tlv->len;
 324                 size -= sizeof(*tlv) + tlv->len;
 325         }
 326 }
 327
 328 static void read_version_rsp(uint16_t index, const void *data, uint8_t size)
 329 {
 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);
 340
 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.
 345          */
 346         if (size != 10 && hw_platform != 0x37) {
 347                 read_version_tlv_rsp(data, size);
 348                 return;
 349         }
 350
 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,
 355                                                 hw_revision & 0x0f);
 356         print_field("Firmware variant: 0x%2.2x", fw_variant);
 357         print_field("Firmware revision: %u.%u", fw_revision >> 4,
 358                                                 fw_revision & 0x0f);
 359
 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);
 363 }
 364
 365 static void read_version_cmd(uint16_t index, const void *data, uint8_t size)
 366 {
 367         char *str;
 368         uint8_t type;
 369
 370         /* This is the legacy read version command format and no further action
 371          * is needed
 372          */
 373         if (size == 0)
 374                 return;
 375
 376         print_field("Requested Type:");
 377
 378         while (size > 0) {
 379                 const struct intel_version_tlv_desc *desc = NULL;
 380                 int i;
 381
 382                 type = get_u8(data);
 383
 384                 /* Get all supported types */
 385                 if (type == 0xff)
 386                         str = "All Supported Types";
 387                 else {
 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];
 391                                         break;
 392                                 }
 393                         }
 394
 395                         if (desc)
 396                                 str = desc->type_str;
 397                         else
 398                                 str = "Unknown Type";
 399                 }
 400
 401                 print_field("  %s(0x%2.2x)", str, type);
 402
 403                 data += sizeof(type);
 404                 size -= sizeof(type);
 405         }
 406 }
 407
 408 static void set_uart_baudrate_cmd(uint16_t index, const void *data,
 409                                                         uint8_t size)
 410 {
 411         uint8_t baudrate = get_u8(data);
 412         const char *str;
 413
 414         switch (baudrate) {
 415         case 0x00:
 416                 str = "9600 Baud";
 417                 break;
 418         case 0x01:
 419                 str = "19200 Baud";
 420                 break;
 421         case 0x02:
 422                 str = "38400 Baud";
 423                 break;
 424         case 0x03:
 425                 str = "57600 Baud";
 426                 break;
 427         case 0x04:
 428                 str = "115200 Baud";
 429                 break;
 430         case 0x05:
 431                 str = "230400 Baud";
 432                 break;
 433         case 0x06:
 434                 str = "460800 Baud";
 435                 break;
 436         case 0x07:
 437                 str = "921600 Baud";
 438                 break;
 439         case 0x08:
 440                 str = "1843200 Baud";
 441                 break;
 442         case 0x09:
 443                 str = "3250000 baud";
 444                 break;
 445         case 0x0a:
 446                 str = "2000000 baud";
 447                 break;
 448         case 0x0b:
 449                 str = "3000000 baud";
 450                 break;
 451         case 0x0c:
 452                 str = "3714286 baud";
 453                 break;
 454         case 0x0d:
 455                 str = "4333333 baud";
 456                 break;
 457         case 0x0e:
 458                 str = "6500000 baud";
 459                 break;
 460         default:
 461                 str = "Reserved";
 462                 break;
 463         }
 464
 465         print_field("Baudrate: %s (0x%2.2x)", str, baudrate);
 466 }
 467
 468 static void secure_send_cmd(uint16_t index, const void *data, uint8_t size)
 469 {
 470         uint8_t type = get_u8(data);
 471         const char *str;
 472
 473         switch (type) {
 474         case 0x00:
 475                 str = "Init";
 476                 break;
 477         case 0x01:
 478                 str = "Data";
 479                 break;
 480         case 0x02:
 481                 str = "Sign";
 482                 break;
 483         case 0x03:
 484                 str = "PKey";
 485                 break;
 486         default:
 487                 str = "Reserved";
 488                 break;
 489         }
 490
 491         print_field("Type: %s fragment (0x%2.2x)", str, type);
 492
 493         packet_hexdump(data + 1, size - 1);
 494 }
 495
 496 static void manufacturer_mode_cmd(uint16_t index, const void *data,
 497                                                         uint8_t size)
 498 {
 499         uint8_t mode = get_u8(data);
 500         uint8_t reset = get_u8(data + 1);
 501         const char *str;
 502
 503         switch (mode) {
 504         case 0x00:
 505                 str = "Disabled";
 506                 break;
 507         case 0x01:
 508                 str = "Enabled";
 509                 break;
 510         default:
 511                 str = "Reserved";
 512                 break;
 513         }
 514
 515         print_field("Mode switch: %s (0x%2.2x)", str, mode);
 516
 517         switch (reset) {
 518         case 0x00:
 519                 str = "No reset";
 520                 break;
 521         case 0x01:
 522                 str = "Reset and deactivate patches";
 523                 break;
 524         case 0x02:
 525                 str = "Reset and activate patches";
 526                 break;
 527         default:
 528                 str = "Reserved";
 529                 break;
 530         }
 531
 532         print_field("Reset behavior: %s (0x%2.2x)", str, reset);
 533 }
 534
 535 static void write_bd_data_cmd(uint16_t index, const void *data, uint8_t size)
 536 {
 537         uint8_t features[8];
 538
 539         packet_print_addr("Address", data, 0x00);
 540         packet_hexdump(data + 6, 6);
 541
 542         memcpy(features, data + 12, 8);
 543         packet_print_features_lmp(features, 0);
 544
 545         memcpy(features, data + 20, 1);
 546         memset(features + 1, 0, 7);
 547         packet_print_features_ll(features);
 548
 549         packet_hexdump(data + 21, size - 21);
 550 }
 551
 552 static void read_bd_data_rsp(uint16_t index, const void *data, uint8_t size)
 553 {
 554         uint8_t status = get_u8(data);
 555
 556         print_status(status);
 557         packet_print_addr("Address", data + 1, 0x00);
 558         packet_hexdump(data + 7, size - 7);
 559 }
 560
 561 static void write_bd_address_cmd(uint16_t index, const void *data, uint8_t size)
 562 {
 563         packet_print_addr("Address", data, 0x00);
 564 }
 565
 566 static void act_deact_traces_cmd(uint16_t index, const void *data, uint8_t size)
 567 {
 568         uint8_t tx = get_u8(data);
 569         uint8_t tx_arq = get_u8(data + 1);
 570         uint8_t rx = get_u8(data + 2);
 571
 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);
 575 }
 576
 577 static void stimulate_exception_cmd(uint16_t index, const void *data,
 578                                                         uint8_t size)
 579 {
 580         uint8_t type = get_u8(data);
 581         const char *str;
 582
 583         switch (type) {
 584         case 0x00:
 585                 str = "Fatal Exception";
 586                 break;
 587         case 0x01:
 588                 str = "Debug Exception";
 589                 break;
 590         default:
 591                 str = "Reserved";
 592                 break;
 593         }
 594
 595         print_field("Type: %s (0x%2.2x)", str, type);
 596 }
 597
 598 static const struct {
 599         uint8_t bit;
 600         const char *str;
 601 } events_table[] = {
 602         {  0, "Bootup"                  },
 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"         },
 611         { }
 612 };
 613
 614 static void set_event_mask_cmd(uint16_t index, const void *data, uint8_t size)
 615 {
 616         const uint8_t *events_array = data;
 617         uint64_t mask, events = 0;
 618         int i;
 619
 620         for (i = 0; i < 8; i++)
 621                 events |= ((uint64_t) events_array[i]) << (i * 8);
 622
 623         print_field("Mask: 0x%16.16" PRIx64, events);
 624
 625         mask = events;
 626
 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);
 631                 }
 632         }
 633
 634         if (mask)
 635                 print_text(COLOR_UNKNOWN_EVENT_MASK, "  Unknown mask "
 636                                                 "(0x%16.16" PRIx64 ")", mask);
 637 }
 638
 639 static void ddc_config_write_cmd(uint16_t index, const void *data, uint8_t size)
 640 {
 641         while (size > 0) {
 642                 uint8_t param_len = get_u8(data);
 643                 uint16_t param_id = get_le16(data + 1);
 644
 645                 print_field("Identifier: 0x%4.4x", param_id);
 646                 packet_hexdump(data + 3, param_len - 2);
 647
 648                 data += param_len + 1;
 649                 size -= param_len + 1;
 650         }
 651 }
 652
 653 static void ddc_config_write_rsp(uint16_t index, const void *data, uint8_t size)
 654 {
 655         uint8_t status = get_u8(data);
 656         uint16_t param_id = get_le16(data + 1);
 657
 658         print_status(status);
 659         print_field("Identifier: 0x%4.4x", param_id);
 660 }
 661
 662 static void memory_write_cmd(uint16_t index, const void *data, uint8_t size)
 663 {
 664         uint32_t addr = get_le32(data);
 665         uint8_t mode = get_u8(data + 4);
 666         uint8_t length = get_u8(data + 5);
 667         const char *str;
 668
 669         print_field("Address: 0x%8.8x", addr);
 670
 671         switch (mode) {
 672         case 0x00:
 673                 str = "Byte access";
 674                 break;
 675         case 0x01:
 676                 str = "Half word access";
 677                 break;
 678         case 0x02:
 679                 str = "Word access";
 680                 break;
 681         default:
 682                 str = "Reserved";
 683                 break;
 684         }
 685
 686         print_field("Mode: %s (0x%2.2x)", str, mode);
 687         print_field("Length: %u", length);
 688
 689         packet_hexdump(data + 6, size - 6);
 690 }
 691
 692 static void read_supported_features_cmd(uint16_t index, const void *data,
 693                                                         uint8_t size)
 694 {
 695         uint8_t page = get_u8(data);
 696
 697         print_field("Page: 0x%2.2x", page);
 698 }
 699
 700 static void read_supported_features_rsp(uint16_t index, const void *data,
 701                                                         uint8_t size)
 702 {
 703         uint8_t status = get_u8(data);
 704         uint8_t page = get_u8(data + 1);
 705         uint8_t max_pages = get_u8(data + 2);
 706
 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);
 712 }
 713
 714 static const struct vendor_ocf vendor_ocf_table[] = {
 715         { 0x001, "Reset",
 716                         reset_cmd, 8, true,
 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",
 731                         null_cmd, 0, true },
 732         { 0x00e, "Write Secure Boot Params" },
 733         { 0x00f, "Unlock" },
 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",
 744                         null_cmd, 0, true,
 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",
 754                         null_cmd, 0, true,
 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 },
 779
 780         { }
 781 };
 782
 783 const struct vendor_ocf *intel_vendor_ocf(uint16_t ocf)
 784 {
 785         int i;
 786
 787         for (i = 0; vendor_ocf_table[i].str; i++) {
 788                 if (vendor_ocf_table[i].ocf == ocf)
 789                         return &vendor_ocf_table[i];
 790         }
 791
 792         return NULL;
 793 }
 794
 795 static void startup_evt(struct timeval *tv, uint16_t index,
 796                                 const void *data, uint8_t size)
 797 {
 798 }
 799
 800 static void fatal_exception_evt(struct timeval *tv, uint16_t index,
 801                                 const void *data, uint8_t size)
 802 {
 803         uint16_t line = get_le16(data);
 804         uint8_t module = get_u8(data + 2);
 805         uint8_t reason = get_u8(data + 3);
 806
 807         print_field("Line: %u", line);
 808         print_module(module);
 809         print_field("Reason: 0x%2.2x", reason);
 810 }
 811
 812 static void bootup_evt(struct timeval *tv, uint16_t index,
 813                                 const void *data, uint8_t size)
 814 {
 815         uint8_t zero = get_u8(data);
 816         uint8_t num_packets = get_u8(data + 1);
 817         uint8_t source = get_u8(data + 2);
 818         uint8_t reset_type = get_u8(data + 3);
 819         uint8_t reset_reason = get_u8(data + 4);
 820         uint8_t ddc_status = get_u8(data + 5);
 821         const char *str;
 822
 823         print_field("Zero: 0x%2.2x", zero);
 824         print_field("Number of packets: %d", num_packets);
 825
 826         switch (source) {
 827         case 0x00:
 828                 str = "Bootloader";
 829                 break;
 830         case 0x01:
 831                 str = "Operational firmware";
 832                 break;
 833         case 0x02:
 834                 str = "Self test firmware";
 835                 break;
 836         default:
 837                 str = "Reserved";
 838                 break;
 839         }
 840
 841         print_field("Source: %s (0x%2.2x)", str, source);
 842
 843         switch (reset_type) {
 844         case 0x00:
 845                 str = "Hardware reset";
 846                 break;
 847         case 0x01:
 848                 str = "Soft watchdog reset";
 849                 break;
 850         case 0x02:
 851                 str = "Soft software reset";
 852                 break;
 853         case 0x03:
 854                 str = "Hard watchdog reset";
 855                 break;
 856         case 0x04:
 857                 str = "Hard software reset";
 858                 break;
 859         default:
 860                 str = "Reserved";
 861                 break;
 862         }
 863
 864         print_field("Reset type: %s (0x%2.2x)", str, reset_type);
 865
 866         switch (reset_reason) {
 867         case 0x00:
 868                 str = "Power on";
 869                 break;
 870         case 0x01:
 871                 str = "Reset command";
 872                 break;
 873         case 0x02:
 874                 str = "Intel reset command";
 875                 break;
 876         case 0x03:
 877                 str = "Watchdog";
 878                 break;
 879         case 0x04:
 880                 str = "Fatal exception";
 881                 break;
 882         case 0x05:
 883                 str = "System exception";
 884                 break;
 885         case 0xff:
 886                 str = "Unknown";
 887                 break;
 888         default:
 889                 str = "Reserved";
 890                 break;
 891         }
 892
 893         print_field("Reset reason: %s (0x%2.2x)", str, reset_reason);
 894
 895         switch (ddc_status) {
 896         case 0x00:
 897                 str = "Firmware default";
 898                 break;
 899         case 0x01:
 900                 str = "Firmware default plus OTP";
 901                 break;
 902         case 0x02:
 903                 str = "Persistent RAM";
 904                 break;
 905         case 0x03:
 906                 str = "Not used";
 907                 break;
 908         default:
 909                 str = "Reserved";
 910                 break;
 911         }
 912
 913         print_field("DDC status: %s (0x%2.2x)", str, ddc_status);
 914 }
 915
 916 static void default_bd_data_evt(struct timeval *tv, uint16_t index,
 917                                         const void *data, uint8_t size)
 918 {
 919         uint8_t mem_status = get_u8(data);
 920         const char *str;
 921
 922         switch (mem_status) {
 923         case 0x02:
 924                 str = "Invalid manufacturing data";
 925                 break;
 926         default:
 927                 str = "Reserved";
 928                 break;
 929         }
 930
 931         print_field("Memory status: %s (0x%2.2x)", str, mem_status);
 932 }
 933
 934 static void secure_send_commands_result_evt(struct timeval *tv, uint16_t index,
 935                                                 const void *data, uint8_t size)
 936 {
 937         uint8_t result = get_u8(data);
 938         uint16_t opcode = get_le16(data + 1);
 939         uint16_t ogf = cmd_opcode_ogf(opcode);
 940         uint16_t ocf = cmd_opcode_ocf(opcode);
 941         uint8_t status = get_u8(data + 3);
 942         const char *str;
 943
 944         switch (result) {
 945         case 0x00:
 946                 str = "Success";
 947                 break;
 948         case 0x01:
 949                 str = "General failure";
 950                 break;
 951         case 0x02:
 952                 str = "Hardware failure";
 953                 break;
 954         case 0x03:
 955                 str = "Signature verification failed";
 956                 break;
 957         case 0x04:
 958                 str = "Parsing error of command buffer";
 959                 break;
 960         case 0x05:
 961                 str = "Command execution failure";
 962                 break;
 963         case 0x06:
 964                 str = "Command parameters error";
 965                 break;
 966         case 0x07:
 967                 str = "Command missing";
 968                 break;
 969         default:
 970                 str = "Reserved";
 971                 break;
 972         }
 973
 974         print_field("Result: %s (0x%2.2x)", str, result);
 975         print_field("Opcode: 0x%4.4x (0x%2.2x|0x%4.4x)", opcode, ogf, ocf);
 976         print_status(status);
 977 }
 978
 979 static void debug_exception_evt(struct timeval *tv, uint16_t index,
 980                                         const void *data, uint8_t size)
 981 {
 982         uint16_t line = get_le16(data);
 983         uint8_t module = get_u8(data + 2);
 984         uint8_t reason = get_u8(data + 3);
 985
 986         print_field("Line: %u", line);
 987         print_module(module);
 988         print_field("Reason: 0x%2.2x", reason);
 989 }
 990
 991 static void le_link_established_evt(struct timeval *tv, uint16_t index,
 992                                         const void *data, uint8_t size)
 993 {
 994         uint16_t handle = get_le16(data);
 995         uint32_t access_addr = get_le32(data + 10);
 996
 997         print_field("Handle: %u", handle);
 998
 999         packet_hexdump(data + 2, 8);
1000
1001         print_field("Access address: 0x%8.8x", access_addr);
1002
1003         packet_hexdump(data + 14, size - 14);
1004 }
1005
1006 static void scan_status_evt(struct timeval *tv, uint16_t index,
1007                                         const void *data, uint8_t size)
1008 {
1009         uint8_t enable = get_u8(data);
1010
1011         print_field("Inquiry scan: %s",
1012                                 (enable & 0x01) ? "Enabled" : "Disabled");
1013         print_field("Page scan: %s",
1014                                 (enable & 0x02) ? "Enabled" : "Disabled");
1015
1016         if (enable & 0xfc)
1017                 print_text(COLOR_UNKNOWN_SCAN_STATUS,
1018                                 "  Unknown status (0x%2.2x)", enable & 0xfc);
1019
1020 }
1021
1022 static void act_deact_traces_complete_evt(struct timeval *tv, uint16_t index,
1023                                         const void *data, uint8_t size)
1024 {
1025         uint8_t status = get_u8(data);
1026
1027         print_status(status);
1028 }
1029
1030 static void lmp_pdu_trace_evt(struct timeval *tv, uint16_t index,
1031                                         const void *data, uint8_t size)
1032 {
1033         uint8_t type, len, id;
1034         uint16_t handle, count;
1035         uint32_t clock;
1036         const char *str;
1037
1038         type = get_u8(data);
1039         handle = get_le16(data + 1);
1040
1041         switch (type) {
1042         case 0x00:
1043                 str = "RX LMP";
1044                 break;
1045         case 0x01:
1046                 str = "TX LMP";
1047                 break;
1048         case 0x02:
1049                 str = "ACK LMP";
1050                 break;
1051         case 0x03:
1052                 str = "RX LL";
1053                 break;
1054         case 0x04:
1055                 str = "TX LL";
1056                 break;
1057         case 0x05:
1058                 str = "ACK LL";
1059                 break;
1060         default:
1061                 str = "Unknown";
1062                 break;
1063         }
1064
1065         print_field("Type: %s (0x%2.2x)", str, type);
1066         print_field("Handle: %u", handle);
1067
1068         switch (type) {
1069         case 0x00:
1070                 len = size - 8;
1071                 clock = get_le32(data + 4 + len);
1072
1073                 packet_hexdump(data + 3, 1);
1074                 lmp_packet(data + 4, len, false);
1075                 print_field("Clock: 0x%8.8x", clock);
1076                 break;
1077         case 0x01:
1078                 len = size - 9;
1079                 clock = get_le32(data + 4 + len);
1080                 id = get_u8(data + 4 + len + 4);
1081
1082                 packet_hexdump(data + 3, 1);
1083                 lmp_packet(data + 4, len, false);
1084                 print_field("Clock: 0x%8.8x", clock);
1085                 print_field("ID: 0x%2.2x", id);
1086                 break;
1087         case 0x02:
1088                 clock = get_le32(data + 3);
1089                 id = get_u8(data + 3 + 4);
1090
1091                 print_field("Clock: 0x%8.8x", clock);
1092                 print_field("ID: 0x%2.2x", id);
1093                 break;
1094         case 0x03:
1095                 len = size - 8;
1096                 count = get_le16(data + 3);
1097
1098                 print_field("Count: 0x%4.4x", count);
1099                 packet_hexdump(data + 3 + 2 + 1, 2);
1100                 llcp_packet(data + 8, len, false);
1101                 break;
1102         case 0x04:
1103                 len = size - 8;
1104                 count = get_le16(data + 3);
1105                 id = get_u8(data + 3 + 2);
1106
1107                 print_field("Count: 0x%4.4x", count);
1108                 print_field("ID: 0x%2.2x", id);
1109                 packet_hexdump(data + 3 + 2 + 1, 2);
1110                 llcp_packet(data + 8, len, false);
1111                 break;
1112         case 0x05:
1113                 count = get_le16(data + 3);
1114                 id = get_u8(data + 3 + 2);
1115
1116                 print_field("Count: 0x%4.4x", count);
1117                 print_field("ID: 0x%2.2x", id);
1118                 break;
1119         default:
1120                 packet_hexdump(data + 3, size - 3);
1121                 break;
1122         }
1123 }
1124
1125 static void write_bd_data_complete_evt(struct timeval *tv, uint16_t index,
1126                                         const void *data, uint8_t size)
1127 {
1128         uint8_t status = get_u8(data);
1129
1130         print_status(status);
1131 }
1132
1133 static void sco_rejected_via_lmp_evt(struct timeval *tv, uint16_t index,
1134                                         const void *data, uint8_t size)
1135 {
1136         uint8_t reason = get_u8(data + 6);
1137
1138         packet_print_addr("Address", data, 0x00);
1139         packet_print_error("Reason", reason);
1140 }
1141
1142 static void ptt_switch_notification_evt(struct timeval *tv, uint16_t index,
1143                                         const void *data, uint8_t size)
1144 {
1145         uint16_t handle = get_le16(data);
1146         uint8_t table = get_u8(data + 2);
1147         const char *str;
1148
1149         print_field("Handle: %u", handle);
1150
1151         switch (table) {
1152         case 0x00:
1153                 str = "Basic rate";
1154                 break;
1155         case 0x01:
1156                 str = "Enhanced data rate";
1157                 break;
1158         default:
1159                 str = "Reserved";
1160                 break;
1161         }
1162
1163         print_field("Packet type table: %s (0x%2.2x)", str, table);
1164 }
1165
1166 static void system_exception_evt(struct timeval *tv, uint16_t index,
1167                                         const void *data, uint8_t size)
1168 {
1169         uint8_t type = get_u8(data);
1170         const char *str;
1171
1172         switch (type) {
1173         case 0x00:
1174                 str = "No Exception";
1175                 break;
1176         case 0x01:
1177                 str = "Undefined Instruction";
1178                 break;
1179         case 0x02:
1180                 str = "Prefetch abort";
1181                 break;
1182         case 0x03:
1183                 str = "Data abort";
1184                 break;
1185         default:
1186                 str = "Reserved";
1187                 break;
1188         }
1189
1190         print_field("Type: %s (0x%2.2x)", str, type);
1191
1192         packet_hexdump(data + 1, size - 1);
1193 }
1194
1195 static const struct vendor_evt vendor_evt_table[] = {
1196         { 0x00, "Startup",
1197                         startup_evt, 0, true },
1198         { 0x01, "Fatal Exception",
1199                         fatal_exception_evt, 4, true },
1200         { 0x02, "Bootup",
1201                         bootup_evt, 6, true },
1202         { 0x05, "Default BD Data",
1203                         default_bd_data_evt, 1, true },
1204         { 0x06, "Secure Send Commands Result",
1205                         secure_send_commands_result_evt, 4, true },
1206         { 0x08, "Debug Exception",
1207                         debug_exception_evt, 4, true },
1208         { 0x0f, "LE Link Established",
1209                         le_link_established_evt, 26, true },
1210         { 0x11, "Scan Status",
1211                         scan_status_evt, 1, true },
1212         { 0x16, "Activate Deactivate Traces Complete",
1213                         act_deact_traces_complete_evt, 1, true },
1214         { 0x17, "LMP PDU Trace",
1215                         lmp_pdu_trace_evt, 3, false },
1216         { 0x19, "Write BD Data Complete",
1217                         write_bd_data_complete_evt, 1, true },
1218         { 0x25, "SCO Rejected via LMP",
1219                         sco_rejected_via_lmp_evt, 7, true },
1220         { 0x26, "PTT Switch Notification",
1221                         ptt_switch_notification_evt, 3, true },
1222         { 0x29, "System Exception",
1223                         system_exception_evt, 133, true },
1224         { 0x2c, "FW Trace String" },
1225         { 0x2e, "FW Trace Binary" },
1226         { }
1227 };
1228
1229 /*
1230  * An Intel telemetry subevent is of the TLV format.
1231  * - Type: takes 1 byte. This is the subevent_id.
1232  * - Length: takes 1 byte.
1233  * - Value: takes |Length| bytes.
1234  */
1235 struct intel_tlv {
1236         uint8_t subevent_id;
1237         uint8_t length;
1238         uint8_t value[];
1239 };
1240
1241 #define TLV_SIZE(tlv) (*((const uint8_t *) tlv + 1) + 2 * sizeof(uint8_t))
1242 #define NEXT_TLV(tlv) (const struct intel_tlv *) \
1243                                         ((const uint8_t *) tlv + TLV_SIZE(tlv))
1244
1245 static void ext_evt_type(const struct intel_tlv *tlv)
1246 {
1247         uint8_t evt_type = get_u8(tlv->value);
1248         const char *str;
1249
1250         switch (evt_type) {
1251         case 0x00:
1252                 str = "System Exception";
1253                 break;
1254         case 0x01:
1255                 str = "Fatal Exception";
1256                 break;
1257         case 0x02:
1258                 str = "Debug Exception";
1259                 break;
1260         case 0x03:
1261                 str = "Connection Event for BR/EDR Link Type";
1262                 break;
1263         case 0x04:
1264                 str = "Disconnection Event";
1265                 break;
1266         case 0x05:
1267                 str = "Performance Stats";
1268                 break;
1269
1270         default:
1271                 print_text(COLOR_UNKNOWN_EXT_EVENT,
1272                         "Unknown extended telemetry event type (0x%2.2x)",
1273                         evt_type);
1274                 packet_hexdump((const void *) tlv,
1275                                         tlv->length + 2 * sizeof(uint8_t));
1276                 return;
1277         }
1278
1279         print_field("Extended event type (0x%2.2x): %s (0x%2.2x)",
1280                         tlv->subevent_id, str, evt_type);
1281 }
1282
1283 static void ext_acl_evt_conn_handle(const struct intel_tlv *tlv)
1284 {
1285         uint16_t conn_handle = get_le16(tlv->value);
1286
1287         print_field("ACL connection handle (0x%2.2x): 0x%4.4x",
1288                         tlv->subevent_id, conn_handle);
1289 }
1290
1291 static void ext_acl_evt_hec_errors(const struct intel_tlv *tlv)
1292 {
1293         uint32_t num = get_le32(tlv->value);
1294
1295         /* Skip if 0 */
1296         if (!num)
1297                 return;
1298
1299         print_field("Rx HEC errors (0x%2.2x): %d", tlv->subevent_id, num);
1300 }
1301
1302 static void ext_acl_evt_crc_errors(const struct intel_tlv *tlv)
1303 {
1304         uint32_t num = get_le32(tlv->value);
1305
1306         /* Skip if 0 */
1307         if (!num)
1308                 return;
1309
1310         print_field("Rx CRC errors (0x%2.2x): %d", tlv->subevent_id, num);
1311 }
1312
1313 static void ext_acl_evt_num_pkt_from_host(const struct intel_tlv *tlv)
1314 {
1315         uint32_t num = get_le32(tlv->value);
1316
1317         /* Skip if 0 */
1318         if (!num)
1319                 return;
1320
1321         print_field("Packets from host (0x%2.2x): %d",
1322                         tlv->subevent_id, num);
1323 }
1324
1325 static void ext_acl_evt_num_tx_pkt_to_air(const struct intel_tlv *tlv)
1326 {
1327         uint32_t num = get_le32(tlv->value);
1328
1329         /* Skip if 0 */
1330         if (!num)
1331                 return;
1332
1333         print_field("Tx packets (0x%2.2x): %d", tlv->subevent_id, num);
1334 }
1335
1336 static void ext_acl_evt_num_tx_pkt_retry(const struct intel_tlv *tlv)
1337 {
1338         char *subevent_str;
1339         uint32_t num = get_le32(tlv->value);
1340
1341         /* Skip if 0 */
1342         if (!num)
1343                 return;
1344
1345         switch (tlv->subevent_id) {
1346         case 0x4f:
1347                 subevent_str = "Tx packets 0 retries";
1348                 break;
1349         case 0x50:
1350                 subevent_str = "Tx packets 1 retries";
1351                 break;
1352         case 0x51:
1353                 subevent_str = "Tx packets 2 retries";
1354                 break;
1355         case 0x52:
1356                 subevent_str = "Tx packets 3 retries";
1357                 break;
1358         case 0x53:
1359                 subevent_str = "Tx packets 4 retries and more";
1360                 break;
1361         default:
1362                 subevent_str = "Unknown";
1363                 break;
1364         }
1365
1366         print_field("%s (0x%2.2x): %d", subevent_str, tlv->subevent_id, num);
1367 }
1368
1369 static void ext_acl_evt_num_tx_pkt_type(const struct intel_tlv *tlv)
1370 {
1371         char *packet_type_str;
1372         uint32_t num = get_le32(tlv->value);
1373
1374         /* Skip if 0 */
1375         if (!num)
1376                 return;
1377
1378         switch (tlv->subevent_id) {
1379         case 0x54:
1380                 packet_type_str = "DH1";
1381                 break;
1382         case 0x55:
1383                 packet_type_str = "DH3";
1384                 break;
1385         case 0x56:
1386                 packet_type_str = "DH5";
1387                 break;
1388         case 0x57:
1389                 packet_type_str = "2DH1";
1390                 break;
1391         case 0x58:
1392                 packet_type_str = "2DH3";
1393                 break;
1394         case 0x59:
1395                 packet_type_str = "2DH5";
1396                 break;
1397         case 0x5a:
1398                 packet_type_str = "3DH1";
1399                 break;
1400         case 0x5b:
1401                 packet_type_str = "3DH3";
1402                 break;
1403         case 0x5c:
1404                 packet_type_str = "3DH5";
1405                 break;
1406         default:
1407                 packet_type_str = "Unknown";
1408                 break;
1409         }
1410
1411         print_field("Tx %s packets (0x%2.2x): %d",
1412                         packet_type_str, tlv->subevent_id, num);
1413 }
1414
1415 static void ext_acl_evt_num_rx_pkt_from_air(const struct intel_tlv *tlv)
1416 {
1417         uint32_t num = get_le32(tlv->value);
1418
1419         /* Skip if 0 */
1420         if (!num)
1421                 return;
1422
1423         print_field("Rx packets (0x%2.2x): %d",
1424                         tlv->subevent_id, num);
1425 }
1426
1427 static void ext_acl_evt_link_throughput(const struct intel_tlv *tlv)
1428 {
1429         uint32_t num = get_le32(tlv->value);
1430
1431         /* Skip if 0 */
1432         if (!num)
1433                 return;
1434
1435         print_field("ACL link throughput (bps) (0x%2.2x): %d",
1436                         tlv->subevent_id, num);
1437 }
1438
1439 static void ext_acl_evt_max_packet_latency(const struct intel_tlv *tlv)
1440 {
1441         uint32_t num = get_le32(tlv->value);
1442
1443         /* Skip if 0 */
1444         if (!num)
1445                 return;
1446
1447         print_field("ACL max packet latency (us) (0x%2.2x): %d",
1448                         tlv->subevent_id, num);
1449 }
1450
1451 static void ext_acl_evt_avg_packet_latency(const struct intel_tlv *tlv)
1452 {
1453         uint32_t num = get_le32(tlv->value);
1454
1455         /* Skip if 0 */
1456         if (!num)
1457                 return;
1458
1459         print_field("ACL avg packet latency (us) (0x%2.2x): %d",
1460                         tlv->subevent_id, num);
1461 }
1462
1463 static void ext_acl_evt_rssi_moving_avg(const struct intel_tlv *tlv)
1464 {
1465         uint32_t num = get_le16(tlv->value);
1466
1467         /* Skip if 0 */
1468         if (!num)
1469                 return;
1470
1471         print_field("ACL RX RSSI moving avg (0x%2.2x): %d",
1472                         tlv->subevent_id, num);
1473 }
1474
1475 static void ext_acl_evt_bad_cnt(const char *prefix, const struct intel_tlv *tlv)
1476 {
1477         uint32_t c_1m = get_le32(tlv->value);
1478         uint32_t c_2m = get_le32(tlv->value + 4);
1479         uint32_t c_3m = get_le32(tlv->value + 8);
1480
1481         /* Skip if all 0 */
1482         if (!c_1m && !c_2m && !c_3m)
1483                 return;
1484
1485         print_field("%s (0x%2.2x): 1M %d 2M %d 3M %d",
1486                         prefix, tlv->subevent_id, c_1m, c_2m, c_3m);
1487 }
1488
1489 static void ext_acl_evt_snr_bad_cnt(const struct intel_tlv *tlv)
1490 {
1491         ext_acl_evt_bad_cnt("ACL RX SNR Bad Margin Counter", tlv);
1492 }
1493
1494 static void ext_acl_evt_rx_rssi_bad_cnt(const struct intel_tlv *tlv)
1495 {
1496         ext_acl_evt_bad_cnt("ACL RX RSSI Bad Counter", tlv);
1497 }
1498
1499 static void ext_acl_evt_tx_rssi_bad_cnt(const struct intel_tlv *tlv)
1500 {
1501         ext_acl_evt_bad_cnt("ACL TX RSSI Bad Counter", tlv);
1502 }
1503
1504 static void ext_sco_evt_conn_handle(const struct intel_tlv *tlv)
1505 {
1506         uint16_t conn_handle = get_le16(tlv->value);
1507
1508         print_field("SCO/eSCO connection handle (0x%2.2x): 0x%4.4x",
1509                         tlv->subevent_id, conn_handle);
1510 }
1511
1512 static void ext_sco_evt_num_rx_pkt_from_air(const struct intel_tlv *tlv)
1513 {
1514         uint32_t num = get_le32(tlv->value);
1515
1516         /* Skip if 0 */
1517         if (!num)
1518                 return;
1519
1520         print_field("Packets from host (0x%2.2x): %d", tlv->subevent_id, num);
1521 }
1522
1523 static void ext_sco_evt_num_tx_pkt_to_air(const struct intel_tlv *tlv)
1524 {
1525         uint32_t num = get_le32(tlv->value);
1526
1527         /* Skip if 0 */
1528         if (!num)
1529                 return;
1530
1531         print_field("Tx packets (0x%2.2x): %d", tlv->subevent_id, num);
1532 }
1533
1534 static void ext_sco_evt_num_rx_payloads_lost(const struct intel_tlv *tlv)
1535 {
1536         uint32_t num = get_le32(tlv->value);
1537
1538         /* Skip if 0 */
1539         if (!num)
1540                 return;
1541
1542         print_field("Rx payload lost (0x%2.2x): %d", tlv->subevent_id, num);
1543 }
1544
1545 static void ext_sco_evt_num_tx_payloads_lost(const struct intel_tlv *tlv)
1546 {
1547
1548         uint32_t num = get_le32(tlv->value);
1549
1550         /* Skip if 0 */
1551         if (!num)
1552                 return;
1553
1554         print_field("Tx payload lost (0x%2.2x): %d", tlv->subevent_id, num);
1555 }
1556
1557 static void slots_errors(const struct intel_tlv *tlv, const char *type_str)
1558 {
1559         /* The subevent has 5 slots where each slot is of the uint32_t type. */
1560         uint32_t num[5];
1561         const uint8_t *data = tlv->value;
1562         int i;
1563
1564         if (tlv->length != 5 * sizeof(uint32_t)) {
1565                 print_text(COLOR_UNKNOWN_EXT_EVENT,
1566                                 "  Invalid subevent length (%d)", tlv->length);
1567                 return;
1568         }
1569
1570         for (i = 0; i < 5; i++) {
1571                 num[i] = get_le32(data);
1572                 data += sizeof(uint32_t);
1573         }
1574
1575         print_field("%s (0x%2.2x): %d %d %d %d %d", type_str, tlv->subevent_id,
1576                         num[0], num[1], num[2], num[3], num[4]);
1577 }
1578
1579 static void ext_sco_evt_num_no_sync_errors(const struct intel_tlv *tlv)
1580 {
1581         slots_errors(tlv, "Rx No SYNC errors");
1582 }
1583
1584 static void ext_sco_evt_num_hec_errors(const struct intel_tlv *tlv)
1585 {
1586         slots_errors(tlv, "Rx HEC errors");
1587 }
1588
1589 static void ext_sco_evt_num_crc_errors(const struct intel_tlv *tlv)
1590 {
1591         slots_errors(tlv, "Rx CRC errors");
1592 }
1593
1594 static void ext_sco_evt_num_naks(const struct intel_tlv *tlv)
1595 {
1596         slots_errors(tlv, "Rx NAK errors");
1597 }
1598
1599 static void ext_sco_evt_num_failed_tx_by_wifi(const struct intel_tlv *tlv)
1600 {
1601         slots_errors(tlv, "Failed Tx due to Wifi coex");
1602 }
1603
1604 static void ext_sco_evt_num_failed_rx_by_wifi(const struct intel_tlv *tlv)
1605 {
1606         slots_errors(tlv, "Failed Rx due to Wifi coex");
1607 }
1608
1609 static void ext_sco_evt_samples_inserted(const struct intel_tlv *tlv)
1610 {
1611         uint32_t num = get_le32(tlv->value);
1612
1613         /* Skip if 0 */
1614         if (!num)
1615                 return;
1616
1617         print_field("Late samples inserted based on CDC (0x%2.2x): %d",
1618                         tlv->subevent_id, num);
1619 }
1620
1621 static void ext_sco_evt_samples_dropped(const struct intel_tlv *tlv)
1622 {
1623         uint32_t num = get_le32(tlv->value);
1624
1625         /* Skip if 0 */
1626         if (!num)
1627                 return;
1628
1629         print_field("Samples dropped (0x%2.2x): %d", tlv->subevent_id, num);
1630 }
1631
1632 static void ext_sco_evt_mute_samples(const struct intel_tlv *tlv)
1633 {
1634         uint32_t num = get_le32(tlv->value);
1635
1636         /* Skip if 0 */
1637         if (!num)
1638                 return;
1639
1640         print_field("Mute samples sent at initial connection (0x%2.2x): %d",
1641                         tlv->subevent_id, num);
1642 }
1643
1644 static void ext_sco_evt_plc_injection_data(const struct intel_tlv *tlv)
1645 {
1646         uint32_t num = get_le32(tlv->value);
1647
1648         /* Skip if 0 */
1649         if (!num)
1650                 return;
1651
1652         print_field("PLC injection data (0x%2.2x): %d", tlv->subevent_id, num);
1653 }
1654
1655 static const struct intel_ext_subevent {
1656         uint8_t subevent_id;
1657         uint8_t length;
1658         void (*func)(const struct intel_tlv *tlv);
1659 } intel_ext_subevent_table[] = {
1660         { 0x01, 1, ext_evt_type },
1661
1662         /* ACL audio link quality subevents */
1663         { 0x4a, 2, ext_acl_evt_conn_handle },
1664         { 0x4b, 4, ext_acl_evt_hec_errors },
1665         { 0x4c, 4, ext_acl_evt_crc_errors },
1666         { 0x4d, 4, ext_acl_evt_num_pkt_from_host },
1667         { 0x4e, 4, ext_acl_evt_num_tx_pkt_to_air },
1668         { 0x4f, 4, ext_acl_evt_num_tx_pkt_retry },
1669         { 0x50, 4, ext_acl_evt_num_tx_pkt_retry },
1670         { 0x51, 4, ext_acl_evt_num_tx_pkt_retry },
1671         { 0x52, 4, ext_acl_evt_num_tx_pkt_retry },
1672         { 0x53, 4, ext_acl_evt_num_tx_pkt_retry },
1673         { 0x54, 4, ext_acl_evt_num_tx_pkt_type },
1674         { 0x55, 4, ext_acl_evt_num_tx_pkt_type },
1675         { 0x56, 4, ext_acl_evt_num_tx_pkt_type },
1676         { 0x57, 4, ext_acl_evt_num_tx_pkt_type },
1677         { 0x58, 4, ext_acl_evt_num_tx_pkt_type },
1678         { 0x59, 4, ext_acl_evt_num_tx_pkt_type },
1679         { 0x5a, 4, ext_acl_evt_num_tx_pkt_type },
1680         { 0x5b, 4, ext_acl_evt_num_tx_pkt_type },
1681         { 0x5c, 4, ext_acl_evt_num_tx_pkt_type },
1682         { 0x5d, 4, ext_acl_evt_num_rx_pkt_from_air },
1683         { 0x5e, 4, ext_acl_evt_link_throughput },
1684         { 0x5f, 4, ext_acl_evt_max_packet_latency },
1685         { 0x60, 4, ext_acl_evt_avg_packet_latency },
1686         { 0x61, 2, ext_acl_evt_rssi_moving_avg },
1687         { 0x62, 12, ext_acl_evt_snr_bad_cnt },
1688         { 0x63, 12, ext_acl_evt_rx_rssi_bad_cnt },
1689         { 0x64, 12, ext_acl_evt_tx_rssi_bad_cnt },
1690
1691         /* SCO/eSCO audio link quality subevents */
1692         { 0x6a, 2, ext_sco_evt_conn_handle },
1693         { 0x6b, 4, ext_sco_evt_num_rx_pkt_from_air },
1694         { 0x6c, 4, ext_sco_evt_num_tx_pkt_to_air },
1695         { 0x6d, 4, ext_sco_evt_num_rx_payloads_lost },
1696         { 0x6e, 4, ext_sco_evt_num_tx_payloads_lost },
1697         { 0x6f, 20, ext_sco_evt_num_no_sync_errors },
1698         { 0x70, 20, ext_sco_evt_num_hec_errors },
1699         { 0x71, 20, ext_sco_evt_num_crc_errors },
1700         { 0x72, 20, ext_sco_evt_num_naks },
1701         { 0x73, 20, ext_sco_evt_num_failed_tx_by_wifi },
1702         { 0x74, 20, ext_sco_evt_num_failed_rx_by_wifi },
1703         { 0x75, 4, ext_sco_evt_samples_inserted },
1704         { 0x76, 4, ext_sco_evt_samples_dropped },
1705         { 0x77, 4, ext_sco_evt_mute_samples },
1706         { 0x78, 4, ext_sco_evt_plc_injection_data },
1707
1708         /* end */
1709         { 0x0, 0}
1710 };
1711
1712 static const struct intel_tlv *process_ext_subevent(const struct intel_tlv *tlv,
1713                                         const struct intel_tlv *last_tlv)
1714 {
1715         const struct intel_tlv *next_tlv = NEXT_TLV(tlv);
1716         const struct intel_ext_subevent *subevent = NULL;
1717         int i;
1718
1719         for (i = 0; intel_ext_subevent_table[i].length > 0; i++) {
1720                 if (intel_ext_subevent_table[i].subevent_id ==
1721                                                         tlv->subevent_id) {
1722                         subevent = &intel_ext_subevent_table[i];
1723                         break;
1724                 }
1725         }
1726
1727         if (!subevent) {
1728                 print_text(COLOR_UNKNOWN_EXT_EVENT,
1729                                 "Unknown extended subevent 0x%2.2x",
1730                                 tlv->subevent_id);
1731                 packet_hexdump(tlv->value, tlv->length);
1732                 return next_tlv;
1733         }
1734
1735         if (tlv->length != subevent->length) {
1736                 print_text(COLOR_ERROR, "Invalid length %d of subevent 0x%2.2x",
1737                                 tlv->length, tlv->subevent_id);
1738                 return NULL;
1739         }
1740
1741         if (next_tlv > last_tlv) {
1742                 print_text(COLOR_ERROR, "Subevent exceeds the buffer size.");
1743                 return NULL;
1744         }
1745
1746         subevent->func(tlv);
1747
1748         return next_tlv;
1749 }
1750
1751 static void intel_vendor_ext_evt(struct timeval *tv, uint16_t index,
1752                                         const void *data, uint8_t size)
1753 {
1754         /* The data pointer points to a number of tlv.*/
1755         const struct intel_tlv *tlv = data;
1756         const struct intel_tlv *last_tlv = data + size;
1757
1758         /* Process every tlv subevent until reaching last_tlv.
1759          * The decoding process terminates normally when tlv == last_tlv.
1760          */
1761         while (tlv && tlv < last_tlv)
1762                 tlv = process_ext_subevent(tlv, last_tlv);
1763
1764         /* If an error occurs in decoding the subevents, hexdump the packet. */
1765         if (!tlv)
1766                 packet_hexdump(data, size);
1767 }
1768
1769 /* Vendor extended events with a vendor prefix. */
1770 static const struct vendor_evt vendor_prefix_evt_table[] = {
1771         { 0x03, "Extended Telemetry", intel_vendor_ext_evt },
1772         { }
1773 };
1774
1775 const uint8_t intel_vendor_prefix[] = {0x87, 0x80};
1776 #define INTEL_VENDOR_PREFIX_SIZE sizeof(intel_vendor_prefix)
1777
1778 /*
1779  * The vendor event with Intel vendor prefix.
1780  * Its format looks like
1781  *   0xff <length> <vendor_prefix> <subopcode> <data>
1782  *   where Intel's <vendor_prefix> is 0x8780.
1783  *
1784  *   When <subopcode> == 0x03, it is a telemetry event; and
1785  *   <data> is a number of tlv data.
1786  */
1787 struct vendor_prefix_evt {
1788         uint8_t prefix_data[INTEL_VENDOR_PREFIX_SIZE];
1789         uint8_t subopcode;
1790 };
1791
1792 static const struct vendor_evt *intel_vendor_prefix_evt(const void *data,
1793                                                         int *consumed_size)
1794 {
1795         unsigned int i;
1796         const struct vendor_prefix_evt *vnd = data;
1797         char prefix_string[INTEL_VENDOR_PREFIX_SIZE * 2 + 1] = { 0 };
1798
1799         /* Check if the vendor prefix matches. */
1800         for (i = 0; i < INTEL_VENDOR_PREFIX_SIZE; i++) {
1801                 if (vnd->prefix_data[i] != intel_vendor_prefix[i])
1802                         return NULL;
1803                 sprintf(prefix_string + i * 2, "%02x", vnd->prefix_data[i]);
1804         }
1805         print_field("Vendor Prefix (0x%s)", prefix_string);
1806
1807         /*
1808          * Handle the vendor event with a vendor prefix.
1809          *   0xff <length> <vendor_prefix> <subopcode> <data>
1810          * This loop checks whether the <subopcode> exists in the
1811          * vendor_prefix_evt_table.
1812          */
1813         for (i = 0; vendor_prefix_evt_table[i].str; i++) {
1814                 if (vendor_prefix_evt_table[i].evt == vnd->subopcode) {
1815                         *consumed_size = sizeof(struct vendor_prefix_evt);
1816                         return &vendor_prefix_evt_table[i];
1817                 }
1818         }
1819
1820         return NULL;
1821 }
1822
1823 const struct vendor_evt *intel_vendor_evt(const void *data, int *consumed_size)
1824 {
1825         uint8_t evt = *((const uint8_t *) data);
1826         int i;
1827
1828         /*
1829          * Handle the vendor event without a vendor prefix.
1830          *   0xff <length> <evt> <data>
1831          * This loop checks whether the <evt> exists in the vendor_evt_table.
1832          */
1833         for (i = 0; vendor_evt_table[i].str; i++) {
1834                 if (vendor_evt_table[i].evt == evt)
1835                         return &vendor_evt_table[i];
1836         }
1837
1838         /*
1839          * It is not a regular event. Check whether it is a vendor extended
1840          * event that comes with a vendor prefix followed by a subopcode.
1841          */
1842         return intel_vendor_prefix_evt(data, consumed_size);
1843 }