fwupd/plugins/altos
Richard Hughes fbd8b5d325 Add fu_device_dump_firmware()
Conceptually we were trying to stuff subtly different actions into one vfunc:

 * Read firmware from the device to update the verification checksums

 * Read a firmware blob from the device for debugging

For the first action we might want to mask out the sections of the flash with
serial numbers (so the verification hashes match the ones published on the LVFS)
and for the second we want just a raw ROM file from the hardware with no
pre-processing that we can compare against an external SPI dumper.

Split out ->dump_firmware to get the raw blob, and allow plugins to also
implement ->read_firmware() if they have to mask out specific offsets or remove
specific images from the FuFirmware container.

In the common case when masking is not required, fall back to using a 'binary'
FuFirmware automatically to make most plugins simpler.
2020-09-24 10:54:27 -05:00
..
data Add support for flashing the ChaosKey 2017-01-09 12:21:35 +00:00
altos.quirk Allow removing device flags from quirk files 2020-04-13 23:18:19 +01:00
fu-altos-device.c Add fu_device_dump_firmware() 2020-09-24 10:54:27 -05:00
fu-altos-device.h trivial: Remove G_BEGIN_DECLS from all private headers 2019-10-09 20:02:16 +01:00
fu-altos-firmware.c Use FuFirmware as a container for firmware images 2019-08-08 13:10:57 +01:00
fu-altos-firmware.h trivial: Remove G_BEGIN_DECLS from all private headers 2019-10-09 20:02:16 +01:00
fu-plugin-altos.c Set the protocol per-device not per-plugin 2019-11-25 18:01:54 +00:00
meson.build Convert libfwupdprivate to a shared library libfwupdplugin 2019-11-27 11:32:43 +00:00
README.md trivial: Document the use of vendor-id in each plugin 2019-12-11 18:10:44 +00:00

Altos Support

Introduction

Altos is a 8051 operating system for Altus-Metrum projects. The ChaosKey is a hardware random number generator that attaches via USB.

When the ChaosKey when inserted it appears as a device handled by the kernel with VID 0x1d50 and PID 0x60c6. If pins 1 and 5 are shorted as the device is connected then the bootloader is run, which presents VID 0xfffe and PID 0x000a.

The bootloader communication is not handled in the kernel, and a tty device is created so userspace can communicate with the hardware. Commands the bootloader accept are as follows:

Firmware Format

The daemon will decompress the cabinet archive and extract a firmware blob in ELF file format. The firmware image is inserted into the .text section.

This plugin supports the following protocol ID:

  • org.altusmetrum.altos

GUID Generation

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

  • USB\VID_1D50&PID_60C6&REV_0001
  • USB\VID_1D50&PID_60C6
  • USB\VID_1D50

Vendor ID Security

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

List Information

Command: l\n Several lines of text about the device are transferred to the host, e.g.

altos-loader
manufacturer     altusmetrum.org
product          AltosFlash
flash-range      08001000 08008000
software-version 1.6.8

There doesn't appear to be any kind of end-of-message signal.

Read Flash

Command: R $addr\n where $addr is a memory address 0x8001000->0x8008000. 256 bytes of raw data are then transferred to the host.

Write Flash

Command: W $addr\n where $addr is a memory address 0x8001000->0x8008000. 256 bytes of raw data are then transferred to the device.

Application Mode

Command: v\n The device will reboot into application mode. This is typically performed after flashing firmware completes successfully.