fwupd/plugins/altos
Richard Hughes 7afd7cba0d Use FuFirmware as a container for firmware images
In many plugins we've wanted to use ->prepare_firmware() to parse the firmware
ahead of ->detach() and ->write_firmware() but this has the limitation that it
can only return a single blob of data.

For many devices, multiple binary blobs are required from one parsed image,
for instance providing signatures, config and data blobs that have to be pushed
to the device in different way.

This also means we parse the firmware *before* we ask the user to detach.

Break the internal FuDevice API to support these firmware types as they become
more popular.

This also allows us to move the Intel HEX and SREC parsing out of the dfu plugin
as they are used by a few plugins now, and resolving symbols between plugins
isn't exactly awesome.
2019-08-08 13:10:57 +01:00
..
data Add support for flashing the ChaosKey 2017-01-09 12:21:35 +00:00
altos.quirk Change the quirk file structure to be more efficient 2018-06-28 13:32:30 +01:00
fu-altos-device.c Use FuFirmware as a container for firmware images 2019-08-08 13:10:57 +01:00
fu-altos-device.h Use '#pragma once' to avoid a lot of boilerplate 2019-02-09 08:42:30 -06: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 Use FuFirmware as a container for firmware images 2019-08-08 13:10:57 +01:00
fu-plugin-altos.c Allow handling FORCE for devices that subclass FuDevice 2019-05-05 15:29:00 -05:00
meson.build Show a console warning if loading an out-of-tree plugin 2019-01-19 07:26:20 +00:00
README.md trivial: Add the missing protocol IDs to the plugin READMEs 2019-01-29 22:28:09 +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

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.