mirror of
https://git.proxmox.com/git/fwupd
synced 2025-05-03 07:08:53 +00:00
52441f28a4
This makes a lot more sense; we can parse a firmware and export the same XML we would use in a .builder.xml file. This allows us to two two things: * Check we can round trip from XML -> binary -> XML * Using a .builder.xml file we can check ->write() is endian safe
215 lines
7.4 KiB
C
215 lines
7.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 <xmlb.h>
|
|
|
|
#include "fu-chunk.h"
|
|
#include "fu-firmware.h"
|
|
|
|
#define FU_TYPE_FIRMWARE (fu_firmware_get_type ())
|
|
G_DECLARE_DERIVABLE_TYPE (FuFirmware, fu_firmware, FU, FIRMWARE, GObject)
|
|
|
|
/**
|
|
* FuFirmwareExportFlags:
|
|
* @FU_FIRMWARE_EXPORT_FLAG_NONE: No flags set
|
|
* @FU_FIRMWARE_EXPORT_FLAG_INCLUDE_DEBUG: Include debug information when exporting
|
|
* @FU_FIRMWARE_EXPORT_FLAG_ASCII_DATA: Write the data as UTF-8 strings
|
|
*
|
|
* The firmware export flags.
|
|
**/
|
|
#define FU_FIRMWARE_EXPORT_FLAG_NONE (0u) /* Since: 1.6.0 */
|
|
#define FU_FIRMWARE_EXPORT_FLAG_INCLUDE_DEBUG (1u << 0) /* Since: 1.6.0 */
|
|
#define FU_FIRMWARE_EXPORT_FLAG_ASCII_DATA (1u << 1) /* Since: 1.6.0 */
|
|
typedef guint64 FuFirmwareExportFlags;
|
|
|
|
struct _FuFirmwareClass
|
|
{
|
|
GObjectClass parent_class;
|
|
gboolean (*parse) (FuFirmware *self,
|
|
GBytes *fw,
|
|
guint64 addr_start,
|
|
guint64 addr_end,
|
|
FwupdInstallFlags flags,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
GBytes *(*write) (FuFirmware *self,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
void (*export) (FuFirmware *self,
|
|
FuFirmwareExportFlags flags,
|
|
XbBuilderNode *bn);
|
|
gboolean (*tokenize) (FuFirmware *self,
|
|
GBytes *fw,
|
|
FwupdInstallFlags flags,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
gboolean (*build) (FuFirmware *self,
|
|
XbNode *n,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
gchar *(*get_checksum) (FuFirmware *self,
|
|
GChecksumType csum_kind,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
/*< private >*/
|
|
gpointer padding[26];
|
|
};
|
|
|
|
/**
|
|
* 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
|
|
* @FU_FIRMWARE_FLAG_HAS_CHECKSUM: Has a CRC or checksum to test internal consistency
|
|
* @FU_FIRMWARE_FLAG_HAS_VID_PID: Has a vendor or product ID in the firmware
|
|
*
|
|
* 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 */
|
|
#define FU_FIRMWARE_FLAG_HAS_CHECKSUM (1u << 2) /* Since: 1.5.6 */
|
|
#define FU_FIRMWARE_FLAG_HAS_VID_PID (1u << 3) /* Since: 1.5.6 */
|
|
typedef guint64 FuFirmwareFlags;
|
|
|
|
#define FU_FIRMWARE_ID_PAYLOAD "payload"
|
|
#define FU_FIRMWARE_ID_SIGNATURE "signature"
|
|
#define FU_FIRMWARE_ID_HEADER "header"
|
|
|
|
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);
|
|
FuFirmware *fu_firmware_new_from_gtypes (GBytes *fw,
|
|
FwupdInstallFlags flags,
|
|
GError **error,
|
|
...);
|
|
gchar *fu_firmware_to_string (FuFirmware *self);
|
|
void fu_firmware_export (FuFirmware *self,
|
|
FuFirmwareExportFlags flags,
|
|
XbBuilderNode *bn);
|
|
gchar *fu_firmware_export_to_xml (FuFirmware *self,
|
|
FuFirmwareExportFlags flags,
|
|
GError **error);
|
|
const gchar *fu_firmware_get_version (FuFirmware *self);
|
|
void fu_firmware_set_version (FuFirmware *self,
|
|
const gchar *version);
|
|
guint64 fu_firmware_get_version_raw (FuFirmware *self);
|
|
void fu_firmware_set_version_raw (FuFirmware *self,
|
|
guint64 version_raw);
|
|
void fu_firmware_add_flag (FuFirmware *firmware,
|
|
FuFirmwareFlags flag);
|
|
gboolean fu_firmware_has_flag (FuFirmware *firmware,
|
|
FuFirmwareFlags flag);
|
|
const gchar *fu_firmware_get_filename (FuFirmware *self);
|
|
void fu_firmware_set_filename (FuFirmware *self,
|
|
const gchar *filename);
|
|
const gchar *fu_firmware_get_id (FuFirmware *self);
|
|
void fu_firmware_set_id (FuFirmware *self,
|
|
const gchar *id);
|
|
guint64 fu_firmware_get_addr (FuFirmware *self);
|
|
void fu_firmware_set_addr (FuFirmware *self,
|
|
guint64 addr);
|
|
guint64 fu_firmware_get_offset (FuFirmware *self);
|
|
void fu_firmware_set_offset (FuFirmware *self,
|
|
guint64 offset);
|
|
gsize fu_firmware_get_size (FuFirmware *self);
|
|
void fu_firmware_set_size (FuFirmware *self,
|
|
gsize size);
|
|
guint64 fu_firmware_get_idx (FuFirmware *self);
|
|
void fu_firmware_set_idx (FuFirmware *self,
|
|
guint64 idx);
|
|
GBytes *fu_firmware_get_bytes (FuFirmware *self,
|
|
GError **error);
|
|
void fu_firmware_set_bytes (FuFirmware *self,
|
|
GBytes *bytes);
|
|
guint8 fu_firmware_get_alignment (FuFirmware *self);
|
|
void fu_firmware_set_alignment (FuFirmware *self,
|
|
guint8 alignment);
|
|
void fu_firmware_add_chunk (FuFirmware *self,
|
|
FuChunk *chk);
|
|
GPtrArray *fu_firmware_get_chunks (FuFirmware *self,
|
|
GError **error);
|
|
|
|
gboolean fu_firmware_tokenize (FuFirmware *self,
|
|
GBytes *fw,
|
|
FwupdInstallFlags flags,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
gboolean fu_firmware_build (FuFirmware *self,
|
|
XbNode *n,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
gboolean fu_firmware_build_from_xml (FuFirmware *self,
|
|
const gchar *xml,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
gboolean fu_firmware_parse (FuFirmware *self,
|
|
GBytes *fw,
|
|
FwupdInstallFlags flags,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
gboolean fu_firmware_parse_file (FuFirmware *self,
|
|
GFile *file,
|
|
FwupdInstallFlags flags,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
gboolean fu_firmware_parse_full (FuFirmware *self,
|
|
GBytes *fw,
|
|
guint64 addr_start,
|
|
guint64 addr_end,
|
|
FwupdInstallFlags flags,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
GBytes *fu_firmware_write (FuFirmware *self,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
GBytes *fu_firmware_write_chunk (FuFirmware *self,
|
|
guint64 address,
|
|
guint64 chunk_sz_max,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
gboolean fu_firmware_write_file (FuFirmware *self,
|
|
GFile *file,
|
|
GError **error)
|
|
G_GNUC_WARN_UNUSED_RESULT;
|
|
gchar *fu_firmware_get_checksum (FuFirmware *self,
|
|
GChecksumType csum_kind,
|
|
GError **error);
|
|
|
|
void fu_firmware_add_image (FuFirmware *self,
|
|
FuFirmware *img);
|
|
gboolean fu_firmware_remove_image (FuFirmware *self,
|
|
FuFirmware *img,
|
|
GError **error);
|
|
gboolean fu_firmware_remove_image_by_idx (FuFirmware *self,
|
|
guint64 idx,
|
|
GError **error);
|
|
gboolean fu_firmware_remove_image_by_id (FuFirmware *self,
|
|
const gchar *id,
|
|
GError **error);
|
|
GPtrArray *fu_firmware_get_images (FuFirmware *self);
|
|
FuFirmware *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);
|
|
FuFirmware *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);
|
|
FuFirmware *fu_firmware_get_image_by_checksum (FuFirmware *self,
|
|
const gchar *checksum,
|
|
GError **error);
|