Hotfix: graphics help display

Try to handle module remove more gracefully if in-use when the
display manager is shutting down

CHANGELOG.md

@@ -5,6 +5,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+# [3.1.4] - 2021-03-10
+### Changed
+- Notify through dbus if user changes profile manually
+- Better help on CLI, show help only for supported items
+- Bugfix to gfx switcher
+
+# [3.1.3] - 2021-03-10
+### Changed
+- Hotfix: gracefully handle removing modules in use caused by display-manager not
+  fully shutdown at the time of trying to remove modules. It will now retry every
+  250ms per module
 
 # [3.1.2] - 2021-03-10
 ### Changed

Cargo.lock

@@ -33,8 +33,9 @@ dependencies = [
 
 [[package]]
 name = "asusctl"
-version = "3.1.0"
+version = "3.1.1"
 dependencies = [
+ "daemon",
  "gumdrop",
  "rog_dbus",
  "rog_types",
@@ -187,7 +188,7 @@ dependencies = [
 
 [[package]]
 name = "daemon"
-version = "3.1.2"
+version = "3.1.4"
 dependencies = [
  "env_logger",
  "intel-pstate",

asusctl/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "asusctl"
-version = "3.1.0"
+version = "3.1.1"
 authors = ["Luke D Jones <luke@ljones.dev>"]
 edition = "2018"
 
@@ -11,6 +11,7 @@ edition = "2018"
 serde_json = "^1.0"
 rog_dbus = { path = "../rog-dbus" }
 rog_types = { path = "../rog-types" }
+daemon = { path = "../daemon" }
 gumdrop = "^0.8"
 yansi-term = "^0.1"
 

asusctl/src/main.rs

@@ -1,3 +1,7 @@
+use daemon::{
+    ctrl_fan_cpu::FanCpuSupportedFunctions, ctrl_leds::LedSupportedFunctions,
+    ctrl_supported::SupportedFunctions,
+};
 use gumdrop::{Opt, Options};
 use rog_dbus::AuraDbusClient;
 use rog_types::{
@@ -104,8 +108,7 @@ struct BiosCommand {
 }
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let mut args: Vec<String> = args().collect();
-    args.remove(0);
+    let args: Vec<String> = args().skip(1).collect();
 
     let parsed: CLIStart;
     let missing_argument_k = gumdrop::Error::missing_argument(Opt::Short('k'));
@@ -125,65 +128,28 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         }
     }
 
-    if parsed.help_requested() {
-        // As help option don't work with `parse_args_default`
-        // we will call `parse_args_default_or_exit` instead
-        CLIStart::parse_args_default_or_exit();
+    let (dbus, _) = AuraDbusClient::new()?;
+
+    let supported_tmp = dbus.proxies().supported().get_supported_functions()?;
+    let supported = serde_json::from_str::<SupportedFunctions>(&supported_tmp)?;
+
+    if parsed.help {
+        print_supported_help(&supported, &parsed);
+        std::process::exit(1);
     }
 
     if parsed.version {
-        println!("  asusctl version {}", env!("CARGO_PKG_VERSION"));
-        println!(" rog-dbus version {}", rog_dbus::VERSION);
-        println!("rog-types version {}", rog_types::VERSION);
+        println!("  asusctl v{}", env!("CARGO_PKG_VERSION"));
+        println!(" rog-dbus v{}", rog_dbus::VERSION);
+        println!("rog-types v{}", rog_types::VERSION);
+        println!("   daemon v{}", daemon::VERSION);
+        return Ok(());
     }
 
-    let (dbus, _) = AuraDbusClient::new()?;
-
     match parsed.command {
-        Some(CliCommand::LedMode(mode)) => {
-            if (mode.command.is_none() && !mode.prev_mode && !mode.next_mode) || mode.help {
-                println!("Missing arg or command\n\n{}", mode.self_usage());
-                if let Some(lst) = mode.self_command_list() {
-                    println!("\n{}", lst);
-                }
-                println!("\nHelp can also be requested on modes, e.g: static --help");
-            }
-            if mode.next_mode && mode.prev_mode {
-                println!("Please specify either next or previous")
-            }
-            if mode.next_mode {
-                dbus.proxies().led().next_led_mode()?;
-            } else if mode.prev_mode {
-                dbus.proxies().led().prev_led_mode()?;
-            } else if let Some(command) = mode.command {
-                dbus.proxies().led().set_led_mode(&command.into())?
-            }
-        }
-        Some(CliCommand::Profile(cmd)) => {
-            if (!cmd.next
-                && !cmd.create
-                && cmd.curve.is_none()
-                && cmd.max_percentage.is_none()
-                && cmd.min_percentage.is_none()
-                && cmd.preset.is_none()
-                && cmd.profile.is_none()
-                && cmd.turbo.is_none())
-                || cmd.help
-            {
-                println!("Missing arg or command\n\n{}", cmd.self_usage());
-                if let Some(lst) = cmd.self_command_list() {
-                    println!("\n{}", lst);
-                }
-            }
-            if cmd.next {
-                dbus.proxies().profile().next_fan()?;
-            } else {
-                dbus.proxies()
-                    .profile()
-                    .write_command(&ProfileEvent::Cli(cmd))?
-            }
-        }
-        Some(CliCommand::Graphics(cmd)) => do_gfx(cmd, &dbus)?,
+        Some(CliCommand::LedMode(mode)) => handle_led_mode(&dbus, &supported.keyboard_led, &mode)?,
+        Some(CliCommand::Profile(cmd)) => handle_profile(&dbus, &supported.fan_cpu_ctrl, &cmd)?,
+        Some(CliCommand::Graphics(cmd)) => do_gfx(&dbus, cmd)?,
         Some(CliCommand::AniMe(cmd)) => {
             if (cmd.command.is_none() && cmd.boot.is_none() && cmd.turn.is_none()) || cmd.help {
                 println!("Missing arg or command\n\n{}", cmd.self_usage());
@@ -282,10 +248,59 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
+fn print_supported_help(supported: &SupportedFunctions, parsed: &CLIStart) {
+    // As help option don't work with `parse_args_default`
+    // we will call `parse_args_default_or_exit` instead
+    let usage: Vec<String> = parsed.self_usage().lines().map(|s| s.to_string()).collect();
+    for line in usage.iter().filter(|line| {
+        if line.contains("--fan-mode") && !supported.fan_cpu_ctrl.stock_fan_modes {
+            return false;
+        }
+        if line.contains("--chg-limit") && !supported.charge_ctrl.charge_level_set {
+            return false;
+        }
+        true
+    }) {
+        println!("{}", line);
+    }
+
+    // command strings are in order of the struct
+    let commands: Vec<String> = CliCommand::usage().lines().map(|s| s.to_string()).collect();
+    println!("\nCommands available");
+    for line in commands.iter().filter(|line| {
+        if line.contains("profile") && !supported.fan_cpu_ctrl.stock_fan_modes && !supported.fan_cpu_ctrl.fan_curve_set {
+            return false;
+        }
+        if line.contains("led-mode") && supported.keyboard_led.stock_led_modes.is_none() {
+            return false;
+        }
+        if line.contains("bios") && (!supported.rog_bios_ctrl.dedicated_gfx_toggle || !supported.rog_bios_ctrl.post_sound_toggle) {
+            return false;
+        }
+        if line.contains("anime") && !supported.anime_ctrl.0 {
+            return false;
+        }
+        true
+    }) {
+        println!("{}", line);
+    }
+
+    if !supported.fan_cpu_ctrl.stock_fan_modes {
+        println!("Note: Fan mode control is not supported by this laptop");
+    }
+    if !supported.charge_ctrl.charge_level_set {
+        println!("Note: Charge control is not supported by this laptop");
+    }
+}
+
 fn do_gfx(
-    command: GraphicsCommand,
     dbus_client: &AuraDbusClient,
+    command: GraphicsCommand,
 ) -> Result<(), Box<dyn std::error::Error>> {
+    if command.mode.is_none() || command.help {
+        println!("{}", command.self_usage());
+    }
+
     if let Some(mode) = command.mode {
         println!("Changing graphics modes...");
         println!("If this takes longer than 30s, ctrl+c then check `journalctl -b -u asusd`");
@@ -331,3 +346,81 @@ fn do_gfx_action(no_confirm: bool, ask_msg: &str, ok_msg: &str) -> bool {
     }
     false
 }
+
+fn handle_led_mode(
+    dbus: &AuraDbusClient,
+    supported: &LedSupportedFunctions,
+    mode: &LedModeCommand,
+) -> Result<(), Box<dyn std::error::Error>> {
+    if mode.command.is_none() && !mode.prev_mode && !mode.next_mode {
+        if !mode.help {
+            println!("Missing arg or command\n");
+        }
+        println!("{}\n", mode.self_usage());
+        println!("Commands available");
+
+        let commands: Vec<String> = LedModeCommand::command_list().unwrap().lines().map(|s| s.to_string()).collect();
+        for (_, command) in commands.iter().enumerate().filter(|(mode_num, _)| {
+            if let Some(modes) = supported.stock_led_modes.as_ref() {
+                return modes.contains(&(*mode_num as u8))
+            }
+            false
+        }) {
+            println!("{}", command);
+        }
+
+        println!("\nHelp can also be requested on modes, e.g: static --help");
+        std::process::exit(1);
+    }
+    if mode.next_mode && mode.prev_mode {
+        println!("Please specify either next or previous")
+    }
+    if mode.next_mode {
+        dbus.proxies().led().next_led_mode()?;
+    } else if mode.prev_mode {
+        dbus.proxies().led().prev_led_mode()?;
+    } else if let Some(command) = mode.command.as_ref() {
+        dbus.proxies().led().set_led_mode(&command.into())?
+    }
+    Ok(())
+}
+
+fn handle_profile(
+    dbus: &AuraDbusClient,
+    supported: &FanCpuSupportedFunctions,
+    cmd: &ProfileCommand,
+) -> Result<(), Box<dyn std::error::Error>> {
+    if !cmd.next
+        && !cmd.create
+        && cmd.curve.is_none()
+        && cmd.max_percentage.is_none()
+        && cmd.min_percentage.is_none()
+        && cmd.fan_preset.is_none()
+        && cmd.profile.is_none()
+        && cmd.turbo.is_none()
+    {
+        if !cmd.help {
+            println!("Missing arg or command\n");
+        }
+        let usage: Vec<String> = ProfileCommand::usage().lines().map(|s| s.to_string()).collect();
+        for line in usage.iter().filter(|line| {
+            !(line.contains("--curve") && !supported.fan_curve_set)
+        }) {
+            println!("{}", line);
+        }
+
+        if let Some(lst) = cmd.self_command_list() {
+            println!("\n{}", lst);
+        }
+        std::process::exit(1);
+    }
+    if cmd.next {
+        dbus.proxies().profile().next_fan()?;
+    } else {
+        dbus.proxies()
+            .profile()
+            .write_command(&ProfileEvent::Cli(cmd.clone()))?
+    }
+
+    Ok(())
+}

daemon/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "daemon"
-version = "3.1.2"
+version = "3.1.4"
 license = "MPL-2.0"
 readme = "README.md"
 authors = ["Luke <luke@ljones.dev>"]
@@ -40,4 +40,4 @@ toml = "^0.5"
 sysfs-class = "^0.1.2" # used for backlight control and baord ID
 rog_fan_curve = { version = "0.1", features = ["serde"] }
 # cpu power management
-intel-pstate = "^0.2"
+intel-pstate = "^0.2"

daemon/src/ctrl_anime.rs

@@ -30,7 +30,7 @@ use crate::GetSupported;
 
 use serde_derive::{Deserialize, Serialize};
 #[derive(Serialize, Deserialize)]
-pub struct AnimeSupportedFunctions(bool);
+pub struct AnimeSupportedFunctions(pub bool);
 
 impl GetSupported for CtrlAnimeDisplay {
     type A = AnimeSupportedFunctions;

daemon/src/ctrl_fan_cpu.rs

@@ -62,7 +62,12 @@ impl DbusFanAndCpu {
                     cfg.read();
                     ctrl.handle_profile_event(&event, &mut cfg)
                         .unwrap_or_else(|err| warn!("{}", err));
-                    self.notify_profile(&cfg.active_profile).unwrap_or(());
+                    if let Some(profile) = cfg.power_profiles.get(&cfg.active_profile) {
+                        if let Ok(json) = serde_json::to_string(profile) {
+                            self.notify_profile(&json)
+                                .unwrap_or_else(|err| warn!("{}", err));
+                        }
+                    }
                 }
             }
         }
@@ -72,6 +77,7 @@ impl DbusFanAndCpu {
     fn next_profile(&mut self) {
         if let Ok(mut ctrl) = self.inner.try_lock() {
             if let Ok(mut cfg) = ctrl.config.clone().try_lock() {
+                cfg.read();
                 ctrl.do_next_profile(&mut cfg)
                     .unwrap_or_else(|err| warn!("{}", err));
                 if let Some(profile) = cfg.power_profiles.get(&cfg.active_profile) {
@@ -258,7 +264,7 @@ impl CtrlFanAndCPU {
                 if let Some(max_perc) = command.max_percentage {
                     profile.max_percentage = max_perc;
                 }
-                if let Some(ref preset) = command.preset {
+                if let Some(ref preset) = command.fan_preset {
                     profile.fan_preset = preset.into();
                 }
                 if let Some(ref curve) = command.curve {

daemon/src/ctrl_gfx/gfx.rs

@@ -261,33 +261,42 @@ impl CtrlGraphics {
     }
 
     fn do_driver_action(driver: &str, action: &str) -> Result<(), RogError> {
-        let mut cmd;
-        if Self::kmod_exists() {
-            info!("using kmod");
-            cmd = Command::new("kmod");
-            cmd.arg(action);
-        } else {
-            cmd = Command::new(action);
-        }
+        let mut cmd= Command::new(action);
         cmd.arg(driver);
 
-        let output = cmd
-            .output()
-            .map_err(|err| RogError::Command(format!("{:?}", cmd), err))?;
-        if !output.status.success() {
-            if output.stderr.ends_with("is not currently loaded\n".as_bytes()) {
+        let mut count = 0;
+        const MAX_TRIES: i32 = 6;
+        loop {
+            if count > MAX_TRIES {
+                let msg = format!("{} {} failed for unknown reason", action, driver);
+                error!("{}", msg);
+                return Ok(()) //Err(RogError::Modprobe(msg));
+            }
+
+            let output = cmd
+                .output()
+                .map_err(|err| RogError::Command(format!("{:?}", cmd), err))?;
+            if !output.status.success() {
+                if output.stderr.ends_with("is not currently loaded\n".as_bytes()) {
+                    return Ok(())
+                }
+                if output.stderr.ends_with("Permission denied\n".as_bytes()) {
+                    let msg = format!("{} {} failed: {:?}", action, driver, String::from_utf8_lossy(&output.stderr));
+                    warn!("{}", msg);
+                    warn!("It may be safe to ignore the above error, run `lsmod |grep nvidia` to confirm modules loaded");
+                    return Ok(())
+                }
+                if count >= MAX_TRIES {
+                    let msg = format!("{} {} failed: {:?}", action, driver, String::from_utf8_lossy(&output.stderr));
+                    return Err(RogError::Modprobe(msg));
+                }
+            } else if output.status.success() {
                 return Ok(())
             }
-            if output.stderr.ends_with("Permission denied\n".as_bytes()) {
-                let msg = format!("{} {} failed: {:?}", action, driver, String::from_utf8_lossy(&output.stderr));
-                warn!("{}", msg);
-                warn!("It may be safe to ignore the above error, run `lsmod |grep nvidia` to confirm modules loaded");
-                return Ok(())
-            }
-            let msg = format!("{} {} failed: {:?}", action, driver, String::from_utf8_lossy(&output.stderr));
-            return Err(RogError::Modprobe(msg));
+
+            count += 1;
+            std::thread::sleep(std::time::Duration::from_millis(250));
         }
-        Ok(())
     }
 
     fn do_display_manager_action(action: &str) -> Result<(), RogError> {
@@ -308,39 +317,28 @@ impl CtrlGraphics {
         Ok(())
     }
 
-    fn wait_display_manager_inactive() -> Result<(), RogError> {
+    fn wait_display_manager_state(state: &str) -> Result<(), RogError> {
         let mut cmd = Command::new("systemctl");
         cmd.arg("is-active");
         cmd.arg(DISPLAY_MANAGER);
 
         let mut count = 0;
 
-        while count <= 4 {
+        while count <= 5 {
             let output = cmd
                 .output()
                 .map_err(|err| RogError::Command(format!("{:?}", cmd), err))?;
-            if output.stdout.starts_with("inactive".as_bytes()) {
+            if output.stdout.starts_with(state.as_bytes()) {
                 return Ok(());
             }
             std::thread::sleep(std::time::Duration::from_millis(500));
             count += 1;
         }
         return Err(
-            GfxError::DisplayManager("display-manager did not completely stop".into()).into(),
+            GfxError::DisplayManager(format!("display-manager timed out waiting for {} state", state).into()).into(),
         );
     }
 
-    fn kmod_exists() -> bool {
-        let mut cmd = Command::new("which");
-        cmd.arg("kmod");
-        if let Ok(output) = cmd
-        .output() {
-            return output.status.success() && output.stdout.ends_with("kmod".as_bytes())
-        }
-        //Path::new("/usr/bin/kmod").exists()
-        false
-    }
-
     pub fn do_vendor_tasks(&mut self, vendor: GfxVendors) -> Result<(), RogError> {
         Self::write_xorg_conf(vendor)?;
         Self::write_modprobe_conf()?; // TODO: Not required here, should put in startup?
@@ -375,9 +373,13 @@ impl CtrlGraphics {
     /// Will stop and start display manager without warning
     pub fn set_gfx_config(&mut self, vendor: GfxVendors) -> Result<String, RogError> {
         Self::do_display_manager_action("stop")?;
-        Self::wait_display_manager_inactive()?;
+        Self::wait_display_manager_state("inactive")?;
         self.do_vendor_tasks(vendor)?;
         Self::do_display_manager_action("start")?;
+        if Self::wait_display_manager_state("active").is_err() {
+            Self::do_display_manager_action("restart")?;
+        }
+        Self::wait_display_manager_state("active")?;
         // TODO: undo if failed? Save last mode, catch errors...
         let v: &str = vendor.into();
         Ok(format!("Graphics mode changed to {} successfully", v))

daemon/src/ctrl_supported.rs

@@ -15,11 +15,11 @@ use crate::{
 
 #[derive(Serialize, Deserialize)]
 pub struct SupportedFunctions {
-    anime_ctrl: AnimeSupportedFunctions,
-    charge_ctrl: ChargeSupportedFunctions,
-    fan_cpu_ctrl: FanCpuSupportedFunctions,
-    keyboard_led: LedSupportedFunctions,
-    rog_bios_ctrl: RogBiosSupportedFunctions,
+    pub anime_ctrl: AnimeSupportedFunctions,
+    pub charge_ctrl: ChargeSupportedFunctions,
+    pub fan_cpu_ctrl: FanCpuSupportedFunctions,
+    pub keyboard_led: LedSupportedFunctions,
+    pub rog_bios_ctrl: RogBiosSupportedFunctions,
 }
 
 #[dbus_interface(name = "org.asuslinux.Daemon")]

data/asusd-ledmodes.toml

@@ -1,17 +1,17 @@
 [[led_modes]]
 prod_family = "Zephyrus S"
 board_names = ["GX502", "GX701", "G531", "GL531", "G532"]
-led_modes = [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 255]
+led_modes = [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 255]
 
 [[led_modes]]
 prod_family = "Zephyrus M"
 board_names = ["GU502GV"]
-led_modes = [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 255]
+led_modes = [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 255]
 
 [[led_modes]]
 prod_family = "ROG Zephyrus M15"
 board_names = ["GU502LW"]
-led_modes = [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 255]
+led_modes = [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 255]
 
 [[led_modes]]
 prod_family = "ROG Zephyrus M15"
@@ -26,7 +26,7 @@ led_modes = [0, 1, 2, 3, 10, 13]
 [[led_modes]]
 prod_family = "ROG Strix"
 board_names = ["G531GW"]
-led_modes = [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 255]
+led_modes = [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 255]
 
 [[led_modes]]
 prod_family = "ROG Strix"

rog-types/src/aura_modes.rs

@@ -223,6 +223,12 @@ impl From<SetAuraBuiltin> for AuraModes {
     }
 }
 
+impl From<&SetAuraBuiltin> for AuraModes {
+    fn from(mode: &SetAuraBuiltin) -> Self {
+        mode.clone().into()
+    }
+}
+
 /// Very specific mode conversion required because numbering isn't linear
 impl From<AuraModes> for u8 {
     fn from(mode: AuraModes) -> Self {

rog-types/src/profile.rs

@@ -81,16 +81,16 @@ pub struct ProfileCommand {
     #[options(help = "create the profile if it doesn't exist")]
     pub create: bool,
 
-    #[options(help = "enable or disable cpu turbo")]
+    #[options(meta = "", help = "enable or disable cpu turbo")]
     pub turbo: Option<bool>,
-    #[options(help = "set min cpu scaling (intel)")]
+    #[options(meta = "", help = "set min cpu scaling (intel)")]
     pub min_percentage: Option<u8>,
-    #[options(help = "set max cpu scaling (intel)")]
+    #[options(meta = "", help = "set max cpu scaling (intel)")]
     pub max_percentage: Option<u8>,
 
-    #[options(meta = "PWR", help = "<silent, normal, boost>")]
-    pub preset: Option<FanLevel>,
-    #[options(parse(try_from_str = "parse_fan_curve"), help = "set fan curve")]
+    #[options(meta = "", help = "<silent, normal, boost>")]
+    pub fan_preset: Option<FanLevel>,
+    #[options(meta = "", parse(try_from_str = "parse_fan_curve"), help = "set fan curve")]
     pub curve: Option<Curve>,
     #[options(free)]
     pub profile: Option<String>,