Add InvalidPreferredSlotId error for use in rot prep_image_update

Author: lzrd

gateway-messages/src/sp_to_mgs.rs

@@ -1283,6 +1283,7 @@ pub enum UpdateError {
     ImageMismatch,
     SignatureNotValidated,
     VersionNotSupported,
+    InvalidPreferredSlotId,
 }
 
 impl fmt::Display for UpdateError {
@@ -1342,6 +1343,12 @@ impl fmt::Display for UpdateError {
             Self::InvalidComponent => {
                 write!(f, "invalid component for operation")
             }
+            Self::InvalidPreferredSlotId => {
+                write!(
+                    f,
+                    "updating a bootloader preferred slot is not permitted"
+                )
+            }
         }
     }
 }

gateway-messages/tests/versioning/mod.rs

@@ -24,6 +24,7 @@ mod v15;
 mod v16;
 mod v17;
 mod v18;
+mod v19;
 
 pub fn assert_serialized<T: Serialize + SerializedSize + std::fmt::Debug>(
     expected: &[u8],

gateway-messages/tests/versioning/v19.rs

@@ -0,0 +1,108 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+//! This source file is named after the protocol version being tested,
+//! e.g. v01.rs implements tests for protocol version 1.
+//! The tested protocol version is represented by "$VERSION" below.
+//!
+//! The tests in this module check that the serialized form of messages from MGS
+//! protocol version $VERSION have not changed.
+//!
+//! If a test in this module fails, _do not change the test_! This means you
+//! have changed, deleted, or reordered an existing message type or enum
+//! variant, and you should revert that change. This will remain true until we
+//! bump the `version::MIN` to a value higher than $VERSION, at which point these
+//! tests can be removed as we will stop supporting $VERSION.
+
+use super::assert_serialized;
+use gateway_messages::Fwid;
+use gateway_messages::ImageError;
+use gateway_messages::MgsRequest;
+use gateway_messages::RotBootInfo;
+use gateway_messages::RotSlotId;
+use gateway_messages::RotStateV3;
+use gateway_messages::SpResponse;
+use gateway_messages::SpStateV3;
+use gateway_messages::UpdateError;
+
+#[test]
+fn sp_response() {
+    let response = SpResponse::SpStateV3(SpStateV3 {
+        hubris_archive_id: [1, 2, 3, 4, 5, 6, 7, 8],
+        serial_number: [
+            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,
+        ],
+        model: [
+            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,
+        ],
+        revision: 0xf0f1f2f3,
+        base_mac_address: [73, 74, 75, 76, 77, 78],
+        power_state: gateway_messages::PowerState::A0,
+    });
+
+    #[rustfmt::skip]
+    let expected = vec![
+        44, // SpStateV3
+        1, 2, 3, 4, 5, 6, 7, 8, // hubris_archive_id
+
+        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, // serial_number
+
+        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, // model
+
+        0xf3, 0xf2, 0xf1, 0xf0, // revision
+        73, 74, 75, 76, 77, 78, // base_mac_address
+        0, // power_state
+    ];
+
+    assert_serialized(&expected, &response);
+}
+
+#[test]
+fn host_request() {
+    let request = MgsRequest::VersionedRotBootInfo { version: 3 };
+
+    #[rustfmt::skip]
+    let expected = vec![
+        45, // VersionedRotBootInfo
+        3, // version
+    ];
+
+    assert_serialized(&expected, &request);
+}
+
+#[test]
+fn error_enums() {
+    let response: [ImageError; 13] = [
+        ImageError::Unchecked,
+        ImageError::FirstPageErased,
+        ImageError::PartiallyProgrammed,
+        ImageError::InvalidLength,
+        ImageError::HeaderNotProgrammed,
+        ImageError::BootloaderTooSmall,
+        ImageError::BadMagic,
+        ImageError::HeaderImageSize,
+        ImageError::UnalignedLength,
+        ImageError::UnsupportedType,
+        ImageError::ResetVectorNotThumb2,
+        ImageError::ResetVector,
+        ImageError::Signature,
+    ];
+    let expected = vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
+    assert_serialized(&expected, &response);
+
+    let response: [UpdateError; 4] = [
+        UpdateError::BlockOutOfOrder,
+        UpdateError::InvalidComponent,
+        UpdateError::InvalidSlotIdForOperation,
+        UpdateError::InvalidPreferredSlotId,
+    ];
+    let expected = vec![27, 28, 29, 34];
+    assert_serialized(&expected, &response);
+}

gateway-sp-comms/src/error.rs

@@ -116,6 +116,8 @@ pub enum UpdateError {
     InvalidComponent,
     #[error("an image was not found")]
     ImageNotFound,
+    #[error("updating a bootloader preferred slot is not permitted")]
+    InvalidPreferredSlotId,
 }
 
 #[derive(Debug, thiserror::Error, SlogInlineError)]