mcumgr-toolkit 0.19.0

Core library of the software suite for Zephyr's MCUmgr 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

use crate::commands::image::ImageState;

/// The current run state of the given image.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ImageRunState<'a> {
    /// The given slot is likely the current and future
    /// image on the system.
    Stable(&'a ImageState),
    /// The image will change at next boot.
    Pending {
        /// Currently running/active image, if known.
        current: Option<&'a ImageState>,
        /// The slot that will run after next boot.
        ///
        /// Examine `next.permanent` to see whether
        /// the image will boot in testing or permanent
        /// mode.
        next: &'a ImageState,
    },
    /// A new image is currently being tested.
    ///
    /// Unless it gets confirmed, it will be
    /// rolled back at next boot.
    Testing {
        /// The currently tested image.
        current: &'a ImageState,
        /// The image that will get rolled back to.
        fallback: &'a ImageState,
    },
    /// The current state is not easily determinable.
    ///
    /// Will contain an educated guess if possible,
    /// but by no means this guess should be relied upon.
    Unknown(Option<&'a ImageState>),
    /// The image state is inconsistent.
    ///
    /// Example: The image has multiple slots that are marked 'active'.
    Inconsistent,
}

/// Analyze the flags of the image slots with the given image ID and determine the most likely run state.
pub fn analyze(image_state: &[ImageState], image_id: u32) -> ImageRunState<'_> {
    fn find_unique(
        image_id: u32,
        image_state: &[ImageState],
        predicate: impl Fn(&ImageState) -> bool,
    ) -> Option<Option<&'_ ImageState>> {
        let mut matches = image_state
            .iter()
            .filter(|img| img.image == image_id)
            .filter(|img| predicate(img));

        let first = matches.next();

        match matches.next() {
            Some(_) => None,     // invalid: duplicate
            None => Some(first), // valid: zero or one
        }
    }

    let active = match find_unique(image_id, image_state, |img| img.active) {
        Some(value) => value,
        None => return ImageRunState::Inconsistent,
    };

    let confirmed = match find_unique(image_id, image_state, |img| img.confirmed) {
        Some(value) => value,
        None => return ImageRunState::Inconsistent,
    };

    let pending = match find_unique(image_id, image_state, |img| img.pending) {
        Some(value) => value,
        None => return ImageRunState::Inconsistent,
    };

    if let Some(pending) = pending {
        return ImageRunState::Pending {
            current: active.or(confirmed),
            next: pending,
        };
    }

    match (active, confirmed) {
        (Some(active), Some(confirmed)) if active.slot == confirmed.slot => {
            ImageRunState::Stable(active)
        }
        (Some(active), Some(confirmed)) => ImageRunState::Testing {
            current: active,
            fallback: confirmed,
        },
        (Some(active), None) => ImageRunState::Stable(active),
        (None, Some(confirmed)) => ImageRunState::Stable(confirmed),
        (None, None) => {
            // Probably MCUboot with image infos disabled, guess slot 0
            ImageRunState::Unknown(
                image_state
                    .iter()
                    .filter(|img| img.image == image_id)
                    .find(|img| img.slot == 0),
            )
        }
    }
}