2021-07-29 02:16:42

by Tedd Ho-Jeong An

[permalink] [raw]
Subject: [PATCH v2] monitor: Add support for tlv based version format for Intel vendor

From: Tedd Ho-Jeong An <[email protected]>

Some Intel device supports two different formats of the
HCI_Intel_Read_Version command depends on the command parameter and this
patch parses the command and response parameters depends on the format.
---
monitor/intel.c | 219 +++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 217 insertions(+), 2 deletions(-)

diff --git a/monitor/intel.c b/monitor/intel.c
index 7591df4ee..e9984bfe3 100644
--- a/monitor/intel.c
+++ b/monitor/intel.c
@@ -164,6 +164,168 @@ static void reset_cmd(const void *data, uint8_t size)
print_field("Boot address: 0x%8.8x", boot_addr);
}

+struct intel_version_tlv {
+ uint8_t type;
+ uint8_t len;
+ uint8_t val[];
+};
+
+static void print_version_tlv_u32(const struct intel_version_tlv *tlv,
+ char *type_str)
+{
+ print_field("%s(%u): 0x%8.8x", type_str, tlv->type, get_le32(tlv->val));
+}
+
+static void print_version_tlv_u16(const struct intel_version_tlv *tlv,
+ char *type_str)
+{
+ print_field("%s(%u): 0x%4.4x", type_str, tlv->type, get_le16(tlv->val));
+}
+
+static void print_version_tlv_u8(const struct intel_version_tlv *tlv,
+ char *type_str)
+{
+ print_field("%s(%u): 0x%2.2x", type_str, tlv->type, get_u8(tlv->val));
+}
+
+static void print_version_tlv_enabled(const struct intel_version_tlv *tlv,
+ char *type_str)
+{
+ print_field("%s(%u): %s(%u)", type_str, tlv->type,
+ tlv->val[0] ? "Enabled" : "Disabled",
+ tlv->val[0]);
+}
+
+static void print_version_tlv_img_type(const struct intel_version_tlv *tlv,
+ char *type_str)
+{
+ const char *str;
+
+ switch (get_u8(tlv->val)) {
+ case 0x01:
+ str = "Bootloader";
+ break;
+ case 0x03:
+ str = "Firmware";
+ break;
+ default:
+ str = "Unknown";
+ break;
+ }
+ print_field("%s(%u): %s(0x%2.2x)", type_str, tlv->type, str,
+ get_u8(tlv->val));
+}
+
+static void print_version_tlv_timestamp(const struct intel_version_tlv *tlv,
+ char *type_str)
+{
+ print_field("%s(%u): %u-%u", type_str, tlv->type,
+ tlv->val[1], tlv->val[0]);
+}
+
+static void print_version_tlv_min_fw(const struct intel_version_tlv *tlv,
+ char *type_str)
+{
+ print_field("%s(%u): %u-%u.%u", type_str, tlv->type,
+ tlv->val[0], tlv->val[1], 2000 + tlv->val[2]);
+}
+
+static void print_version_tlv_otp_bdaddr(const struct intel_version_tlv *tlv,
+ char *type_str)
+{
+ packet_print_addr(type_str, tlv->val, false);
+}
+
+static void print_version_tlv_unknown(const struct intel_version_tlv *tlv,
+ char *type_str)
+{
+ print_field("%s(%u): ", type_str, tlv->type);
+ packet_hexdump(tlv->val, tlv->len);
+}
+
+static void print_version_tlv_mfg(const struct intel_version_tlv *tlv,
+ char *type_str)
+{
+ uint16_t mfg_id = get_le16(tlv->val);
+
+ print_field("%s(%u): %s (%u)", type_str, tlv->type,
+ bt_compidtostr(mfg_id), mfg_id);
+}
+
+static const struct intel_version_tlv_desc {
+ uint8_t type;
+ char *type_str;
+ void (*func)(const struct intel_version_tlv *tlv, char *type_str);
+} intel_version_tlv_table[] = {
+ { 16, "CNVi TOP", print_version_tlv_u32 },
+ { 17, "CNVr TOP", print_version_tlv_u32 },
+ { 18, "CNVi BT", print_version_tlv_u32 },
+ { 19, "CNVr BT", print_version_tlv_u32 },
+ { 20, "CNVi OTP", print_version_tlv_u16 },
+ { 21, "CNVr OTP", print_version_tlv_u16 },
+ { 22, "Device Rev ID", print_version_tlv_u16 },
+ { 23, "USB VID", print_version_tlv_u16 },
+ { 24, "USB PID", print_version_tlv_u16 },
+ { 25, "PCIE VID", print_version_tlv_u16 },
+ { 26, "PCIe DID", print_version_tlv_u16 },
+ { 27, "PCIe Subsystem ID", print_version_tlv_u16 },
+ { 28, "Image Type", print_version_tlv_img_type },
+ { 29, "Time Stamp", print_version_tlv_timestamp },
+ { 30, "Build Type", print_version_tlv_u8 },
+ { 31, "Build Num", print_version_tlv_u32 },
+ { 32, "FW Build Product", print_version_tlv_u8 },
+ { 33, "FW Build HW", print_version_tlv_u8 },
+ { 34, "FW Build Step", print_version_tlv_u8 },
+ { 35, "BT Spec", print_version_tlv_u8 },
+ { 36, "Manufacturer", print_version_tlv_mfg },
+ { 37, "HCI Revision", print_version_tlv_u16 },
+ { 38, "LMP SubVersion", print_version_tlv_u16 },
+ { 39, "OTP Patch Version", print_version_tlv_u8 },
+ { 40, "Secure Boot", print_version_tlv_enabled },
+ { 41, "Key From Header", print_version_tlv_enabled },
+ { 42, "OTP Lock", print_version_tlv_enabled },
+ { 43, "API Lock", print_version_tlv_enabled },
+ { 44, "Debug Lock", print_version_tlv_enabled },
+ { 45, "Minimum FW", print_version_tlv_min_fw },
+ { 46, "Limited CCE", print_version_tlv_enabled },
+ { 47, "SBE Type", print_version_tlv_u8 },
+ { 48, "OTP BDADDR", print_version_tlv_otp_bdaddr },
+ { 49, "Unlocked State", print_version_tlv_enabled },
+ { 0, NULL, NULL },
+};
+
+static void read_version_tlv_rsp(const void *data, uint8_t size)
+{
+ uint8_t status = get_u8(data);
+
+ print_status(status);
+
+ /* Consume the status */
+ data++;
+ size--;
+
+ while (size > 0) {
+ const struct intel_version_tlv *tlv = data;
+ const struct intel_version_tlv_desc *desc = NULL;
+ int i;
+
+ for (i = 0; intel_version_tlv_table[i].type > 0; i++) {
+ if (intel_version_tlv_table[i].type == tlv->type) {
+ desc = &intel_version_tlv_table[i];
+ break;
+ }
+ }
+
+ if (desc)
+ desc->func(tlv, desc->type_str);
+ else
+ print_version_tlv_unknown(tlv, "Unknown Type");
+
+ data += sizeof(*tlv) + tlv->len;
+ size -= sizeof(*tlv) + tlv->len;
+ }
+}
+
static void read_version_rsp(const void *data, uint8_t size)
{
uint8_t status = get_u8(data);
@@ -177,6 +339,16 @@ static void read_version_rsp(const void *data, uint8_t size)
uint8_t fw_build_yy = get_u8(data + 8);
uint8_t fw_patch = get_u8(data + 9);

+ /* There are two different formats of the response for the
+ * HCI_Intel_Read_version command depends on the command parameters
+ * If the size is fixed to 10 and hw_platform is 0x37, then it is the
+ * legacy format, otherwise use the tlv based format.
+ */
+ if (size != 10 && hw_platform != 0x37) {
+ read_version_tlv_rsp(data, size);
+ return;
+ }
+
print_status(status);
print_field("Hardware platform: 0x%2.2x", hw_platform);
print_field("Hardware variant: 0x%2.2x", hw_variant);
@@ -191,6 +363,49 @@ static void read_version_rsp(const void *data, uint8_t size)
print_field("Firmware patch: %u", fw_patch);
}

+static void read_version_cmd(const void *data, uint8_t size)
+{
+ char *str;
+ uint8_t type;
+
+ /* This is the legacy read version command format and no further action
+ * is needed
+ */
+ if (size == 0)
+ return;
+
+ print_field("Requested Type:");
+
+ while (size > 0) {
+ const struct intel_version_tlv_desc *desc = NULL;
+ int i;
+
+ type = get_u8(data);
+
+ /* Get all supported types */
+ if (type == 0xff)
+ str = "All Supported Types";
+ else {
+ for (i = 0; intel_version_tlv_table[i].type > 0; i++) {
+ if (intel_version_tlv_table[i].type == type) {
+ desc = &intel_version_tlv_table[i];
+ break;
+ }
+ }
+
+ if (desc)
+ str = desc->type_str;
+ else
+ str = "Unknown Type";
+ }
+
+ print_field(" %s(0x%2.2x)", str, type);
+
+ data += sizeof(type);
+ size -= sizeof(type);
+ }
+}
+
static void set_uart_baudrate_cmd(const void *data, uint8_t size)
{
uint8_t baudrate = get_u8(data);
@@ -498,8 +713,8 @@ static const struct vendor_ocf vendor_ocf_table[] = {
status_rsp, 1, true },
{ 0x002, "No Operation" },
{ 0x005, "Read Version",
- null_cmd, 0, true,
- read_version_rsp, 10, true },
+ read_version_cmd, 0, false,
+ read_version_rsp, 1, false },
{ 0x006, "Set UART Baudrate",
set_uart_baudrate_cmd, 1, true,
status_rsp, 1, true },
--
2.25.1