fwupd/plugins/ebitdo
Richard Hughes 19abf996c7 Allow the daemon to request interactive action from the end user
The "return error and hope the client resubmits the firmware again"
pattern is clunky. There are two plugins doing this now, and about to
be one more.

This adds FwupdRequest which provides a structured way of asking the
user to perform an action, e.g. to replug the device or to press a
special key or button.

This replaces much of the UpdateMessage and UpdateImage API although
it is still used internally. Clients capable of processing the new
DeviceRequest signal should add REQUESTS to their feature flags.

Also, this allows us go back to the old meaning of _NEEDS_BOOTLOADER,
which was "needs rebooting into a bootloader mode" rather than the
slightly weird "user needs to do something and resubmit request".
2021-07-14 17:03:50 +01:00
..
data Updated: Add support for 8BitDo M30. 2019-04-09 12:38:24 -04:00
ebitdo.quirk Add N30 Pro 2 gamepad 2021-06-04 06:44:32 -05: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 Allow the daemon to request interactive action from the end user 2021-07-14 17:03:50 +01:00
fu-ebitdo-device.h trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-ebitdo-firmware.c trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-ebitdo-firmware.h trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-plugin-ebitdo.c trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
meson.build Move the plugin build logic to the plugins themselves 2021-02-18 14:46:20 +00:00
README.md trivial: Use new 8BitDo name 2021-05-24 08:59:54 +01: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.