mirror of
https://git.proxmox.com/git/fwupd
synced 2025-05-16 13:54:31 +00:00
153 lines
5.2 KiB
C
153 lines
5.2 KiB
C
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
|
|
*
|
|
* Copyright (C) 2015 Richard Hughes <richard@hughsie.com>
|
|
*
|
|
* Licensed under the GNU Lesser General Public License Version 2.1
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef __DFU_FIRMWARE_H
|
|
#define __DFU_FIRMWARE_H
|
|
|
|
#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;
|
|
/*< private >*/
|
|
/* Padding for future expansion */
|
|
void (*_dfu_firmware_reserved1) (void);
|
|
void (*_dfu_firmware_reserved2) (void);
|
|
void (*_dfu_firmware_reserved3) (void);
|
|
void (*_dfu_firmware_reserved4) (void);
|
|
void (*_dfu_firmware_reserved5) (void);
|
|
void (*_dfu_firmware_reserved6) (void);
|
|
void (*_dfu_firmware_reserved7) (void);
|
|
void (*_dfu_firmware_reserved8) (void);
|
|
void (*_dfu_firmware_reserved9) (void);
|
|
};
|
|
|
|
/**
|
|
* 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_ELF: ELF
|
|
*
|
|
* 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_ELF,
|
|
/*< 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,
|
|
GCancellable *cancellable,
|
|
GError **error);
|
|
|
|
GBytes *dfu_firmware_write_data (DfuFirmware *firmware,
|
|
GError **error);
|
|
gboolean dfu_firmware_write_file (DfuFirmware *firmware,
|
|
GFile *file,
|
|
GCancellable *cancellable,
|
|
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
|
|
|
|
#endif /* __DFU_FIRMWARE_H */
|