mirror of
https://git.proxmox.com/git/fwupd
synced 2025-08-04 15:41:16 +00:00
6da96cd04a
The function fu_firmware_add_image() has the comment text 'If an image with the same ID is present it is replaced' which has not been true for some time. This was removed, as the common case of adding two images with no ID would only leave one. However, some plugins do actually want to dedupe on the ID or IDX, so provide a flag they can set which enables this functionality without introducing regressions into other plugins.
109 lines
3.4 KiB
C
109 lines
3.4 KiB
C
/*
|
|
* Copyright (C) 2019 Richard Hughes <richard@hughsie.com>
|
|
*
|
|
* SPDX-License-Identifier: LGPL-2.1+
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <glib-object.h>
|
|
#include <fwupd.h>
|
|
|
|
#include "fu-firmware-image.h"
|
|
|
|
#define FU_TYPE_FIRMWARE (fu_firmware_get_type ())
|
|
G_DECLARE_DERIVABLE_TYPE (FuFirmware, fu_firmware, FU, FIRMWARE, GObject)
|
|
|
|
struct _FuFirmwareClass
|
|
{
|
|
GObjectClass parent_class;
|
|
gboolean (*parse) (FuFirmware *self,
|
|
GBytes *fw,
|
|
guint64 addr_start,
|
|
guint64 addr_end,
|
|
FwupdInstallFlags flags,
|
|
GError **error);
|
|
GBytes *(*write) (FuFirmware *self,
|
|
GError **error);
|
|
void (*to_string) (FuFirmware *self,
|
|
guint indent,
|
|
GString *str);
|
|
gboolean (*tokenize) (FuFirmware *self,
|
|
GBytes *fw,
|
|
FwupdInstallFlags flags,
|
|
GError **error);
|
|
/*< private >*/
|
|
gpointer padding[28];
|
|
};
|
|
|
|
/**
|
|
* FuFirmwareFlags:
|
|
* @FU_FIRMWARE_FLAG_NONE: No flags set
|
|
* @FU_FIRMWARE_FLAG_DEDUPE_ID: Dedupe imges by ID
|
|
* @FU_FIRMWARE_FLAG_DEDUPE_IDX: Dedupe imges by IDX
|
|
*
|
|
* The firmware flags.
|
|
**/
|
|
#define FU_FIRMWARE_FLAG_NONE (0u) /* Since: 1.5.0 */
|
|
#define FU_FIRMWARE_FLAG_DEDUPE_ID (1u << 0) /* Since: 1.5.0 */
|
|
#define FU_FIRMWARE_FLAG_DEDUPE_IDX (1u << 1) /* Since: 1.5.0 */
|
|
typedef guint64 FuFirmwareFlags;
|
|
|
|
const gchar *fu_firmware_flag_to_string (FuFirmwareFlags flag);
|
|
FuFirmwareFlags fu_firmware_flag_from_string (const gchar *flag);
|
|
|
|
FuFirmware *fu_firmware_new (void);
|
|
FuFirmware *fu_firmware_new_from_bytes (GBytes *fw);
|
|
gchar *fu_firmware_to_string (FuFirmware *self);
|
|
const gchar *fu_firmware_get_version (FuFirmware *self);
|
|
void fu_firmware_set_version (FuFirmware *self,
|
|
const gchar *version);
|
|
void fu_firmware_add_flag (FuFirmware *firmware,
|
|
FuFirmwareFlags flag);
|
|
gboolean fu_firmware_has_flag (FuFirmware *firmware,
|
|
FuFirmwareFlags flag);
|
|
|
|
gboolean fu_firmware_tokenize (FuFirmware *self,
|
|
GBytes *fw,
|
|
FwupdInstallFlags flags,
|
|
GError **error);
|
|
gboolean fu_firmware_parse (FuFirmware *self,
|
|
GBytes *fw,
|
|
FwupdInstallFlags flags,
|
|
GError **error);
|
|
gboolean fu_firmware_parse_file (FuFirmware *self,
|
|
GFile *file,
|
|
FwupdInstallFlags flags,
|
|
GError **error);
|
|
gboolean fu_firmware_parse_full (FuFirmware *self,
|
|
GBytes *fw,
|
|
guint64 addr_start,
|
|
guint64 addr_end,
|
|
FwupdInstallFlags flags,
|
|
GError **error);
|
|
GBytes *fu_firmware_write (FuFirmware *self,
|
|
GError **error);
|
|
gboolean fu_firmware_write_file (FuFirmware *self,
|
|
GFile *file,
|
|
GError **error);
|
|
|
|
void fu_firmware_add_image (FuFirmware *self,
|
|
FuFirmwareImage *img);
|
|
GPtrArray *fu_firmware_get_images (FuFirmware *self);
|
|
FuFirmwareImage *fu_firmware_get_image_by_id (FuFirmware *self,
|
|
const gchar *id,
|
|
GError **error);
|
|
GBytes *fu_firmware_get_image_by_id_bytes (FuFirmware *self,
|
|
const gchar *id,
|
|
GError **error);
|
|
FuFirmwareImage *fu_firmware_get_image_by_idx (FuFirmware *self,
|
|
guint64 idx,
|
|
GError **error);
|
|
GBytes *fu_firmware_get_image_by_idx_bytes (FuFirmware *self,
|
|
guint64 idx,
|
|
GError **error);
|
|
FuFirmwareImage *fu_firmware_get_image_default (FuFirmware *self,
|
|
GError **error);
|
|
GBytes *fu_firmware_get_image_default_bytes (FuFirmware *self,
|
|
GError **error);
|