From 35fff9684eb24261c116b6607b0628c61e45256d Mon Sep 17 00:00:00 2001 From: Richard Hughes Date: Sat, 25 Sep 2021 20:43:38 +0100 Subject: [PATCH] trivial: Export the CFU enum conversion functions We need these in the CFU plugin too. --- .../fu-cfu-common.c | 38 +++++++++++++++++-- .../fu-cfu-common.h | 8 ++-- libfwupdplugin/fwupdplugin.h | 1 + libfwupdplugin/fwupdplugin.map | 3 ++ libfwupdplugin/meson.build | 2 + plugins/elanfp/fu-elanfp-device.c | 7 ++-- plugins/elanfp/meson.build | 1 - 7 files changed, 47 insertions(+), 13 deletions(-) rename plugins/elanfp/fu-elanfp-common.c => libfwupdplugin/fu-cfu-common.c (70%) rename plugins/elanfp/fu-elanfp-common.h => libfwupdplugin/fu-cfu-common.h (88%) diff --git a/plugins/elanfp/fu-elanfp-common.c b/libfwupdplugin/fu-cfu-common.c similarity index 70% rename from plugins/elanfp/fu-elanfp-common.c rename to libfwupdplugin/fu-cfu-common.c index fa655fdcf..ca22db322 100644 --- a/plugins/elanfp/fu-elanfp-common.c +++ b/libfwupdplugin/fu-cfu-common.c @@ -6,10 +6,20 @@ #include "config.h" -#include "fu-elanfp-common.h" +#include "fu-cfu-common.h" +/** + * fu_cfu_device_reject_to_string: + * @val: a enumerated value, e.g. %FU_CFU_DEVICE_REJECT_OLD_FIRMWARE + * + * Converts an enumerated reject type to a string. + * + * Returns: a string, or `unknown` for invalid + * + * Since: 1.7.0 + **/ const gchar * -fu_elanfp_cfu_device_reject_to_string(guint8 val) +fu_cfu_device_reject_to_string(guint8 val) { if (val == FU_CFU_DEVICE_REJECT_OLD_FIRMWARE) return "old-firmware"; @@ -28,8 +38,18 @@ fu_elanfp_cfu_device_reject_to_string(guint8 val) return "unknown"; } +/** + * fu_cfu_device_offer_to_string: + * @val: a enumerated value, e.g. %FU_CFU_DEVICE_OFFER_ACCEPT + * + * Converts an enumerated offer type to a string. + * + * Returns: a string, or `unknown` for invalid + * + * Since: 1.7.0 + **/ const gchar * -fu_elanfp_cfu_device_offer_to_string(guint8 val) +fu_cfu_device_offer_to_string(guint8 val) { if (val == FU_CFU_DEVICE_OFFER_SKIP) return "skip"; @@ -46,8 +66,18 @@ fu_elanfp_cfu_device_offer_to_string(guint8 val) return "unknown"; } +/** + * fu_cfu_device_status_to_string: + * @val: a enumerated value, e.g. %FU_CFU_DEVICE_OFFER_ACCEPT + * + * Converts an enumerated status type to a string. + * + * Returns: a string, or `unknown` for invalid + * + * Since: 1.7.0 + **/ const gchar * -fu_elanfp_cfu_device_status_to_string(guint8 val) +fu_cfu_device_status_to_string(guint8 val) { if (val == FU_CFU_DEVICE_STATUS_SUCCESS) return "success"; diff --git a/plugins/elanfp/fu-elanfp-common.h b/libfwupdplugin/fu-cfu-common.h similarity index 88% rename from plugins/elanfp/fu-elanfp-common.h rename to libfwupdplugin/fu-cfu-common.h index 75e8a8250..2c94524a5 100644 --- a/plugins/elanfp/fu-elanfp-common.h +++ b/libfwupdplugin/fu-cfu-common.h @@ -6,7 +6,7 @@ #pragma once -#include +#include #define FU_CFU_DEVICE_OFFER_SKIP 0x00 #define FU_CFU_DEVICE_OFFER_ACCEPT 0x01 @@ -40,8 +40,8 @@ #define FU_CFU_DEVICE_REJECT_DEBUG_SAME_VERSION 0xE2 const gchar * -fu_elanfp_cfu_device_reject_to_string(guint8 val); +fu_cfu_device_reject_to_string(guint8 val); const gchar * -fu_elanfp_cfu_device_status_to_string(guint8 val); +fu_cfu_device_status_to_string(guint8 val); const gchar * -fu_elanfp_cfu_device_offer_to_string(guint8 val); +fu_cfu_device_offer_to_string(guint8 val); diff --git a/libfwupdplugin/fwupdplugin.h b/libfwupdplugin/fwupdplugin.h index affcb37c6..8b92cb1c7 100644 --- a/libfwupdplugin/fwupdplugin.h +++ b/libfwupdplugin/fwupdplugin.h @@ -11,6 +11,7 @@ #include #include #include +#include #include #include #include diff --git a/libfwupdplugin/fwupdplugin.map b/libfwupdplugin/fwupdplugin.map index d4c756d9f..1300b30ce 100644 --- a/libfwupdplugin/fwupdplugin.map +++ b/libfwupdplugin/fwupdplugin.map @@ -861,6 +861,9 @@ LIBFWUPDPLUGIN_1.6.2 { LIBFWUPDPLUGIN_1.7.0 { global: + fu_cfu_device_offer_to_string; + fu_cfu_device_reject_to_string; + fu_cfu_device_status_to_string; fu_cfu_offer_get_bank; fu_cfu_offer_get_component_id; fu_cfu_offer_get_force_ignore_version; diff --git a/libfwupdplugin/meson.build b/libfwupdplugin/meson.build index ec26e9790..d6a2ed687 100644 --- a/libfwupdplugin/meson.build +++ b/libfwupdplugin/meson.build @@ -18,6 +18,7 @@ fwupdplugin_src = [ 'fu-device-locker.c', # fuzzing 'fu-device.c', # fuzzing 'fu-dfu-firmware.c', # fuzzing + 'fu-cfu-common.c', # fuzzing 'fu-cfu-offer.c', # fuzzing 'fu-cfu-payload.c', # fuzzing 'fu-volume.c', # fuzzing @@ -84,6 +85,7 @@ fwupdplugin_headers = [ 'fu-device-metadata.h', 'fu-device-locker.h', 'fu-dfu-firmware.h', + 'fu-cfu-common.h', 'fu-cfu-offer.h', 'fu-cfu-payload.h', 'fu-efi-common.h', diff --git a/plugins/elanfp/fu-elanfp-device.c b/plugins/elanfp/fu-elanfp-device.c index e9e331c67..781b91ebe 100644 --- a/plugins/elanfp/fu-elanfp-device.c +++ b/plugins/elanfp/fu-elanfp-device.c @@ -6,7 +6,6 @@ #include "config.h" -#include "fu-elanfp-common.h" #include "fu-elanfp-device.h" #include "fu-elanfp-firmware.h" @@ -339,7 +338,7 @@ fu_elanfp_device_write_payload(FuElanfpDevice *self, G_IO_ERROR_INVALID_DATA, "failed to send chunk %u: %s", i + 1, - fu_elanfp_cfu_device_status_to_string(recvbuf[5])); + fu_cfu_device_status_to_string(recvbuf[5])); return FALSE; } fu_progress_step_done(progress); @@ -397,8 +396,8 @@ fu_elanfp_device_write_firmware(FuDevice *device, } g_debug("offer-%s status:%s reject:%s", items[i].tag, - fu_elanfp_cfu_device_offer_to_string(recvbuf[13]), - fu_elanfp_cfu_device_reject_to_string(recvbuf[9])); + fu_cfu_device_offer_to_string(recvbuf[13]), + fu_cfu_device_reject_to_string(recvbuf[9])); if (recvbuf[13] == FU_CFU_DEVICE_OFFER_ACCEPT) break; } diff --git a/plugins/elanfp/meson.build b/plugins/elanfp/meson.build index 1c8bb3605..e8bb82550 100644 --- a/plugins/elanfp/meson.build +++ b/plugins/elanfp/meson.build @@ -8,7 +8,6 @@ shared_module('fu_plugin_elanfp', fu_hash, sources : [ 'fu-plugin-elanfp.c', - 'fu-elanfp-common.c', 'fu-elanfp-device.c', 'fu-elanfp-firmware.c' # fuzzing ],