Struct MIONFirmwareFile

pub struct MIONFirmwareFile { /* private fields */ }

A MION Firmware File.

The MION itself has 3 types of firmware:

• “fpga.${version}.bin” aka MIONFirmwareType::Fpga
• “fw.${version}.bin” aka MIONFirmwareType::Ipl
• “ipl.${version}.bin” aka MIONFirmwareType::Mion

Each of these are used for separate part of firmware, but all follow the same format. An encrypted blob, followed by a 4 byte version string, followed by a checksum.

Implementations

impl MIONFirmwareFile

pub fn parse( firmware: &[u8], firmware_type: MIONFirmwareType, ) -> Result<Self, MIONFirmwareAPIError>

Attempt to parse a firmware file that would be uploaded to the MION board.

These packages would be manually uploaded to: http://<mionip>/update.cgi.

Errors

This function will error if the original MION firmwares would throw an error at this package, or would otherwise corrupt when installing it. This consistetues the following checks:

• Validating the file is at least 0x26 (38) bytes long (note: the mion only checks for 0x16 but will fail because the AES block size is 32 bytes.)
• The file has an invalid checksum (the checksum is the last byte in the file.)
• If uploading a firmware type of MIONFirmwareType::Mion, the last byte in the version must be 0x00, if it’s not the upload will corrupt heavily as the programmers treated it as a load-bearing NUL terminator which is required for strings in C (the language the FW was written in).
• If the main contents of the file were not encrypted with the common AES key.
• If the decrypted contents do not end with the correct signature, this is PWI-SS_FW_IMAGE for [MionFirmwareType::Mion] & [MionFirmwareType::Ipl], and PWI-SS_FP_IMAGE for [MionFirmwareType::FPGA].

pub const fn checksum(&self) -> u8

Get the checksum for this firmware file.

pub const fn contents(&self) -> &Vec<u8>

Get the underlying decrypted contents of this firmware file.

pub const fn firmware_type(&self) -> MIONFirmwareType

Get the type of firmware this is.

pub fn get_deployable_firmware_data(&self) -> Vec<u8>

Get the bytes that would need to be written to a file, and uploaded to /update.cgi on the MION to deploy this firmware file.

pub fn version(&self) -> String

Get the version for the actual firmware file.

Each firmware type has a slightly different format than the rest of the firmware types. An example of known following firmware types are:

• MIONFirmwareType::Mion -> 0.00.14.80
• MIONFirmwareType::Fpga -> 13052071
• MIONFirmwareType::Ipl -> 0.5

Trait Implementations

impl Clone for MIONFirmwareFile

fn clone(&self) -> MIONFirmwareFile

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MIONFirmwareFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MIONFirmwareFile

fn eq(&self, other: &MIONFirmwareFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MIONFirmwareFile

impl StructuralPartialEq for MIONFirmwareFile