fwupd/plugins/logitech-hidpp/fu-logitech-hidpp-bootloader.h
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

93 lines
3.0 KiB
C

/*
* Copyright (C) 2016 Richard Hughes <richard@hughsie.com>
*
* SPDX-License-Identifier: LGPL-2.1+
*/
#pragma once
#include <fwupdplugin.h>
#define FU_TYPE_UNIFYING_BOOTLOADER (fu_logitech_hidpp_bootloader_get_type())
G_DECLARE_DERIVABLE_TYPE(FuLogitechHidPpBootloader,
fu_logitech_hidpp_bootloader,
FU,
UNIFYING_BOOTLOADER,
FuHidDevice)
struct _FuLogitechHidPpBootloaderClass {
FuHidDeviceClass parent_class;
};
/**
* FU_LOGITECH_HIDPP_BOOTLOADER_FLAG_IS_SIGNED:
*
* Device requires signed firmware.
*
* Since: 1.7.0
*/
#define FU_LOGITECH_HIDPP_BOOTLOADER_FLAG_IS_SIGNED (1 << 0)
typedef enum {
FU_UNIFYING_BOOTLOADER_CMD_GENERAL_ERROR = 0x01,
FU_UNIFYING_BOOTLOADER_CMD_READ = 0x10,
FU_UNIFYING_BOOTLOADER_CMD_WRITE = 0x20,
FU_UNIFYING_BOOTLOADER_CMD_WRITE_INVALID_ADDR = 0x21,
FU_UNIFYING_BOOTLOADER_CMD_WRITE_VERIFY_FAIL = 0x22,
FU_UNIFYING_BOOTLOADER_CMD_WRITE_NONZERO_START = 0x23,
FU_UNIFYING_BOOTLOADER_CMD_WRITE_INVALID_CRC = 0x24,
FU_UNIFYING_BOOTLOADER_CMD_ERASE_PAGE = 0x30,
FU_UNIFYING_BOOTLOADER_CMD_ERASE_PAGE_INVALID_ADDR = 0x31,
FU_UNIFYING_BOOTLOADER_CMD_ERASE_PAGE_NONZERO_START = 0x33,
FU_UNIFYING_BOOTLOADER_CMD_GET_HW_PLATFORM_ID = 0x40,
FU_UNIFYING_BOOTLOADER_CMD_GET_FW_VERSION = 0x50,
FU_UNIFYING_BOOTLOADER_CMD_GET_CHECKSUM = 0x60,
FU_UNIFYING_BOOTLOADER_CMD_REBOOT = 0x70,
FU_UNIFYING_BOOTLOADER_CMD_GET_MEMINFO = 0x80,
FU_UNIFYING_BOOTLOADER_CMD_GET_BL_VERSION = 0x90,
FU_UNIFYING_BOOTLOADER_CMD_GET_INIT_FW_VERSION = 0xa0,
FU_UNIFYING_BOOTLOADER_CMD_READ_SIGNATURE = 0xb0,
FU_UNIFYING_BOOTLOADER_CMD_WRITE_RAM_BUFFER = 0xc0,
FU_UNIFYING_BOOTLOADER_CMD_WRITE_RAM_BUFFER_INVALID_ADDR = 0xc1,
FU_UNIFYING_BOOTLOADER_CMD_WRITE_RAM_BUFFER_OVERFLOW = 0xc2,
FU_UNIFYING_BOOTLOADER_CMD_FLASH_RAM = 0xd0,
FU_UNIFYING_BOOTLOADER_CMD_FLASH_RAM_INVALID_ADDR = 0xd1,
FU_UNIFYING_BOOTLOADER_CMD_FLASH_RAM_WRONG_CRC = 0xd2,
FU_UNIFYING_BOOTLOADER_CMD_FLASH_RAM_PAGE0_INVALID = 0xd3,
FU_UNIFYING_BOOTLOADER_CMD_FLASH_RAM_INVALID_ORDER = 0xd4,
FU_UNIFYING_BOOTLOADER_CMD_WRITE_SIGNATURE = 0xe0,
FU_UNIFYING_BOOTLOADER_CMD_LAST
} FuLogitechHidPpBootloaderCmd;
/* packet to and from device */
typedef struct __attribute__((packed)) {
guint8 cmd;
guint16 addr;
guint8 len;
guint8 data[28];
} FuLogitechHidPpBootloaderRequest;
FuLogitechHidPpBootloaderRequest *
fu_logitech_hidpp_bootloader_request_new(void);
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-function"
G_DEFINE_AUTOPTR_CLEANUP_FUNC(FuLogitechHidPpBootloaderRequest, g_free);
#pragma clang diagnostic pop
GPtrArray *
fu_logitech_hidpp_bootloader_parse_requests(FuLogitechHidPpBootloader *self,
GBytes *fw,
GError **error);
gboolean
fu_logitech_hidpp_bootloader_request(FuLogitechHidPpBootloader *self,
FuLogitechHidPpBootloaderRequest *req,
GError **error);
guint16
fu_logitech_hidpp_bootloader_get_addr_lo(FuLogitechHidPpBootloader *self);
guint16
fu_logitech_hidpp_bootloader_get_addr_hi(FuLogitechHidPpBootloader *self);
guint16
fu_logitech_hidpp_bootloader_get_blocksize(FuLogitechHidPpBootloader *self);