Add support for EcRequestPs2EmulationControlV1

Signed-off-by: Daniel Schaefer <dhs@frame.work>

Author: JohnAZoidberg

framework_lib/src/chromium_ec/commands.rs

@@ -1502,6 +1502,10 @@ impl EcRequest<EcResponseChargeLimitControl> for EcRequestChargeLimitControl {
 /// TODO: Use this
 pub const EC_CHARGE_LIMIT_RESTORE: u8 = 0x7F;
 
+pub const PS2_EMULATION_AUTO: u8 = 0;
+pub const PS2_EMULATION_DISABLE: u8 = 1;
+pub const PS2_EMULATION_FORCE_ENABLE: u8 = 2;
+
 #[repr(C, packed)]
 pub struct EcRequestDisablePs2Emulation {
     pub disable: u8,
@@ -1513,6 +1517,28 @@ impl EcRequest<()> for EcRequestDisablePs2Emulation {
     }
 }
 
+#[repr(C, packed)]
+pub struct EcRequestPs2EmulationControlV1 {
+    pub mode: u8,
+}
+
+#[repr(C, packed)]
+#[derive(Clone, Copy)]
+pub struct EcResponsePs2EmulationStatus {
+    pub emulation_disabled: u8,
+    pub host_driver_confirmed: u8,
+    pub detected_host_packet: u8,
+}
+
+impl EcRequest<EcResponsePs2EmulationStatus> for EcRequestPs2EmulationControlV1 {
+    fn command_id() -> EcCommands {
+        EcCommands::DisablePs2Emulation
+    }
+    fn command_version() -> u8 {
+        1
+    }
+}
+
 #[repr(u8)]
 #[derive(Debug, FromPrimitive)]
 pub enum FpLedBrightnessLevel {

framework_lib/src/chromium_ec/mod.rs

@@ -745,6 +745,13 @@ impl CrosEc {
         .send_command(self)
     }
 
+    pub fn ps2_emulation_control(
+        &self,
+        mode: u8,
+    ) -> EcResult<EcResponsePs2EmulationStatus> {
+        EcRequestPs2EmulationControlV1 { mode }.send_command(self)
+    }
+
     pub fn fan_set_rpm(&self, fan: Option<u32>, rpm: u32) -> EcResult<()> {
         if let Some(fan_idx) = fan {
             EcRequestPwmSetFanTargetRpmV1 { rpm, fan_idx }.send_command(self)

framework_lib/src/commandline/clap_std.rs

@@ -12,8 +12,8 @@ use clap_num::maybe_hex;
 use crate::chromium_ec::commands::SetGpuSerialMagic;
 use crate::chromium_ec::CrosEcDriverType;
 use crate::commandline::{
-    Cli, ConsoleArg, FpBrightnessArg, HardwareDeviceType, InputDeckModeArg, LogLevel, RebootEcArg,
-    TabletModeArg,
+    Cli, ConsoleArg, FpBrightnessArg, HardwareDeviceType, InputDeckModeArg, LogLevel, Ps2ModeArg,
+    RebootEcArg, TabletModeArg,
 };
 
 /// Swiss army knife for Framework laptops
@@ -213,10 +213,10 @@ struct ClapCli {
     #[arg(long, value_parser=maybe_hex::<u64>, value_names(["START", "HEXCOLOR"]))]
     rgbkbd: Vec<u64>,
 
-    /// Control PS2 touchpad emulation (DEBUG COMMAND, if touchpad not working, reboot system)
+    /// Control PS2 touchpad emulation (auto/disable/enable)
     #[clap(value_enum, hide(true))]
     #[arg(long)]
-    ps2_enable: Option<bool>,
+    ps2_mode: Option<Ps2ModeArg>,
 
     /// Set tablet mode override
     #[clap(value_enum)]
@@ -519,7 +519,7 @@ pub fn parse(args: &[String]) -> Cli {
         kblight: args.kblight,
         remap_key,
         rgbkbd: args.rgbkbd,
-        ps2_enable: args.ps2_enable,
+        ps2_mode: args.ps2_mode,
         tablet_mode: args.tablet_mode,
         touchscreen_enable: args.touchscreen_enable,
         stylus_battery: args.stylus_battery,

framework_lib/src/commandline/mod.rs

@@ -40,6 +40,7 @@ use crate::chromium_ec::commands::DeckStateMode;
 use crate::chromium_ec::commands::FpLedBrightnessLevel;
 use crate::chromium_ec::commands::RebootEcCmd;
 use crate::chromium_ec::commands::RgbS;
+use crate::chromium_ec::commands::{PS2_EMULATION_AUTO, PS2_EMULATION_DISABLE, PS2_EMULATION_FORCE_ENABLE};
 use crate::chromium_ec::commands::TabletModeOverride;
 use crate::chromium_ec::EcResponseStatus;
 use crate::chromium_ec::{print_err, EcFlashType};
@@ -80,6 +81,14 @@ use crate::chromium_ec::{CrosEc, CrosEcDriverType, HardwareDeviceType};
 #[cfg(feature = "uefi")]
 use core::prelude::rust_2021::derive;
 
+#[cfg_attr(not(feature = "uefi"), derive(clap::ValueEnum))]
+#[derive(Clone, Debug, PartialEq)]
+pub enum Ps2ModeArg {
+    Auto,
+    Disable,
+    Enable,
+}
+
 #[cfg_attr(not(feature = "uefi"), derive(clap::ValueEnum))]
 #[derive(Clone, Debug, PartialEq)]
 pub enum TabletModeArg {
@@ -208,7 +217,7 @@ pub struct Cli {
     pub kblight: Option<Option<u8>>,
     pub remap_key: Option<(u8, u8, u16)>,
     pub rgbkbd: Vec<u64>,
-    pub ps2_enable: Option<bool>,
+    pub ps2_mode: Option<Ps2ModeArg>,
     pub tablet_mode: Option<TabletModeArg>,
     pub touchscreen_enable: Option<bool>,
     pub stylus_battery: bool,
@@ -296,7 +305,7 @@ pub fn parse(args: &[String]) -> Cli {
             kblight: cli.kblight,
             remap_key: cli.remap_key,
             rgbkbd: cli.rgbkbd,
-            ps2_enable: cli.ps2_enable,
+            ps2_mode: cli.ps2_mode,
             // tablet_mode
             // touchscreen_enable
             stylus_battery: cli.stylus_battery,
@@ -1441,8 +1450,25 @@ pub fn run_with_args(args: &Cli, _allupdate: bool) -> i32 {
             });
             ec.rgbkbd_set_color(start_key, colors.collect()).unwrap();
         }
-    } else if let Some(enable) = args.ps2_enable {
-        print_err(ec.ps2_emulation_enable(enable));
+    } else if let Some(ps2_arg) = &args.ps2_mode {
+        let mode = match ps2_arg {
+            Ps2ModeArg::Auto => PS2_EMULATION_AUTO,
+            Ps2ModeArg::Disable => PS2_EMULATION_DISABLE,
+            Ps2ModeArg::Enable => PS2_EMULATION_FORCE_ENABLE,
+        };
+        match ec.ps2_emulation_control(mode) {
+            Ok(status) => {
+                println!("PS2 Emulation:      {}", if status.emulation_disabled != 0 { "Disabled" } else { "Auto" });
+                println!("Host Driver:        {}", if status.host_driver_confirmed != 0 { "Confirmed" } else { "Not Confirmed" });
+                println!("Host I2C Activity:  {}", if status.detected_host_packet != 0 { "Detected" } else { "Not Detected" });
+            }
+            Err(e) => {
+                // Fall back to v0 if EC firmware doesn't support v1
+                println!("Note: EC firmware does not support status query ({:?})", e);
+                let enable = !matches!(ps2_arg, Ps2ModeArg::Disable);
+                print_err(ec.ps2_emulation_enable(enable));
+            }
+        }
     } else if let Some(tablet_arg) = &args.tablet_mode {
         let mode = match tablet_arg {
             TabletModeArg::Auto => TabletModeOverride::Default,

framework_lib/src/commandline/uefi.rs

@@ -12,7 +12,7 @@ use crate::chromium_ec::commands::SetGpuSerialMagic;
 use crate::chromium_ec::{CrosEcDriverType, HardwareDeviceType};
 use crate::commandline::{Cli, LogLevel};
 
-use super::{ConsoleArg, FpBrightnessArg, InputDeckModeArg, RebootEcArg, TabletModeArg};
+use super::{ConsoleArg, FpBrightnessArg, InputDeckModeArg, Ps2ModeArg, RebootEcArg, TabletModeArg};
 
 /// Get commandline arguments from UEFI environment
 pub fn get_args(bs: &BootServices, image_handle: Handle) -> Vec<String> {
@@ -71,7 +71,7 @@ pub fn parse(args: &[String]) -> Cli {
         kblight: None,
         remap_key: None,
         rgbkbd: vec![],
-        ps2_enable: None,
+        ps2_mode: None,
         tablet_mode: None,
         touchscreen_enable: None,
         stylus_battery: false,
@@ -370,23 +370,25 @@ pub fn parse(args: &[String]) -> Cli {
                 println!("--rgbkbd requires at least 2 arguments, the start key and an RGB value");
                 vec![]
             }
-        } else if arg == "--ps2-enable" {
-            cli.ps2_enable = if args.len() > i + 1 {
-                let enable_arg = &args[i + 1];
-                if enable_arg == "true" {
-                    Some(true)
-                } else if enable_arg == "false" {
-                    Some(false)
+        } else if arg == "--ps2-mode" {
+            cli.ps2_mode = if args.len() > i + 1 {
+                let mode_arg = &args[i + 1];
+                if mode_arg == "auto" {
+                    Some(Ps2ModeArg::Auto)
+                } else if mode_arg == "disable" {
+                    Some(Ps2ModeArg::Disable)
+                } else if mode_arg == "enable" {
+                    Some(Ps2ModeArg::Enable)
                 } else {
                     println!(
-                        "Need to provide a value for --ps2-enable: '{}'. {}",
+                        "Need to provide a value for --ps2-mode: '{}'. {}",
                         args[i + 1],
-                        "Must be `true` or `false`",
+                        "Must be `auto`, `disable` or `enable`",
                     );
                     None
                 }
             } else {
-                println!("Need to provide a value for --tablet-mode. One of: `auto`, `tablet` or `laptop`");
+                println!("Need to provide a value for --ps2-mode. One of: `auto`, `disable` or `enable`");
                 None
             };
             found_an_option = true;