fwupd/plugins/hailuck/fu-hailuck-kbd-device.c
Richard Hughes 40cd18fa97 Allow using a per-device global percentage completion
It's actually quite hard to build a front-end for fwupd at the moment
as you're never sure when the progress bar is going to zip back to 0%
and start all over again. Some plugins go 0..100% for write, others
go 0..100% for erase, then again for write, then *again* for verify.

By creating a helper object we can easily split up the progress of the
specific task, e.g. write_firmware().

We can encode at the plugin level "the erase takes 50% of the time, the
write takes 40% and the read takes 10%". This means we can have a
progressbar which goes up just once at a consistent speed.
2021-09-13 14:28:15 +01:00

96 lines
3.1 KiB
C

/*
* Copyright (C) 2020 Richard Hughes <richard@hughsie.com>
*
* SPDX-License-Identifier: LGPL-2.1+
*/
#include "config.h"
#include "fu-hailuck-common.h"
#include "fu-hailuck-kbd-device.h"
#include "fu-hailuck-tp-device.h"
struct _FuHailuckKbdDevice {
FuHidDevice parent_instance;
};
G_DEFINE_TYPE(FuHailuckKbdDevice, fu_hailuck_kbd_device, FU_TYPE_HID_DEVICE)
static gboolean
fu_hailuck_kbd_device_detach(FuDevice *device, FuProgress *progress, GError **error)
{
guint8 buf[6] = {FU_HAILUCK_REPORT_ID_SHORT, FU_HAILUCK_CMD_DETACH};
if (!fu_hid_device_set_report(FU_HID_DEVICE(device),
buf[0],
buf,
sizeof(buf),
1000,
FU_HID_DEVICE_FLAG_IS_FEATURE,
error))
return FALSE;
fu_device_add_flag(device, FWUPD_DEVICE_FLAG_WAIT_FOR_REPLUG);
return TRUE;
}
static gboolean
fu_hailuck_kbd_device_probe(FuDevice *device, GError **error)
{
g_autofree gchar *devid = NULL;
g_autoptr(FuHailuckTpDevice) tp_device = fu_hailuck_tp_device_new(FU_DEVICE(device));
/* FuUsbDevice->probe */
if (!FU_DEVICE_CLASS(fu_hailuck_kbd_device_parent_class)->probe(device, error))
return FALSE;
/* add extra keyboard-specific GUID */
devid = g_strdup_printf("USB\\VID_%04X&PID_%04X&MODE_KBD",
fu_usb_device_get_vid(FU_USB_DEVICE(device)),
fu_usb_device_get_pid(FU_USB_DEVICE(device)));
fu_device_add_instance_id(device, devid);
/* add touchpad */
if (!fu_device_probe(FU_DEVICE(tp_device), error))
return FALSE;
/* assume the TP has the same version as the keyboard */
fu_device_set_version(FU_DEVICE(tp_device), fu_device_get_version(device));
fu_device_set_version_format(FU_DEVICE(tp_device), fu_device_get_version_format(device));
fu_device_add_child(device, FU_DEVICE(tp_device));
/* success */
return TRUE;
}
static void
fu_hailuck_kbd_device_set_progress(FuDevice *self, FuProgress *progress)
{
fu_progress_set_id(progress, G_STRLOC);
fu_progress_add_flag(progress, FU_PROGRESS_FLAG_GUESSED);
fu_progress_add_step(progress, FWUPD_STATUS_DEVICE_RESTART, 2); /* detach */
fu_progress_add_step(progress, FWUPD_STATUS_DEVICE_WRITE, 94); /* write */
fu_progress_add_step(progress, FWUPD_STATUS_DEVICE_RESTART, 2); /* attach */
fu_progress_add_step(progress, FWUPD_STATUS_DEVICE_BUSY, 2); /* reload */
}
static void
fu_hailuck_kbd_device_init(FuHailuckKbdDevice *self)
{
fu_device_set_firmware_size(FU_DEVICE(self), 0x4000);
fu_device_add_protocol(FU_DEVICE(self), "com.hailuck.kbd");
fu_device_add_flag(FU_DEVICE(self), FWUPD_DEVICE_FLAG_INTERNAL);
fu_device_add_flag(FU_DEVICE(self), FWUPD_DEVICE_FLAG_UPDATABLE);
fu_device_add_internal_flag(FU_DEVICE(self), FU_DEVICE_INTERNAL_FLAG_REPLUG_MATCH_GUID);
fu_device_add_icon(FU_DEVICE(self), "input-keyboard");
fu_hid_device_set_interface(FU_HID_DEVICE(self), 0x1);
fu_device_set_remove_delay(FU_DEVICE(self), FU_DEVICE_REMOVE_DELAY_RE_ENUMERATE);
}
static void
fu_hailuck_kbd_device_class_init(FuHailuckKbdDeviceClass *klass)
{
FuDeviceClass *klass_device = FU_DEVICE_CLASS(klass);
klass_device->detach = fu_hailuck_kbd_device_detach;
klass_device->probe = fu_hailuck_kbd_device_probe;
klass_device->set_progress = fu_hailuck_kbd_device_set_progress;
}