Struct PartTab

pub struct PartTab {
    pub rma_w_state: u8,
    pub rma_ov_state: u8,
    pub eFWV: u8,
    pub fw1_idx: u8,
    pub fw2_idx: u8,
    pub ota_trap: TrapConfig,
    pub mp_trap: TrapConfig,
    pub key_exp_op: KeyExportOp,
    /* private fields */
}

===================================================================================== Partition Table (PartTab)

The PartTab struct represents a partition table for the flash, containing various metadata and configuration related to the partitioning, as well as firmware-specific data such as the state of firmware updates, trap configurations, and key export operations.

Layout:

         +-----------------+------------------+---+----------+---------+-------------+-------------+---+---+---+-------+-------+-------+------+----+----------------+
         | 0               | 1                | 2 | 3        | 4       | 5           | 6           | 7 | 8 | 9 | 10    | 11    | 12    | 13   | 14 | 15             |
+========+=================+==================+===+==========+=========+=============+=============+===+===+===+=======+=======+=======+======+====+================+
| 0x00   | rma_w_state: u8 | rma_ov_state: u8 |   | eFWV: u8 | num: u8 | fw1_idx: u8 | fw2_idx: u8 |           | ota_trap: u16 | mp_trap: u16 |    | key_exp_op: u8 |
+--------+-----------------+------------------+---+----------+---------+-------------+-------------+-----------+---------------+--------------+----+----------------+
| 0x10   |                   user_len: u32                   |                                         user_ext: bytes[12]                                          |
+--------+---------------------------------------------------+------------------------------------------------------------------------------------------------------+
| 0x20   |                                                                  records: Record * num                                                                   |
+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| 0x30   |                                                                                                                                                          |
+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| 0x40   |                                                                                                                                                          |
+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| 0x50   |                                                                                                                                                          |
+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| 0x60   |                                                                user_bin: bytes[user_len]                                                                 |
+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------+

Fields

rma_w_state: u8

rma_ov_state: u8

eFWV: u8

fw1_idx: u8

fw2_idx: u8

ota_trap: TrapConfig

mp_trap: TrapConfig

key_exp_op: KeyExportOp

Implementations

impl PartTab

pub fn get_records(&self) -> &[Record]

Returns the records in the partition table.

Returns:

• A slice of Record structs.

pub fn get_user_bin(&self) -> &[u8]

Returns the user binary data.

This method provides access to the raw user binary data in the partition table.

Returns:

• A slice of bytes representing the user binary data.

pub fn get_user_ext(&self) -> &[u8]

Returns the user extension data (12 bytes).

This method provides access to the 12-byte user extension field, which can be used for storing additional metadata related to the partition table.

Returns:

• A reference to the 12-byte array representing the user extension data.

pub fn set_user_bin(&mut self, user_bin: &[u8])

Sets the user binary data in the partition table.

Arguments:

• user_bin: A slice of bytes representing the new user binary data to store.

pub fn set_user_ext(&mut self, user_ext: &[u8])

Sets the user extension data in the partition table.

Arguments:

• user_ext: A slice of bytes representing the new user extension data (12 bytes).

pub fn add_record(&mut self, record: Record)

Adds a new partition record to the partition table.

Arguments:

• record: The Record struct that defines the new partition entry to add.

pub fn new_record(&mut self, part_type: PartitionType) -> &mut Record

Creates and returns a new record for a specific partition type.

Arguments:

• part_type: The PartitionType enum value representing the type of the new record.

Returns:

• A mutable reference to the newly created record.

pub fn get_record(&self, part_type: PartitionType) -> Option<&Record>

Returns the record for a specific partition type.

Arguments:

• part_type: The PartitionType enum value representing the partition type.

Returns:

• Some(&Record) if the record for the given partition type is found.
• None if the record for the given partition type is not found.

pub fn get_record_mut( &mut self, part_type: PartitionType, ) -> Option<&mut Record>

Returns the record for a specific partition type.

Arguments:

• part_type: The PartitionType enum value representing the partition type.

Returns:

• Some(&mut Record) if the record for the given partition type is found.
• None if the record for the given partition type is not found.

pub fn rem_record(&mut self, part_type: PartitionType)

Removes a partition record from the partition table.

Arguments:

• part_type: The PartitionType enum value representing the partition type to remove.

pub fn has_record(&self, part_type: PartitionType) -> bool

Checks if a record exists for a specific partition type.

Arguments:

• part_type: The PartitionType enum value representing the partition type to check.

Returns:

• true if a record exists for the given partition type.
• false if no record exists for the given partition type.

Trait Implementations

impl Debug for PartTab

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

Formats the value using the given formatter.

impl Default for PartTab

fn default() -> Self

Returns the “default value” for a type.

impl FromStream for PartTab

fn read_from<R>(&mut self, reader: &mut R) -> Result<(), Error>

where R: Read + Seek,

Parses a PartTab from a binary stream.

Returns:

• Ok(()) if the PartTab was successfully parsed.
• Err(Error) if there was an issue reading from the stream.

impl ToStream for PartTab

fn write_to<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek,

Writes a PartTab to a binary stream.

Arguments:

• writer: A mutable reference to a writer that implements std::io::Write.

impl TryInto<PartTab> for PartitionTableCfg

fn try_into(self) -> Result<PartTab, Self::Error>

Converts a PartitionTableCfg instance into a PartTab instance.

Returns:

• Ok(PartTab): A PartTab instance with the appropriate values set.
• Err(Error): An error if something goes wrong, such as if the user extension file does not exist or cannot be read.

type Error = Error

The type returned in the event of a conversion error.