Check whether (processor generation, spi_mode_bulldozer, spi_mode_zen_naples, spi_mode_zen_rome) that was specified by the user is actually valid

Fixes <#141>.

Author: Danny Milosavljevic

Cargo.toml

@@ -8,7 +8,7 @@ edition = "2018"
 
 [dependencies]
 amd-apcb = { git = "https://github.com/oxidecomputer/amd-apcb.git", tag = "v0.1.5", features = ["std", "serde", "schemars"] }
-amd-efs = { git = "ssh://[email protected]/oxidecomputer/amd-efs.git", tag = "v0.3.0", features = ["std", "serde", "schemars"] }
+amd-efs = { path = "../amd-efs", features = ["std", "serde", "schemars"] }
 amd-flash = { git = "ssh://[email protected]/oxidecomputer/amd-flash.git", tag = "v0.2.1", features = ["std"] }
 goblin = { version = "0.4", features = ["elf64", "endian_fd"] }
 #serde = { version = "1.0", default-features = false, features = ["derive"] }

amd-host-image-builder-config/src/lib.rs

@@ -19,10 +19,16 @@ use amd_efs::{
 use amd_flash::Location;
 
 #[derive(Debug)]
+#[derive(thiserror::Error)]
+#[non_exhaustive]
 pub enum Error {
+    #[error("Efs {0}")]
     Efs(amd_efs::Error),
+    #[error("incompatible executable")]
     IncompatibleExecutable,
+    #[error("Io {0}")]
     Io(std::io::Error),
+    #[error("image too big")]
     ImageTooBig,
 }
 
@@ -283,21 +289,102 @@ pub enum SerdeBhdDirectoryVariant<'a> {
 #[derive(serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
 #[serde(rename = "Config")]
 #[serde(deny_unknown_fields)]
-pub struct SerdeConfig<'a> {
+struct RawSerdeConfig<'a> {
     pub processor_generation: ProcessorGeneration,
     #[serde(default)]
-    pub spi_mode_bulldozer: EfhBulldozerSpiMode,
+    pub spi_mode_bulldozer: Option<EfhBulldozerSpiMode>,
     #[serde(default)]
-    pub spi_mode_zen_naples: EfhNaplesSpiMode,
+    pub spi_mode_zen_naples: Option<EfhNaplesSpiMode>,
     #[serde(default)]
-    pub spi_mode_zen_rome: EfhRomeSpiMode,
+    pub spi_mode_zen_rome: Option<EfhRomeSpiMode>,
     pub psp: SerdePspDirectoryVariant,
     #[serde(bound(
         deserialize = "SerdeBhdDirectoryVariant<'a>: Deserialize<'de>"
     ))]
     pub bhd: SerdeBhdDirectoryVariant<'a>,
 }
 
+// TODO: #[serde(bound(serialize = "T: MySerTrait", deserialize = "T: MyDeTrait"))]
+// TODO: impl serde::Serialize
+#[derive(serde::Serialize, serde::Deserialize)]
+#[serde(try_from = "RawSerdeConfig")]
+#[serde(into = "RawSerdeConfig")]
+pub struct SerdeConfig<'a> { // Note: same fields as above!
+    pub processor_generation: ProcessorGeneration,
+    pub spi_mode_bulldozer: Option<EfhBulldozerSpiMode>,
+    pub spi_mode_zen_naples: Option<EfhNaplesSpiMode>,
+    pub spi_mode_zen_rome: Option<EfhRomeSpiMode>,
+    pub psp: SerdePspDirectoryVariant,
+    pub bhd: SerdeBhdDirectoryVariant<'a>,
+}
+
+impl<'a> schemars::JsonSchema for SerdeConfig<'a> {
+    fn schema_name() -> std::string::String {
+        RawSerdeConfig::schema_name()
+    }
+    fn json_schema(
+        gen: &mut schemars::gen::SchemaGenerator,
+    ) -> schemars::schema::Schema {
+        RawSerdeConfig::json_schema(gen)
+    }
+    fn is_referenceable() -> bool {
+        RawSerdeConfig::is_referenceable()
+    }
+}
+
+impl<'a> From<SerdeConfig<'a>> for RawSerdeConfig<'a> {
+    fn from(config: SerdeConfig<'a>) -> Self {
+        Self {
+            processor_generation: config.processor_generation,
+            spi_mode_bulldozer: config.spi_mode_bulldozer,
+            spi_mode_zen_naples: config.spi_mode_zen_naples,
+            spi_mode_zen_rome: config.spi_mode_zen_rome,
+            psp: config.psp,
+            bhd: config.bhd,
+        }
+    }
+}
+
+/// This validates whether the spi mode is compatible with the
+/// processor generation (used to validate after deserialization
+/// of a json5 config)
+impl<'a> core::convert::TryFrom<RawSerdeConfig<'a>> for SerdeConfig<'a> {
+    type Error = Error;
+    fn try_from(raw: RawSerdeConfig<'a>) -> core::result::Result<Self, Self::Error> {
+        match raw.processor_generation {
+            ProcessorGeneration::Naples => {
+                if raw.spi_mode_bulldozer.is_none()
+                && raw.spi_mode_zen_naples.is_some()
+                && raw.spi_mode_zen_rome.is_none() {
+                    return Ok(SerdeConfig {
+                        processor_generation: raw.processor_generation,
+                        spi_mode_bulldozer: raw.spi_mode_bulldozer,
+                        spi_mode_zen_naples: raw.spi_mode_zen_naples,
+                        spi_mode_zen_rome: raw.spi_mode_zen_rome,
+                        psp: raw.psp,
+                        bhd: raw.bhd,
+                    });
+                }
+            }
+            ProcessorGeneration::Rome | ProcessorGeneration::Milan => {
+                if raw.spi_mode_bulldozer.is_none()
+                && raw.spi_mode_zen_naples.is_none()
+                && raw.spi_mode_zen_rome.is_some() {
+                    return Ok(SerdeConfig {
+                        processor_generation: raw.processor_generation,
+                        spi_mode_bulldozer: raw.spi_mode_bulldozer,
+                        spi_mode_zen_naples: raw.spi_mode_zen_naples,
+                        spi_mode_zen_rome: raw.spi_mode_zen_rome,
+                        psp: raw.psp,
+                        bhd: raw.bhd,
+                    });
+                }
+            }
+        }
+        Err(Error::Efs(amd_efs::Error::SpiModeMismatch))
+    }
+}
+
 #[cfg(test)]
 mod tests {
     #[test]