Add host command to control retimer status

Not normally used, only during firmware update and compliance testing.
Adding it for debug purposes only.

Signed-off-by: Daniel Schaefer <[email protected]>

Author: JohnAZoidberg

framework_lib/src/chromium_ec/command.rs

@@ -72,6 +72,8 @@ pub enum EcCommands {
     ChassisOpenCheck = 0x3E0F,
     /// Get information about historical chassis open/close (intrusion) information
     ChassisIntrusion = 0x3E09,
+    /// Control and check retimer modes (firmware update and compliance)
+    RetimerControl = 0x3E0A,
 
     /// Not used by this library
     AcpiNotify = 0xE10,

framework_lib/src/chromium_ec/commands.rs

@@ -1022,6 +1022,39 @@ impl EcRequest<EcResponseChassisIntrusionControl> for EcRequestChassisIntrusionC
     }
 }
 
+#[repr(u8)]
+pub enum RetimerControlMode {
+    /// AMD and Intel
+    EntryFwUpdateMode = 0x01,
+    /// AMD and Intel
+    ExitFwUpdateMode = 0x02,
+    /// Intel only
+    EnableComplianceMode = 0x04,
+    /// Intel only
+    DisableComplianceMode = 0x08,
+    /// Check if in FwUpdateMode
+    CheckStatus = 0x80,
+}
+
+#[repr(C, packed)]
+pub struct EcRequestRetimerControl {
+    /// 0 (right) or 1 (left)
+    pub controller: u8,
+    /// See RetimerControlMode
+    pub mode: u8,
+}
+
+#[repr(C, packed)]
+pub struct EcResponseRetimerControlStatus {
+    pub status: u8,
+}
+
+impl EcRequest<EcResponseRetimerControlStatus> for EcRequestRetimerControl {
+    fn command_id() -> EcCommands {
+        EcCommands::RetimerControl
+    }
+}
+
 #[repr(C, packed)]
 pub struct EcRequestReadPdVersionV0 {}
 

framework_lib/src/chromium_ec/mod.rs

@@ -547,6 +547,63 @@ impl CrosEc {
         })
     }
 
+    /// Check if the retimer is in firmware update mode
+    ///
+    /// This is normally false. Update mode is used to enable the retimer power even when no device
+    /// is attached.
+    pub fn retimer_in_fwupd_mode(&self, retimer: u8) -> EcResult<bool> {
+        let status = EcRequestRetimerControl {
+            controller: retimer,
+            mode: RetimerControlMode::CheckStatus as u8,
+        }
+        .send_command(self)?;
+
+        Ok(status.status == 0x01)
+    }
+
+    /// Enable or disable retimer update mode
+    ///
+    /// Check for success and returns Err if not successful
+    pub fn retimer_enable_fwupd(&self, retimer: u8, enable: bool) -> EcResult<()> {
+        if self.retimer_in_fwupd_mode(retimer)? == enable {
+            info!("Retimer update mode already: {:?}", enable);
+            return Ok(());
+        }
+        EcRequestRetimerControl {
+            controller: retimer,
+            mode: if enable {
+                RetimerControlMode::EntryFwUpdateMode as u8
+            } else {
+                RetimerControlMode::ExitFwUpdateMode as u8
+            },
+        }
+        .send_command(self)?;
+
+        if self.retimer_in_fwupd_mode(retimer)? != enable {
+            return Err(EcError::DeviceError(format!(
+                "Failed to set retimer update mode to: {}",
+                enable
+            )));
+        }
+        Ok(())
+    }
+
+    /// Enable or disable retimer Thunderbolt compliance mode (Intel only)
+    ///
+    /// Cannot check for success
+    pub fn retimer_enable_compliance(&self, retimer: u8, enable: bool) -> EcResult<()> {
+        EcRequestRetimerControl {
+            controller: retimer,
+            mode: if enable {
+                RetimerControlMode::EnableComplianceMode as u8
+            } else {
+                RetimerControlMode::DisableComplianceMode as u8
+            },
+        }
+        .send_command(self)?;
+        Ok(())
+    }
+
     pub fn get_input_deck_status(&self) -> EcResult<InputDeckStatus> {
         let status = EcRequestDeckState {
             mode: DeckStateMode::ReadOnly,