mirror of https://git.proxmox.com/git/fwupd synced 2025-06-28 12:22:05 +00:00

History

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	Add support for flashing the ChaosKey	2017-01-09 12:21:35 +00:00
altos.quirk	Simplify the quirk file format	2021-03-03 08:30:34 +00:00
fu-altos-device.c	Remove FuFirmwareImage and just use FuFirmware instead	2021-03-09 21:14:12 +00:00
fu-altos-device.h	Only include the start year in the copyright header	2021-01-07 14:48:16 +00:00
fu-altos-firmware.c	Remove FuFirmwareImage and just use FuFirmware instead	2021-03-09 21:14:12 +00:00
fu-altos-firmware.h	Only include the start year in the copyright header	2021-01-07 14:48:16 +00:00
fu-plugin-altos.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

README.md

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

Update Behavior

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

External interface access

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