fwupd/plugins/hailuck
Richard Hughes 1981c63d58 Remove FuFirmwareImage and just use FuFirmware instead
This allows us to 'nest' firmware formats, and removes a ton of duplication.

The aim here is to deprecate FuFirmwareImage -- it's almost always acting
as a 'child' FuFirmware instance, and even copies most of the vfuncs to allow
custom types. If I'm struggling to work out what should be a FuFirmware and
what should be a FuFirmwareImage then a plugin author has no hope.

For simple payloads we were adding bytes into an image and then the image into
a firmware. This gets really messy when most plugins are treating the FuFirmware
*as* the binary firmware file.

The GBytes saved in the FuFirmware would be considered the payload with the
aim of not using FuFirmwareImage in the single-image case.
2021-03-09 21:14:12 +00:00
..
data hailuck: Add an plugin for the Pinebook Pro laptop 2020-11-09 16:17:34 +00:00
fu-hailuck-bl-device.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-hailuck-bl-device.h hailuck: trivial: Fix the GType name 2021-01-03 21:07:44 +00:00
fu-hailuck-common.c hailuck: Add an plugin for the Pinebook Pro laptop 2020-11-09 16:17:34 +00:00
fu-hailuck-common.h hailuck: Add an plugin for the Pinebook Pro laptop 2020-11-09 16:17:34 +00:00
fu-hailuck-kbd-device.c Support more than one protocol for a given device 2021-03-01 16:14:36 +00:00
fu-hailuck-kbd-device.h hailuck: trivial: Fix the GType name 2021-01-03 21:07:44 +00:00
fu-hailuck-kbd-firmware.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-hailuck-kbd-firmware.h hailuck: trivial: Fix the GType name 2021-01-03 21:07:44 +00:00
fu-hailuck-tp-device.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-hailuck-tp-device.h hailuck: trivial: Fix the GType name 2021-01-03 21:07:44 +00:00
fu-plugin-hailuck.c Use FWUPD_COMPILATION define to indicate an in tree build 2021-01-22 14:01:25 -06:00
hailuck.quirk Simplify the quirk file format 2021-03-03 08:30:34 +00:00
meson.build Move the plugin build logic to the plugins themselves 2021-02-18 14:46:20 +00:00
README.md Add a new internal flag to opt-in to GUID matching 2021-02-25 15:47:25 +00:00

Hailuck Support

Introduction

Hailuck produce the firmware used on the keyboard and trackpad used in the Pinebook Pro laptops.

Firmware Format

The daemon will decompress the cabinet archive and extract a firmware blob in a packed binary file format.

This plugin supports the following protocol ID:

  • com.hailuck.kbd
  • com.hailuck.tp

GUID Generation

These devices use the standard USB DeviceInstanceId values, e.g.

  • USB\VID_0603&PID_1020

Update Behavior

The keyboard device usually presents in runtime mode, but on detach it re-enumerates with a different USB VID and PID in bootloader mode. On attach the device again re-enumerates back to the runtime mode.

For this reason the REPLUG_MATCH_GUID internal device flag is used so that the bootloader and runtime modes are treated as the same device.

The touchpad firmware is deployed when the device is in normal runtime mode, and the device will reset when the new firmware has been written.

Vendor ID Security

The vendor ID is set from the USB vendor, in this instance set to USB:0x0603

External interface access

This plugin requires read/write access to /dev/bus/usb.