Add command APIs

Author: jamesmunns

faux-mgs/src/main.rs

@@ -3281,27 +3281,8 @@ fn component_details_to_json(details: SpComponentDetails) -> serde_json::Value {
         Measurement(Measurement),
         LastPostCode(u32),
         PostCode(u32),
-        GpioToggleCount {
-            edge_count: u32,
-            cycles_since_last_edge: u32,
-        },
-        Pcie {
-            bar: u32,
-            offset: u32,
-            reg_result: Result<u32, u32>,
-        },
-        PmbusStatus {
-            status_word: u16,
-            status_vout: u8,
-            status_iout: u8,
-            status_temperature: u8,
-            status_cml: u8,
-            status_other: u8,
-            status_input: u8,
-            status_mfr_specific: u8,
-            status_fans_1_2: u8,
-            status_fans_3_4: u8,
-        },
+        GpioToggleCount { edge_count: u32, cycles_since_last_edge: u32 },
+        Pcie { bar: u32, offset: u32, reg_result: Result<u32, u32> },
     }
 
     #[derive(serde::Serialize)]
@@ -3344,20 +3325,6 @@ fn component_details_to_json(details: SpComponentDetails) -> serde_json::Value {
                     reg_result: p.reg_result,
                 }
             }
-            gateway_messages::ComponentDetails::PmbusStatus(stat) => {
-                ComponentDetails::PmbusStatus {
-                    status_word: stat.status_word,
-                    status_vout: stat.status_vout,
-                    status_iout: stat.status_iout,
-                    status_temperature: stat.status_temperature,
-                    status_cml: stat.status_cml,
-                    status_other: stat.status_other,
-                    status_input: stat.status_input,
-                    status_mfr_specific: stat.status_mfr_specific,
-                    status_fans_1_2: stat.status_fans_1_2,
-                    status_fans_3_4: stat.status_fans_3_4,
-                }
-            }
         })
         .collect::<Vec<_>>();
 

gateway-messages/src/mgs_to_sp.rs

@@ -5,6 +5,7 @@
 //! Types for messages sent from MGS to SPs.
 
 use crate::BadRequestReason;
+use crate::PowerRailName;
 use crate::PowerState;
 use crate::RotRequest;
 use crate::RotSlotId;
@@ -241,6 +242,9 @@ pub enum MgsRequest {
     /// current default slot as persisted in non-volatile memory. This may be
     /// different than the current active slot (see `ComponentGetActiveSlot`).
     ComponentGetPersistentSlot(SpComponent),
+
+    /// Request the STATUS registers of a PMBus device, indexed by Power Rail Name
+    GetPMBusStatus(PowerRailName),
 }
 
 #[derive(

gateway-messages/src/sp_impl.rs

@@ -26,6 +26,10 @@ use crate::MessageKind;
 use crate::MgsError;
 use crate::MgsRequest;
 use crate::MgsResponse;
+use crate::PMBusStatusResponse;
+use crate::PmbusStatus;
+use crate::PmbusStatusError;
+use crate::PowerRailName;
 use crate::PowerState;
 use crate::PowerStateTransition;
 use crate::ROT_PAGE_SIZE;
@@ -422,6 +426,11 @@ pub trait SpHandler {
     fn start_host_flash_hash(&mut self, slot: u16) -> Result<(), SpError>;
 
     fn get_host_flash_hash(&mut self, slot: u16) -> Result<[u8; 32], SpError>;
+
+    fn get_pmbus_status(
+        &mut self,
+        rail: &PowerRailName,
+    ) -> Result<Result<PmbusStatus, PmbusStatusError>, SpError>;
 }
 
 /// Handle a single incoming message.
@@ -1055,6 +1064,14 @@ fn handle_mgs_request<H: SpHandler>(
         MgsRequest::GetHostFlashHash { slot } => {
             handler.get_host_flash_hash(slot).map(SpResponse::HostFlashHash)
         }
+        MgsRequest::GetPMBusStatus(power_rail_name) => {
+            handler.get_pmbus_status(&power_rail_name).map(|res| {
+                SpResponse::PmbusStatus(PMBusStatusResponse {
+                    rail: power_rail_name,
+                    result: res,
+                })
+            })
+        }
     };
 
     let response = match result {
@@ -1487,6 +1504,13 @@ mod tests {
         ) -> Result<[u8; 32], SpError> {
             unimplemented!()
         }
+
+        fn get_pmbus_status(
+            &mut self,
+            _rail: &PowerRailName,
+        ) -> Result<Result<PmbusStatus, PmbusStatusError>, SpError> {
+            unimplemented!()
+        }
     }
 
     #[cfg(feature = "std")]

gateway-messages/src/sp_to_mgs.rs

@@ -5,6 +5,7 @@
 //! Types for messages sent from SPs to MGS.
 
 use crate::BadRequestReason;
+use crate::PowerRailName;
 use crate::PowerState;
 use crate::RotResponse;
 use crate::RotSlotId;
@@ -186,6 +187,17 @@ pub enum SpResponse {
 
     /// Default slot as persisted in non-volatile memory
     ComponentPersistentSlot(u16),
+
+    /// PMBus status of a given rail
+    PmbusStatus(PMBusStatusResponse),
+}
+
+#[derive(
+    Clone, Copy, Debug, PartialEq, Serialize, Deserialize, SerializedSize,
+)]
+pub struct PMBusStatusResponse {
+    pub rail: PowerRailName,
+    pub result: Result<PmbusStatus, PmbusStatusError>,
 }
 
 /// Identifier for one of of an SP's KSZ8463 management-network-facing ports.
@@ -712,24 +724,25 @@ pub struct TlvPage {
     pub total: u32,
 }
 
+#[derive(
+    Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, SerializedSize,
+)]
+pub enum PmbusStatusError {}
+
 #[derive(
     Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, SerializedSize,
 )]
 pub struct PmbusStatus {
     pub status_word: u16,
-    pub status_vout: u8,
-    pub status_iout: u8,
-    pub status_temperature: u8,
-    pub status_cml: u8,
-    pub status_other: u8,
-    pub status_input: u8,
-    pub status_mfr_specific: u8,
-    pub status_fans_1_2: u8,
-    pub status_fans_3_4: u8,
-}
-
-impl PmbusStatus {
-    pub const TAG: tlv::Tag = tlv::Tag(*b"PMBS");
+    pub status_vout: Result<u8, PmbusStatusError>,
+    pub status_iout: Result<u8, PmbusStatusError>,
+    pub status_temperature: Result<u8, PmbusStatusError>,
+    pub status_cml: Result<u8, PmbusStatusError>,
+    pub status_other: Result<u8, PmbusStatusError>,
+    pub status_input: Result<u8, PmbusStatusError>,
+    pub status_mfr_specific: Result<u8, PmbusStatusError>,
+    pub status_fans_1_2: Result<u8, PmbusStatusError>,
+    pub status_fans_3_4: Result<u8, PmbusStatusError>,
 }
 
 /// Types of component details that can be included in the TLV-encoded data of
@@ -749,7 +762,6 @@ pub enum ComponentDetails {
     PostCode(PostCode),
     GpioToggleCount(GpioToggleCount),
     Pcie(PcieRegisterRead),
-    PmbusStatus(PmbusStatus),
 }
 
 impl ComponentDetails {
@@ -761,7 +773,6 @@ impl ComponentDetails {
             ComponentDetails::PostCode(_) => PostCode::TAG,
             ComponentDetails::GpioToggleCount(_) => GpioToggleCount::TAG,
             ComponentDetails::Pcie(_) => PcieRegisterRead::TAG,
-            ComponentDetails::PmbusStatus(_) => PmbusStatus::TAG,
         }
     }
 
@@ -791,9 +802,6 @@ impl ComponentDetails {
                 hubpack::serialize(buf, code)
             }
             ComponentDetails::Pcie(p) => hubpack::serialize(buf, p),
-            ComponentDetails::PmbusStatus(stat) => {
-                hubpack::serialize(buf, stat)
-            }
         }
     }
 }

wireshark/protofields.lua

@@ -95,6 +95,7 @@ M.mgs_request.names = {
     [48] = "StartHostFlashHash",
     [49] = "GetHostFlashHash",
     [50] = "ComponentGetPersistentSlot",
+    [51] = "GetPmBusStatus",
 }
 M.mgs_request.handlers = {
     [0] = "dissect_discover",
@@ -148,6 +149,7 @@ M.mgs_request.handlers = {
     [48] = "dissect_start_host_flash_hash",
     [49] = "dissect_get_host_flash_hash",
     [50] = "dissect_component_get_persistent_slot",
+    [51] = "dissect_get_pm_bus_status",
 }
 M.mgs_request.field = ProtoField.uint8(
     "mgs.mgs_request",
@@ -333,6 +335,7 @@ M.sp_response.names = {
     [50] = "StartHostFlashHashAck",
     [51] = "HostFlashHash",
     [52] = "ComponentPersistentSlot",
+    [53] = "PmbusStatus",
 }
 M.sp_response.handlers = {
     [0] = "dissect_discover",
@@ -388,6 +391,7 @@ M.sp_response.handlers = {
     [50] = "dissect_start_host_flash_hash_ack",
     [51] = "dissect_host_flash_hash",
     [52] = "dissect_component_persistent_slot",
+    [53] = "dissect_pmbus_status",
 }
 M.sp_response.field = ProtoField.uint8(
     "mgs.sp_response",