fwupd/plugins/ebitdo
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 Updated: Add support for 8BitDo M30. 2019-04-09 12:38:24 -04:00
ebitdo.quirk Simplify the quirk file format 2021-03-03 08:30:34 +00:00
fu-ebitdo-common.c ebitdo: Modernize the plugin to use FuFirmware 2019-10-31 09:21:35 -05:00
fu-ebitdo-common.h ebitdo: Modernize the plugin to use FuFirmware 2019-10-31 09:21:35 -05:00
fu-ebitdo-device.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-ebitdo-device.h ebitdo: Use klass_device->write_firmware like other plugins 2019-10-09 20:02:16 +01:00
fu-ebitdo-firmware.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-ebitdo-firmware.h Only include the start year in the copyright header 2021-01-07 14:48:16 +00:00
fu-plugin-ebitdo.c Use FWUPD_COMPILATION define to indicate an in tree build 2021-01-22 14:01:25 -06: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

8Bitdo Support

Introduction

This plugin can flash the firmware on the 8Bitdo game pads.

Ebitdo support is supported directly by this project with the embedded libebitdo library and is possible thanks to the vendor open sourcing the flashing tool.

The 8Bitdo devices share legacy USB VID/PIDs with other projects and so we have to be a bit careful to not claim other devices as our own.

Firmware Format

The daemon will decompress the cabinet archive and extract a firmware blob in an unspecified binary file format. The binary file has a vendor-specific header that is used when flashing the image.

This plugin supports the following protocol ID:

  • com.8bitdo

GUID Generation

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

  • USB\VID_2DC8&PID_AB11&REV_0001
  • USB\VID_2DC8&PID_AB11
  • USB\VID_2DC8

Update Behavior

The device usually presents in runtime mode, but on detach re-enumerates with a different USB VID and PID in a 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.

Vendor ID Security

The vendor ID is set from the USB vendor, which is set to various different values depending on the model and device mode. The list of USB VIDs used is:

  • USB:0x2DC8
  • USB:0x0483
  • USB:0x1002
  • USB:0x1235
  • USB:0x2002
  • USB:0x8000

External interface access

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