memsolve 0.2.2

ROM memory layout solver for linker script generation
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

//! Support for ESP32 partition table generation.
use esp_idf_part::{Flags, Partition, PartitionTable, SubType, Type};

use crate::{
    Memory,
    layout::{Layout, ResolvedLayout},
    section::{ResolvedSection, Section},
};

/// A section with ESP32 metadata.
pub type EspSection = Section<EspMetaData>;
/// A layout with ESP32 metadata in the sections.
pub type EspLayout = Layout<EspMetaData>;
/// A memory with ESP32 metadata in the sections.
pub type EspMemory = Memory<EspMetaData>;

/// ESP32 partition metadata.
#[derive(Clone, Debug)]
pub struct EspMetaData {
    /// The ESP32 partition type.
    pub partition_type: esp_idf_part::Type,
    /// The ESP32 partition subtype.
    pub partition_subtype: esp_idf_part::SubType,
    /// The ESP32 partition flags.
    pub flags: esp_idf_part::Flags,
}

impl EspMetaData {
    /// Creates new partition metadata
    #[must_use]
    pub fn new(partition_type: Type, partition_subtype: SubType, flags: Flags) -> Self {
        Self {
            partition_type,
            partition_subtype,
            flags,
        }
    }

    /// Set the flags on the metadata.
    #[must_use]
    pub fn set_flags(mut self, flags: Flags) -> Self {
        self.flags = flags;
        self
    }
}

impl Section<()> {
    /// Add ESP partition data to this section.
    #[must_use]
    pub fn add_esp_metadata(self, partition_type: Type, subtype: impl Into<SubType>) -> EspSection {
        let metadata = EspMetaData::new(partition_type, subtype.into(), Flags::empty());
        self.replace_metadata(metadata)
    }
}

impl Memory<()> {
    /// Convert the memory to use [`EspMetaData`]
    ///
    /// # Panics
    ///
    /// Panics when the layout in the memory contains sections
    #[must_use]
    pub fn with_esp_metadata(self) -> EspMemory {
        Memory {
            chip: self.chip,
            layout: self.layout.with_esp_metadata(),
        }
    }
}

impl Layout<()> {
    /// Converts an empty layout to use [`EspMetaData`]
    ///
    /// # Panics
    ///
    /// Panics when the layout contains sections
    #[must_use]
    #[allow(clippy::assert_is_empty)]
    pub fn with_esp_metadata(self) -> EspLayout {
        assert!(self.sections.is_empty());

        Layout::empty()
    }
}

impl Section<EspMetaData> {
    /// set ESP partition flags on this section.
    #[must_use]
    pub fn set_esp_flags(mut self, flags: Flags) -> Section<EspMetaData> {
        self.metadata = self.metadata.set_flags(flags);
        self
    }
}

impl ResolvedSection<EspMetaData> {
    /// Generate a [`esp_idf_part::Partition`] from this section.
    #[cfg(feature = "esp")]
    #[must_use]
    #[allow(clippy::cast_possible_truncation)]
    pub fn as_esp_partition(&self) -> Partition {
        Partition::new(
            &self.linker_name,
            self.metadata.partition_type,
            self.metadata.partition_subtype,
            self.address as u32,
            self.size as u32,
            self.metadata.flags,
        )
    }
}

impl ResolvedLayout<EspMetaData> {
    /// Generate a [`esp_idf_part::PartitionTable`] from this layout.
    #[must_use]
    pub fn into_esp_partition(&self) -> PartitionTable {
        let partitions = self
            .sections
            .iter()
            .map(ResolvedSection::as_esp_partition)
            .collect();
        PartitionTable::new(partitions)
    }
}

#[cfg(test)]
mod tests {
    use esp_idf_part::{AppType, DataType};

    use crate::{Memory, chip::Chip};

    use super::*;

    #[test]
    fn default_layout() {
        let esp_single_factory_app = "# ESP-IDF Partition Table\n\
        # Name,Type,SubType,Offset,Size,Flags\n\
        nvs,data,nvs,0x9000,0x6000,\n\
        phy_init,data,phy,0xf000,0x1000,\n\
        factory,app,factory,0x10000,0x100000,\n\
        ";

        let nvs = Section::new("nvs")
            .unwrap()
            .set_size(0x6000)
            .set_address(0x9000)
            .add_esp_metadata(Type::Data, DataType::Nvs);
        let phy_init = Section::new("phy_init")
            .unwrap()
            .set_size(0x1000)
            .set_address(0xf000)
            .add_esp_metadata(Type::Data, DataType::Phy);
        let factory = Section::new("factory")
            .unwrap()
            .set_size(1024 * 1024)
            .set_address_align(64 * 1024)
            .add_esp_metadata(Type::App, AppType::Factory);

        let chip = Chip::new(512, 0, 2048 * 1048).unwrap();
        let mut memory = Memory::new(chip);
        memory.add_section(nvs);
        memory.add_section(phy_init);
        memory.add_section(factory);

        let resolved = memory.resolve_layout().unwrap();

        let csv = resolved.into_esp_partition().to_csv().unwrap();
        assert_eq!(&csv, esp_single_factory_app);
    }
}