ebds 0.4.2

Messages and related types for implementing the EBDS serial communication protocol
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
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
use crate::std;
use std::fmt;

#[cfg(not(feature = "std"))]
use alloc::string::String;

/// Check digit for the [ProjectNumber].
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct CheckDigit(u8);

impl CheckDigit {
    /// The length (in bytes) of the [CheckDigit].
    pub const LEN: usize = 1;

    /// Converts [CheckDigit] to a u8.
    pub const fn as_u8(&self) -> u8 {
        self.0
    }
}

impl From<u8> for CheckDigit {
    /// Parse the byte as an ASCII string.
    ///
    /// If a direct conversion from a u8 is wanted, use:
    ///
    /// let num = 0x0u8;
    /// let _ = CheckDigit(num);
    fn from(b: u8) -> Self {
        let digit = std::str::from_utf8(&[b])
            .unwrap_or("")
            .parse::<u8>()
            .unwrap_or(0xff);

        Self(digit)
    }
}

impl From<CheckDigit> for u8 {
    fn from(c: CheckDigit) -> Self {
        c.0
    }
}

impl From<&CheckDigit> for u8 {
    fn from(c: &CheckDigit) -> Self {
        (*c).into()
    }
}

/// The Application Part Number type.
#[repr(u8)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum PartNumberType {
    Type1 = 1,
    Type2 = 2,
    Variant = 3,
    Unknown = 0x00,
}

/// The part number is composed of a project number (5-6 digits) and version number (3 digits) with an
/// optional Check sum digit in the middle. Please see the following table for expected values.
///
/// | Project Number (5-6 bytes) | Check Digit (0-1 bytes) | Version (3 bytes) | Description |
/// |----------------------------|-------------------------|-------------------|-------------|
/// | 28000...28599              |                         |                   | Type 1 Application Part Number (Requires Check Digit) **CFSC Only** |
/// | 286000...289999            |                         |                   | Type 2 Application Part Number (No Check Digit) |
/// |                            | 0...9                   |                   | Check digit (Not applicable for Type 2 Application Part Numbers) **CFSC Only** |
/// |                            |                         | 000...999         | Formatted as V1.23 |
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct ProjectNumber {
    number: u32,
    check_digit: CheckDigit,
    part_type: PartNumberType,
}

impl ProjectNumber {
    /// The length (in bytes) of the [ProjectNumber].
    ///
    /// The length represents the ASCII string length, not the internal representation.
    pub const LEN: usize = 6;
    /// The length (in bytes) of a Type 1 Application Part Number.
    pub const TYPE_1_LEN: usize = 5;
    /// The length (in bytes) of a Type 2 Application Part Number.
    pub const TYPE_2_LEN: usize = 6;
    /// The length (in bytes) of a Variant Application Part Number.
    pub const VARIANT_LEN: usize = 5;
    /// The index of the Checksum Digit (invalid for Type 2 Application Part Number).
    pub const CHECK_DIGIT_IDX: usize = 5;

    /// Creates a Type 1 [ProjectNumber] from a number and [CheckDigit].
    pub const fn type1(number: u32, check_digit: CheckDigit) -> Self {
        Self {
            number,
            check_digit,
            part_type: PartNumberType::Type1,
        }
    }

    /// Creates a Type 2 [ProjectNumber].
    pub const fn type2(number: u32) -> Self {
        Self {
            number,
            check_digit: CheckDigit(0xff),
            part_type: PartNumberType::Type2,
        }
    }

    /// Creates a Variant [ProjectNumber] from a number and [CheckDigit].
    pub const fn variant(number: u32, check_digit: CheckDigit) -> Self {
        Self {
            number,
            check_digit,
            part_type: PartNumberType::Variant,
        }
    }

    /// Creates a zeroed [ProjectNumber].
    pub const fn zero() -> Self {
        Self {
            number: 0,
            check_digit: CheckDigit(0x00),
            part_type: PartNumberType::Unknown,
        }
    }

    /// Gets the application part number.
    pub const fn number(&self) -> u32 {
        self.number
    }

    /// Gets the check digit.
    pub const fn check_digit(&self) -> CheckDigit {
        self.check_digit
    }

    /// Gets the [PartNumberType].
    pub const fn part_type(&self) -> PartNumberType {
        self.part_type
    }
}

impl From<&[u8]> for ProjectNumber {
    fn from(b: &[u8]) -> Self {
        if b.len() < Self::LEN {
            return Self::zero();
        }

        let type1: u32 = std::str::from_utf8(b[..Self::TYPE_1_LEN].as_ref())
            .unwrap_or("")
            .parse::<u32>()
            .unwrap_or(0);

        let type2: u32 = std::str::from_utf8(b[..Self::TYPE_2_LEN].as_ref())
            .unwrap_or("")
            .parse::<u32>()
            .unwrap_or(0);

        if (28_000..=28_599).contains(&type1) {
            Self::type1(type1, CheckDigit::from(b[Self::CHECK_DIGIT_IDX]))
        } else if (49000..=49999).contains(&type1) || (51_000..=52_999).contains(&type1) {
            Self::variant(type1, CheckDigit::from(b[Self::CHECK_DIGIT_IDX]))
        } else if (286_000..=289_999).contains(&type2) {
            Self::type2(type2)
        } else {
            Self::zero()
        }
    }
}

impl fmt::Display for ProjectNumber {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self.part_type() {
            PartNumberType::Type1 => write!(
                f,
                "{} check digit: {}",
                self.number,
                self.check_digit.as_u8()
            ),
            PartNumberType::Type2 => write!(f, "{}", self.number),
            PartNumberType::Variant => write!(
                f,
                "{} check digit: {}",
                self.number,
                self.check_digit.as_u8()
            ),
            PartNumberType::Unknown => write!(f, "Unknown"),
        }
    }
}

/// The Boot Version number.
///
/// Formatted as the 3-digit ASCII string divided by one hundred.
///
/// Example:
///
/// ```rust
/// # use ebds::PartVersion;
/// let version = PartVersion::from(b"123");
/// let formatted_version = version.as_string();
/// assert_eq!(formatted_version, "V1.23");
/// ```
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct PartVersion(u16);

impl PartVersion {
    /// The length (in bytes) of the [PartVersion].
    ///
    /// The length represents the ASCII string length, not the internal representation.
    pub const LEN: usize = 3;

    pub fn as_string(&self) -> String {
        format!("{self}")
    }
}

impl From<&[u8]> for PartVersion {
    fn from(b: &[u8]) -> Self {
        let version = std::str::from_utf8(b)
            .unwrap_or("")
            .parse::<u16>()
            .unwrap_or(0);

        if version > 999 {
            Self(0)
        } else {
            Self(version)
        }
    }
}

impl<const N: usize> From<[u8; N]> for PartVersion {
    fn from(b: [u8; N]) -> Self {
        b.as_ref().into()
    }
}

impl<const N: usize> From<&[u8; N]> for PartVersion {
    fn from(b: &[u8; N]) -> Self {
        b.as_ref().into()
    }
}

impl fmt::Display for PartVersion {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "V{:.2}", (self.0 as f32) / 100f32)
    }
}

/// The boot part number from the device firmware.
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct BootPartNumber {
    project_number: ProjectNumber,
    version: PartVersion,
}

impl BootPartNumber {
    /// The length (in bytes) of the [BootPartNumber].
    pub const LEN: usize = 9;

    /// Creates a new [BootPartNumber].
    pub const fn new(project_number: ProjectNumber, version: PartVersion) -> Self {
        Self {
            project_number,
            version,
        }
    }

    pub const fn default() -> Self {
        Self {
            project_number: ProjectNumber::zero(),
            version: PartVersion(0),
        }
    }
}

impl From<&[u8]> for BootPartNumber {
    fn from(b: &[u8]) -> Self {
        if b.len() < Self::LEN {
            Self::default()
        } else {
            let len = std::cmp::min(b.len(), Self::LEN);

            let project_number: ProjectNumber = b[..ProjectNumber::LEN].as_ref().into();
            let version: PartVersion = b[ProjectNumber::LEN..len].as_ref().into();

            Self {
                project_number,
                version,
            }
        }
    }
}

impl fmt::Display for BootPartNumber {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Project number: {}, Version: {}",
            self.project_number, self.version
        )
    }
}

/// The application part number from the device firmware.
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct ApplicationPartNumber {
    project_number: ProjectNumber,
    version: PartVersion,
}

impl ApplicationPartNumber {
    /// The length (in bytes) of the [ApplicationPartNumber].
    pub const LEN: usize = 9;

    /// Creates a new [ApplicationPartNumber].
    pub const fn new(project_number: ProjectNumber, version: PartVersion) -> Self {
        Self {
            project_number,
            version,
        }
    }

    pub const fn default() -> Self {
        Self {
            project_number: ProjectNumber::zero(),
            version: PartVersion(0),
        }
    }
}

impl From<&[u8]> for ApplicationPartNumber {
    fn from(b: &[u8]) -> Self {
        if b.len() < Self::LEN {
            Self::default()
        } else {
            let len = std::cmp::min(b.len(), Self::LEN);

            let project_number: ProjectNumber = b[..ProjectNumber::LEN].as_ref().into();
            let version: PartVersion = b[ProjectNumber::LEN..len].as_ref().into();

            Self {
                project_number,
                version,
            }
        }
    }
}

impl fmt::Display for ApplicationPartNumber {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Project number: {}, Version: {}",
            self.project_number, self.version
        )
    }
}

/// The part number is composed of a project number (5-6 digits) and version number (3 digits) with an
/// optional Check sum digit in the middle. Please see the following table for expected values.
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct VariantPartNumber {
    project_number: ProjectNumber,
    version: PartVersion,
}

impl VariantPartNumber {
    /// The length (in bytes) of the [VariantPartNumber].
    pub const LEN: usize = 9;

    /// Creates a new [VariantPartNumber].
    pub const fn new(project_number: ProjectNumber, version: PartVersion) -> Self {
        Self {
            project_number,
            version,
        }
    }

    pub const fn default() -> Self {
        Self {
            project_number: ProjectNumber::zero(),
            version: PartVersion(0),
        }
    }
}

impl From<&[u8]> for VariantPartNumber {
    fn from(b: &[u8]) -> Self {
        if b.len() < Self::LEN {
            Self::default()
        } else {
            let len = std::cmp::min(b.len(), Self::LEN);

            let project_number: ProjectNumber = b[..ProjectNumber::LEN].as_ref().into();
            let version: PartVersion = b[ProjectNumber::LEN..len].as_ref().into();

            Self {
                project_number,
                version,
            }
        }
    }
}

impl fmt::Display for VariantPartNumber {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Project number: {}, Version: {}",
            self.project_number, self.version
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn boot_version_parsing() {
        let version = PartVersion::from(b"123");
        let formatted_version = version.as_string();
        assert_eq!(formatted_version, "V1.23");

        let version = PartVersion::from(b"23");
        let formatted_version = version.as_string();
        assert_eq!(formatted_version, "V0.23");

        let version = PartVersion::from(b"3");
        let formatted_version = version.as_string();
        assert_eq!(formatted_version, "V0.03");

        let version = PartVersion::from(b"");
        let formatted_version = version.as_string();
        assert_eq!(formatted_version, "V0.00");

        // Number is out of range
        let version = PartVersion::from(b"999888777");
        let formatted_version = version.as_string();
        assert_eq!(formatted_version, "V0.00");
    }
}