fwupd/libfwupd/fwupd-enums-private.h
Richard Hughes 19abf996c7 Allow the daemon to request interactive action from the end user
The "return error and hope the client resubmits the firmware again"
pattern is clunky. There are two plugins doing this now, and about to
be one more.

This adds FwupdRequest which provides a structured way of asking the
user to perform an action, e.g. to replug the device or to press a
special key or button.

This replaces much of the UpdateMessage and UpdateImage API although
it is still used internally. Clients capable of processing the new
DeviceRequest signal should add REQUESTS to their feature flags.

Also, this allows us go back to the old meaning of _NEEDS_BOOTLOADER,
which was "needs rebooting into a bootloader mode" rather than the
slightly weird "user needs to do something and resubmit request".
2021-07-14 17:03:50 +01:00

463 lines
11 KiB
C

/*
* Copyright (C) 2016 Richard Hughes <richard@hughsie.com>
*
* SPDX-License-Identifier: LGPL-2.1+
*/
#pragma once
#include <glib.h>
G_BEGIN_DECLS
/**
* FWUPD_RESULT_KEY_APPSTREAM_ID:
*
* Result key to represent AppstreamId
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_APPSTREAM_ID "AppstreamId"
/**
* FWUPD_RESULT_KEY_CHECKSUM:
*
* Result key to represent Checksum
*
* The D-Bus type signature string is 'as' i.e. an array of strings.
**/
#define FWUPD_RESULT_KEY_CHECKSUM "Checksum"
/**
* FWUPD_RESULT_KEY_CREATED:
*
* Result key to represent Created
*
* The D-Bus type signature string is 't' i.e. a unsigned 64 bit integer.
**/
#define FWUPD_RESULT_KEY_CREATED "Created"
/**
* FWUPD_RESULT_KEY_DESCRIPTION:
*
* Result key to represent Description
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_DESCRIPTION "Description"
/**
* FWUPD_RESULT_KEY_DETACH_CAPTION:
*
* Result key to represent DetachCaption
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_DETACH_CAPTION "DetachCaption"
/**
* FWUPD_RESULT_KEY_DETACH_IMAGE:
*
* Result key to represent DetachImage
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_DETACH_IMAGE "DetachImage"
/**
* FWUPD_RESULT_KEY_DEVICE_ID:
*
* Result key to represent DeviceId
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_DEVICE_ID "DeviceId"
/**
* FWUPD_RESULT_KEY_PARENT_DEVICE_ID:
*
* Result key to represent ParentDeviceId
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_PARENT_DEVICE_ID "ParentDeviceId"
/**
* FWUPD_RESULT_KEY_COMPOSITE_ID:
*
* Result key to represent CompositeId
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_COMPOSITE_ID "CompositeId"
/**
* FWUPD_RESULT_KEY_FILENAME:
*
* Result key to represent Filename
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_FILENAME "Filename"
/**
* FWUPD_RESULT_KEY_PROTOCOL:
*
* Result key to represent Protocol
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_PROTOCOL "Protocol"
/**
* FWUPD_RESULT_KEY_CATEGORIES:
*
* Result key to represent Categories
*
* The D-Bus type signature string is 'as' i.e. an array of strings.
**/
#define FWUPD_RESULT_KEY_CATEGORIES "Categories"
/**
* FWUPD_RESULT_KEY_ISSUES:
*
* Result key to represent Issues
*
* The D-Bus type signature string is 'as' i.e. an array of strings.
**/
#define FWUPD_RESULT_KEY_ISSUES "Issues"
/**
* FWUPD_RESULT_KEY_FLAGS:
*
* Result key to represent Flags
*
* The D-Bus type signature string is 't' i.e. a unsigned 64 bit integer.
**/
#define FWUPD_RESULT_KEY_FLAGS "Flags"
/**
* FWUPD_RESULT_KEY_FLASHES_LEFT:
*
* Result key to represent FlashesLeft
*
* The D-Bus type signature string is 'u' i.e. a unsigned 32 bit integer.
**/
#define FWUPD_RESULT_KEY_FLASHES_LEFT "FlashesLeft"
/**
* FWUPD_RESULT_KEY_URGENCY:
*
* Result key to represent Urgency
*
* The D-Bus type signature string is 'u' i.e. a unsigned 32 bit integer.
**/
#define FWUPD_RESULT_KEY_URGENCY "Urgency"
/**
* FWUPD_RESULT_KEY_REQUEST_KIND:
*
* Result key to represent RequestKind
*
* The D-Bus type signature string is 'u' i.e. a unsigned 32 bit integer.
**/
#define FWUPD_RESULT_KEY_REQUEST_KIND "RequestKind"
/**
* FWUPD_RESULT_KEY_HSI_LEVEL:
*
* Result key to represent HsiLevel
*
* The D-Bus type signature string is 'u' i.e. a unsigned 32 bit integer.
**/
#define FWUPD_RESULT_KEY_HSI_LEVEL "HsiLevel"
/**
* FWUPD_RESULT_KEY_HSI_RESULT:
*
* Result key to represent HsiResult
*
* The D-Bus type signature string is 'u' i.e. a unsigned 32 bit integer.
**/
#define FWUPD_RESULT_KEY_HSI_RESULT "HsiResult"
/**
* FWUPD_RESULT_KEY_INSTALL_DURATION:
*
* Result key to represent InstallDuration
*
* The D-Bus type signature string is 'u' i.e. a unsigned 32 bit integer.
**/
#define FWUPD_RESULT_KEY_INSTALL_DURATION "InstallDuration"
/**
* FWUPD_RESULT_KEY_GUID:
*
* Result key to represent Guid
*
* The D-Bus type signature string is 'as' i.e. an array of strings.
**/
#define FWUPD_RESULT_KEY_GUID "Guid"
/**
* FWUPD_RESULT_KEY_INSTANCE_IDS:
*
* Result key to represent InstanceIds
*
* The D-Bus type signature string is 'as' i.e. an array of strings.
**/
#define FWUPD_RESULT_KEY_INSTANCE_IDS "InstanceIds"
/**
* FWUPD_RESULT_KEY_HOMEPAGE:
*
* Result key to represent Homepage
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_HOMEPAGE "Homepage"
/**
* FWUPD_RESULT_KEY_DETAILS_URL:
*
* Result key to represent DetailsUrl
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_DETAILS_URL "DetailsUrl"
/**
* FWUPD_RESULT_KEY_SOURCE_URL:
*
* Result key to represent SourceUrl
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_SOURCE_URL "SourceUrl"
/**
* FWUPD_RESULT_KEY_ICON:
*
* Result key to represent Icon
*
* The D-Bus type signature string is 'as' i.e. an array of strings.
**/
#define FWUPD_RESULT_KEY_ICON "Icon"
/**
* FWUPD_RESULT_KEY_LICENSE:
*
* Result key to represent License
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_LICENSE "License"
/**
* FWUPD_RESULT_KEY_MODIFIED:
*
* Result key to represent Modified
*
* The D-Bus type signature string is 't' i.e. a unsigned 64 bit integer.
**/
#define FWUPD_RESULT_KEY_MODIFIED "Modified"
/**
* FWUPD_RESULT_KEY_VERSION_BUILD_DATE:
*
* Result key to represent VersionBuildDate
*
* The D-Bus type signature string is 't' i.e. a unsigned 64 bit integer.
**/
#define FWUPD_RESULT_KEY_VERSION_BUILD_DATE "VersionBuildDate"
/**
* FWUPD_RESULT_KEY_METADATA:
*
* Result key to represent Metadata
*
* The D-Bus type signature string is 'a{ss}' i.e. a string dictionary.
**/
#define FWUPD_RESULT_KEY_METADATA "Metadata"
/**
* FWUPD_RESULT_KEY_NAME:
*
* Result key to represent Name
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_NAME "Name"
/**
* FWUPD_RESULT_KEY_NAME_VARIANT_SUFFIX:
*
* Result key to represent NameVariantSuffix
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_NAME_VARIANT_SUFFIX "NameVariantSuffix"
/**
* FWUPD_RESULT_KEY_PLUGIN:
*
* Result key to represent Plugin
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_PLUGIN "Plugin"
/**
* FWUPD_RESULT_KEY_RELEASE:
*
* Result key to represent Release
*
* The D-Bus type signature string is 'a{sv}' i.e. a variant dictionary.
**/
#define FWUPD_RESULT_KEY_RELEASE "Release"
/**
* FWUPD_RESULT_KEY_REMOTE_ID:
*
* Result key to represent RemoteId
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_REMOTE_ID "RemoteId"
/**
* FWUPD_RESULT_KEY_SERIAL:
*
* Result key to represent Serial
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_SERIAL "Serial"
/**
* FWUPD_RESULT_KEY_SIZE:
*
* Result key to represent Size
*
* The D-Bus type signature string is 't' i.e. a unsigned 64 bit integer.
**/
#define FWUPD_RESULT_KEY_SIZE "Size"
/**
* FWUPD_RESULT_KEY_STATUS:
*
* Result key to represent Status
*
* The D-Bus type signature string is 'u' i.e. a unsigned 32 bit integer.
**/
#define FWUPD_RESULT_KEY_STATUS "Status"
/**
* FWUPD_RESULT_KEY_SUMMARY:
*
* Result key to represent Summary
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_SUMMARY "Summary"
/**
* FWUPD_RESULT_KEY_BRANCH:
*
* Result key to represent Branch
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_BRANCH "Branch"
/**
* FWUPD_RESULT_KEY_TRUST_FLAGS:
*
* Result key to represent TrustFlags
*
* The D-Bus type signature string is 't' i.e. a unsigned 64 bit integer.
**/
#define FWUPD_RESULT_KEY_TRUST_FLAGS "TrustFlags"
/**
* FWUPD_RESULT_KEY_UPDATE_MESSAGE:
*
* Result key to represent UpdateMessage
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_UPDATE_MESSAGE "UpdateMessage"
/**
* FWUPD_RESULT_KEY_UPDATE_IMAGE:
*
* Result key to represent UpdateImage
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_UPDATE_IMAGE "UpdateImage"
/**
* FWUPD_RESULT_KEY_UPDATE_ERROR:
*
* Result key to represent UpdateError
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_UPDATE_ERROR "UpdateError"
/**
* FWUPD_RESULT_KEY_UPDATE_STATE:
*
* Result key to represent UpdateState
*
* The D-Bus type signature string is 'u' i.e. a unsigned 32 bit integer.
**/
#define FWUPD_RESULT_KEY_UPDATE_STATE "UpdateState"
/**
* FWUPD_RESULT_KEY_URI:
*
* Result key to represent Uri
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_URI "Uri"
/**
* FWUPD_RESULT_KEY_LOCATIONS:
*
* Result key to represent Locations
*
* The D-Bus type signature string is 'as' i.e. an array of strings.
**/
#define FWUPD_RESULT_KEY_LOCATIONS "Locations"
/**
* FWUPD_RESULT_KEY_VENDOR_ID:
*
* Result key to represent VendorId
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_VENDOR_ID "VendorId"
/**
* FWUPD_RESULT_KEY_VENDOR:
*
* Result key to represent Vendor
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_VENDOR "Vendor"
/**
* FWUPD_RESULT_KEY_VERSION_BOOTLOADER:
*
* Result key to represent VersionBootloader
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_VERSION_BOOTLOADER "VersionBootloader"
/**
* FWUPD_RESULT_KEY_VERSION_BOOTLOADER_RAW:
*
* Result key to represent VersionBootloaderRaw
*
* The D-Bus type signature string is 't' i.e. a unsigned 64 bit integer.
**/
#define FWUPD_RESULT_KEY_VERSION_BOOTLOADER_RAW "VersionBootloaderRaw"
/**
* FWUPD_RESULT_KEY_VERSION_FORMAT:
*
* Result key to represent VersionFormat
*
* The D-Bus type signature string is 'u' i.e. a unsigned 32 bit integer.
**/
#define FWUPD_RESULT_KEY_VERSION_FORMAT "VersionFormat"
/**
* FWUPD_RESULT_KEY_VERSION_RAW:
*
* Result key to represent VersionRaw
*
* The D-Bus type signature string is 't' i.e. a unsigned 64 bit integer.
**/
#define FWUPD_RESULT_KEY_VERSION_RAW "VersionRaw"
/**
* FWUPD_RESULT_KEY_VERSION_LOWEST:
*
* Result key to represent VersionLowest
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_VERSION_LOWEST "VersionLowest"
/**
* FWUPD_RESULT_KEY_VERSION_LOWEST_RAW:
*
* Result key to represent VersionLowestRaw
*
* The D-Bus type signature string is 't' i.e. a unsigned 64 bit integer.
**/
#define FWUPD_RESULT_KEY_VERSION_LOWEST_RAW "VersionLowestRaw"
/**
* FWUPD_RESULT_KEY_VERSION:
*
* Result key to represent Version
*
* The D-Bus type signature string is 's' i.e. a string.
**/
#define FWUPD_RESULT_KEY_VERSION "Version"
G_END_DECLS