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 void ppag_enable(uint16_t index, const void *data, uint8_t size)
 715 {
 716         uint32_t enable = get_le32(data);
 717         char *ppag_enable_flags;
 718
 719         switch (enable) {
 720         case 0x01:
 721                 ppag_enable_flags = "EU";
 722                 break;
 723         case 0x02:
 724                 ppag_enable_flags = "China";
 725                 break;
 726         case 0x03:
 727                 ppag_enable_flags = "EU and China";
 728                 break;
 729         default:
 730                 ppag_enable_flags = "Unknown";
 731                 break;
 732         }
 733
 734         print_field("Enable: %s (0x%8.8x)", ppag_enable_flags, enable);
 735 }
 736
 737 static const struct vendor_ocf vendor_ocf_table[] = {
 738         { 0x001, "Reset",
 739                         reset_cmd, 8, true,
 740                         status_rsp, 1, true },
 741         { 0x002, "No Operation" },
 742         { 0x005, "Read Version",
 743                         read_version_cmd, 0, false,
 744                         read_version_rsp, 1, false },
 745         { 0x006, "Set UART Baudrate",
 746                         set_uart_baudrate_cmd, 1, true,
 747                         status_rsp, 1, true },
 748         { 0x007, "Enable LPM" },
 749         { 0x008, "PCM Write Configuration" },
 750         { 0x009, "Secure Send",
 751                         secure_send_cmd, 1, false,
 752                         status_rsp, 1, true },
 753         { 0x00d, "Read Secure Boot Params",
 754                         null_cmd, 0, true },
 755         { 0x00e, "Write Secure Boot Params" },
 756         { 0x00f, "Unlock" },
 757         { 0x010, "Change UART Baudrate" },
 758         { 0x011, "Manufacturer Mode",
 759                         manufacturer_mode_cmd, 2, true,
 760                         status_rsp, 1, true },
 761         { 0x012, "Read Link RSSI" },
 762         { 0x022, "Get Exception Info" },
 763         { 0x024, "Clear Exception Info" },
 764         { 0x02f, "Write BD Data",
 765                         write_bd_data_cmd, 6, false },
 766         { 0x030, "Read BD Data",
 767                         null_cmd, 0, true,
 768                         read_bd_data_rsp, 7, false },
 769         { 0x031, "Write BD Address",
 770                         write_bd_address_cmd, 6, true,
 771                         status_rsp, 1, true },
 772         { 0x032, "Flow Specification" },
 773         { 0x034, "Read Secure ID" },
 774         { 0x038, "Set Synchronous USB Interface Type" },
 775         { 0x039, "Config Synchronous Interface" },
 776         { 0x03f, "SW RF Kill",
 777                         null_cmd, 0, true,
 778                         status_rsp, 1, true },
 779         { 0x043, "Activate Deactivate Traces",
 780                         act_deact_traces_cmd, 3, true },
 781         { 0x04d, "Stimulate Exception",
 782                         stimulate_exception_cmd, 1, true,
 783                         status_rsp, 1, true },
 784         { 0x050, "Read HW Version" },
 785         { 0x052, "Set Event Mask",
 786                         set_event_mask_cmd, 8, true,
 787                         status_rsp, 1, true },
 788         { 0x053, "Config_Link_Controller" },
 789         { 0x089, "DDC Write" },
 790         { 0x08a, "DDC Read" },
 791         { 0x08b, "DDC Config Write",
 792                         ddc_config_write_cmd, 3, false,
 793                         ddc_config_write_rsp, 3, true },
 794         { 0x08c, "DDC Config Read" },
 795         { 0x08d, "Memory Read" },
 796         { 0x08e, "Memory Write",
 797                         memory_write_cmd, 6, false,
 798                         status_rsp, 1, true },
 799         { 0x0a6, "Read Supported Features",
 800                         read_supported_features_cmd, 1, true,
 801                         read_supported_features_rsp, 19, true },
 802         { 0x20b, "PPAG Enable",
 803                         ppag_enable, 4, true,
 804                         status_rsp, 1, true },
 805         { }
 806 };
 807
 808 const struct vendor_ocf *intel_vendor_ocf(uint16_t ocf)
 809 {
 810         int i;
 811
 812         for (i = 0; vendor_ocf_table[i].str; i++) {
 813                 if (vendor_ocf_table[i].ocf == ocf)
 814                         return &vendor_ocf_table[i];
 815         }
 816
 817         return NULL;
 818 }
 819
 820 static void startup_evt(struct timeval *tv, uint16_t index,
 821                                 const void *data, uint8_t size)
 822 {
 823 }
 824
 825 static void fatal_exception_evt(struct timeval *tv, uint16_t index,
 826                                 const void *data, uint8_t size)
 827 {
 828         uint16_t line = get_le16(data);
 829         uint8_t module = get_u8(data + 2);
 830         uint8_t reason = get_u8(data + 3);
 831
 832         print_field("Line: %u", line);
 833         print_module(module);
 834         print_field("Reason: 0x%2.2x", reason);
 835 }
 836
 837 static void bootup_evt(struct timeval *tv, uint16_t index,
 838                                 const void *data, uint8_t size)
 839 {
 840         uint8_t zero = get_u8(data);
 841         uint8_t num_packets = get_u8(data + 1);
 842         uint8_t source = get_u8(data + 2);
 843         uint8_t reset_type = get_u8(data + 3);
 844         uint8_t reset_reason = get_u8(data + 4);
 845         uint8_t ddc_status = get_u8(data + 5);
 846         const char *str;
 847
 848         print_field("Zero: 0x%2.2x", zero);
 849         print_field("Number of packets: %d", num_packets);
 850
 851         switch (source) {
 852         case 0x00:
 853                 str = "Bootloader";
 854                 break;
 855         case 0x01:
 856                 str = "Operational firmware";
 857                 break;
 858         case 0x02:
 859                 str = "Self test firmware";
 860                 break;
 861         default:
 862                 str = "Reserved";
 863                 break;
 864         }
 865
 866         print_field("Source: %s (0x%2.2x)", str, source);
 867
 868         switch (reset_type) {
 869         case 0x00:
 870                 str = "Hardware reset";
 871                 break;
 872         case 0x01:
 873                 str = "Soft watchdog reset";
 874                 break;
 875         case 0x02:
 876                 str = "Soft software reset";
 877                 break;
 878         case 0x03:
 879                 str = "Hard watchdog reset";
 880                 break;
 881         case 0x04:
 882                 str = "Hard software reset";
 883                 break;
 884         default:
 885                 str = "Reserved";
 886                 break;
 887         }
 888
 889         print_field("Reset type: %s (0x%2.2x)", str, reset_type);
 890
 891         switch (reset_reason) {
 892         case 0x00:
 893                 str = "Power on";
 894                 break;
 895         case 0x01:
 896                 str = "Reset command";
 897                 break;
 898         case 0x02:
 899                 str = "Intel reset command";
 900                 break;
 901         case 0x03:
 902                 str = "Watchdog";
 903                 break;
 904         case 0x04:
 905                 str = "Fatal exception";
 906                 break;
 907         case 0x05:
 908                 str = "System exception";
 909                 break;
 910         case 0xff:
 911                 str = "Unknown";
 912                 break;
 913         default:
 914                 str = "Reserved";
 915                 break;
 916         }
 917
 918         print_field("Reset reason: %s (0x%2.2x)", str, reset_reason);
 919
 920         switch (ddc_status) {
 921         case 0x00:
 922                 str = "Firmware default";
 923                 break;
 924         case 0x01:
 925                 str = "Firmware default plus OTP";
 926                 break;
 927         case 0x02:
 928                 str = "Persistent RAM";
 929                 break;
 930         case 0x03:
 931                 str = "Not used";
 932                 break;
 933         default:
 934                 str = "Reserved";
 935                 break;
 936         }
 937
 938         print_field("DDC status: %s (0x%2.2x)", str, ddc_status);
 939 }
 940
 941 static void default_bd_data_evt(struct timeval *tv, uint16_t index,
 942                                         const void *data, uint8_t size)
 943 {
 944         uint8_t mem_status = get_u8(data);
 945         const char *str;
 946
 947         switch (mem_status) {
 948         case 0x02:
 949                 str = "Invalid manufacturing data";
 950                 break;
 951         default:
 952                 str = "Reserved";
 953                 break;
 954         }
 955
 956         print_field("Memory status: %s (0x%2.2x)", str, mem_status);
 957 }
 958
 959 static void secure_send_commands_result_evt(struct timeval *tv, uint16_t index,
 960                                                 const void *data, uint8_t size)
 961 {
 962         uint8_t result = get_u8(data);
 963         uint16_t opcode = get_le16(data + 1);
 964         uint16_t ogf = cmd_opcode_ogf(opcode);
 965         uint16_t ocf = cmd_opcode_ocf(opcode);
 966         uint8_t status = get_u8(data + 3);
 967         const char *str;
 968
 969         switch (result) {
 970         case 0x00:
 971                 str = "Success";
 972                 break;
 973         case 0x01:
 974                 str = "General failure";
 975                 break;
 976         case 0x02:
 977                 str = "Hardware failure";
 978                 break;
 979         case 0x03:
 980                 str = "Signature verification failed";
 981                 break;
 982         case 0x04:
 983                 str = "Parsing error of command buffer";
 984                 break;
 985         case 0x05:
 986                 str = "Command execution failure";
 987                 break;
 988         case 0x06:
 989                 str = "Command parameters error";
 990                 break;
 991         case 0x07:
 992                 str = "Command missing";
 993                 break;
 994         default:
 995                 str = "Reserved";
 996                 break;
 997         }
 998
 999         print_field("Result: %s (0x%2.2x)", str, result);
1000         print_field("Opcode: 0x%4.4x (0x%2.2x|0x%4.4x)", opcode, ogf, ocf);
1001         print_status(status);
1002 }
1003
1004 static void debug_exception_evt(struct timeval *tv, uint16_t index,
1005                                         const void *data, uint8_t size)
1006 {
1007         uint16_t line = get_le16(data);
1008         uint8_t module = get_u8(data + 2);
1009         uint8_t reason = get_u8(data + 3);
1010
1011         print_field("Line: %u", line);
1012         print_module(module);
1013         print_field("Reason: 0x%2.2x", reason);
1014 }
1015
1016 static void le_link_established_evt(struct timeval *tv, uint16_t index,
1017                                         const void *data, uint8_t size)
1018 {
1019         uint16_t handle = get_le16(data);
1020         uint32_t access_addr = get_le32(data + 10);
1021
1022         print_field("Handle: %u", handle);
1023
1024         packet_hexdump(data + 2, 8);
1025
1026         print_field("Access address: 0x%8.8x", access_addr);
1027
1028         packet_hexdump(data + 14, size - 14);
1029 }
1030
1031 static void scan_status_evt(struct timeval *tv, uint16_t index,
1032                                         const void *data, uint8_t size)
1033 {
1034         uint8_t enable = get_u8(data);
1035
1036         print_field("Inquiry scan: %s",
1037                                 (enable & 0x01) ? "Enabled" : "Disabled");
1038         print_field("Page scan: %s",
1039                                 (enable & 0x02) ? "Enabled" : "Disabled");
1040
1041         if (enable & 0xfc)
1042                 print_text(COLOR_UNKNOWN_SCAN_STATUS,
1043                                 "  Unknown status (0x%2.2x)", enable & 0xfc);
1044
1045 }
1046
1047 static void act_deact_traces_complete_evt(struct timeval *tv, uint16_t index,
1048                                         const void *data, uint8_t size)
1049 {
1050         uint8_t status = get_u8(data);
1051
1052         print_status(status);
1053 }
1054
1055 static void lmp_pdu_trace_evt(struct timeval *tv, uint16_t index,
1056                                         const void *data, uint8_t size)
1057 {
1058         uint8_t type, len, id;
1059         uint16_t handle, count;
1060         uint32_t clock;
1061         const char *str;
1062
1063         type = get_u8(data);
1064         handle = get_le16(data + 1);
1065
1066         switch (type) {
1067         case 0x00:
1068                 str = "RX LMP";
1069                 break;
1070         case 0x01:
1071                 str = "TX LMP";
1072                 break;
1073         case 0x02:
1074                 str = "ACK LMP";
1075                 break;
1076         case 0x03:
1077                 str = "RX LL";
1078                 break;
1079         case 0x04:
1080                 str = "TX LL";
1081                 break;
1082         case 0x05:
1083                 str = "ACK LL";
1084                 break;
1085         default:
1086                 str = "Unknown";
1087                 break;
1088         }
1089
1090         print_field("Type: %s (0x%2.2x)", str, type);
1091         print_field("Handle: %u", handle);
1092
1093         switch (type) {
1094         case 0x00:
1095                 len = size - 8;
1096                 clock = get_le32(data + 4 + len);
1097
1098                 packet_hexdump(data + 3, 1);
1099                 lmp_packet(data + 4, len, false);
1100                 print_field("Clock: 0x%8.8x", clock);
1101                 break;
1102         case 0x01:
1103                 len = size - 9;
1104                 clock = get_le32(data + 4 + len);
1105                 id = get_u8(data + 4 + len + 4);
1106
1107                 packet_hexdump(data + 3, 1);
1108                 lmp_packet(data + 4, len, false);
1109                 print_field("Clock: 0x%8.8x", clock);
1110                 print_field("ID: 0x%2.2x", id);
1111                 break;
1112         case 0x02:
1113                 clock = get_le32(data + 3);
1114                 id = get_u8(data + 3 + 4);
1115
1116                 print_field("Clock: 0x%8.8x", clock);
1117                 print_field("ID: 0x%2.2x", id);
1118                 break;
1119         case 0x03:
1120                 len = size - 8;
1121                 count = get_le16(data + 3);
1122
1123                 print_field("Count: 0x%4.4x", count);
1124                 packet_hexdump(data + 3 + 2 + 1, 2);
1125                 llcp_packet(data + 8, len, false);
1126                 break;
1127         case 0x04:
1128                 len = size - 8;
1129                 count = get_le16(data + 3);
1130                 id = get_u8(data + 3 + 2);
1131
1132                 print_field("Count: 0x%4.4x", count);
1133                 print_field("ID: 0x%2.2x", id);
1134                 packet_hexdump(data + 3 + 2 + 1, 2);
1135                 llcp_packet(data + 8, len, false);
1136                 break;
1137         case 0x05:
1138                 count = get_le16(data + 3);
1139                 id = get_u8(data + 3 + 2);
1140
1141                 print_field("Count: 0x%4.4x", count);
1142                 print_field("ID: 0x%2.2x", id);
1143                 break;
1144         default:
1145                 packet_hexdump(data + 3, size - 3);
1146                 break;
1147         }
1148 }
1149
1150 static void write_bd_data_complete_evt(struct timeval *tv, uint16_t index,
1151                                         const void *data, uint8_t size)
1152 {
1153         uint8_t status = get_u8(data);
1154
1155         print_status(status);
1156 }
1157
1158 static void sco_rejected_via_lmp_evt(struct timeval *tv, uint16_t index,
1159                                         const void *data, uint8_t size)
1160 {
1161         uint8_t reason = get_u8(data + 6);
1162
1163         packet_print_addr("Address", data, 0x00);
1164         packet_print_error("Reason", reason);
1165 }
1166
1167 static void ptt_switch_notification_evt(struct timeval *tv, uint16_t index,
1168                                         const void *data, uint8_t size)
1169 {
1170         uint16_t handle = get_le16(data);
1171         uint8_t table = get_u8(data + 2);
1172         const char *str;
1173
1174         print_field("Handle: %u", handle);
1175
1176         switch (table) {
1177         case 0x00:
1178                 str = "Basic rate";
1179                 break;
1180         case 0x01:
1181                 str = "Enhanced data rate";
1182                 break;
1183         default:
1184                 str = "Reserved";
1185                 break;
1186         }
1187
1188         print_field("Packet type table: %s (0x%2.2x)", str, table);
1189 }
1190
1191 static void system_exception_evt(struct timeval *tv, uint16_t index,
1192                                         const void *data, uint8_t size)
1193 {
1194         uint8_t type = get_u8(data);
1195         const char *str;
1196
1197         switch (type) {
1198         case 0x00:
1199                 str = "No Exception";
1200                 break;
1201         case 0x01:
1202                 str = "Undefined Instruction";
1203                 break;
1204         case 0x02:
1205                 str = "Prefetch abort";
1206                 break;
1207         case 0x03:
1208                 str = "Data abort";
1209                 break;
1210         default:
1211                 str = "Reserved";
1212                 break;
1213         }
1214
1215         print_field("Type: %s (0x%2.2x)", str, type);
1216
1217         packet_hexdump(data + 1, size - 1);
1218 }
1219
1220 static const struct vendor_evt vendor_evt_table[] = {
1221         { 0x00, "Startup",
1222                         startup_evt, 0, true },
1223         { 0x01, "Fatal Exception",
1224                         fatal_exception_evt, 4, true },
1225         { 0x02, "Bootup",
1226                         bootup_evt, 6, true },
1227         { 0x05, "Default BD Data",
1228                         default_bd_data_evt, 1, true },
1229         { 0x06, "Secure Send Commands Result",
1230                         secure_send_commands_result_evt, 4, true },
1231         { 0x08, "Debug Exception",
1232                         debug_exception_evt, 4, true },
1233         { 0x0f, "LE Link Established",
1234                         le_link_established_evt, 26, true },
1235         { 0x11, "Scan Status",
1236                         scan_status_evt, 1, true },
1237         { 0x16, "Activate Deactivate Traces Complete",
1238                         act_deact_traces_complete_evt, 1, true },
1239         { 0x17, "LMP PDU Trace",
1240                         lmp_pdu_trace_evt, 3, false },
1241         { 0x19, "Write BD Data Complete",
1242                         write_bd_data_complete_evt, 1, true },
1243         { 0x25, "SCO Rejected via LMP",
1244                         sco_rejected_via_lmp_evt, 7, true },
1245         { 0x26, "PTT Switch Notification",
1246                         ptt_switch_notification_evt, 3, true },
1247         { 0x29, "System Exception",
1248                         system_exception_evt, 133, true },
1249         { 0x2c, "FW Trace String" },
1250         { 0x2e, "FW Trace Binary" },
1251         { }
1252 };
1253
1254 /*
1255  * An Intel telemetry subevent is of the TLV format.
1256  * - Type: takes 1 byte. This is the subevent_id.
1257  * - Length: takes 1 byte.
1258  * - Value: takes |Length| bytes.
1259  */
1260 struct intel_tlv {
1261         uint8_t subevent_id;
1262         uint8_t length;
1263         uint8_t value[];
1264 };
1265
1266 #define TLV_SIZE(tlv) (*((const uint8_t *) tlv + 1) + 2 * sizeof(uint8_t))
1267 #define NEXT_TLV(tlv) (const struct intel_tlv *) \
1268                                         ((const uint8_t *) tlv + TLV_SIZE(tlv))
1269
1270 static void ext_evt_type(const struct intel_tlv *tlv)
1271 {
1272         uint8_t evt_type = get_u8(tlv->value);
1273         const char *str;
1274
1275         switch (evt_type) {
1276         case 0x00:
1277                 str = "System Exception";
1278                 break;
1279         case 0x01:
1280                 str = "Fatal Exception";
1281                 break;
1282         case 0x02:
1283                 str = "Debug Exception";
1284                 break;
1285         case 0x03:
1286                 str = "Connection Event for BR/EDR Link Type";
1287                 break;
1288         case 0x04:
1289                 str = "Disconnection Event";
1290                 break;
1291         case 0x05:
1292                 str = "Performance Stats";
1293                 break;
1294
1295         default:
1296                 print_text(COLOR_UNKNOWN_EXT_EVENT,
1297                         "Unknown extended telemetry event type (0x%2.2x)",
1298                         evt_type);
1299                 packet_hexdump((const void *) tlv,
1300                                         tlv->length + 2 * sizeof(uint8_t));
1301                 return;
1302         }
1303
1304         print_field("Extended event type (0x%2.2x): %s (0x%2.2x)",
1305                         tlv->subevent_id, str, evt_type);
1306 }
1307
1308 static void ext_acl_evt_conn_handle(const struct intel_tlv *tlv)
1309 {
1310         uint16_t conn_handle = get_le16(tlv->value);
1311
1312         print_field("ACL connection handle (0x%2.2x): 0x%4.4x",
1313                         tlv->subevent_id, conn_handle);
1314 }
1315
1316 static void ext_acl_evt_hec_errors(const struct intel_tlv *tlv)
1317 {
1318         uint32_t num = get_le32(tlv->value);
1319
1320         /* Skip if 0 */
1321         if (!num)
1322                 return;
1323
1324         print_field("Rx HEC errors (0x%2.2x): %d", tlv->subevent_id, num);
1325 }
1326
1327 static void ext_acl_evt_crc_errors(const struct intel_tlv *tlv)
1328 {
1329         uint32_t num = get_le32(tlv->value);
1330
1331         /* Skip if 0 */
1332         if (!num)
1333                 return;
1334
1335         print_field("Rx CRC errors (0x%2.2x): %d", tlv->subevent_id, num);
1336 }
1337
1338 static void ext_acl_evt_num_pkt_from_host(const struct intel_tlv *tlv)
1339 {
1340         uint32_t num = get_le32(tlv->value);
1341
1342         /* Skip if 0 */
1343         if (!num)
1344                 return;
1345
1346         print_field("Packets from host (0x%2.2x): %d",
1347                         tlv->subevent_id, num);
1348 }
1349
1350 static void ext_acl_evt_num_tx_pkt_to_air(const struct intel_tlv *tlv)
1351 {
1352         uint32_t num = get_le32(tlv->value);
1353
1354         /* Skip if 0 */
1355         if (!num)
1356                 return;
1357
1358         print_field("Tx packets (0x%2.2x): %d", tlv->subevent_id, num);
1359 }
1360
1361 static void ext_acl_evt_num_tx_pkt_retry(const struct intel_tlv *tlv)
1362 {
1363         char *subevent_str;
1364         uint32_t num = get_le32(tlv->value);
1365
1366         /* Skip if 0 */
1367         if (!num)
1368                 return;
1369
1370         switch (tlv->subevent_id) {
1371         case 0x4f:
1372                 subevent_str = "Tx packets 0 retries";
1373                 break;
1374         case 0x50:
1375                 subevent_str = "Tx packets 1 retries";
1376                 break;
1377         case 0x51:
1378                 subevent_str = "Tx packets 2 retries";
1379                 break;
1380         case 0x52:
1381                 subevent_str = "Tx packets 3 retries";
1382                 break;
1383         case 0x53:
1384                 subevent_str = "Tx packets 4 retries and more";
1385                 break;
1386         default:
1387                 subevent_str = "Unknown";
1388                 break;
1389         }
1390
1391         print_field("%s (0x%2.2x): %d", subevent_str, tlv->subevent_id, num);
1392 }
1393
1394 static void ext_acl_evt_num_tx_pkt_type(const struct intel_tlv *tlv)
1395 {
1396         char *packet_type_str;
1397         uint32_t num = get_le32(tlv->value);
1398
1399         /* Skip if 0 */
1400         if (!num)
1401                 return;
1402
1403         switch (tlv->subevent_id) {
1404         case 0x54:
1405                 packet_type_str = "DH1";
1406                 break;
1407         case 0x55:
1408                 packet_type_str = "DH3";
1409                 break;
1410         case 0x56:
1411                 packet_type_str = "DH5";
1412                 break;
1413         case 0x57:
1414                 packet_type_str = "2DH1";
1415                 break;
1416         case 0x58:
1417                 packet_type_str = "2DH3";
1418                 break;
1419         case 0x59:
1420                 packet_type_str = "2DH5";
1421                 break;
1422         case 0x5a:
1423                 packet_type_str = "3DH1";
1424                 break;
1425         case 0x5b:
1426                 packet_type_str = "3DH3";
1427                 break;
1428         case 0x5c:
1429                 packet_type_str = "3DH5";
1430                 break;
1431         default:
1432                 packet_type_str = "Unknown";
1433                 break;
1434         }
1435
1436         print_field("Tx %s packets (0x%2.2x): %d",
1437                         packet_type_str, tlv->subevent_id, num);
1438 }
1439
1440 static void ext_acl_evt_num_rx_pkt_from_air(const struct intel_tlv *tlv)
1441 {
1442         uint32_t num = get_le32(tlv->value);
1443
1444         /* Skip if 0 */
1445         if (!num)
1446                 return;
1447
1448         print_field("Rx packets (0x%2.2x): %d",
1449                         tlv->subevent_id, num);
1450 }
1451
1452 static void ext_acl_evt_link_throughput(const struct intel_tlv *tlv)
1453 {
1454         uint32_t num = get_le32(tlv->value);
1455
1456         /* Skip if 0 */
1457         if (!num)
1458                 return;
1459
1460         print_field("ACL link throughput (bps) (0x%2.2x): %d",
1461                         tlv->subevent_id, num);
1462 }
1463
1464 static void ext_acl_evt_max_packet_latency(const struct intel_tlv *tlv)
1465 {
1466         uint32_t num = get_le32(tlv->value);
1467
1468         /* Skip if 0 */
1469         if (!num)
1470                 return;
1471
1472         print_field("ACL max packet latency (us) (0x%2.2x): %d",
1473                         tlv->subevent_id, num);
1474 }
1475
1476 static void ext_acl_evt_avg_packet_latency(const struct intel_tlv *tlv)
1477 {
1478         uint32_t num = get_le32(tlv->value);
1479
1480         /* Skip if 0 */
1481         if (!num)
1482                 return;
1483
1484         print_field("ACL avg packet latency (us) (0x%2.2x): %d",
1485                         tlv->subevent_id, num);
1486 }
1487
1488 static void ext_acl_evt_rssi_moving_avg(const struct intel_tlv *tlv)
1489 {
1490         uint32_t num = get_le16(tlv->value);
1491
1492         /* Skip if 0 */
1493         if (!num)
1494                 return;
1495
1496         print_field("ACL RX RSSI moving avg (0x%2.2x): %d",
1497                         tlv->subevent_id, num);
1498 }
1499
1500 static void ext_acl_evt_bad_cnt(const char *prefix, const struct intel_tlv *tlv)
1501 {
1502         uint32_t c_1m = get_le32(tlv->value);
1503         uint32_t c_2m = get_le32(tlv->value + 4);
1504         uint32_t c_3m = get_le32(tlv->value + 8);
1505
1506         /* Skip if all 0 */
1507         if (!c_1m && !c_2m && !c_3m)
1508                 return;
1509
1510         print_field("%s (0x%2.2x): 1M %d 2M %d 3M %d",
1511                         prefix, tlv->subevent_id, c_1m, c_2m, c_3m);
1512 }
1513
1514 static void ext_acl_evt_snr_bad_cnt(const struct intel_tlv *tlv)
1515 {
1516         ext_acl_evt_bad_cnt("ACL RX SNR Bad Margin Counter", tlv);
1517 }
1518
1519 static void ext_acl_evt_rx_rssi_bad_cnt(const struct intel_tlv *tlv)
1520 {
1521         ext_acl_evt_bad_cnt("ACL RX RSSI Bad Counter", tlv);
1522 }
1523
1524 static void ext_acl_evt_tx_rssi_bad_cnt(const struct intel_tlv *tlv)
1525 {
1526         ext_acl_evt_bad_cnt("ACL TX RSSI Bad Counter", tlv);
1527 }
1528
1529 static void ext_sco_evt_conn_handle(const struct intel_tlv *tlv)
1530 {
1531         uint16_t conn_handle = get_le16(tlv->value);
1532
1533         print_field("SCO/eSCO connection handle (0x%2.2x): 0x%4.4x",
1534                         tlv->subevent_id, conn_handle);
1535 }
1536
1537 static void ext_sco_evt_num_rx_pkt_from_air(const struct intel_tlv *tlv)
1538 {
1539         uint32_t num = get_le32(tlv->value);
1540
1541         /* Skip if 0 */
1542         if (!num)
1543                 return;
1544
1545         print_field("Packets from host (0x%2.2x): %d", tlv->subevent_id, num);
1546 }
1547
1548 static void ext_sco_evt_num_tx_pkt_to_air(const struct intel_tlv *tlv)
1549 {
1550         uint32_t num = get_le32(tlv->value);
1551
1552         /* Skip if 0 */
1553         if (!num)
1554                 return;
1555
1556         print_field("Tx packets (0x%2.2x): %d", tlv->subevent_id, num);
1557 }
1558
1559 static void ext_sco_evt_num_rx_payloads_lost(const struct intel_tlv *tlv)
1560 {
1561         uint32_t num = get_le32(tlv->value);
1562
1563         /* Skip if 0 */
1564         if (!num)
1565                 return;
1566
1567         print_field("Rx payload lost (0x%2.2x): %d", tlv->subevent_id, num);
1568 }
1569
1570 static void ext_sco_evt_num_tx_payloads_lost(const struct intel_tlv *tlv)
1571 {
1572
1573         uint32_t num = get_le32(tlv->value);
1574
1575         /* Skip if 0 */
1576         if (!num)
1577                 return;
1578
1579         print_field("Tx payload lost (0x%2.2x): %d", tlv->subevent_id, num);
1580 }
1581
1582 static void slots_errors(const struct intel_tlv *tlv, const char *type_str)
1583 {
1584         /* The subevent has 5 slots where each slot is of the uint32_t type. */
1585         uint32_t num[5];
1586         const uint8_t *data = tlv->value;
1587         int i;
1588
1589         if (tlv->length != 5 * sizeof(uint32_t)) {
1590                 print_text(COLOR_UNKNOWN_EXT_EVENT,
1591                                 "  Invalid subevent length (%d)", tlv->length);
1592                 return;
1593         }
1594
1595         for (i = 0; i < 5; i++) {
1596                 num[i] = get_le32(data);
1597                 data += sizeof(uint32_t);
1598         }
1599
1600         print_field("%s (0x%2.2x): %d %d %d %d %d", type_str, tlv->subevent_id,
1601                         num[0], num[1], num[2], num[3], num[4]);
1602 }
1603
1604 static void ext_sco_evt_num_no_sync_errors(const struct intel_tlv *tlv)
1605 {
1606         slots_errors(tlv, "Rx No SYNC errors");
1607 }
1608
1609 static void ext_sco_evt_num_hec_errors(const struct intel_tlv *tlv)
1610 {
1611         slots_errors(tlv, "Rx HEC errors");
1612 }
1613
1614 static void ext_sco_evt_num_crc_errors(const struct intel_tlv *tlv)
1615 {
1616         slots_errors(tlv, "Rx CRC errors");
1617 }
1618
1619 static void ext_sco_evt_num_naks(const struct intel_tlv *tlv)
1620 {
1621         slots_errors(tlv, "Rx NAK errors");
1622 }
1623
1624 static void ext_sco_evt_num_failed_tx_by_wifi(const struct intel_tlv *tlv)
1625 {
1626         slots_errors(tlv, "Failed Tx due to Wifi coex");
1627 }
1628
1629 static void ext_sco_evt_num_failed_rx_by_wifi(const struct intel_tlv *tlv)
1630 {
1631         slots_errors(tlv, "Failed Rx due to Wifi coex");
1632 }
1633
1634 static void ext_sco_evt_samples_inserted(const struct intel_tlv *tlv)
1635 {
1636         uint32_t num = get_le32(tlv->value);
1637
1638         /* Skip if 0 */
1639         if (!num)
1640                 return;
1641
1642         print_field("Late samples inserted based on CDC (0x%2.2x): %d",
1643                         tlv->subevent_id, num);
1644 }
1645
1646 static void ext_sco_evt_samples_dropped(const struct intel_tlv *tlv)
1647 {
1648         uint32_t num = get_le32(tlv->value);
1649
1650         /* Skip if 0 */
1651         if (!num)
1652                 return;
1653
1654         print_field("Samples dropped (0x%2.2x): %d", tlv->subevent_id, num);
1655 }
1656
1657 static void ext_sco_evt_mute_samples(const struct intel_tlv *tlv)
1658 {
1659         uint32_t num = get_le32(tlv->value);
1660
1661         /* Skip if 0 */
1662         if (!num)
1663                 return;
1664
1665         print_field("Mute samples sent at initial connection (0x%2.2x): %d",
1666                         tlv->subevent_id, num);
1667 }
1668
1669 static void ext_sco_evt_plc_injection_data(const struct intel_tlv *tlv)
1670 {
1671         uint32_t num = get_le32(tlv->value);
1672
1673         /* Skip if 0 */
1674         if (!num)
1675                 return;
1676
1677         print_field("PLC injection data (0x%2.2x): %d", tlv->subevent_id, num);
1678 }
1679
1680 static const struct intel_ext_subevent {
1681         uint8_t subevent_id;
1682         uint8_t length;
1683         void (*func)(const struct intel_tlv *tlv);
1684 } intel_ext_subevent_table[] = {
1685         { 0x01, 1, ext_evt_type },
1686
1687         /* ACL audio link quality subevents */
1688         { 0x4a, 2, ext_acl_evt_conn_handle },
1689         { 0x4b, 4, ext_acl_evt_hec_errors },
1690         { 0x4c, 4, ext_acl_evt_crc_errors },
1691         { 0x4d, 4, ext_acl_evt_num_pkt_from_host },
1692         { 0x4e, 4, ext_acl_evt_num_tx_pkt_to_air },
1693         { 0x4f, 4, ext_acl_evt_num_tx_pkt_retry },
1694         { 0x50, 4, ext_acl_evt_num_tx_pkt_retry },
1695         { 0x51, 4, ext_acl_evt_num_tx_pkt_retry },
1696         { 0x52, 4, ext_acl_evt_num_tx_pkt_retry },
1697         { 0x53, 4, ext_acl_evt_num_tx_pkt_retry },
1698         { 0x54, 4, ext_acl_evt_num_tx_pkt_type },
1699         { 0x55, 4, ext_acl_evt_num_tx_pkt_type },
1700         { 0x56, 4, ext_acl_evt_num_tx_pkt_type },
1701         { 0x57, 4, ext_acl_evt_num_tx_pkt_type },
1702         { 0x58, 4, ext_acl_evt_num_tx_pkt_type },
1703         { 0x59, 4, ext_acl_evt_num_tx_pkt_type },
1704         { 0x5a, 4, ext_acl_evt_num_tx_pkt_type },
1705         { 0x5b, 4, ext_acl_evt_num_tx_pkt_type },
1706         { 0x5c, 4, ext_acl_evt_num_tx_pkt_type },
1707         { 0x5d, 4, ext_acl_evt_num_rx_pkt_from_air },
1708         { 0x5e, 4, ext_acl_evt_link_throughput },
1709         { 0x5f, 4, ext_acl_evt_max_packet_latency },
1710         { 0x60, 4, ext_acl_evt_avg_packet_latency },
1711         { 0x61, 2, ext_acl_evt_rssi_moving_avg },
1712         { 0x62, 12, ext_acl_evt_snr_bad_cnt },
1713         { 0x63, 12, ext_acl_evt_rx_rssi_bad_cnt },
1714         { 0x64, 12, ext_acl_evt_tx_rssi_bad_cnt },
1715
1716         /* SCO/eSCO audio link quality subevents */
1717         { 0x6a, 2, ext_sco_evt_conn_handle },
1718         { 0x6b, 4, ext_sco_evt_num_rx_pkt_from_air },
1719         { 0x6c, 4, ext_sco_evt_num_tx_pkt_to_air },
1720         { 0x6d, 4, ext_sco_evt_num_rx_payloads_lost },
1721         { 0x6e, 4, ext_sco_evt_num_tx_payloads_lost },
1722         { 0x6f, 20, ext_sco_evt_num_no_sync_errors },
1723         { 0x70, 20, ext_sco_evt_num_hec_errors },
1724         { 0x71, 20, ext_sco_evt_num_crc_errors },
1725         { 0x72, 20, ext_sco_evt_num_naks },
1726         { 0x73, 20, ext_sco_evt_num_failed_tx_by_wifi },
1727         { 0x74, 20, ext_sco_evt_num_failed_rx_by_wifi },
1728         { 0x75, 4, ext_sco_evt_samples_inserted },
1729         { 0x76, 4, ext_sco_evt_samples_dropped },
1730         { 0x77, 4, ext_sco_evt_mute_samples },
1731         { 0x78, 4, ext_sco_evt_plc_injection_data },
1732
1733         /* end */
1734         { 0x0, 0}
1735 };
1736
1737 static const struct intel_tlv *process_ext_subevent(const struct intel_tlv *tlv,
1738                                         const struct intel_tlv *last_tlv)
1739 {
1740         const struct intel_tlv *next_tlv = NEXT_TLV(tlv);
1741         const struct intel_ext_subevent *subevent = NULL;
1742         int i;
1743
1744         for (i = 0; intel_ext_subevent_table[i].length > 0; i++) {
1745                 if (intel_ext_subevent_table[i].subevent_id ==
1746                                                         tlv->subevent_id) {
1747                         subevent = &intel_ext_subevent_table[i];
1748                         break;
1749                 }
1750         }
1751
1752         if (!subevent) {
1753                 print_text(COLOR_UNKNOWN_EXT_EVENT,
1754                                 "Unknown extended subevent 0x%2.2x",
1755                                 tlv->subevent_id);
1756                 packet_hexdump(tlv->value, tlv->length);
1757                 return next_tlv;
1758         }
1759
1760         if (tlv->length != subevent->length) {
1761                 print_text(COLOR_ERROR, "Invalid length %d of subevent 0x%2.2x",
1762                                 tlv->length, tlv->subevent_id);
1763                 return NULL;
1764         }
1765
1766         if (next_tlv > last_tlv) {
1767                 print_text(COLOR_ERROR, "Subevent exceeds the buffer size.");
1768                 return NULL;
1769         }
1770
1771         subevent->func(tlv);
1772
1773         return next_tlv;
1774 }
1775
1776 static void intel_vendor_ext_evt(struct timeval *tv, uint16_t index,
1777                                         const void *data, uint8_t size)
1778 {
1779         /* The data pointer points to a number of tlv.*/
1780         const struct intel_tlv *tlv = data;
1781         const struct intel_tlv *last_tlv = data + size;
1782
1783         /* Process every tlv subevent until reaching last_tlv.
1784          * The decoding process terminates normally when tlv == last_tlv.
1785          */
1786         while (tlv && tlv < last_tlv)
1787                 tlv = process_ext_subevent(tlv, last_tlv);
1788
1789         /* If an error occurs in decoding the subevents, hexdump the packet. */
1790         if (!tlv)
1791                 packet_hexdump(data, size);
1792 }
1793
1794 /* Vendor extended events with a vendor prefix. */
1795 static const struct vendor_evt vendor_prefix_evt_table[] = {
1796         { 0x03, "Extended Telemetry", intel_vendor_ext_evt },
1797         { }
1798 };
1799
1800 const uint8_t intel_vendor_prefix[] = {0x87, 0x80};
1801 #define INTEL_VENDOR_PREFIX_SIZE sizeof(intel_vendor_prefix)
1802
1803 /*
1804  * The vendor event with Intel vendor prefix.
1805  * Its format looks like
1806  *   0xff <length> <vendor_prefix> <subopcode> <data>
1807  *   where Intel's <vendor_prefix> is 0x8780.
1808  *
1809  *   When <subopcode> == 0x03, it is a telemetry event; and
1810  *   <data> is a number of tlv data.
1811  */
1812 struct vendor_prefix_evt {
1813         uint8_t prefix_data[INTEL_VENDOR_PREFIX_SIZE];
1814         uint8_t subopcode;
1815 };
1816
1817 static const struct vendor_evt *intel_vendor_prefix_evt(const void *data,
1818                                                         int *consumed_size)
1819 {
1820         unsigned int i;
1821         const struct vendor_prefix_evt *vnd = data;
1822         char prefix_string[INTEL_VENDOR_PREFIX_SIZE * 2 + 1] = { 0 };
1823
1824         /* Check if the vendor prefix matches. */
1825         for (i = 0; i < INTEL_VENDOR_PREFIX_SIZE; i++) {
1826                 if (vnd->prefix_data[i] != intel_vendor_prefix[i])
1827                         return NULL;
1828                 sprintf(prefix_string + i * 2, "%02x", vnd->prefix_data[i]);
1829         }
1830         print_field("Vendor Prefix (0x%s)", prefix_string);
1831
1832         /*
1833          * Handle the vendor event with a vendor prefix.
1834          *   0xff <length> <vendor_prefix> <subopcode> <data>
1835          * This loop checks whether the <subopcode> exists in the
1836          * vendor_prefix_evt_table.
1837          */
1838         for (i = 0; vendor_prefix_evt_table[i].str; i++) {
1839                 if (vendor_prefix_evt_table[i].evt == vnd->subopcode) {
1840                         *consumed_size = sizeof(struct vendor_prefix_evt);
1841                         return &vendor_prefix_evt_table[i];
1842                 }
1843         }
1844
1845         return NULL;
1846 }
1847
1848 const struct vendor_evt *intel_vendor_evt(const void *data, int *consumed_size)
1849 {
1850         uint8_t evt = *((const uint8_t *) data);
1851         int i;
1852
1853         /*
1854          * Handle the vendor event without a vendor prefix.
1855          *   0xff <length> <evt> <data>
1856          * This loop checks whether the <evt> exists in the vendor_evt_table.
1857          */
1858         for (i = 0; vendor_evt_table[i].str; i++) {
1859                 if (vendor_evt_table[i].evt == evt)
1860                         return &vendor_evt_table[i];
1861         }
1862
1863         /*
1864          * It is not a regular event. Check whether it is a vendor extended
1865          * event that comes with a vendor prefix followed by a subopcode.
1866          */
1867         return intel_vendor_prefix_evt(data, consumed_size);
1868 }