fwupd/libfwupd/fwupd-common.h
Mario Limonciello 4d7585f8ee trivial: promote fwupd_checksum_format_for_display into ABI
This symbol is used by one plugin and so it should be properly
exported.
2021-06-16 08:37:34 +01:00

96 lines
2.6 KiB
C

/*
* Copyright (C) 2015 Richard Hughes <richard@hughsie.com>
*
* SPDX-License-Identifier: LGPL-2.1+
*/
#pragma once
#include <glib.h>
G_BEGIN_DECLS
/**
* FWUPD_DBUS_PATH:
*
* The dbus path
**/
#define FWUPD_DBUS_PATH "/"
/**
* FWUPD_DBUS_SERVICE:
*
* The dbus service
**/
#define FWUPD_DBUS_SERVICE "org.freedesktop.fwupd"
/**
* FWUPD_DBUS_INTERFACE:
*
* The dbus interface
**/
#define FWUPD_DBUS_INTERFACE "org.freedesktop.fwupd"
/**
* FWUPD_DEVICE_ID_ANY:
*
* Wildcard used for matching all device ids in fwupd
**/
#define FWUPD_DEVICE_ID_ANY "*"
/**
* FwupdGuidFlags:
* @FWUPD_GUID_FLAG_NONE: No trust
* @FWUPD_GUID_FLAG_NAMESPACE_MICROSOFT: Use the Microsoft-compatible namespace
* @FWUPD_GUID_FLAG_MIXED_ENDIAN: Use EFI mixed endian representation
*
* The flags to show how the data should be converted.
**/
typedef enum {
FWUPD_GUID_FLAG_NONE = 0, /* Since: 1.2.5 */
FWUPD_GUID_FLAG_NAMESPACE_MICROSOFT = 1 << 0, /* Since: 1.2.5 */
FWUPD_GUID_FLAG_MIXED_ENDIAN = 1 << 1, /* Since: 1.2.5 */
/*< private >*/
FWUPD_GUID_FLAG_LAST
} FwupdGuidFlags;
/* GObject Introspection does not understand typedefs with sizes */
#ifndef __GI_SCANNER__
typedef guint8 fwupd_guid_t[16];
#endif
const gchar *fwupd_checksum_get_best (GPtrArray *checksums);
const gchar *fwupd_checksum_get_by_kind (GPtrArray *checksums,
GChecksumType kind);
GChecksumType fwupd_checksum_guess_kind (const gchar *checksum);
gchar *fwupd_checksum_format_for_display (const gchar *checksum);
gchar *fwupd_build_user_agent (const gchar *package_name,
const gchar *package_version)
G_DEPRECATED_FOR(fwupd_client_set_user_agent_for_package);
gchar *fwupd_build_machine_id (const gchar *salt,
GError **error);
GHashTable *fwupd_get_os_release (GError **error);
gchar *fwupd_build_history_report_json (GPtrArray *devices,
GError **error);
gboolean fwupd_device_id_is_valid (const gchar *device_id);
#ifndef __GI_SCANNER__
gchar *fwupd_guid_to_string (const fwupd_guid_t *guid,
FwupdGuidFlags flags);
gboolean fwupd_guid_from_string (const gchar *guidstr,
fwupd_guid_t *guid,
FwupdGuidFlags flags,
GError **error);
#else
gchar *fwupd_guid_to_string (const guint8 guid[16],
FwupdGuidFlags flags);
gboolean fwupd_guid_from_string (const gchar *guidstr,
guint8 guid[16],
FwupdGuidFlags flags,
GError **error);
#endif
gboolean fwupd_guid_is_valid (const gchar *guid);
gchar *fwupd_guid_hash_string (const gchar *str);
gchar *fwupd_guid_hash_data (const guint8 *data,
gsize datasz,
FwupdGuidFlags flags);
G_END_DECLS