Class

FwupdPluginPlugin

Description [src]

class FwupdPlugin.Plugin : Fwupd.Plugin {
  parent_instance: FwupdPlugin
}

A plugin which is used by fwupd to enumerate and update devices.

See also: FuDevice, FwupdPlugin

Hierarchy

hierarchy this FuPlugin ancestor_0 FwupdPlugin ancestor_0--this ancestor_1 GObject ancestor_1--ancestor_0

Ancestors

Constructors

fu_plugin_new

Creates a new FuPlugin.

Available since: 0.8.0

Functions

fu_plugin_guess_name_from_fn

Tries to guess the name of the plugin from a filename.

Available since: 1.0.8

Instance methods

fu_plugin_add_device_gtype

Adds the device GType which is used when creating devices.

Available since: 1.6.0

fu_plugin_add_firmware_gtype

Adds a firmware GType which is used when creating devices. If id is not specified then it is guessed using the GType name.

Available since: 1.3.3

fu_plugin_add_report_metadata

Sets any additional metadata to be included in the firmware report to aid debugging problems.

Available since: 1.0.4

fu_plugin_add_rule

If the plugin name is found, the rule will be used to sort the plugin list, for example the plugin specified by name will be ordered after this plugin when FU_PLUGIN_RULE_RUN_AFTER is used.

Available since: 1.0.0

fu_plugin_add_udev_subsystem

Registers the udev subsystem to be watched by the daemon.

Available since: 1.6.2

fu_plugin_alloc_data

Allocates the per-plugin allocated private data.

Available since: 0.8.0

fu_plugin_cache_add

Adds an object to the per-plugin cache.

Available since: 0.8.0

fu_plugin_cache_lookup

Finds an object in the per-plugin cache.

Available since: 0.8.0

fu_plugin_cache_remove

Removes an object from the per-plugin cache.

Available since: 0.8.0

fu_plugin_device_add

Asks the daemon to add a device to the exported list. If this device ID has already been added by a different plugin then this request will be ignored.

Available since: 0.8.0

fu_plugin_device_register

Registers the device with other plugins so they can set metadata.

Available since: 0.9.7

fu_plugin_device_remove

Asks the daemon to remove a device from the exported list.

Available since: 0.8.0

fu_plugin_get_build_hash

Gets the build hash a plugin was generated with.

Available since: 1.2.4

fu_plugin_get_config_value

Return the value of a key if it’s been configured.

Available since: 1.0.6

fu_plugin_get_config_value_boolean

Return the boolean value of a key if it’s been configured.

Available since: 1.4.0

fu_plugin_get_context

Gets the context for a plugin.

Available since: 1.6.0

fu_plugin_get_data

Gets the per-plugin allocated private data. This will return NULL unless fu_plugin_alloc_data() has been called by the plugin.

Available since: 0.8.0

fu_plugin_get_devices

Returns all devices added by the plugin using fu_plugin_device_add() and not yet removed with fu_plugin_device_remove().

Available since: 1.5.6

fu_plugin_get_name

Gets the plugin name.

Available since: 0.8.0

fu_plugin_get_order

Gets the plugin order, where higher numbers are run after lower numbers.

Available since: 1.0.0

fu_plugin_get_priority

Gets the plugin priority, where higher numbers are better.

Available since: 1.1.1

fu_plugin_get_report_metadata

Returns the list of additional metadata to be added when filing a report.

Available since: 1.0.4

fu_plugin_get_rules

Gets the plugin IDs that should be run after this plugin.

Available since: 1.0.0

fu_plugin_has_custom_flag

Returns if a per-plugin HwId custom flag exists, typically added from a DMI quirk.

Available since: 1.3.1

fu_plugin_has_rule

Gets the plugin IDs that should be run after this plugin.

Available since: 1.0.0

fu_plugin_is_open

Determines if the plugin is opened.

Available since: 1.3.5

fu_plugin_name_compare

Compares two plugins by their names.

Available since: 1.0.8

fu_plugin_open

Opens the plugin module, and calls ->load() on it.

Available since: 0.8.0

fu_plugin_order_compare

Compares two plugins by their depsolved order, and then by name.

Available since: 1.0.8

fu_plugin_runner_activate

Call into the plugin’s activate routine.

Available since: 1.2.6

fu_plugin_runner_add_security_attrs

Runs the add_security_attrs() routine for the plugin.

Available since: 1.5.0

fu_plugin_runner_attach

Runs the update_attach routine for the plugin.

Available since: 1.7.0

fu_plugin_runner_backend_device_added

Call the backend_device_added routine for the plugin.

Available since: 1.5.6

fu_plugin_runner_backend_device_changed

Call the backend_device_changed routine for the plugin.

Available since: 1.5.6

fu_plugin_runner_cleanup

Runs the update_cleanup routine for the plugin.

Available since: 1.7.0

fu_plugin_runner_clear_results

Call into the plugin’s clear results routine.

Available since: 0.8.0

fu_plugin_runner_coldplug

Runs the coldplug routine for the plugin.

Available since: 0.8.0

fu_plugin_runner_composite_cleanup

Runs the composite_cleanup routine for the plugin.

Available since: 1.0.9

fu_plugin_runner_composite_prepare

Runs the composite_prepare routine for the plugin.

Available since: 1.0.9

fu_plugin_runner_detach

Runs the update_detach routine for the plugin.

Available since: 1.7.0

fu_plugin_runner_device_added

Call the device_added routine for the plugin.

Available since: 1.5.0

fu_plugin_runner_device_created

Call the device_created routine for the plugin.

Available since: 1.4.0

fu_plugin_runner_device_register

Call the device_registered routine for the plugin.

Available since: 0.9.7

fu_plugin_runner_device_removed

Call the device_removed routine for the plugin.

Available since: 1.1.2

fu_plugin_runner_get_results

Call into the plugin’s get results routine.

Available since: 0.8.0

fu_plugin_runner_init

Runs the init routine for the plugin, if enabled.

Available since: 1.8.1

fu_plugin_runner_prepare

Runs the update_prepare routine for the plugin.

Available since: 1.7.0

fu_plugin_runner_reload

Runs reload routine for a device.

Available since: 1.7.0

fu_plugin_runner_startup

Runs the startup routine for the plugin.

Available since: 0.8.0

fu_plugin_runner_unlock

Call into the plugin’s unlock routine.

Available since: 0.8.0

fu_plugin_runner_verify

Call into the plugin’s verify routine.

Available since: 0.8.0

fu_plugin_runner_write_firmware

Call into the plugin’s write firmware routine.

Available since: 1.7.0

fu_plugin_set_config_value

Sets a plugin config value.

Available since: 1.7.0

fu_plugin_set_name

Sets the plugin name.

Available since: 0.8.0

fu_plugin_set_order

Sets the plugin order, where higher numbers are run after lower numbers.

Available since: 1.0.0

fu_plugin_set_priority

Sets the plugin priority, where higher numbers are better.

Available since: 1.0.0

fu_plugin_set_secure_config_value

Sets a plugin config file value and updates file so that non-privileged users cannot read it.

Available since: 1.7.4

Methods inherited from FwupdPlugin (10)
fwupd_plugin_add_flag

Adds a specific plugin flag to the plugin.

Available since: 1.5.0

fwupd_plugin_get_flags

Gets the plugin flags.

Available since: 1.5.0

fwupd_plugin_get_name

Gets the plugin name.

Available since: 1.5.0

fwupd_plugin_has_flag

Finds if the plugin has a specific plugin flag.

Available since: 1.5.0

fwupd_plugin_remove_flag

Removes a specific plugin flag from the plugin.

Available since: 1.5.0

fwupd_plugin_set_flags

Sets the plugin flags.

Available since: 1.5.0

fwupd_plugin_set_name

Sets the plugin name.

Available since: 1.5.0

fwupd_plugin_to_json

Adds a fwupd plugin to a JSON builder.

Available since: 1.5.0

fwupd_plugin_to_string

Builds a text representation of the object.

Available since: 1.5.0

fwupd_plugin_to_variant

Serialize the plugin data omitting sensitive fields.

Available since: 1.5.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Properties inherited from FwupdPlugin (2)
Fwupd.Plugin:flags

The plugin flags.

Available since: 1.5.0

Fwupd.Plugin:name

The plugin name.

Available since: 1.5.0

Signals

FwupdPlugin.Plugin::check-supported

The ::check-supported signal is emitted when a plugin wants to ask the daemon if a specific device GUID is supported in the existing system metadata.

Available since: 1.0.0

FwupdPlugin.Plugin::config-changed

The ::config-changed signal is emitted when one or more config files have changed which may affect how the daemon should be run.

Available since: 1.7.0

FwupdPlugin.Plugin::device-added

The ::device-added signal is emitted when a device has been added by the plugin.

Available since: 0.8.0

FwupdPlugin.Plugin::device-register

The ::device-register signal is emitted when another plugin has added the device.

Available since: 0.9.7

FwupdPlugin.Plugin::device-removed

The ::device-removed signal is emitted when a device has been removed by the plugin.

Available since: 0.8.0

FwupdPlugin.Plugin::rules-changed
No description available.
Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct FwupdPluginPluginClass {
  FwupdPluginClass parent_class;
  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 (* device_register) (
    FuPlugin* self,
    FuDevice* device
  );
  gboolean (* check_supported) (
    FuPlugin* self,
    const gchar* guid
  );
  void (* rules_changed) (
    FuPlugin* self
  );
  void (* config_changed) (
    FuPlugin* self
  );
  
}
Class members
parent_class
FwupdPluginClass
  No description available.
device_added
void (* device_added) (
    FuPlugin* self,
    FuDevice* device
  )
  No description available.
device_removed
void (* device_removed) (
    FuPlugin* self,
    FuDevice* device
  )
  No description available.
status_changed
void (* status_changed) (
    FuPlugin* self,
    FwupdStatus status
  )
  No description available.
percentage_changed
void (* percentage_changed) (
    FuPlugin* self,
    guint percentage
  )
  No description available.
device_register
void (* device_register) (
    FuPlugin* self,
    FuDevice* device
  )
  No description available.
check_supported
gboolean (* check_supported) (
    FuPlugin* self,
    const gchar* guid
  )
  No description available.
rules_changed
void (* rules_changed) (
    FuPlugin* self
  )
  No description available.
config_changed
void (* config_changed) (
    FuPlugin* self
  )
  No description available.

Virtual methods

FwupdPlugin.PluginClass.check_supported
No description available.
FwupdPlugin.PluginClass.config_changed
No description available.
FwupdPlugin.PluginClass.device_added
No description available.
FwupdPlugin.PluginClass.device_register

Registers the device with other plugins so they can set metadata.

Available since: 0.9.7

FwupdPlugin.PluginClass.device_removed
No description available.
FwupdPlugin.PluginClass.percentage_changed
No description available.
FwupdPlugin.PluginClass.rules_changed
No description available.
FwupdPlugin.PluginClass.status_changed
No description available.