SCSI support: ROG Arion external drive LED control

asusd/src/aura_scsi/config.rs

@@ -0,0 +1,114 @@
+use std::collections::BTreeMap;
+
+use config_traits::{StdConfig, StdConfigLoad};
+use rog_aura::AuraDeviceType;
+use rog_scsi::{AuraEffect, AuraMode};
+use serde::{Deserialize, Serialize};
+
+const CONFIG_FILE: &str = "scsi.ron";
+
+/// Config for base system actions for the anime display
+#[derive(Deserialize, Serialize, Debug)]
+pub struct ScsiConfig {
+    #[serde(skip)]
+    pub dev_type: AuraDeviceType,
+    pub enabled: bool,
+    pub current_mode: AuraMode,
+    pub modes: BTreeMap<AuraMode, AuraEffect>,
+}
+
+impl ScsiConfig {
+    pub fn get_effect(&mut self, mode: AuraMode) -> Option<&AuraEffect> {
+        self.modes.get(&mode)
+    }
+
+    pub fn save_effect(&mut self, effect: AuraEffect) {
+        self.current_mode = effect.mode;
+        self.modes.insert(*effect.mode(), effect);
+    }
+}
+
+impl Default for ScsiConfig {
+    fn default() -> Self {
+        ScsiConfig {
+            enabled: true,
+            current_mode: AuraMode::Static,
+            dev_type: AuraDeviceType::ScsiExtDisk,
+            modes: BTreeMap::from([
+                (AuraMode::Off, AuraEffect::default_with_mode(AuraMode::Off)),
+                (
+                    AuraMode::Static,
+                    AuraEffect::default_with_mode(AuraMode::Static),
+                ),
+                (
+                    AuraMode::Breathe,
+                    AuraEffect::default_with_mode(AuraMode::Breathe),
+                ),
+                (
+                    AuraMode::Flashing,
+                    AuraEffect::default_with_mode(AuraMode::Flashing),
+                ),
+                (
+                    AuraMode::RainbowCycle,
+                    AuraEffect::default_with_mode(AuraMode::RainbowCycle),
+                ),
+                (
+                    AuraMode::RainbowWave,
+                    AuraEffect::default_with_mode(AuraMode::RainbowWave),
+                ),
+                (
+                    AuraMode::RainbowCycleBreathe,
+                    AuraEffect::default_with_mode(AuraMode::RainbowCycleBreathe),
+                ),
+                (
+                    AuraMode::ChaseFade,
+                    AuraEffect::default_with_mode(AuraMode::ChaseFade),
+                ),
+                (
+                    AuraMode::RainbowCycleChaseFade,
+                    AuraEffect::default_with_mode(AuraMode::RainbowCycleChaseFade),
+                ),
+                (
+                    AuraMode::Chase,
+                    AuraEffect::default_with_mode(AuraMode::Chase),
+                ),
+                (
+                    AuraMode::RainbowCycleChase,
+                    AuraEffect::default_with_mode(AuraMode::RainbowCycleChase),
+                ),
+                (
+                    AuraMode::RainbowCycleWave,
+                    AuraEffect::default_with_mode(AuraMode::RainbowCycleWave),
+                ),
+                (
+                    AuraMode::RainbowPulseChase,
+                    AuraEffect::default_with_mode(AuraMode::RainbowPulseChase),
+                ),
+                (
+                    AuraMode::RandomFlicker,
+                    AuraEffect::default_with_mode(AuraMode::RandomFlicker),
+                ),
+                (
+                    AuraMode::DoubleFade,
+                    AuraEffect::default_with_mode(AuraMode::DoubleFade),
+                ),
+            ]),
+        }
+    }
+}
+
+impl StdConfig for ScsiConfig {
+    fn new() -> Self {
+        Self::default()
+    }
+
+    fn file_name(&self) -> String {
+        CONFIG_FILE.to_owned()
+    }
+
+    fn config_dir() -> std::path::PathBuf {
+        std::path::PathBuf::from(crate::CONFIG_PATH_BASE)
+    }
+}
+
+impl StdConfigLoad for ScsiConfig {}

asusd/src/aura_scsi/mod.rs

@@ -0,0 +1,45 @@
+use std::sync::Arc;
+
+use config::ScsiConfig;
+use rog_scsi::{AuraEffect, Device, Task};
+use tokio::sync::{Mutex, MutexGuard};
+
+use crate::error::RogError;
+
+pub mod config;
+pub mod trait_impls;
+
+#[derive(Clone)]
+pub struct ScsiAura {
+    device: Arc<Mutex<Device>>,
+    config: Arc<Mutex<ScsiConfig>>,
+}
+
+impl ScsiAura {
+    pub fn new(device: Arc<Mutex<Device>>, config: Arc<Mutex<ScsiConfig>>) -> Self {
+        Self { device, config }
+    }
+
+    pub async fn lock_config(&self) -> MutexGuard<ScsiConfig> {
+        self.config.lock().await
+    }
+
+    pub async fn write_effect(&self, effect: &AuraEffect) -> Result<(), RogError> {
+        let tasks: Vec<Task> = effect.into();
+        for task in &tasks {
+            self.device.lock().await.perform(task).ok();
+        }
+        Ok(())
+    }
+
+    /// Initialise the device if required. Locks the internal config so be wary
+    /// of deadlocks.
+    pub async fn do_initialization(&self) -> Result<(), RogError> {
+        let config = self.config.lock().await;
+        let mode = config.current_mode;
+        if let Some(effect) = config.modes.get(&mode) {
+            self.write_effect(effect).await?;
+        }
+        Ok(())
+    }
+}

asusd/src/aura_scsi/trait_impls.rs

@@ -0,0 +1,116 @@
+use std::collections::BTreeMap;
+
+use config_traits::StdConfig;
+use log::error;
+use rog_aura::AuraDeviceType;
+use rog_scsi::{AuraEffect, AuraMode};
+use zbus::fdo::Error as ZbErr;
+use zbus::zvariant::OwnedObjectPath;
+use zbus::{interface, Connection};
+
+use super::ScsiAura;
+use crate::error::RogError;
+
+#[derive(Clone)]
+pub struct ScsiZbus(ScsiAura);
+
+impl ScsiZbus {
+    pub fn new(scsi: ScsiAura) -> Self {
+        Self(scsi)
+    }
+
+    pub async fn start_tasks(
+        self,
+        connection: &Connection,
+        path: OwnedObjectPath,
+    ) -> Result<(), RogError> {
+        connection
+            .object_server()
+            .at(path.clone(), self)
+            .await
+            .map_err(|e| error!("Couldn't add server at path: {path}, {e:?}"))
+            .ok();
+        Ok(())
+    }
+}
+
+#[interface(name = "org.asuslinux.ScsiAura")]
+impl ScsiZbus {
+    /// Return the device type for this Aura keyboard
+    #[zbus(property)]
+    async fn device_type(&self) -> AuraDeviceType {
+        self.0.config.lock().await.dev_type
+    }
+
+    /// Get enabled or not
+    #[zbus(property)]
+    async fn enabled(&self) -> bool {
+        let lock = self.0.lock_config().await;
+        lock.enabled
+    }
+
+    /// Set enabled true or false
+    #[zbus(property)]
+    async fn set_enabled(&self, enabled: bool) {
+        let mut config = self.0.lock_config().await;
+        config.enabled = enabled;
+        config.write();
+    }
+
+    #[zbus(property)]
+    async fn led_mode(&self) -> u8 {
+        let config = self.0.lock_config().await;
+        config.current_mode as u8
+    }
+
+    #[zbus(property)]
+    async fn set_led_mode(&self, mode: AuraMode) -> Result<(), zbus::Error> {
+        let mut config = self.0.lock_config().await;
+        if let Some(effect) = config.get_effect(mode) {
+            self.0
+                .write_effect(effect)
+                .await
+                .map_err(|e| zbus::Error::Failure(format!("{e:?}")))?;
+        } else {
+            return Err(zbus::Error::Failure("Mode data does not exist".to_string()));
+        }
+        config.current_mode = mode;
+        config.write();
+        Ok(())
+    }
+
+    /// The current mode data
+    #[zbus(property)]
+    async fn led_mode_data(&self) -> Result<AuraEffect, ZbErr> {
+        // entirely possible to deadlock here, so use try instead of lock()
+        if let Ok(config) = self.0.config.try_lock() {
+            let mode = config.current_mode;
+            match config.modes.get(&mode) {
+                Some(effect) => Ok(effect.clone()),
+                None => Err(ZbErr::Failed("Could not get the current effect".into())),
+            }
+        } else {
+            Err(ZbErr::Failed("Aura control couldn't lock self".to_string()))
+        }
+    }
+
+    /// Set an Aura effect if the effect mode or zone is supported.
+    ///
+    /// On success the aura config file is read to refresh cached values, then
+    /// the effect is stored and config written to disk.
+    #[zbus(property)]
+    async fn set_led_mode_data(&mut self, effect: AuraEffect) -> Result<(), ZbErr> {
+        self.0.write_effect(&effect).await?;
+
+        let mut config = self.0.config.lock().await;
+        config.save_effect(effect);
+        config.write();
+        Ok(())
+    }
+
+    /// Get the data set for every mode available
+    async fn all_mode_data(&self) -> BTreeMap<AuraMode, AuraEffect> {
+        let config = self.0.config.lock().await;
+        config.modes.clone()
+    }
+}