fwupd/plugins/altos
Richard Hughes 9729584ee4 Allow plugins to define support for a 'well-known' protocol
Future metadata from the LVFS will set the protocol the firmware is expected to
use. As vendors love to re-use common terms like DFU for incompatible protocols,
namespace them with the controlling company ID with an approximate reverse DNS
namespace.

This also allows more than one plugin to define support for the same protocol,
for instance rts54hid+rts54hub and synapticsmst+dell-dock.
2018-12-14 18:15:01 +00: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 Add shared functionality for reading and writing with O_NONBLOCK 2018-12-06 14:07:02 +00:00
fu-altos-device.h trivial: Remove duplicate header includes 2018-09-04 08:22:39 -05:00
fu-altos-firmware.c Remove the unused Emacs indenting headers from all source files 2018-08-09 12:48:04 +01:00
fu-altos-firmware.h trivial: Remove duplicate header includes 2018-09-04 08:22:39 -05:00
fu-plugin-altos.c Allow plugins to define support for a 'well-known' protocol 2018-12-14 18:15:01 +00:00
meson.build trivial: Move gudev to the core plugin deps 2018-08-26 19:38:58 +01:00
README.md trivial: Document the expected plugin firmware formats 2018-12-03 08:48:13 -06: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.

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.