/src/fwupd/libfwupdplugin/fu-intel-thunderbolt-nvm.c

Source
/*
 * Copyright 2021 Dell Inc.
 * Copyright 2020 Richard Hughes <richard@hughsie.com>
 * Copyright 2020 Mario Limonciello <mario.limonciello@dell.com>
 * Copyright 2017 Intel Corporation.
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

#define G_LOG_DOMAIN "FuFirmware"

#include "config.h"

#include "fu-byte-array.h"
#include "fu-common.h"
#include "fu-input-stream.h"
#include "fu-intel-thunderbolt-nvm.h"
#include "fu-intel-thunderbolt-struct.h"
#include "fu-string.h"
#include "fu-version-common.h"

/**
 * FuIntelThunderboltNvm:
 *
 * The Non-Volatile-Memory device specification. This is what you would find on the device SPI chip.
 *
 * See also: [class@FuFirmware]
 */

typedef struct {
  guint32 sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_LAST];
  FuIntelThunderboltNvmFamily family;
  gboolean is_host;
  gboolean is_native;
  gboolean has_pd;
  guint16 vendor_id;
  guint16 device_id;
  guint16 model_id;
  guint gen;
  guint ports;
  guint8 flash_size;
} FuIntelThunderboltNvmPrivate;

G_DEFINE_TYPE_WITH_PRIVATE(FuIntelThunderboltNvm, fu_intel_thunderbolt_nvm, FU_TYPE_FIRMWARE)
#define GET_PRIVATE(o) (fu_intel_thunderbolt_nvm_get_instance_private(o))

/**
 * fu_intel_thunderbolt_nvm_get_vendor_id:
 * @self: a #FuFirmware
 *
 * Gets the vendor ID.
 *
 * Returns: an integer, or 0x0 for unset
 *
 * Since: 1.8.5
 **/
guint16
fu_intel_thunderbolt_nvm_get_vendor_id(FuIntelThunderboltNvm *self)
{
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FU_IS_INTEL_THUNDERBOLT_NVM(self), G_MAXUINT16);
  return priv->vendor_id;
}

/**
 * fu_intel_thunderbolt_nvm_get_device_id:
 * @self: a #FuFirmware
 *
 * Gets the device ID.
 *
 * Returns: an integer, or 0x0 for unset
 *
 * Since: 1.8.5
 **/
guint16
fu_intel_thunderbolt_nvm_get_device_id(FuIntelThunderboltNvm *self)
{
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  return priv->device_id;
}

/**
 * fu_intel_thunderbolt_nvm_is_host:
 * @self: a #FuFirmware
 *
 * Gets if the firmware is designed for a host controller rather than a device.
 *
 * Returns: %TRUE for controller, %FALSE for device
 *
 * Since: 1.8.5
 **/
gboolean
fu_intel_thunderbolt_nvm_is_host(FuIntelThunderboltNvm *self)
{
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FU_IS_INTEL_THUNDERBOLT_NVM(self), FALSE);
  return priv->is_host;
}

/**
 * fu_intel_thunderbolt_nvm_is_native:
 * @self: a #FuFirmware
 *
 * Gets if the device is native, i.e. not in recovery mode.
 *
 * Returns: %TRUE if set
 *
 * Since: 1.8.5
 **/
gboolean
fu_intel_thunderbolt_nvm_is_native(FuIntelThunderboltNvm *self)
{
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FU_IS_INTEL_THUNDERBOLT_NVM(self), FALSE);
  return priv->is_native;
}

/**
 * fu_intel_thunderbolt_nvm_has_pd:
 * @self: a #FuFirmware
 *
 * Gets if the device has power delivery capability.
 *
 * Returns: %TRUE if set
 *
 * Since: 1.8.5
 **/
gboolean
fu_intel_thunderbolt_nvm_has_pd(FuIntelThunderboltNvm *self)
{
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FU_IS_INTEL_THUNDERBOLT_NVM(self), FALSE);
  return priv->has_pd;
}

/**
 * fu_intel_thunderbolt_nvm_get_model_id:
 * @self: a #FuFirmware
 *
 * Gets the model ID.
 *
 * Returns: an integer, or 0x0 for unset
 *
 * Since: 1.8.5
 **/
guint16
fu_intel_thunderbolt_nvm_get_model_id(FuIntelThunderboltNvm *self)
{
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FU_IS_INTEL_THUNDERBOLT_NVM(self), 0x0);
  return priv->model_id;
}

/**
 * fu_intel_thunderbolt_nvm_get_flash_size:
 * @self: a #FuFirmware
 *
 * Gets the flash size.
 *
 * NOTE: This does not correspond to a size in bytes, or a power of 2 and is only useful for
 * comparison between firmware and device.
 *
 * Returns: an integer, or 0x0 for unset
 *
 * Since: 1.8.5
 **/
guint8
fu_intel_thunderbolt_nvm_get_flash_size(FuIntelThunderboltNvm *self)
{
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FU_IS_INTEL_THUNDERBOLT_NVM(self), 0x0);
  return priv->flash_size;
}

static void
fu_intel_thunderbolt_nvm_export(FuFirmware *firmware,
        FuFirmwareExportFlags flags,
        XbBuilderNode *bn)
{
  FuIntelThunderboltNvm *self = FU_INTEL_THUNDERBOLT_NVM(firmware);
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  fu_xmlb_builder_insert_kx(bn, "vendor_id", priv->vendor_id);
  fu_xmlb_builder_insert_kx(bn, "device_id", priv->device_id);
  fu_xmlb_builder_insert_kx(bn, "model_id", priv->model_id);
  fu_xmlb_builder_insert_kv(bn,
          "family",
          fu_intel_thunderbolt_nvm_family_to_string(priv->family));
  fu_xmlb_builder_insert_kb(bn, "is_host", priv->is_host);
  fu_xmlb_builder_insert_kb(bn, "is_native", priv->is_native);
  fu_xmlb_builder_insert_kx(bn, "flash_size", priv->flash_size);
  fu_xmlb_builder_insert_kx(bn, "generation", priv->gen);
  fu_xmlb_builder_insert_kx(bn, "ports", priv->ports);
  fu_xmlb_builder_insert_kb(bn, "has_pd", priv->has_pd);
  for (guint i = 0; i < FU_INTEL_THUNDERBOLT_NVM_SECTION_LAST; i++) {
    if (priv->sections[i] != 0x0) {
      g_autofree gchar *tmp = g_strdup_printf("0x%x", priv->sections[i]);
      g_autoptr(XbBuilderNode) bc =
          xb_builder_node_insert(bn,
               "section",
               "type",
               fu_intel_thunderbolt_nvm_section_to_string(i),
               "offset",
               tmp,
               NULL);
      g_return_if_fail(bc != NULL);
    }
  }
}

static inline gboolean
fu_intel_thunderbolt_nvm_valid_pd_pointer(guint32 pointer)
{
  return pointer != 0 && pointer != 0xFFFFFFFF;
}

/*
 * Size of ucode sections is uint16 value saved at the start of the section,
 * it's in DWORDS (4-bytes) units and it doesn't include itself. We need the
 * offset to the next section, so we translate it to bytes and add 2 for the
 * size field itself.
 *
 * offset parameter must be relative to digital section
 */
static gboolean
fu_intel_thunderbolt_nvm_read_ucode_section_len(FuIntelThunderboltNvm *self,
            GInputStream *stream,
            guint32 offset,
            gsize *value,
            GError **error)
{
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  guint16 value_tmp = 0;

  if (!fu_input_stream_read_u16(stream,
              priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL] +
            offset,
              &value_tmp,
              G_LITTLE_ENDIAN,
              error)) {
    g_prefix_error_literal(error, "failed to read ucode section len: ");
    return FALSE;
  }
  *value = value_tmp;
  *value *= sizeof(guint32);
  *value += sizeof(guint16);
  return TRUE;
}

/* assumes sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL].offset is already set */
static gboolean
fu_intel_thunderbolt_nvm_read_sections(FuIntelThunderboltNvm *self,
               GInputStream *stream,
               GError **error)
{
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);

  if (priv->gen >= 3 || priv->gen == 0) {
    guint32 offset32 = 0;
    if (!fu_input_stream_read_u32(
      stream,
      priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL] +
          FU_INTEL_THUNDERBOLT_NVM_DIGITAL_OFFSET_DROM,
      &offset32,
      G_LITTLE_ENDIAN,
      error))
      return FALSE;
    priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DROM] =
        offset32 + priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL];

    if (!fu_input_stream_read_u32(
      stream,
      priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL] +
          FU_INTEL_THUNDERBOLT_NVM_DIGITAL_OFFSET_ARC_PARAMS,
      &offset32,
      G_LITTLE_ENDIAN,
      error))
      return FALSE;
    priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_ARC_PARAMS] =
        offset32 + priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL];
  }

  if (priv->is_host && priv->gen > 2) {
    /*
     * To find the DRAM section, we have to jump from section to
     * section in a chain of sections.
     * available_sections location tells what sections exist at all
     * (with a flag per section).
     * ee_ucode_start_addr location tells the offset of the first
     * section in the list relatively to the digital section start.
     * After having the offset of the first section, we have a loop
     * over the section list. If the section exists, we read its
     * length (2 bytes at section start) and add it to current
     * offset to find the start of the next section. Otherwise, we
     * already have the next section offset...
     */
    gsize offset;
    guint16 offset16 = 0;
    guint8 available_sections = 0;

    if (!fu_input_stream_read_u8(
      stream,
      priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL] +
          FU_INTEL_THUNDERBOLT_NVM_DIGITAL_OFFSET_AVAILABLE_SECTIONS,
      &available_sections,
      error)) {
      g_prefix_error_literal(error, "failed to read available sections: ");
      return FALSE;
    }
    if (!fu_input_stream_read_u16(
      stream,
      priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL] +
          FU_INTEL_THUNDERBOLT_NVM_DIGITAL_OFFSET_UCODE,
      &offset16,
      G_LITTLE_ENDIAN,
      error)) {
      g_prefix_error_literal(error, "failed to read ucode offset: ");
      return FALSE;
    }
    offset = offset16;
    if ((available_sections & FU_INTEL_THUNDERBOLT_NVM_SECTION_FLAG_DRAM) == 0) {
      g_set_error_literal(error,
              FWUPD_ERROR,
              FWUPD_ERROR_INVALID_FILE,
              "cannot find needed FW sections in the FW image file");
      return FALSE;
    }

    for (guint8 i = 1; i < FU_INTEL_THUNDERBOLT_NVM_SECTION_FLAG_DRAM; i <<= 1) {
      if (available_sections & i) {
        gsize section_len = 0;

        if (!fu_intel_thunderbolt_nvm_read_ucode_section_len(self,
                         stream,
                         offset,
                         &section_len,
                         error))
          return FALSE;

        /* add section offset */
        if (!fu_size_checked_inc(&offset, section_len, error)) {
          g_prefix_error_literal(error, "section offset overflow: ");
          return FALSE;
        }
      }
    }
    priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DRAM_UCODE] =
        offset + priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL];
  }

  return TRUE;
}

static gboolean
fu_intel_thunderbolt_nvm_missing_needed_drom(FuIntelThunderboltNvm *self)
{
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  if (priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DROM] != 0)
    return FALSE;
  if (priv->is_host && priv->gen < 3)
    return FALSE;
  return TRUE;
}

static gboolean
fu_intel_thunderbolt_nvm_parse(FuFirmware *firmware,
             GInputStream *stream,
             FuFirmwareParseFlags flags,
             GError **error)
{
  FuIntelThunderboltNvm *self = FU_INTEL_THUNDERBOLT_NVM(firmware);
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  guint8 tmp = 0;
  guint16 version_raw = 0;
  struct {
    guint16 device_id;
    guint gen;
    FuIntelThunderboltNvmFamily family;
    guint ports;
  } hw_info_arr[] = {{0x156D, 2, FU_INTEL_THUNDERBOLT_NVM_FAMILY_FALCON_RIDGE, 2},
         {0x156B, 2, FU_INTEL_THUNDERBOLT_NVM_FAMILY_FALCON_RIDGE, 1},
         {0x157E, 2, FU_INTEL_THUNDERBOLT_NVM_FAMILY_WIN_RIDGE, 1},
         {0x1578, 3, FU_INTEL_THUNDERBOLT_NVM_FAMILY_ALPINE_RIDGE, 2},
         {0x1576, 3, FU_INTEL_THUNDERBOLT_NVM_FAMILY_ALPINE_RIDGE, 1},
         {0x15C0, 3, FU_INTEL_THUNDERBOLT_NVM_FAMILY_ALPINE_RIDGE, 1},
         {0x15D3, 3, FU_INTEL_THUNDERBOLT_NVM_FAMILY_ALPINE_RIDGE_C, 2},
         {0x15DA, 3, FU_INTEL_THUNDERBOLT_NVM_FAMILY_ALPINE_RIDGE_C, 1},
         {0x15E7, 3, FU_INTEL_THUNDERBOLT_NVM_FAMILY_TITAN_RIDGE, 1},
         {0x15EA, 3, FU_INTEL_THUNDERBOLT_NVM_FAMILY_TITAN_RIDGE, 2},
         {0x15EF, 3, FU_INTEL_THUNDERBOLT_NVM_FAMILY_TITAN_RIDGE, 2},
         {0x15EE, 3, FU_INTEL_THUNDERBOLT_NVM_FAMILY_BB, 0},
         {0x0B26, 4, FU_INTEL_THUNDERBOLT_NVM_FAMILY_GOSHEN_RIDGE, 2},
         {0x5786, 5, FU_INTEL_THUNDERBOLT_NVM_FAMILY_BARLOW_RIDGE, 2},
         /* Maple ridge devices
          * NOTE: These are expected to be flashed via UEFI capsules *not*
          * Thunderbolt plugin Flashing via fwupd will require matching kernel
          * work. They're left here only for parsing the binaries
          */
         {0x1136, 4, FU_INTEL_THUNDERBOLT_NVM_FAMILY_MAPLE_RIDGE, 2},
         {0x1137, 4, FU_INTEL_THUNDERBOLT_NVM_FAMILY_MAPLE_RIDGE, 2},
         {0}};
  g_autoptr(FuFirmware) img_payload = fu_firmware_new();
  gsize streamsz = 0;

  /* add this straight away */
  priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL] = 0x0;

  /* is native */
  if (!fu_input_stream_read_u8(stream,
             priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL] +
           FU_INTEL_THUNDERBOLT_NVM_DIGITAL_OFFSET_FLAGS_IS_NATIVE,
             &tmp,
             error)) {
    g_prefix_error_literal(error, "failed to read native: ");
    return FALSE;
  }
  priv->is_native = tmp & 0x20;

  /* we're only reading the first chunk */
  if (!fu_input_stream_size(stream, &streamsz, error))
    return FALSE;
  if (streamsz == 0x80)
    return TRUE;

  /* host or device */
  if (!fu_input_stream_read_u8(stream,
             priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL] +
           FU_INTEL_THUNDERBOLT_NVM_DIGITAL_OFFSET_FLAGS_HOST,
             &tmp,
             error)) {
    g_prefix_error_literal(error, "failed to read is-host: ");
    return FALSE;
  }
  priv->is_host = tmp & (1 << 1);

  /* device ID */
  if (!fu_input_stream_read_u16(stream,
              priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL] +
            FU_INTEL_THUNDERBOLT_NVM_DIGITAL_OFFSET_DEVICE_ID,
              &priv->device_id,
              G_LITTLE_ENDIAN,
              error)) {
    g_prefix_error_literal(error, "failed to read device-id: ");
    return FALSE;
  }

  /* this is best-effort */
  for (guint i = 0; hw_info_arr[i].device_id != 0; i++) {
    if (hw_info_arr[i].device_id == priv->device_id) {
      priv->family = hw_info_arr[i].family;
      priv->gen = hw_info_arr[i].gen;
      priv->ports = hw_info_arr[i].ports;
      break;
    }
  }
  if (priv->family == FU_INTEL_THUNDERBOLT_NVM_FAMILY_UNKNOWN) {
    g_set_error_literal(error,
            FWUPD_ERROR,
            FWUPD_ERROR_INVALID_DATA,
            "unknown NVM family");
    return FALSE;
  }
  if (priv->ports == 0 && priv->is_host) {
    g_set_error(error,
          FWUPD_ERROR,
          FWUPD_ERROR_NOT_SUPPORTED,
          "unknown controller: %x",
          priv->device_id);
    return FALSE;
  }

  /* read sections from file */
  if (!fu_intel_thunderbolt_nvm_read_sections(self, stream, error))
    return FALSE;
  if (fu_intel_thunderbolt_nvm_missing_needed_drom(self)) {
    g_set_error_literal(error,
            FWUPD_ERROR,
            FWUPD_ERROR_READ,
            "cannot find required drom section");
    return FALSE;
  }

  /* vendor:model */
  if (priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DROM] != 0x0) {
    if (!fu_input_stream_read_u16(
      stream,
      priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DROM] +
          FU_INTEL_THUNDERBOLT_NVM_DROM_OFFSET_VENDOR_ID,
      &priv->vendor_id,
      G_LITTLE_ENDIAN,
      error)) {
      g_prefix_error_literal(error, "failed to read vendor-id: ");
      return FALSE;
    }
    if (!fu_input_stream_read_u16(
      stream,
      priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DROM] +
          FU_INTEL_THUNDERBOLT_NVM_DROM_OFFSET_MODEL_ID,
      &priv->model_id,
      G_LITTLE_ENDIAN,
      error)) {
      g_prefix_error_literal(error, "failed to read model-id: ");
      return FALSE;
    }
  }

  /* versions */
  switch (priv->family) {
  case FU_INTEL_THUNDERBOLT_NVM_FAMILY_TITAN_RIDGE:
  case FU_INTEL_THUNDERBOLT_NVM_FAMILY_GOSHEN_RIDGE:
  case FU_INTEL_THUNDERBOLT_NVM_FAMILY_BARLOW_RIDGE:
    if (!fu_input_stream_read_u16(
      stream,
      priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL] +
          FU_INTEL_THUNDERBOLT_NVM_DIGITAL_OFFSET_VERSION,
      &version_raw,
      G_LITTLE_ENDIAN,
      error)) {
      g_prefix_error_literal(error, "failed to read version: ");
      return FALSE;
    }
    fu_firmware_set_version_raw(FU_FIRMWARE(self), version_raw);
    break;
  default:
    break;
  }

  if (priv->is_host) {
    switch (priv->family) {
    case FU_INTEL_THUNDERBOLT_NVM_FAMILY_ALPINE_RIDGE:
    case FU_INTEL_THUNDERBOLT_NVM_FAMILY_ALPINE_RIDGE_C:
    case FU_INTEL_THUNDERBOLT_NVM_FAMILY_TITAN_RIDGE:
      /* used for comparison between old and new image, not a raw number */
      if (!fu_input_stream_read_u8(
        stream,
        priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_DIGITAL] +
            FU_INTEL_THUNDERBOLT_NVM_DIGITAL_OFFSET_FLASH_SIZE,
        &tmp,
        error)) {
        g_prefix_error_literal(error, "failed to read flash size: ");
        return FALSE;
      }
      priv->flash_size = tmp & 0x07;
      break;
    default:
      break;
    }
  }

  /* we're only reading enough to get the vendor-id and model-id */
  if (streamsz < priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_ARC_PARAMS])
    return TRUE;

  /* has PD */
  if (priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_ARC_PARAMS] != 0x0) {
    guint32 pd_pointer = 0x0;
    if (!fu_input_stream_read_u32(
      stream,
      priv->sections[FU_INTEL_THUNDERBOLT_NVM_SECTION_ARC_PARAMS] +
          FU_INTEL_THUNDERBOLT_NVM_ARC_PARAMS_OFFSET_PD_POINTER,
      &pd_pointer,
      G_LITTLE_ENDIAN,
      error)) {
      g_prefix_error_literal(error, "failed to read pd-pointer: ");
      return FALSE;
    }
    priv->has_pd = fu_intel_thunderbolt_nvm_valid_pd_pointer(pd_pointer);
  }

  /* as as easy-to-grab payload blob */
  if (!fu_firmware_parse_stream(img_payload, stream, 0x0, flags, error))
    return FALSE;
  fu_firmware_set_id(img_payload, FU_FIRMWARE_ID_PAYLOAD);
  if (!fu_firmware_add_image(firmware, img_payload, error))
    return FALSE;

  /* success */
  return TRUE;
}

/* can only write version 3 NVM */
static GByteArray *
fu_intel_thunderbolt_nvm_write(FuFirmware *firmware, GError **error)
{
  FuIntelThunderboltNvm *self = FU_INTEL_THUNDERBOLT_NVM(firmware);
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  g_autoptr(FuIntelThunderboltNvmDigital) st = fu_intel_thunderbolt_nvm_digital_new();
  g_autoptr(FuIntelThunderboltNvmDrom) st_drom = fu_intel_thunderbolt_nvm_drom_new();
  g_autoptr(FuIntelThunderboltNvmArcParams) st_arc =
      fu_intel_thunderbolt_nvm_arc_params_new();
  g_autoptr(FuIntelThunderboltNvmDram) st_dram = fu_intel_thunderbolt_nvm_dram_new();

  /* digital section */
  fu_intel_thunderbolt_nvm_digital_set_available_sections(
      st,
      FU_INTEL_THUNDERBOLT_NVM_SECTION_FLAG_DRAM);
  fu_intel_thunderbolt_nvm_digital_set_device_id(st, priv->device_id);
  fu_intel_thunderbolt_nvm_digital_set_version(st, fu_firmware_get_version_raw(firmware));
  fu_intel_thunderbolt_nvm_digital_set_flags_host(st, priv->is_host ? 0x2 : 0x0);
  fu_intel_thunderbolt_nvm_digital_set_flash_size(st, priv->flash_size);
  fu_intel_thunderbolt_nvm_digital_set_flags_is_native(st, priv->is_native ? 0x20 : 0x0);

  /* drom section */
  fu_intel_thunderbolt_nvm_digital_set_drom(st, st->buf->len);
  fu_intel_thunderbolt_nvm_drom_set_vendor_id(st_drom, priv->vendor_id);
  fu_intel_thunderbolt_nvm_drom_set_model_id(st_drom, priv->model_id);
  fu_byte_array_append_array(st->buf, st_drom->buf);

  /* ARC param section */
  fu_intel_thunderbolt_nvm_digital_set_arc_params(st, st->buf->len);
  fu_intel_thunderbolt_nvm_arc_params_set_pd_pointer(st_arc, priv->has_pd ? 0x1 : 0x0);
  fu_byte_array_append_array(st->buf, st_arc->buf);

  /* dram section */
  fu_intel_thunderbolt_nvm_digital_set_ucode(st, st->buf->len);
  fu_byte_array_append_array(st->buf, st_dram->buf);

  /* success */
  return g_steal_pointer(&st->buf);
}

static gboolean
fu_intel_thunderbolt_nvm_check_compatible(FuFirmware *firmware,
            FuFirmware *firmware_other,
            FuFirmwareParseFlags flags,
            GError **error)
{
  FuIntelThunderboltNvm *self = FU_INTEL_THUNDERBOLT_NVM(firmware);
  FuIntelThunderboltNvm *other = FU_INTEL_THUNDERBOLT_NVM(firmware_other);
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  FuIntelThunderboltNvmPrivate *priv_other = GET_PRIVATE(other);

  if (priv->is_host != priv_other->is_host) {
    g_set_error(error,
          FWUPD_ERROR,
          FWUPD_ERROR_INVALID_FILE,
          "incorrect firmware mode, got %s, expected %s",
          priv->is_host ? "host" : "device",
          priv_other->is_host ? "host" : "device");
    return FALSE;
  }
  if (priv->vendor_id != priv_other->vendor_id) {
    g_set_error(error,
          FWUPD_ERROR,
          FWUPD_ERROR_INVALID_FILE,
          "incorrect device vendor, got 0x%04x, expected 0x%04x",
          priv->vendor_id,
          priv_other->vendor_id);
    return FALSE;
  }
  if (priv->device_id != priv_other->device_id) {
    g_set_error(error,
          FWUPD_ERROR,
          FWUPD_ERROR_INVALID_FILE,
          "incorrect device type, got 0x%04x, expected 0x%04x",
          priv->device_id,
          priv_other->device_id);
    return FALSE;
  }
  if ((flags & FU_FIRMWARE_PARSE_FLAG_IGNORE_VID_PID) == 0) {
    if (priv->model_id != priv_other->model_id) {
      g_set_error(error,
            FWUPD_ERROR,
            FWUPD_ERROR_INVALID_FILE,
            "incorrect device model, got 0x%04x, expected 0x%04x",
            priv->model_id,
            priv_other->model_id);
      return FALSE;
    }
    /* old firmware has PD but new doesn't (we don't care about other way around) */
    if (priv->has_pd && !priv_other->has_pd) {
      g_set_error_literal(error,
              FWUPD_ERROR,
              FWUPD_ERROR_INVALID_FILE,
              "incorrect PD section");
      return FALSE;
    }
    if (priv->flash_size != priv_other->flash_size) {
      g_set_error(error,
            FWUPD_ERROR,
            FWUPD_ERROR_INVALID_FILE,
            "incorrect flash size, got 0x%x and expected 0x%x",
            priv->flash_size,
            priv_other->flash_size);
      return FALSE;
    }
  }
  return TRUE;
}

static gboolean
fu_intel_thunderbolt_nvm_build(FuFirmware *firmware, XbNode *n, GError **error)
{
  FuIntelThunderboltNvm *self = FU_INTEL_THUNDERBOLT_NVM(firmware);
  FuIntelThunderboltNvmPrivate *priv = GET_PRIVATE(self);
  const gchar *tmp;

  /* simple properties */
  tmp = xb_node_query_text(n, "vendor_id", NULL);
  if (tmp != NULL) {
    guint64 val = 0;
    if (!fu_strtoull(tmp, &val, 0x0, G_MAXUINT16, FU_INTEGER_BASE_AUTO, error))
      return FALSE;
    priv->vendor_id = val;
  }
  tmp = xb_node_query_text(n, "device_id", NULL);
  if (tmp != NULL) {
    guint64 val = 0;
    if (!fu_strtoull(tmp, &val, 0x0, G_MAXUINT16, FU_INTEGER_BASE_AUTO, error))
      return FALSE;
    priv->device_id = val;
  }
  tmp = xb_node_query_text(n, "model_id", NULL);
  if (tmp != NULL) {
    guint64 val = 0;
    if (!fu_strtoull(tmp, &val, 0x0, G_MAXUINT16, FU_INTEGER_BASE_AUTO, error))
      return FALSE;
    priv->model_id = val;
  }
  tmp = xb_node_query_text(n, "family", NULL);
  if (tmp != NULL) {
    priv->family = fu_intel_thunderbolt_nvm_family_from_string(tmp);
    if (priv->family == FU_INTEL_THUNDERBOLT_NVM_FAMILY_UNKNOWN) {
      g_set_error(error,
            FWUPD_ERROR,
            FWUPD_ERROR_INVALID_DATA,
            "unknown family: %s",
            tmp);
      return FALSE;
    }
  }
  tmp = xb_node_query_text(n, "flash_size", NULL);
  if (tmp != NULL) {
    guint64 val = 0;
    if (!fu_strtoull(tmp, &val, 0x0, 0x07, FU_INTEGER_BASE_AUTO, error))
      return FALSE;
    priv->flash_size = val;
  }
  tmp = xb_node_query_text(n, "is_host", NULL);
  if (tmp != NULL) {
    if (!fu_strtobool(tmp, &priv->is_host, error))
      return FALSE;
  }
  tmp = xb_node_query_text(n, "is_native", NULL);
  if (tmp != NULL) {
    if (!fu_strtobool(tmp, &priv->is_native, error))
      return FALSE;
  }

  /* success */
  return TRUE;
}

static gchar *
fu_intel_thunderbolt_nvm_convert_version(FuFirmware *firmware, guint64 version_raw)
{
  return fu_version_from_uint16(version_raw, fu_firmware_get_version_format(firmware));
}

static void
fu_intel_thunderbolt_nvm_init(FuIntelThunderboltNvm *self)
{
  fu_firmware_add_flag(FU_FIRMWARE(self), FU_FIRMWARE_FLAG_HAS_VID_PID);
  fu_firmware_add_image_gtype(FU_FIRMWARE(self), FU_TYPE_FIRMWARE);
  fu_firmware_set_images_max(FU_FIRMWARE(self), 1024);
  fu_firmware_set_size_max(FU_FIRMWARE(self), 32 * FU_MB);
  fu_firmware_set_version_format(FU_FIRMWARE(self), FWUPD_VERSION_FORMAT_BCD);
}

static void
fu_intel_thunderbolt_nvm_class_init(FuIntelThunderboltNvmClass *klass)
{
  FuFirmwareClass *firmware_class = FU_FIRMWARE_CLASS(klass);
  firmware_class->convert_version = fu_intel_thunderbolt_nvm_convert_version;
  firmware_class->export = fu_intel_thunderbolt_nvm_export;
  firmware_class->parse = fu_intel_thunderbolt_nvm_parse;
  firmware_class->write = fu_intel_thunderbolt_nvm_write;
  firmware_class->build = fu_intel_thunderbolt_nvm_build;
  firmware_class->check_compatible = fu_intel_thunderbolt_nvm_check_compatible;
}

/**
 * fu_intel_thunderbolt_nvm_new:
 *
 * Creates a new #FuFirmware of Intel NVM format
 *
 * Since: 1.8.5
 **/
FuFirmware *
fu_intel_thunderbolt_nvm_new(void)
{
  return FU_FIRMWARE(g_object_new(FU_TYPE_INTEL_THUNDERBOLT_NVM, NULL));
}

Coverage Report

Created: 2026-04-28 06:49