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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
use crate::PartitionError;

/// Partition type and subtype
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub enum PartitionType {
    /// Application partition
    App(AppPartitionType),

    /// Data partition
    Data(DataPartitionType),

    /// Any type
    #[default]
    Any,

    /// User-defined type
    User(u8, u8),
}

impl From<AppPartitionType> for PartitionType {
    fn from(subtype: AppPartitionType) -> Self {
        Self::App(subtype)
    }
}

impl From<DataPartitionType> for PartitionType {
    fn from(subtype: DataPartitionType) -> Self {
        Self::Data(subtype)
    }
}

impl TryFrom<(u8, u8)> for PartitionType {
    type Error = PartitionError;

    fn try_from((raw_type, raw_subtype): (u8, u8)) -> Result<Self, Self::Error> {
        Ok(match raw_type {
            0x00 => Self::App(raw_subtype.try_into()?),
            0x01 => Self::Data(raw_subtype.try_into()?),
            0x40..=0xfe => Self::User(raw_type, raw_subtype),
            0xff => Self::Any,
            _ => return Err(PartitionError::InvalidType(raw_type)),
        })
    }
}

impl TryFrom<&[u8; 2]> for PartitionType {
    type Error = PartitionError;

    fn try_from([raw_type, raw_subtype]: &[u8; 2]) -> Result<Self, Self::Error> {
        (*raw_type, *raw_subtype).try_into()
    }
}

impl TryFrom<[u8; 2]> for PartitionType {
    type Error = PartitionError;

    fn try_from([raw_type, raw_subtype]: [u8; 2]) -> Result<Self, Self::Error> {
        (raw_type, raw_subtype).try_into()
    }
}

impl TryFrom<&[u8]> for PartitionType {
    type Error = PartitionError;

    fn try_from(slice: &[u8]) -> Result<Self, Self::Error> {
        <[u8; 2]>::try_from(slice)
            .map_err(|_| PartitionError::NotEnoughData)?
            .try_into()
    }
}

impl TryFrom<PartitionType> for (u8, u8) {
    type Error = PartitionError;

    fn try_from(ty: PartitionType) -> Result<Self, Self::Error> {
        use PartitionType::*;
        Ok(match ty {
            App(subtype) => (0x00, subtype.try_into()?),
            Data(subtype) => (0x01, subtype.into()),
            User(usertype @ 0x40..=0xfe, subtype) => (usertype, subtype),
            User(usertype, _) => return Err(PartitionError::InvalidUserType(usertype)),
            Any => (0xff, 0x00),
        })
    }
}

impl TryFrom<PartitionType> for [u8; 2] {
    type Error = PartitionError;

    fn try_from(ty: PartitionType) -> Result<Self, Self::Error> {
        let (type_, subtype) = ty.try_into()?;
        Ok([type_, subtype])
    }
}

impl PartitionType {
    /// Application partition alignment
    const APP_ALIGN: u32 = 0x10000;

    /// Data partition alignment
    const DATA_ALIGN: u32 = 0x1000;

    /// Get partition alignment
    pub fn align(&self) -> u32 {
        match self {
            PartitionType::App(_) => Self::APP_ALIGN,
            _ => Self::DATA_ALIGN,
        }
    }

    /// Check offset for alignment
    pub fn check_offset(&self, offset: u32) -> Result<(), PartitionError> {
        if offset & (self.align() - 1) == 0 {
            Ok(())
        } else {
            Err(PartitionError::InvalidAlignment)
        }
    }

    /// Convert type and subtype from binary representation
    pub fn from_bytes(data: &[u8; 2]) -> Result<Self, PartitionError> {
        data.try_into()
    }

    /// Convert type and subtype to binary representation
    pub fn to_bytes(&self, data: &mut [u8; 2]) -> Result<(), PartitionError> {
        let (type_, subtype) = (*self).try_into()?;
        data[0] = type_;
        data[1] = subtype;
        Ok(())
    }
}

/// Application partition subtype
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub enum AppPartitionType {
    /// Factory application
    #[default]
    Factory,

    /// OTA application
    Ota(u8),

    /// Test application
    Test,
}

impl TryFrom<u8> for AppPartitionType {
    type Error = PartitionError;

    fn try_from(raw: u8) -> Result<Self, Self::Error> {
        Ok(match raw {
            0x00 => Self::Factory,
            0x10..=0x1f => Self::Ota(raw - 0x10),
            0x20 => Self::Test,
            _ => return Err(PartitionError::InvalidSubType(raw)),
        })
    }
}

impl TryFrom<AppPartitionType> for u8 {
    type Error = PartitionError;

    fn try_from(ty: AppPartitionType) -> Result<Self, Self::Error> {
        use AppPartitionType::*;
        Ok(match ty {
            Factory => 0x00,
            Ota(number @ 0x00..=0x0f) => number + 0x10,
            Ota(number) => return Err(PartitionError::InvalidOtaNumber(number)),
            Test => 0x20,
        })
    }
}

/// Data partition subtype
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
#[repr(u8)]
pub enum DataPartitionType {
    /// OTA data
    #[default]
    Ota = 0x00,

    /// Phy data
    Phy = 0x01,

    /// Non-volatile storage data
    Nvs = 0x02,

    /// Core dump
    CoreDump = 0x03,

    /// Encrypted non-volatile storage keys
    NvsKeys = 0x04,

    /// Efuse data
    EfuseEm = 0x05,

    /// Undefined data
    Undefined = 0x06,

    /// ESP HTTPd data
    EspHttpd = 0x80,

    /// FAT partition
    Fat = 0x81,

    /// SPIFFS partition
    SpiFfs = 0x82,
}

impl TryFrom<u8> for DataPartitionType {
    type Error = PartitionError;

    fn try_from(raw: u8) -> Result<Self, Self::Error> {
        Ok(match raw {
            0x00 => Self::Ota,
            0x01 => Self::Phy,
            0x02 => Self::Nvs,
            0x03 => Self::CoreDump,
            0x04 => Self::NvsKeys,
            0x05 => Self::EfuseEm,
            0x06 => Self::Undefined,
            0x80 => Self::EspHttpd,
            0x81 => Self::Fat,
            0x82 => Self::SpiFfs,
            _ => return Err(PartitionError::InvalidSubType(raw)),
        })
    }
}

impl From<DataPartitionType> for u8 {
    fn from(ty: DataPartitionType) -> Self {
        ty as _
    }
}