Add ComponentDetails::GpioToggleCount (#452)

Author: mkeeter

faux-mgs/src/main.rs

@@ -2263,6 +2263,7 @@ fn component_details_to_json(details: SpComponentDetails) -> serde_json::Value {
         PortStatus(Result<PortStatus, PortStatusError>),
         Measurement(Measurement),
         LastPostCode(u32),
+        GpioToggleCount { edge_count: u32, cycles_since_last_edge: u32 },
     }
 
     #[derive(serde::Serialize)]
@@ -2289,6 +2290,12 @@ fn component_details_to_json(details: SpComponentDetails) -> serde_json::Value {
             gateway_messages::ComponentDetails::LastPostCode(code) => {
                 ComponentDetails::LastPostCode(code.0)
             }
+            gateway_messages::ComponentDetails::GpioToggleCount(n) => {
+                ComponentDetails::GpioToggleCount {
+                    edge_count: n.edge_count,
+                    cycles_since_last_edge: n.cycles_since_last_edge,
+                }
+            }
         })
         .collect::<Vec<_>>();
 

gateway-messages/src/sp_to_mgs.rs

@@ -22,14 +22,15 @@ use serde::Serialize;
 use serde_repr::Deserialize_repr;
 use serde_repr::Serialize_repr;
 
+pub mod host_cpu_details;
 pub mod ignition;
 pub mod measurement;
 pub mod monorail_port_status;
-pub mod sp5_details;
 
+pub use host_cpu_details::GpioToggleCount;
+pub use host_cpu_details::LastPostCode;
 pub use ignition::IgnitionState;
 pub use measurement::Measurement;
-pub use sp5_details::LastPostCode;
 
 use ignition::IgnitionError;
 use measurement::MeasurementHeader;
@@ -719,6 +720,7 @@ pub enum ComponentDetails {
     PortStatus(Result<PortStatus, PortStatusError>),
     Measurement(Measurement),
     LastPostCode(LastPostCode),
+    GpioToggleCount(GpioToggleCount),
 }
 
 impl ComponentDetails {
@@ -727,6 +729,7 @@ impl ComponentDetails {
             ComponentDetails::PortStatus(_) => PortStatus::TAG,
             ComponentDetails::Measurement(_) => MeasurementHeader::TAG,
             ComponentDetails::LastPostCode(_) => LastPostCode::TAG,
+            ComponentDetails::GpioToggleCount(_) => GpioToggleCount::TAG,
         }
     }
 
@@ -751,6 +754,9 @@ impl ComponentDetails {
             ComponentDetails::LastPostCode(code) => {
                 hubpack::serialize(buf, code)
             }
+            ComponentDetails::GpioToggleCount(code) => {
+                hubpack::serialize(buf, code)
+            }
         }
     }
 }

gateway-messages/src/sp_to_mgs/sp5_details.rs renamed to gateway-messages/src/sp_to_mgs/host_cpu_details.rs

@@ -6,6 +6,19 @@ use crate::tlv;
 use hubpack::SerializedSize;
 use serde::{Deserialize, Serialize};
 
+/// Timestamped count values for a toggling GPIO, used for liveness checks
+#[derive(Copy, Clone, Debug, Serialize, Deserialize, SerializedSize)]
+pub struct GpioToggleCount {
+    /// Number of edges seen on the GPIO
+    pub edge_count: u32,
+    /// Number of clock cycles since the last GPIO edge has been seen
+    pub cycles_since_last_edge: u32,
+}
+
+impl GpioToggleCount {
+    pub const TAG: tlv::Tag = tlv::Tag(*b"TOGL");
+}
+
 /// Most recent POST code seen by the sequencer FPGA
 #[derive(Copy, Clone, Debug, Serialize, Deserialize, SerializedSize)]
 pub struct LastPostCode(pub u32);

gateway-sp-comms/src/single_sp.rs

@@ -1572,11 +1572,12 @@ impl TlvRpc for ComponentDetailsTlvRpc<'_> {
         tag: tlv::Tag,
         value: &[u8],
     ) -> Result<Option<Self::Item>> {
+        use gateway_messages::host_cpu_details::GpioToggleCount;
+        use gateway_messages::host_cpu_details::LastPostCode;
         use gateway_messages::measurement::Measurement;
         use gateway_messages::measurement::MeasurementHeader;
         use gateway_messages::monorail_port_status::PortStatus;
         use gateway_messages::monorail_port_status::PortStatusError;
-        use gateway_messages::sp5_details::LastPostCode;
 
         match tag {
             PortStatus::TAG => {
@@ -1640,6 +1641,23 @@ impl TlvRpc for ComponentDetailsTlvRpc<'_> {
 
                 Ok(Some(ComponentDetails::LastPostCode(result)))
             }
+            GpioToggleCount::TAG => {
+                let (result, leftover) =
+                    gateway_messages::deserialize::<GpioToggleCount>(value)
+                        .map_err(|err| CommunicationError::TlvDeserialize {
+                            tag,
+                            err,
+                        })?;
+
+                if !leftover.is_empty() {
+                    info!(
+                        self.log,
+                        "ignoring unexpected data in GpioToggleCount TLV entry"
+                    );
+                }
+
+                Ok(Some(ComponentDetails::GpioToggleCount(result)))
+            }
             _ => {
                 info!(
                     self.log,