/src/fwupd/libfwupd/fwupd-bios-setting.c

Source
/*
 * Copyright 2022 Mario Limonciello <mario.limonciello@amd.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

#include "config.h"

#include "fwupd-bios-setting.h"
#include "fwupd-codec.h"
#include "fwupd-enums-private.h"
#include "fwupd-error.h"
#include "fwupd-json-array.h"
#include "fwupd-json-object.h"
#include "fwupd-variant.h"

/**
 * FwupdBiosSetting:
 *
 * A BIOS setting that represents a setting in the firmware.
 */

static void
fwupd_bios_setting_finalize(GObject *object);

typedef struct {
  FwupdBiosSettingKind kind;
  gchar *id;
  gchar *name;
  gchar *description;
  gchar *path;
  gchar *value_filename;
  gchar *current_value;
  guint64 lower_bound;
  guint64 upper_bound;
  guint64 scalar_increment;
  gboolean read_only;
  GPtrArray *possible_values;
} FwupdBiosSettingPrivate;

static void
fwupd_bios_setting_codec_iface_init(FwupdCodecInterface *iface);

G_DEFINE_TYPE_EXTENDED(FwupdBiosSetting,
           fwupd_bios_setting,
           G_TYPE_OBJECT,
           0,
           G_ADD_PRIVATE(FwupdBiosSetting)
         G_IMPLEMENT_INTERFACE(FWUPD_TYPE_CODEC,
             fwupd_bios_setting_codec_iface_init));

#define GET_PRIVATE(o) (fwupd_bios_setting_get_instance_private(o))

/**
 * fwupd_bios_setting_get_id
 * @self: a #FwupdBiosSetting
 *
 * Gets the unique attribute identifier for this attribute/driver
 *
 * Returns: attribute ID if set otherwise NULL
 *
 * Since: 1.8.4
 **/
const gchar *
fwupd_bios_setting_get_id(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), NULL);
  return priv->id;
}

/**
 * fwupd_bios_setting_set_id
 * @self: a #FwupdBiosSetting
 *
 * Sets the unique attribute identifier for this attribute
 *
 * Since: 1.8.4
 **/
void
fwupd_bios_setting_set_id(FwupdBiosSetting *self, const gchar *id)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_if_fail(FWUPD_IS_BIOS_SETTING(self));

  /* not changed */
  if (g_strcmp0(priv->id, id) == 0)
    return;

  g_free(priv->id);
  priv->id = g_strdup(id);
}

/**
 * fwupd_bios_setting_get_read_only:
 * @self: a #FwupdBiosSetting
 *
 * Determines if a BIOS setting is read only
 *
 * Returns: gboolean
 *
 * Since: 1.8.4
 **/
gboolean
fwupd_bios_setting_get_read_only(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), FALSE);
  return priv->read_only;
}

/**
 * fwupd_bios_setting_set_read_only:
 * @self: a #FwupdBiosSetting
 *
 * Configures whether an attribute is read only
 * maximum length for string attributes.
 *
 *
 * Since: 1.8.4
 **/
void
fwupd_bios_setting_set_read_only(FwupdBiosSetting *self, gboolean val)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_if_fail(FWUPD_IS_BIOS_SETTING(self));
  priv->read_only = val;
}

/**
 * fwupd_bios_setting_get_filename:
 * @self: a #FwupdBiosSetting
 *
 * Gets the filename within @path where values are read/written.
 *
 * Returns: the value filename or NULL if not set
 *
 * Since: 2.1.1
 **/
const gchar *
fwupd_bios_setting_get_filename(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), NULL);
  return priv->value_filename;
}

/**
 * fwupd_bios_setting_set_filename:
 * @self: a #FwupdBiosSetting
 * @filename: the filename within @path for value operations
 *
 * Sets the filename within @path where values are read/written.
 * If not set, defaults to "current_value".
 *
 * Since: 2.1.1
 **/
void
fwupd_bios_setting_set_filename(FwupdBiosSetting *self, const gchar *filename)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_if_fail(FWUPD_IS_BIOS_SETTING(self));

  /* not changed */
  if (g_strcmp0(priv->value_filename, filename) == 0)
    return;

  g_free(priv->value_filename);
  priv->value_filename = g_strdup(filename);
}

/**
 * fwupd_bios_setting_get_lower_bound:
 * @self: a #FwupdBiosSetting
 *
 * Gets the lower bound for integer attributes or
 * minimum length for string attributes.
 *
 * Returns: guint64
 *
 * Since: 1.8.4
 **/
guint64
fwupd_bios_setting_get_lower_bound(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), 0);
  return priv->lower_bound;
}

/**
 * fwupd_bios_setting_get_upper_bound:
 * @self: a #FwupdBiosSetting
 *
 * Gets the upper bound for integer attributes or
 * maximum length for string attributes.
 *
 * Returns: guint64
 *
 * Since: 1.8.4
 **/
guint64
fwupd_bios_setting_get_upper_bound(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), 0);
  return priv->upper_bound;
}

/**
 * fwupd_bios_setting_get_scalar_increment:
 * @self: a #FwupdBiosSetting
 *
 * Gets the scalar increment used for integer attributes.
 *
 * Returns: guint64
 *
 * Since: 1.8.4
 **/
guint64
fwupd_bios_setting_get_scalar_increment(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), 0);
  return priv->scalar_increment;
}

/**
 * fwupd_bios_setting_set_upper_bound:
 * @self: a #FwupdBiosSetting
 * @val: a guint64 value to set bound to
 *
 * Sets the upper bound used for BIOS integer attributes or max
 * length for string attributes.
 *
 * Since: 1.8.4
 **/
void
fwupd_bios_setting_set_upper_bound(FwupdBiosSetting *self, guint64 val)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_if_fail(FWUPD_IS_BIOS_SETTING(self));
  priv->upper_bound = val;
}

/**
 * fwupd_bios_setting_set_lower_bound:
 * @self: a #FwupdBiosSetting
 * @val: a guint64 value to set bound to
 *
 * Sets the lower bound used for BIOS integer attributes or max
 * length for string attributes.
 *
 * Since: 1.8.4
 **/
void
fwupd_bios_setting_set_lower_bound(FwupdBiosSetting *self, guint64 val)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_if_fail(FWUPD_IS_BIOS_SETTING(self));
  priv->lower_bound = val;
}

/**
 * fwupd_bios_setting_set_scalar_increment:
 * @self: a #FwupdBiosSetting
 * @val: a guint64 value to set increment to
 *
 * Sets the scalar increment used for BIOS integer attributes.
 *
 * Since: 1.8.4
 **/
void
fwupd_bios_setting_set_scalar_increment(FwupdBiosSetting *self, guint64 val)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_if_fail(FWUPD_IS_BIOS_SETTING(self));
  priv->scalar_increment = val;
}

/**
 * fwupd_bios_setting_get_kind:
 * @self: a #FwupdBiosSetting
 *
 * Gets the BIOS setting type used by the kernel interface.
 *
 * Returns: the bios setting type, or %FWUPD_BIOS_SETTING_KIND_UNKNOWN if unset.
 *
 * Since: 1.8.4
 **/
FwupdBiosSettingKind
fwupd_bios_setting_get_kind(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), 0);
  return priv->kind;
}

/**
 * fwupd_bios_setting_set_kind:
 * @self: a #FwupdBiosSetting
 * @type: a bios setting type, e.g. %FWUPD_BIOS_SETTING_KIND_ENUMERATION
 *
 * Sets the BIOS setting type used by the kernel interface.
 *
 * Since: 1.8.4
 **/
void
fwupd_bios_setting_set_kind(FwupdBiosSetting *self, FwupdBiosSettingKind type)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_if_fail(FWUPD_IS_BIOS_SETTING(self));
  priv->kind = type;
}

/**
 * fwupd_bios_setting_set_name:
 * @self: a #FwupdBiosSetting
 * @name: (nullable): the attribute name
 *
 * Sets the attribute name provided by a kernel driver.
 *
 * Since: 1.8.4
 **/
void
fwupd_bios_setting_set_name(FwupdBiosSetting *self, const gchar *name)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_if_fail(FWUPD_IS_BIOS_SETTING(self));

  /* not changed */
  if (g_strcmp0(priv->name, name) == 0)
    return;

  g_free(priv->name);
  priv->name = g_strdup(name);
}

/**
 * fwupd_bios_setting_set_path:
 * @self: a #FwupdBiosSetting
 * @path: (nullable): the path the driver providing the attribute uses
 *
 * Sets path to the attribute.
 *
 * Since: 1.8.4
 **/
void
fwupd_bios_setting_set_path(FwupdBiosSetting *self, const gchar *path)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_if_fail(FWUPD_IS_BIOS_SETTING(self));

  /* not changed */
  if (g_strcmp0(priv->path, path) == 0)
    return;

  g_free(priv->path);
  priv->path = g_strdup(path);
}

/**
 * fwupd_bios_setting_set_description:
 * @self: a #FwupdBiosSetting
 * @description: (nullable): the attribute description
 *
 * Sets the attribute description.
 *
 * Since: 1.8.4
 **/
void
fwupd_bios_setting_set_description(FwupdBiosSetting *self, const gchar *description)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_if_fail(FWUPD_IS_BIOS_SETTING(self));

  /* not changed */
  if (g_strcmp0(priv->description, description) == 0)
    return;

  g_free(priv->description);
  priv->description = g_strdup(description);
}

/* determine if key is supposed to be positive */
static gboolean
fwupd_bios_setting_key_is_positive(const gchar *key)
{
  if (g_strrstr(key, "enable"))
    return TRUE;
  if (g_strcmp0(key, "true") == 0)
    return TRUE;
  if (g_strcmp0(key, "1") == 0)
    return TRUE;
  if (g_strcmp0(key, "on") == 0)
    return TRUE;
  return FALSE;
}

/* determine if key is supposed to be negative */
static gboolean
fwupd_bios_setting_key_is_negative(const gchar *key)
{
  if (g_strrstr(key, "disable"))
    return TRUE;
  if (g_strcmp0(key, "false") == 0)
    return TRUE;
  if (g_strcmp0(key, "0") == 0)
    return TRUE;
  if (g_strcmp0(key, "off") == 0)
    return TRUE;
  return FALSE;
}

/**
 * fwupd_bios_setting_map_possible_value:
 * @self: a #FwupdBiosSetting
 * @key: the string to try to map
 * @error: (nullable): optional return location for an error
 *
 * Attempts to map a user provided string into strings that a #FwupdBiosSetting can
 * support.  The following heuristics are used:
 * - Ignore case sensitivity
 * - Map obviously "positive" phrases into a value that turns on the #FwupdBiosSetting
 * - Map obviously "negative" phrases into a value that turns off the #FwupdBiosSetting
 *
 * Returns: (transfer none): the possible value that maps or NULL if none if found
 *
 * Since: 1.8.4
 **/
const gchar *
fwupd_bios_setting_map_possible_value(FwupdBiosSetting *self, const gchar *key, GError **error)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  gboolean positive_key = FALSE;
  gboolean negative_key = FALSE;
  g_autofree gchar *lower_key = NULL;

  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), NULL);
  g_return_val_if_fail(priv->kind == FWUPD_BIOS_SETTING_KIND_ENUMERATION, NULL);

  if (priv->possible_values->len == 0) {
    g_set_error(error,
          FWUPD_ERROR,
          FWUPD_ERROR_NOT_SUPPORTED,
          "%s doesn't contain any possible values",
          priv->name);
    return NULL;
  }

  lower_key = g_utf8_strdown(key, -1);
  positive_key = fwupd_bios_setting_key_is_positive(lower_key);
  negative_key = fwupd_bios_setting_key_is_negative(lower_key);
  for (guint i = 0; i < priv->possible_values->len; i++) {
    const gchar *possible = g_ptr_array_index(priv->possible_values, i);
    g_autofree gchar *lower_possible = g_utf8_strdown(possible, -1);
    gboolean positive_possible;
    gboolean negative_possible;

    /* perfect match */
    if (g_strcmp0(lower_possible, lower_key) == 0)
      return possible;
    /* fuzzy match */
    positive_possible = fwupd_bios_setting_key_is_positive(lower_possible);
    negative_possible = fwupd_bios_setting_key_is_negative(lower_possible);
    if ((positive_possible && positive_key) || (negative_possible && negative_key))
      return possible;
  }
  g_set_error(error,
        FWUPD_ERROR,
        FWUPD_ERROR_NOT_SUPPORTED,
        "%s doesn't map to any possible values for %s",
        key,
        priv->name);
  return NULL;
}

/**
 * fwupd_bios_setting_has_possible_value:
 * @self: a #FwupdBiosSetting
 * @val: the possible value string
 *
 * Finds out if a specific possible value was added to the attribute.
 *
 * Returns: %TRUE if the self matches.
 *
 * Since: 1.8.4
 **/
gboolean
fwupd_bios_setting_has_possible_value(FwupdBiosSetting *self, const gchar *val)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), FALSE);
  g_return_val_if_fail(val != NULL, FALSE);

  if (priv->possible_values->len == 0)
    return TRUE;

  for (guint i = 0; i < priv->possible_values->len; i++) {
    const gchar *tmp = g_ptr_array_index(priv->possible_values, i);
    if (g_strcmp0(tmp, val) == 0)
      return TRUE;
  }
  return FALSE;
}

/**
 * fwupd_bios_setting_add_possible_value:
 * @self: a #FwupdBiosSetting
 * @possible_value: the possible
 *
 * Adds a possible value to the attribute.  This indicates one of the values the
 * kernel driver will accept from userspace.
 *
 * Since: 1.8.4
 **/
void
fwupd_bios_setting_add_possible_value(FwupdBiosSetting *self, const gchar *possible_value)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_if_fail(FWUPD_IS_BIOS_SETTING(self));
  if (priv->possible_values->len > 0 &&
      fwupd_bios_setting_has_possible_value(self, possible_value))
    return;
  g_ptr_array_add(priv->possible_values, g_strdup(possible_value));
}

/**
 * fwupd_bios_setting_get_possible_values:
 * @self: a #FwupdBiosSetting
 *
 * Find all possible values for an enumeration attribute.
 *
 * Returns: (transfer container) (element-type gchar*): all possible values.
 *
 * Since: 1.8.4
 **/
GPtrArray *
fwupd_bios_setting_get_possible_values(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), NULL);
  g_return_val_if_fail(priv->kind == FWUPD_BIOS_SETTING_KIND_ENUMERATION, NULL);
  return priv->possible_values;
}

/**
 * fwupd_bios_setting_get_name:
 * @self: a #FwupdBiosSetting
 *
 * Gets the attribute name.
 *
 * Returns: the attribute name, or %NULL if unset.
 *
 * Since: 1.8.4
 **/
const gchar *
fwupd_bios_setting_get_name(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), NULL);
  return priv->name;
}

/**
 * fwupd_bios_setting_get_path:
 * @self: a #FwupdBiosSetting
 *
 * Gets the path for the driver providing the attribute.
 *
 * Returns: (nullable): the driver, or %NULL if unfound.
 *
 * Since: 1.8.4
 **/
const gchar *
fwupd_bios_setting_get_path(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), NULL);
  return priv->path;
}

/**
 * fwupd_bios_setting_get_description:
 * @self: a #FwupdBiosSetting
 *
 * Gets the attribute description which is provided by some drivers to explain
 * what they change.
 *
 * Returns: the attribute description, or %NULL if unset.
 *
 * Since: 1.8.4
 **/
const gchar *
fwupd_bios_setting_get_description(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), NULL);
  return priv->description;
}

/**
 * fwupd_bios_setting_get_current_value:
 * @self: a #FwupdBiosSetting
 *
 * Gets the string representation of the current_value stored in an attribute
 * from the kernel.  This value is cached; so changing it outside of fwupd may
 * may put it out of sync.
 *
 * Returns: the current value of the attribute.
 *
 * Since: 1.8.4
 **/
const gchar *
fwupd_bios_setting_get_current_value(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), NULL);
  return priv->current_value;
}

/**
 * fwupd_bios_setting_set_current_value:
 * @self: a #FwupdBiosSetting
 * @value: (nullable): The string to set an attribute to
 *
 * Sets the string stored in an attribute.
 * This doesn't change the representation in the kernel.
 *
 * Since: 1.8.4
 **/
void
fwupd_bios_setting_set_current_value(FwupdBiosSetting *self, const gchar *value)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);

  /* not changed */
  if (g_strcmp0(priv->current_value, value) == 0)
    return;

  g_free(priv->current_value);
  priv->current_value = g_strdup(value);
}

static gboolean
_fu_strtoull_simple(const gchar *str, guint64 *value, GError **error)
{
  gchar *endptr = NULL;
  guint base = 10;

  /* convert */
  if (g_str_has_prefix(str, "0x")) {
    str += 2;
    base = 16;
  }
  *value = g_ascii_strtoull(str, &endptr, base); /* nocheck:blocked */
  if ((gsize)(endptr - str) != strlen(str) && *endptr != '\n') {
    g_set_error(error, FWUPD_ERROR, FWUPD_ERROR_INVALID_DATA, "cannot parse %s", str);
    return FALSE;
  }
  return TRUE;
}

static gboolean
fwupd_bios_setting_validate_value(FwupdBiosSetting *self, const gchar *value, GError **error)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);

  if (priv->kind == FWUPD_BIOS_SETTING_KIND_INTEGER) {
    guint64 tmp = 0;
    if (!_fu_strtoull_simple(value, &tmp, error))
      return FALSE;
    if (tmp < priv->lower_bound) {
      g_set_error(error, /* nocheck:error */
            FWUPD_ERROR,
            FWUPD_ERROR_NOT_SUPPORTED,
            "%s is too small (%" G_GUINT64_FORMAT
            ") expected at least %" G_GUINT64_FORMAT,
            value,
            tmp,
            priv->lower_bound);
      return FALSE;
    }
    if (tmp > priv->upper_bound) {
      g_set_error(error, /* nocheck:error */
            FWUPD_ERROR,
            FWUPD_ERROR_NOT_SUPPORTED,
            "%s is too big (%" G_GUINT64_FORMAT
            ") expected no more than %" G_GUINT64_FORMAT,
            value,
            tmp,
            priv->upper_bound);
      return FALSE;
    }
    return TRUE;
  }
  if (priv->kind == FWUPD_BIOS_SETTING_KIND_STRING) {
    gsize tmp = strlen(value);
    if (tmp < priv->lower_bound) {
      g_set_error(error, /* nocheck:error */
            FWUPD_ERROR,
            FWUPD_ERROR_NOT_SUPPORTED,
            "%s is too short (%" G_GSIZE_FORMAT
            ") expected at least %" G_GUINT64_FORMAT,
            value,
            tmp,
            priv->lower_bound);
      return FALSE;
    }
    if (tmp > priv->upper_bound) {
      g_set_error(error, /* nocheck:error */
            FWUPD_ERROR,
            FWUPD_ERROR_NOT_SUPPORTED,
            "%s is too long (%" G_GSIZE_FORMAT
            ") expected no more than %" G_GUINT64_FORMAT,
            value,
            tmp,
            priv->upper_bound);
      return FALSE;
    }
    return TRUE;
  }
  if (priv->kind == FWUPD_BIOS_SETTING_KIND_ENUMERATION)
    return TRUE;

  /* not supported */
  g_set_error_literal(error,
          FWUPD_ERROR,
          FWUPD_ERROR_NOT_SUPPORTED,
          "unknown attribute type");
  return FALSE;
}

/**
 * fwupd_bios_setting_write_value:
 * @self: a #FwupdBiosSetting
 * @value: (not nullable): The string to write
 * @error: (nullable): optional return location for an error
 *
 * Writes a new value into the setting if it is different from the current value.
 *
 * NOTE: A subclass should handle the `->write_value()` vfunc and actually write the value to the
 * firmware.
 *
 * Returns: %TRUE for success
 *
 * Since: 1.9.4
 **/
gboolean
fwupd_bios_setting_write_value(FwupdBiosSetting *self, const gchar *value, GError **error)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  FwupdBiosSettingClass *klass = FWUPD_BIOS_SETTING_GET_CLASS(self);

  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), FALSE);
  g_return_val_if_fail(value != NULL, FALSE);
  g_return_val_if_fail(error == NULL || *error == NULL, FALSE);

  /* not changed */
  if (g_strcmp0(priv->current_value, value) == 0) {
    g_set_error(error,
          FWUPD_ERROR,
          FWUPD_ERROR_NOTHING_TO_DO,
          "%s is already set to %s",
          priv->id,
          value);
    return FALSE;
  }

  /* sanity check */
  if (fwupd_bios_setting_get_read_only(self)) {
    g_set_error(error,
          FWUPD_ERROR,
          FWUPD_ERROR_NOT_SUPPORTED,
          "%s is read only",
          priv->name);
    return FALSE;
  }

  /* convert the value */
  if (priv->kind == FWUPD_BIOS_SETTING_KIND_ENUMERATION) {
    value = fwupd_bios_setting_map_possible_value(self, value, error);
    if (value == NULL)
      return FALSE;
  }

  /* also done by the kernel or firmware, doing it here too allows for better errors */
  if (!fwupd_bios_setting_validate_value(self, value, error))
    return FALSE;

  /* not implemented */
  if (klass->write_value == NULL) {
    g_set_error_literal(error, FWUPD_ERROR, FWUPD_ERROR_NOT_SUPPORTED, "not supported");
    return FALSE;
  }

  /* proxy */
  return klass->write_value(self, value, error);
}

static gboolean
fwupd_bios_setting_trusted(FwupdBiosSetting *self, gboolean trusted)
{
  g_return_val_if_fail(FWUPD_IS_BIOS_SETTING(self), FALSE);

  if (trusted)
    return TRUE;
  if (g_strcmp0(fwupd_bios_setting_get_name(self), "pending_reboot") == 0)
    return TRUE;
  return FALSE;
}

static void
fwupd_bios_setting_add_variant(FwupdCodec *codec, GVariantBuilder *builder, FwupdCodecFlags flags)
{
  FwupdBiosSetting *self = FWUPD_BIOS_SETTING(codec);
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);

  g_variant_builder_add(builder,
            "{sv}",
            FWUPD_RESULT_KEY_BIOS_SETTING_TYPE,
            g_variant_new_uint64(priv->kind));
  if (priv->id != NULL) {
    g_variant_builder_add(builder,
              "{sv}",
              FWUPD_RESULT_KEY_BIOS_SETTING_ID,
              g_variant_new_string(priv->id));
  }
  if (priv->name != NULL) {
    g_variant_builder_add(builder,
              "{sv}",
              FWUPD_RESULT_KEY_NAME,
              g_variant_new_string(priv->name));
  }
  if (priv->path != NULL) {
    g_variant_builder_add(builder,
              "{sv}",
              FWUPD_RESULT_KEY_FILENAME,
              g_variant_new_string(priv->path));
  }
  if (priv->description != NULL) {
    g_variant_builder_add(builder,
              "{sv}",
              FWUPD_RESULT_KEY_DESCRIPTION,
              g_variant_new_string(priv->description));
  }
  if (priv->value_filename != NULL) {
    g_variant_builder_add(builder,
              "{sv}",
              FWUPD_RESULT_KEY_BIOS_SETTING_FILENAME,
              g_variant_new_string(priv->value_filename));
  }
  g_variant_builder_add(builder,
            "{sv}",
            FWUPD_RESULT_KEY_BIOS_SETTING_READ_ONLY,
            g_variant_new_boolean(priv->read_only));
  if (priv->current_value != NULL &&
      fwupd_bios_setting_trusted(self, flags & FWUPD_CODEC_FLAG_TRUSTED)) {
    g_variant_builder_add(builder,
              "{sv}",
              FWUPD_RESULT_KEY_BIOS_SETTING_CURRENT_VALUE,
              g_variant_new_string(priv->current_value));
  }
  if (priv->kind == FWUPD_BIOS_SETTING_KIND_INTEGER ||
      priv->kind == FWUPD_BIOS_SETTING_KIND_STRING) {
    g_variant_builder_add(builder,
              "{sv}",
              FWUPD_RESULT_KEY_BIOS_SETTING_LOWER_BOUND,
              g_variant_new_uint64(priv->lower_bound));
    g_variant_builder_add(builder,
              "{sv}",
              FWUPD_RESULT_KEY_BIOS_SETTING_UPPER_BOUND,
              g_variant_new_uint64(priv->upper_bound));
    if (priv->kind == FWUPD_BIOS_SETTING_KIND_INTEGER) {
      g_variant_builder_add(builder,
                "{sv}",
                FWUPD_RESULT_KEY_BIOS_SETTING_SCALAR_INCREMENT,
                g_variant_new_uint64(priv->scalar_increment));
    }
  } else if (priv->kind == FWUPD_BIOS_SETTING_KIND_ENUMERATION) {
    if (priv->possible_values->len > 0) {
      g_autofree const gchar **strv =
          g_new0(const gchar *, priv->possible_values->len + 1);
      for (guint i = 0; i < priv->possible_values->len; i++)
        strv[i] =
            (const gchar *)g_ptr_array_index(priv->possible_values, i);
      g_variant_builder_add(builder,
                "{sv}",
                FWUPD_RESULT_KEY_BIOS_SETTING_POSSIBLE_VALUES,
                g_variant_new_strv(strv, -1));
    }
  }
}

static void
fwupd_bios_setting_from_key_value(FwupdBiosSetting *self, const gchar *key, GVariant *value)
{
  if (g_strcmp0(key, FWUPD_RESULT_KEY_BIOS_SETTING_TYPE) == 0) {
    fwupd_bios_setting_set_kind(self, fwupd_variant_get_uint64(value));
    return;
  }
  if (g_strcmp0(key, FWUPD_RESULT_KEY_BIOS_SETTING_ID) == 0) {
    fwupd_bios_setting_set_id(self, fwupd_variant_get_string(value));
    return;
  }
  if (g_strcmp0(key, FWUPD_RESULT_KEY_NAME) == 0) {
    fwupd_bios_setting_set_name(self, fwupd_variant_get_string(value));
    return;
  }
  if (g_strcmp0(key, FWUPD_RESULT_KEY_FILENAME) == 0) {
    fwupd_bios_setting_set_path(self, fwupd_variant_get_string(value));
    return;
  }
  if (g_strcmp0(key, FWUPD_RESULT_KEY_BIOS_SETTING_CURRENT_VALUE) == 0) {
    fwupd_bios_setting_set_current_value(self, fwupd_variant_get_string(value));
    return;
  }
  if (g_strcmp0(key, FWUPD_RESULT_KEY_BIOS_SETTING_FILENAME) == 0) {
    fwupd_bios_setting_set_filename(self, fwupd_variant_get_string(value));
    return;
  }
  if (g_strcmp0(key, FWUPD_RESULT_KEY_DESCRIPTION) == 0) {
    fwupd_bios_setting_set_description(self, fwupd_variant_get_string(value));
    return;
  }
  if (g_strcmp0(key, FWUPD_RESULT_KEY_BIOS_SETTING_POSSIBLE_VALUES) == 0) {
    g_autofree const gchar **strv = fwupd_variant_get_strv(value);
    for (guint i = 0; strv != NULL && strv[i] != NULL; i++)
      fwupd_bios_setting_add_possible_value(self, strv[i]);
    return;
  }
  if (g_strcmp0(key, FWUPD_RESULT_KEY_BIOS_SETTING_LOWER_BOUND) == 0) {
    fwupd_bios_setting_set_lower_bound(self, fwupd_variant_get_uint64(value));
    return;
  }
  if (g_strcmp0(key, FWUPD_RESULT_KEY_BIOS_SETTING_UPPER_BOUND) == 0) {
    fwupd_bios_setting_set_upper_bound(self, fwupd_variant_get_uint64(value));
    return;
  }
  if (g_strcmp0(key, FWUPD_RESULT_KEY_BIOS_SETTING_SCALAR_INCREMENT) == 0) {
    fwupd_bios_setting_set_scalar_increment(self, fwupd_variant_get_uint64(value));
    return;
  }
  if (g_strcmp0(key, FWUPD_RESULT_KEY_BIOS_SETTING_READ_ONLY) == 0) {
    fwupd_bios_setting_set_read_only(self, fwupd_variant_get_boolean(value));
    return;
  }
}

static gboolean
fwupd_bios_setting_from_json(FwupdCodec *codec, FwupdJsonObject *json_obj, GError **error)
{
  FwupdBiosSetting *self = FWUPD_BIOS_SETTING(codec);
  gboolean tmpb = FALSE;
  gint64 tmpi = 0;
  g_autoptr(FwupdJsonArray) json_arr = NULL;

  if (!fwupd_json_object_get_integer_with_default(json_obj,
              FWUPD_RESULT_KEY_BIOS_SETTING_TYPE,
              &tmpi,
              0,
              error))
    return FALSE;
  fwupd_bios_setting_set_kind(self, tmpi);
  fwupd_bios_setting_set_id(
      self,
      fwupd_json_object_get_string(json_obj, FWUPD_RESULT_KEY_BIOS_SETTING_ID, NULL));

  fwupd_bios_setting_set_name(
      self,
      fwupd_json_object_get_string(json_obj, FWUPD_RESULT_KEY_NAME, NULL));
  fwupd_bios_setting_set_description(
      self,
      fwupd_json_object_get_string(json_obj, FWUPD_RESULT_KEY_DESCRIPTION, NULL));
  fwupd_bios_setting_set_path(
      self,
      fwupd_json_object_get_string(json_obj, FWUPD_RESULT_KEY_FILENAME, NULL));
  fwupd_bios_setting_set_current_value(
      self,
      fwupd_json_object_get_string(json_obj,
           FWUPD_RESULT_KEY_BIOS_SETTING_CURRENT_VALUE,
           NULL));
  fwupd_bios_setting_set_filename(
      self,
      fwupd_json_object_get_string(json_obj, FWUPD_RESULT_KEY_BIOS_SETTING_FILENAME, NULL));
  json_arr = fwupd_json_object_get_array(json_obj,
                 FWUPD_RESULT_KEY_BIOS_SETTING_POSSIBLE_VALUES,
                 NULL);
  if (json_arr != NULL) {
    for (guint i = 0; i < fwupd_json_array_get_size(json_arr); i++) {
      const gchar *tmp = fwupd_json_array_get_string(json_arr, i, NULL);
      fwupd_bios_setting_add_possible_value(self, tmp);
    }
  }
  if (!fwupd_json_object_get_integer_with_default(json_obj,
              FWUPD_RESULT_KEY_BIOS_SETTING_LOWER_BOUND,
              &tmpi,
              0,
              error))
    return FALSE;
  fwupd_bios_setting_set_lower_bound(self, tmpi);
  if (!fwupd_json_object_get_integer_with_default(json_obj,
              FWUPD_RESULT_KEY_BIOS_SETTING_UPPER_BOUND,
              &tmpi,
              0,
              error))
    return FALSE;
  fwupd_bios_setting_set_upper_bound(self, tmpi);
  if (!fwupd_json_object_get_integer_with_default(
    json_obj,
    FWUPD_RESULT_KEY_BIOS_SETTING_SCALAR_INCREMENT,
    &tmpi,
    0,
    error))
    return FALSE;
  fwupd_bios_setting_set_scalar_increment(self, tmpi);
  if (!fwupd_json_object_get_boolean_with_default(json_obj,
              FWUPD_RESULT_KEY_BIOS_SETTING_READ_ONLY,
              &tmpb,
              FALSE,
              error))
    return FALSE;
  fwupd_bios_setting_set_read_only(self, tmpb);
  /* success */
  return TRUE;
}

static void
fwupd_bios_setting_add_json(FwupdCodec *codec, FwupdJsonObject *json_obj, FwupdCodecFlags flags)
{
  FwupdBiosSetting *self = FWUPD_BIOS_SETTING(codec);
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);

  if (priv->name != NULL)
    fwupd_json_object_add_string(json_obj, FWUPD_RESULT_KEY_NAME, priv->name);
  if (priv->description != NULL)
    fwupd_json_object_add_string(json_obj,
               FWUPD_RESULT_KEY_DESCRIPTION,
               priv->description);
  if (priv->path != NULL)
    fwupd_json_object_add_string(json_obj, FWUPD_RESULT_KEY_FILENAME, priv->path);
  if (priv->id != NULL)
    fwupd_json_object_add_string(json_obj, FWUPD_RESULT_KEY_BIOS_SETTING_ID, priv->id);
  if (priv->current_value != NULL) {
    fwupd_json_object_add_string(json_obj,
               FWUPD_RESULT_KEY_BIOS_SETTING_CURRENT_VALUE,
               priv->current_value);
  }
  if (priv->value_filename != NULL) {
    fwupd_json_object_add_string(json_obj,
               FWUPD_RESULT_KEY_BIOS_SETTING_FILENAME,
               priv->value_filename);
  }
  fwupd_json_object_add_boolean(json_obj,
              FWUPD_RESULT_KEY_BIOS_SETTING_READ_ONLY,
              priv->read_only);
  fwupd_json_object_add_integer(json_obj, FWUPD_RESULT_KEY_BIOS_SETTING_TYPE, priv->kind);
  if (priv->kind == FWUPD_BIOS_SETTING_KIND_ENUMERATION) {
    if (priv->possible_values->len > 0) {
      g_autoptr(FwupdJsonArray) json_arr = fwupd_json_array_new();
      for (guint i = 0; i < priv->possible_values->len; i++) {
        const gchar *tmp = g_ptr_array_index(priv->possible_values, i);
        fwupd_json_array_add_string(json_arr, tmp);
      }
      fwupd_json_object_add_array(json_obj,
                FWUPD_RESULT_KEY_BIOS_SETTING_POSSIBLE_VALUES,
                json_arr);
    }
  }
  if (priv->kind == FWUPD_BIOS_SETTING_KIND_INTEGER ||
      priv->kind == FWUPD_BIOS_SETTING_KIND_STRING) {
    fwupd_json_object_add_integer(json_obj,
                FWUPD_RESULT_KEY_BIOS_SETTING_LOWER_BOUND,
                priv->lower_bound);
    fwupd_json_object_add_integer(json_obj,
                FWUPD_RESULT_KEY_BIOS_SETTING_UPPER_BOUND,
                priv->upper_bound);
    if (priv->kind == FWUPD_BIOS_SETTING_KIND_INTEGER) {
      fwupd_json_object_add_integer(
          json_obj,
          FWUPD_RESULT_KEY_BIOS_SETTING_SCALAR_INCREMENT,
          priv->scalar_increment);
    }
  }
}

static void
fwupd_bios_setting_add_string(FwupdCodec *codec, guint idt, GString *str)
{
  FwupdBiosSetting *self = FWUPD_BIOS_SETTING(codec);
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);

  fwupd_codec_string_append(str, idt, FWUPD_RESULT_KEY_NAME, priv->name);
  fwupd_codec_string_append(str, idt, FWUPD_RESULT_KEY_BIOS_SETTING_ID, priv->id);
  fwupd_codec_string_append(str, idt, FWUPD_RESULT_KEY_DESCRIPTION, priv->description);
  fwupd_codec_string_append(str, idt, FWUPD_RESULT_KEY_FILENAME, priv->path);
  fwupd_codec_string_append_int(str, idt, FWUPD_RESULT_KEY_BIOS_SETTING_TYPE, priv->kind);
  fwupd_codec_string_append(str,
          idt,
          FWUPD_RESULT_KEY_BIOS_SETTING_CURRENT_VALUE,
          priv->current_value);
  fwupd_codec_string_append(str,
          idt,
          FWUPD_RESULT_KEY_BIOS_SETTING_FILENAME,
          priv->value_filename);
  fwupd_codec_string_append(str,
          idt,
          FWUPD_RESULT_KEY_BIOS_SETTING_READ_ONLY,
          priv->read_only ? "True" : "False");
  if (priv->kind == FWUPD_BIOS_SETTING_KIND_ENUMERATION) {
    for (guint i = 0; i < priv->possible_values->len; i++) {
      const gchar *tmp = g_ptr_array_index(priv->possible_values, i);
      fwupd_codec_string_append(str,
              idt,
              FWUPD_RESULT_KEY_BIOS_SETTING_POSSIBLE_VALUES,
              tmp);
    }
  }
  if (priv->kind == FWUPD_BIOS_SETTING_KIND_INTEGER ||
      priv->kind == FWUPD_BIOS_SETTING_KIND_STRING) {
    fwupd_codec_string_append_int(str,
                idt,
                FWUPD_RESULT_KEY_BIOS_SETTING_LOWER_BOUND,
                priv->lower_bound);
    fwupd_codec_string_append_int(str,
                idt,
                FWUPD_RESULT_KEY_BIOS_SETTING_UPPER_BOUND,
                priv->upper_bound);
    if (priv->kind == FWUPD_BIOS_SETTING_KIND_INTEGER) {
      fwupd_codec_string_append_int(
          str,
          idt,
          FWUPD_RESULT_KEY_BIOS_SETTING_SCALAR_INCREMENT,
          priv->scalar_increment);
    }
  }
}

static void
fwupd_bios_setting_class_init(FwupdBiosSettingClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS(klass);
  object_class->finalize = fwupd_bios_setting_finalize;
}

static void
fwupd_bios_setting_init(FwupdBiosSetting *self)
{
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);
  priv->possible_values = g_ptr_array_new_with_free_func(g_free);
}

static void
fwupd_bios_setting_finalize(GObject *object)
{
  FwupdBiosSetting *self = FWUPD_BIOS_SETTING(object);
  FwupdBiosSettingPrivate *priv = GET_PRIVATE(self);

  g_free(priv->current_value);
  g_free(priv->id);
  g_free(priv->name);
  g_free(priv->description);
  g_free(priv->path);
  g_free(priv->value_filename);
  g_ptr_array_unref(priv->possible_values);

  G_OBJECT_CLASS(fwupd_bios_setting_parent_class)->finalize(object);
}

static void
fwupd_bios_setting_from_variant_iter(FwupdCodec *codec, GVariantIter *iter)
{
  FwupdBiosSetting *self = FWUPD_BIOS_SETTING(codec);
  GVariant *value;
  const gchar *key;
  while (g_variant_iter_next(iter, "{&sv}", &key, &value)) {
    fwupd_bios_setting_from_key_value(self, key, value);
    g_variant_unref(value);
  }
}

static void
fwupd_bios_setting_codec_iface_init(FwupdCodecInterface *iface)
{
  iface->add_string = fwupd_bios_setting_add_string;
  iface->add_json = fwupd_bios_setting_add_json;
  iface->from_json = fwupd_bios_setting_from_json;
  iface->add_variant = fwupd_bios_setting_add_variant;
  iface->from_variant_iter = fwupd_bios_setting_from_variant_iter;
}

/**
 * fwupd_bios_setting_new:
 * @name: (nullable): the attribute name
 * @path: (nullable): the path the driver providing this attribute uses
 *
 * Creates a new bios setting.
 *
 * Returns: a new #FwupdBiosSetting.
 *
 * Since: 1.8.4
 **/
FwupdBiosSetting *
fwupd_bios_setting_new(const gchar *name, const gchar *path)
{
  FwupdBiosSetting *self;

  self = g_object_new(FWUPD_TYPE_BIOS_SETTING, NULL);
  if (name != NULL)
    fwupd_bios_setting_set_name(self, name);
  if (path != NULL)
    fwupd_bios_setting_set_path(self, path);

  return FWUPD_BIOS_SETTING(self);
}

Coverage Report

Created: 2026-06-15 06:54