mirror of
https://git.proxmox.com/git/fwupd
synced 2025-05-09 18:17:54 +00:00
7bcb8d4385
For instance, we can tell the user that UEFI UpdateCapsule is disabled in the system firmware, or that efivarfs is not mounted. This is much better than creating "dummy" devices which are really just hacks around the problem because no better API existed. THe dummy devices cause as many problems as they solve. Plugins have to set FWUPD_PLUGIN_FLAG_USER_WARNING if a warning should be shown to the user, and only one warning will be shown of each failure type. It is expected that GUI clients like gnome-software and gnome-firmware would use this API to notify the user the localized message for why firmware updates are not being shown. Fixes https://github.com/fwupd/fwupd/issues/2456
174 lines
5.7 KiB
C
174 lines
5.7 KiB
C
/*
|
|
* Copyright (C) 2015 Richard Hughes <richard@hughsie.com>
|
|
*
|
|
* SPDX-License-Identifier: LGPL-2.1+
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <gio/gio.h>
|
|
#include <gusb.h>
|
|
|
|
#include "fu-common.h"
|
|
#include "fu-common-guid.h"
|
|
#include "fu-common-version.h"
|
|
#include "fu-device.h"
|
|
#include "fu-device-locker.h"
|
|
#include "fu-quirks.h"
|
|
#include "fu-hwids.h"
|
|
#include "fu-usb-device.h"
|
|
//#include "fu-hid-device.h"
|
|
#ifdef HAVE_GUDEV
|
|
#include "fu-udev-device.h"
|
|
#endif
|
|
#include "fwupd-common.h"
|
|
#include "fwupd-plugin.h"
|
|
|
|
#define FU_TYPE_PLUGIN (fu_plugin_get_type ())
|
|
G_DECLARE_DERIVABLE_TYPE (FuPlugin, fu_plugin, FU, PLUGIN, FwupdPlugin)
|
|
|
|
#define fu_plugin_get_flags(p) fwupd_plugin_get_flags(FWUPD_PLUGIN(p))
|
|
#define fu_plugin_has_flag(p,f) fwupd_plugin_has_flag(FWUPD_PLUGIN(p),f)
|
|
#define fu_plugin_add_flag(p,f) fwupd_plugin_add_flag(FWUPD_PLUGIN(p),f)
|
|
|
|
struct _FuPluginClass
|
|
{
|
|
FwupdPluginClass parent_class;
|
|
/* signals */
|
|
void (* device_added) (FuPlugin *self,
|
|
FuDevice *device);
|
|
void (* device_removed) (FuPlugin *self,
|
|
FuDevice *device);
|
|
void (* status_changed) (FuPlugin *self,
|
|
FwupdStatus status);
|
|
void (* percentage_changed) (FuPlugin *self,
|
|
guint percentage);
|
|
void (* recoldplug) (FuPlugin *self);
|
|
void (* set_coldplug_delay) (FuPlugin *self,
|
|
guint duration);
|
|
void (* device_register) (FuPlugin *self,
|
|
FuDevice *device);
|
|
gboolean (* check_supported) (FuPlugin *self,
|
|
const gchar *guid);
|
|
void (* rules_changed) (FuPlugin *self);
|
|
gboolean (* add_firmware_gtype) (FuPlugin *self,
|
|
const gchar *id,
|
|
GType gtype);
|
|
void (* security_changed) (FuPlugin *self);
|
|
/*< private >*/
|
|
gpointer padding[20];
|
|
};
|
|
|
|
/**
|
|
* FuPluginVerifyFlags:
|
|
* @FU_PLUGIN_VERIFY_FLAG_NONE: No flags set
|
|
*
|
|
* Flags used when verifying, currently unused.
|
|
**/
|
|
typedef enum {
|
|
FU_PLUGIN_VERIFY_FLAG_NONE = 0,
|
|
/*< private >*/
|
|
FU_PLUGIN_VERIFY_FLAG_LAST
|
|
} FuPluginVerifyFlags;
|
|
|
|
/**
|
|
* FuPluginRule:
|
|
* @FU_PLUGIN_RULE_CONFLICTS: The plugin conflicts with another
|
|
* @FU_PLUGIN_RULE_RUN_AFTER: Order the plugin after another
|
|
* @FU_PLUGIN_RULE_RUN_BEFORE: Order the plugin before another
|
|
* @FU_PLUGIN_RULE_BETTER_THAN: Is better than another plugin
|
|
* @FU_PLUGIN_RULE_INHIBITS_IDLE: The plugin inhibits the idle shutdown
|
|
* @FU_PLUGIN_RULE_METADATA_SOURCE: Uses another plugin as a source of report metadata
|
|
*
|
|
* The rules used for ordering plugins.
|
|
* Plugins are expected to add rules in fu_plugin_initialize().
|
|
**/
|
|
typedef enum {
|
|
FU_PLUGIN_RULE_CONFLICTS,
|
|
FU_PLUGIN_RULE_RUN_AFTER,
|
|
FU_PLUGIN_RULE_RUN_BEFORE,
|
|
FU_PLUGIN_RULE_BETTER_THAN,
|
|
FU_PLUGIN_RULE_INHIBITS_IDLE,
|
|
FU_PLUGIN_RULE_METADATA_SOURCE, /* Since: 1.3.6 */
|
|
/*< private >*/
|
|
FU_PLUGIN_RULE_LAST
|
|
} FuPluginRule;
|
|
|
|
typedef struct FuPluginData FuPluginData;
|
|
|
|
/* for plugins to use */
|
|
const gchar *fu_plugin_get_name (FuPlugin *self);
|
|
FuPluginData *fu_plugin_get_data (FuPlugin *self);
|
|
FuPluginData *fu_plugin_alloc_data (FuPlugin *self,
|
|
gsize data_sz);
|
|
gboolean fu_plugin_get_enabled (FuPlugin *self)
|
|
G_DEPRECATED_FOR(fu_plugin_has_flag);
|
|
void fu_plugin_set_enabled (FuPlugin *self,
|
|
gboolean enabled)
|
|
G_DEPRECATED_FOR(fu_plugin_add_flag);
|
|
void fu_plugin_set_build_hash (FuPlugin *self,
|
|
const gchar *build_hash);
|
|
GUsbContext *fu_plugin_get_usb_context (FuPlugin *self);
|
|
void fu_plugin_device_add (FuPlugin *self,
|
|
FuDevice *device);
|
|
void fu_plugin_device_remove (FuPlugin *self,
|
|
FuDevice *device);
|
|
void fu_plugin_device_register (FuPlugin *self,
|
|
FuDevice *device);
|
|
void fu_plugin_request_recoldplug (FuPlugin *self);
|
|
void fu_plugin_security_changed (FuPlugin *self);
|
|
void fu_plugin_set_coldplug_delay (FuPlugin *self,
|
|
guint duration);
|
|
void fu_plugin_set_device_gtype (FuPlugin *self,
|
|
GType device_gtype);
|
|
void fu_plugin_add_firmware_gtype (FuPlugin *self,
|
|
const gchar *id,
|
|
GType gtype);
|
|
gpointer fu_plugin_cache_lookup (FuPlugin *self,
|
|
const gchar *id);
|
|
void fu_plugin_cache_remove (FuPlugin *self,
|
|
const gchar *id);
|
|
void fu_plugin_cache_add (FuPlugin *self,
|
|
const gchar *id,
|
|
gpointer dev);
|
|
gboolean fu_plugin_check_hwid (FuPlugin *self,
|
|
const gchar *hwid);
|
|
gchar *fu_plugin_get_hwid_replace_value (FuPlugin *self,
|
|
const gchar *keys,
|
|
GError **error);
|
|
GPtrArray *fu_plugin_get_hwids (FuPlugin *self);
|
|
const gchar *fu_plugin_get_dmi_value (FuPlugin *self,
|
|
const gchar *dmi_id);
|
|
const gchar *fu_plugin_get_smbios_string (FuPlugin *self,
|
|
guint8 structure_type,
|
|
guint8 offset);
|
|
GBytes *fu_plugin_get_smbios_data (FuPlugin *self,
|
|
guint8 structure_type);
|
|
void fu_plugin_add_rule (FuPlugin *self,
|
|
FuPluginRule rule,
|
|
const gchar *name);
|
|
void fu_plugin_add_udev_subsystem (FuPlugin *self,
|
|
const gchar *subsystem);
|
|
FuQuirks *fu_plugin_get_quirks (FuPlugin *self);
|
|
const gchar *fu_plugin_lookup_quirk_by_id (FuPlugin *self,
|
|
const gchar *group,
|
|
const gchar *key);
|
|
guint64 fu_plugin_lookup_quirk_by_id_as_uint64 (FuPlugin *self,
|
|
const gchar *group,
|
|
const gchar *key);
|
|
void fu_plugin_add_report_metadata (FuPlugin *self,
|
|
const gchar *key,
|
|
const gchar *value);
|
|
gchar *fu_plugin_get_config_value (FuPlugin *self,
|
|
const gchar *key);
|
|
gboolean fu_plugin_get_config_value_boolean (FuPlugin *self,
|
|
const gchar *key);
|
|
void fu_plugin_add_runtime_version (FuPlugin *self,
|
|
const gchar *component_id,
|
|
const gchar *version);
|
|
void fu_plugin_add_compile_version (FuPlugin *self,
|
|
const gchar *component_id,
|
|
const gchar *version);
|
|
gboolean fu_plugin_has_custom_flag (FuPlugin *self,
|
|
const gchar *flag);
|