mirror of
https://git.proxmox.com/git/fwupd
synced 2025-05-16 13:54:31 +00:00
122 lines
3.8 KiB
C
122 lines
3.8 KiB
C
/*
|
|
* Copyright (C) 2015-2018 Richard Hughes <richard@hughsie.com>
|
|
*
|
|
* SPDX-License-Identifier: LGPL-2.1+
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <glib-object.h>
|
|
#include <gio/gio.h>
|
|
|
|
#include "dfu-common.h"
|
|
#include "dfu-image.h"
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define DFU_TYPE_FIRMWARE (dfu_firmware_get_type ())
|
|
G_DECLARE_DERIVABLE_TYPE (DfuFirmware, dfu_firmware, DFU, FIRMWARE, GObject)
|
|
|
|
struct _DfuFirmwareClass
|
|
{
|
|
GObjectClass parent_class;
|
|
};
|
|
|
|
/**
|
|
* DfuFirmwareParseFlags:
|
|
* @DFU_FIRMWARE_PARSE_FLAG_NONE: No flags set
|
|
* @DFU_FIRMWARE_PARSE_FLAG_NO_CRC_TEST: Do not verify the CRC
|
|
* @DFU_FIRMWARE_PARSE_FLAG_NO_VERSION_TEST: Do not verify the DFU version
|
|
* @DFU_FIRMWARE_PARSE_FLAG_NO_METADATA: Do not read the metadata table
|
|
*
|
|
* The optional flags used for parsing.
|
|
**/
|
|
typedef enum {
|
|
DFU_FIRMWARE_PARSE_FLAG_NONE = 0,
|
|
DFU_FIRMWARE_PARSE_FLAG_NO_CRC_TEST = (1 << 0),
|
|
DFU_FIRMWARE_PARSE_FLAG_NO_VERSION_TEST = (1 << 1),
|
|
DFU_FIRMWARE_PARSE_FLAG_NO_METADATA = (1 << 2),
|
|
/*< private >*/
|
|
DFU_FIRMWARE_PARSE_FLAG_LAST
|
|
} DfuFirmwareParseFlags;
|
|
|
|
/**
|
|
* DfuFirmwareFormat:
|
|
* @DFU_FIRMWARE_FORMAT_UNKNOWN: Format unknown
|
|
* @DFU_FIRMWARE_FORMAT_RAW: Raw format
|
|
* @DFU_FIRMWARE_FORMAT_DFU: DFU footer
|
|
* @DFU_FIRMWARE_FORMAT_DFUSE: DfuSe header
|
|
* @DFU_FIRMWARE_FORMAT_INTEL_HEX: Intel HEX
|
|
* @DFU_FIRMWARE_FORMAT_SREC: Motorola S-record
|
|
*
|
|
* The known versions of the DFU standard in BCD format.
|
|
**/
|
|
typedef enum {
|
|
DFU_FIRMWARE_FORMAT_UNKNOWN,
|
|
DFU_FIRMWARE_FORMAT_RAW,
|
|
DFU_FIRMWARE_FORMAT_DFU,
|
|
DFU_FIRMWARE_FORMAT_DFUSE,
|
|
DFU_FIRMWARE_FORMAT_INTEL_HEX,
|
|
DFU_FIRMWARE_FORMAT_SREC,
|
|
/*< private >*/
|
|
DFU_FIRMWARE_FORMAT_LAST
|
|
} DfuFirmwareFormat;
|
|
|
|
DfuFirmware *dfu_firmware_new (void);
|
|
|
|
const gchar *dfu_firmware_format_to_string (DfuFirmwareFormat format);
|
|
DfuFirmwareFormat dfu_firmware_format_from_string(const gchar *format);
|
|
|
|
DfuImage *dfu_firmware_get_image (DfuFirmware *firmware,
|
|
guint8 alt_setting);
|
|
DfuImage *dfu_firmware_get_image_by_name (DfuFirmware *firmware,
|
|
const gchar *name);
|
|
DfuImage *dfu_firmware_get_image_default (DfuFirmware *firmware);
|
|
GPtrArray *dfu_firmware_get_images (DfuFirmware *firmware);
|
|
guint16 dfu_firmware_get_vid (DfuFirmware *firmware);
|
|
guint16 dfu_firmware_get_pid (DfuFirmware *firmware);
|
|
guint16 dfu_firmware_get_release (DfuFirmware *firmware);
|
|
guint16 dfu_firmware_get_format (DfuFirmware *firmware);
|
|
guint32 dfu_firmware_get_size (DfuFirmware *firmware);
|
|
DfuCipherKind dfu_firmware_get_cipher_kind (DfuFirmware *firmware);
|
|
|
|
void dfu_firmware_add_image (DfuFirmware *firmware,
|
|
DfuImage *image);
|
|
void dfu_firmware_set_vid (DfuFirmware *firmware,
|
|
guint16 vid);
|
|
void dfu_firmware_set_pid (DfuFirmware *firmware,
|
|
guint16 pid);
|
|
void dfu_firmware_set_release (DfuFirmware *firmware,
|
|
guint16 release);
|
|
void dfu_firmware_set_format (DfuFirmware *firmware,
|
|
DfuFirmwareFormat format);
|
|
void dfu_firmware_set_cipher_kind (DfuFirmware *firmware,
|
|
DfuCipherKind cipher_kind);
|
|
|
|
gboolean dfu_firmware_parse_data (DfuFirmware *firmware,
|
|
GBytes *bytes,
|
|
DfuFirmwareParseFlags flags,
|
|
GError **error);
|
|
gboolean dfu_firmware_parse_file (DfuFirmware *firmware,
|
|
GFile *file,
|
|
DfuFirmwareParseFlags flags,
|
|
GError **error);
|
|
|
|
GBytes *dfu_firmware_write_data (DfuFirmware *firmware,
|
|
GError **error);
|
|
gboolean dfu_firmware_write_file (DfuFirmware *firmware,
|
|
GFile *file,
|
|
GError **error);
|
|
gchar *dfu_firmware_to_string (DfuFirmware *firmware);
|
|
|
|
GHashTable *dfu_firmware_get_metadata_table(DfuFirmware *firmware);
|
|
const gchar *dfu_firmware_get_metadata (DfuFirmware *firmware,
|
|
const gchar *key);
|
|
void dfu_firmware_set_metadata (DfuFirmware *firmware,
|
|
const gchar *key,
|
|
const gchar *value);
|
|
void dfu_firmware_remove_metadata (DfuFirmware *firmware,
|
|
const gchar *key);
|
|
|
|
G_END_DECLS
|