moonboot 0.1.2

OTA Bootloader Construction Framework for Rust no_std environments
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

pub mod processor;

use crate::Address;

#[cfg(feature = "defmt")]
use defmt::Format;
#[cfg(feature = "ram-state")]
use desse::{Desse, DesseSized};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// Identifier for multiple memory instances. Currently only Internal memory is supported
#[cfg_attr(feature = "defmt", derive(Format))]
#[cfg_attr(feature = "derive", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "ram-state", derive(Desse, DesseSized))]
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub enum MemoryUnit {
    /// On-chip memory of your SoC
    Internal,
    // External(usize) // nth external unit
}

/// Description of a memory bank in a specific memory unit
#[cfg_attr(feature = "defmt", derive(Format))]
#[cfg_attr(feature = "derive", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "ram-state", derive(Desse, DesseSized))]
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub struct Bank {
    // TODO: Hide members?
    /// Starting address of this Bank
    pub location: Address,
    /// Size of this Bank
    pub size: Address, // TODO: Use NonZeroU32 to remove checks?
    /// In which memory unit this bank is stored
    pub memory_unit: MemoryUnit,
}

/// Configuration of your SoCs partitioning
#[cfg_attr(feature = "defmt", derive(Format))]
#[cfg_attr(feature = "derive", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "ram-state", derive(Desse, DesseSized))]
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub struct Config {
    /// bank this bootloader jumps to, holds your main firmware
    pub boot_bank: Bank,
    /// alternative bank we write the new firmware image to, used as a memory only
    pub update_bank: Bank,
    /// bank the bootloader is contained in, switching between banks
    pub bootloader_bank: Bank,
    // Initial Image is stored to this bank after first update, restore on failure
    // pub golden_bank: Bank,
    /// section of RAM of this device
    pub ram_bank: Bank,
}

/// Configuration for linker scripts
#[cfg_attr(feature = "defmt", derive(Format))]
#[cfg_attr(feature = "derive", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "ram-state", derive(Desse, DesseSized))]
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub struct LinkerConfig {
    /// Origin address of the internal non-volatile memory
    pub flash_origin: Address,
    /// Origin address of the internal RAM bank
    pub ram_origin: Address,
    // TODO enable via feature flag?
    /// Whether to store the shared state in RAM and thus reserve some RAM memory for that
    pub has_ram_state: bool,
}