/* * Copyright © 2023 Collabora Ltd. * Copyright © 2024 Valve Software * Copyright © 2024 Igalia S.L. * * SPDX-License-Identifier: MIT */ use anyhow::Result; use std::collections::HashMap; use tokio::sync::mpsc::{Sender, UnboundedSender}; use tokio::sync::oneshot; use tracing::error; use zbus::proxy::Builder; use zbus::{fdo, interface, zvariant, CacheProperties, Connection, Proxy, SignalContext}; use crate::cec::{HdmiCecControl, HdmiCecState}; use crate::daemon::user::Command; use crate::daemon::DaemonCommand; use crate::error::{to_zbus_error, to_zbus_fdo_error, zbus_to_zbus_fdo}; use crate::hardware::{ check_support, is_deck, variant, HardwareCurrentlySupported, HardwareVariant, }; use crate::job::JobManagerCommand; use crate::platform::platform_config; use crate::power::{ get_available_cpu_scaling_governors, get_available_gpu_performance_levels, get_available_gpu_power_profiles, get_cpu_scaling_governor, get_gpu_clocks, get_gpu_clocks_range, get_gpu_performance_level, get_gpu_power_profile, get_tdp_limit, }; use crate::wifi::{get_wifi_backend, get_wifi_power_management_state, list_wifi_interfaces}; use crate::API_VERSION; const MANAGER_PATH: &str = "/com/steampowered/SteamOSManager1"; macro_rules! method { ($self:expr, $method:expr, $($args:expr),+) => { $self.proxy .call($method, &($($args,)*)) .await .map_err(zbus_to_zbus_fdo) }; ($self:expr, $method:expr) => { $self.proxy .call($method, &()) .await .map_err(zbus_to_zbus_fdo) }; } macro_rules! job_method { ($self:expr, $method:expr, $($args:expr),+) => { { let (tx, rx) = oneshot::channel(); $self.job_manager.send(JobManagerCommand::MirrorJob { connection: $self.proxy.connection().clone(), path: method!($self, $method, $($args),+)?, reply: tx, }).map_err(to_zbus_fdo_error)?; rx.await.map_err(to_zbus_fdo_error)? } }; ($self:expr, $method:expr) => { { let (tx, rx) = oneshot::channel(); $self.job_manager.send(JobManagerCommand::MirrorJob { connection: $self.proxy.connection().clone(), path: method!($self, $method)?, reply: tx, }).map_err(to_zbus_fdo_error)?; rx.await.map_err(to_zbus_fdo_error)? } }; } macro_rules! getter { ($self:expr, $prop:expr) => { $self .proxy .get_property($prop) .await .map_err(zbus_to_zbus_fdo) }; } macro_rules! setter { ($self:expr, $prop:expr, $value:expr) => { $self .proxy .set_property($prop, $value) .await .map_err(|e| zbus::Error::FDO(Box::new(e))) }; } struct SteamOSManager { proxy: Proxy<'static>, } struct AmbientLightSensor1 { proxy: Proxy<'static>, } struct CpuScaling1 { proxy: Proxy<'static>, } struct FactoryReset1 { proxy: Proxy<'static>, } struct FanControl1 { proxy: Proxy<'static>, } struct GpuPerformanceLevel1 { proxy: Proxy<'static>, } struct GpuPowerProfile1 { proxy: Proxy<'static>, } struct TdpLimit1 { proxy: Proxy<'static>, } struct HdmiCec1 { hdmi_cec: HdmiCecControl<'static>, } struct Manager2 { proxy: Proxy<'static>, channel: Sender, } struct Storage1 { proxy: Proxy<'static>, job_manager: UnboundedSender, } struct UpdateBios1 { proxy: Proxy<'static>, job_manager: UnboundedSender, } struct UpdateDock1 { proxy: Proxy<'static>, job_manager: UnboundedSender, } struct WifiDebug1 { proxy: Proxy<'static>, } struct WifiPowerManagement1 { proxy: Proxy<'static>, } impl SteamOSManager { pub async fn new( system_conn: Connection, proxy: Proxy<'static>, job_manager: UnboundedSender, ) -> Result { job_manager.send(JobManagerCommand::MirrorConnection(system_conn))?; Ok(SteamOSManager { proxy }) } } #[interface(name = "com.steampowered.SteamOSManager1.Manager")] impl SteamOSManager { #[zbus(property(emits_changed_signal = "const"))] async fn version(&self) -> u32 { API_VERSION } #[zbus(property(emits_changed_signal = "const"))] async fn tdp_limit_min(&self) -> u32 { 0 } #[zbus(property)] async fn wifi_debug_mode_state(&self) -> fdo::Result { getter!(self, "WifiDebugModeState") } async fn set_wifi_debug_mode( &self, mode: u32, buffer_size: u32, #[zbus(signal_context)] ctx: SignalContext<'_>, ) -> fdo::Result<()> { method!(self, "SetWifiDebugMode", mode, buffer_size)?; self.wifi_debug_mode_state_changed(&ctx) .await .map_err(zbus_to_zbus_fdo)?; Ok(()) } #[zbus(property(emits_changed_signal = "false"))] async fn wifi_backend(&self) -> fdo::Result { match get_wifi_backend().await { Ok(backend) => Ok(backend as u32), Err(e) => Err(to_zbus_fdo_error(e)), } } #[zbus(property)] async fn set_wifi_backend(&self, backend: u32) -> zbus::Result<()> { self.proxy.call("SetWifiBackend", &(backend)).await } } #[interface(name = "com.steampowered.SteamOSManager1.AmbientLightSensor1")] impl AmbientLightSensor1 { #[zbus(property(emits_changed_signal = "false"))] async fn als_calibration_gain(&self) -> fdo::Result> { getter!(self, "AlsCalibrationGain") } } #[interface(name = "com.steampowered.SteamOSManager1.CpuScaling1")] impl CpuScaling1 { #[zbus(property(emits_changed_signal = "false"))] async fn available_cpu_scaling_governors(&self) -> fdo::Result> { let governors = get_available_cpu_scaling_governors() .await .map_err(to_zbus_fdo_error)?; let mut result = Vec::new(); for g in governors { result.push(g.to_string()); } Ok(result) } #[zbus(property(emits_changed_signal = "false"))] async fn cpu_scaling_governor(&self) -> fdo::Result { let governor = get_cpu_scaling_governor() .await .map_err(to_zbus_fdo_error)?; Ok(governor.to_string()) } #[zbus(property)] async fn set_cpu_scaling_governor(&self, governor: String) -> zbus::Result<()> { self.proxy.call("SetCpuScalingGovernor", &(governor)).await } } #[interface(name = "com.steampowered.SteamOSManager1.FactoryReset1")] impl FactoryReset1 { async fn prepare_factory_reset(&self) -> fdo::Result { method!(self, "PrepareFactoryReset") } } #[interface(name = "com.steampowered.SteamOSManager1.FanControl1")] impl FanControl1 { #[zbus(property(emits_changed_signal = "false"))] async fn fan_control_state(&self) -> fdo::Result { getter!(self, "FanControlState") } #[zbus(property)] async fn set_fan_control_state(&self, state: u32) -> zbus::Result<()> { setter!(self, "FanControlState", state) } } #[interface(name = "com.steampowered.SteamOSManager1.GpuPerformanceLevel1")] impl GpuPerformanceLevel1 { #[zbus(property(emits_changed_signal = "false"))] async fn available_gpu_performance_levels(&self) -> fdo::Result> { get_available_gpu_performance_levels() .await .inspect_err(|message| error!("Error getting GPU performance levels: {message}")) .map(|levels| levels.into_iter().map(|level| level.to_string()).collect()) .map_err(to_zbus_fdo_error) } #[zbus(property(emits_changed_signal = "false"))] async fn gpu_performance_level(&self) -> fdo::Result { match get_gpu_performance_level().await { Ok(level) => Ok(level.to_string()), Err(e) => { error!("Error getting GPU performance level: {e}"); Err(to_zbus_fdo_error(e)) } } } #[zbus(property)] async fn set_gpu_performance_level(&self, level: &str) -> zbus::Result<()> { self.proxy.call("SetGpuPerformanceLevel", &(level)).await } #[zbus(property(emits_changed_signal = "false"))] async fn manual_gpu_clock(&self) -> fdo::Result { get_gpu_clocks() .await .inspect_err(|message| error!("Error getting manual GPU clock: {message}")) .map_err(to_zbus_fdo_error) } #[zbus(property)] async fn set_manual_gpu_clock(&self, clocks: u32) -> zbus::Result<()> { self.proxy.call("SetManualGpuClock", &(clocks)).await } #[zbus(property(emits_changed_signal = "const"))] async fn manual_gpu_clock_min(&self) -> fdo::Result { Ok(get_gpu_clocks_range().await.map_err(to_zbus_fdo_error)?.0) } #[zbus(property(emits_changed_signal = "const"))] async fn manual_gpu_clock_max(&self) -> fdo::Result { Ok(get_gpu_clocks_range().await.map_err(to_zbus_fdo_error)?.1) } } #[interface(name = "com.steampowered.SteamOSManager1.GpuPowerProfile1")] impl GpuPowerProfile1 { #[zbus(property(emits_changed_signal = "false"))] async fn available_gpu_power_profiles(&self) -> fdo::Result> { let (_, names): (Vec, Vec) = get_available_gpu_power_profiles() .await .map_err(to_zbus_fdo_error)? .into_iter() .unzip(); Ok(names) } #[zbus(property(emits_changed_signal = "false"))] async fn gpu_power_profile(&self) -> fdo::Result { match get_gpu_power_profile().await { Ok(profile) => Ok(profile.to_string()), Err(e) => { error!("Error getting GPU power profile: {e}"); Err(to_zbus_fdo_error(e)) } } } #[zbus(property)] async fn set_gpu_power_profile(&self, profile: &str) -> zbus::Result<()> { self.proxy.call("SetGpuPowerProfile", &(profile)).await } } impl HdmiCec1 { async fn new(connection: &Connection) -> Result { let hdmi_cec = HdmiCecControl::new(connection).await?; Ok(HdmiCec1 { hdmi_cec }) } } #[interface(name = "com.steampowered.SteamOSManager1.HdmiCec1")] impl HdmiCec1 { #[zbus(property(emits_changed_signal = "false"))] async fn hdmi_cec_state(&self) -> fdo::Result { match self.hdmi_cec.get_enabled_state().await { Ok(state) => Ok(state as u32), Err(e) => Err(to_zbus_fdo_error(e)), } } #[zbus(property)] async fn set_hdmi_cec_state(&self, state: u32) -> zbus::Result<()> { let state = match HdmiCecState::try_from(state) { Ok(state) => state, Err(err) => return Err(fdo::Error::InvalidArgs(err.to_string()).into()), }; self.hdmi_cec .set_enabled_state(state) .await .inspect_err(|message| error!("Error setting CEC state: {message}")) .map_err(to_zbus_error) } } #[interface(name = "com.steampowered.SteamOSManager1.Manager2")] impl Manager2 { #[zbus(property(emits_changed_signal = "const"))] async fn hardware_currently_supported(&self) -> u32 { match check_support().await { Ok(res) => res as u32, Err(_) => HardwareCurrentlySupported::Unknown as u32, } } async fn reload_config(&self) -> fdo::Result<()> { self.channel .send(DaemonCommand::ReadConfig) .await .inspect_err(|message| error!("Error sending ReadConfig command: {message}")) .map_err(to_zbus_fdo_error)?; method!(self, "ReloadConfig") } } #[interface(name = "com.steampowered.SteamOSManager1.Storage1")] impl Storage1 { async fn format_device( &mut self, device: &str, label: &str, validate: bool, ) -> fdo::Result { job_method!(self, "FormatDevice", device, label, validate) } async fn trim_devices(&mut self) -> fdo::Result { job_method!(self, "TrimDevices") } } #[interface(name = "com.steampowered.SteamOSManager1.TdpLimit1")] impl TdpLimit1 { #[zbus(property(emits_changed_signal = "false"))] async fn tdp_limit(&self) -> fdo::Result { get_tdp_limit().await.map_err(to_zbus_fdo_error) } #[zbus(property)] async fn set_tdp_limit(&self, limit: u32) -> zbus::Result<()> { self.proxy.call("SetTdpLimit", &(limit)).await } #[zbus(property(emits_changed_signal = "const"))] async fn tdp_limit_min(&self) -> u32 { // TODO: Can this be queried from somewhere? 3 } #[zbus(property(emits_changed_signal = "const"))] async fn tdp_limit_max(&self) -> u32 { // TODO: Can this be queried from somewhere? 15 } } #[interface(name = "com.steampowered.SteamOSManager1.UpdateBios1")] impl UpdateBios1 { async fn update_bios(&mut self) -> fdo::Result { job_method!(self, "UpdateBios") } } #[interface(name = "com.steampowered.SteamOSManager1.UpdateDock1")] impl UpdateDock1 { async fn update_dock(&mut self) -> fdo::Result { job_method!(self, "UpdateDock") } } #[interface(name = "com.steampowered.SteamOSManager1.WifiDebug1")] impl WifiDebug1 { #[zbus(property)] async fn wifi_debug_mode_state(&self) -> fdo::Result { getter!(self, "WifiDebugModeState") } async fn set_wifi_debug_mode( &self, mode: u32, options: HashMap<&str, zvariant::Value<'_>>, #[zbus(signal_context)] ctx: SignalContext<'_>, ) -> fdo::Result<()> { method!(self, "SetWifiDebugMode", mode, options)?; self.wifi_debug_mode_state_changed(&ctx) .await .map_err(zbus_to_zbus_fdo)?; Ok(()) } #[zbus(property(emits_changed_signal = "false"))] async fn wifi_backend(&self) -> fdo::Result { match get_wifi_backend().await { Ok(backend) => Ok(backend.to_string()), Err(e) => Err(to_zbus_fdo_error(e)), } } #[zbus(property)] async fn set_wifi_backend(&self, backend: &str) -> zbus::Result<()> { self.proxy.call("SetWifiBackend", &(backend)).await } } #[interface(name = "com.steampowered.SteamOSManager1.WifiPowerManagement1")] impl WifiPowerManagement1 { #[zbus(property(emits_changed_signal = "false"))] async fn wifi_power_management_state(&self) -> fdo::Result { match get_wifi_power_management_state().await { Ok(state) => Ok(state as u32), Err(e) => Err(to_zbus_fdo_error(e)), } } #[zbus(property)] async fn set_wifi_power_management_state(&self, state: u32) -> zbus::Result<()> { self.proxy .call("SetWifiPowerManagementState", &(state)) .await } } #[allow(clippy::too_many_lines)] pub(crate) async fn create_interfaces( session: Connection, system: Connection, daemon: Sender, job_manager: UnboundedSender, ) -> Result<()> { let proxy = Builder::::new(&system) .destination("com.steampowered.SteamOSManager1")? .path("/com/steampowered/SteamOSManager1")? .interface("com.steampowered.SteamOSManager1.RootManager")? .cache_properties(CacheProperties::No) .build() .await?; let manager = SteamOSManager::new(system.clone(), proxy.clone(), job_manager.clone()).await?; let als = AmbientLightSensor1 { proxy: proxy.clone(), }; let cpu_scaling = CpuScaling1 { proxy: proxy.clone(), }; let factory_reset = FactoryReset1 { proxy: proxy.clone(), }; let fan_control = FanControl1 { proxy: proxy.clone(), }; let gpu_performance_level = GpuPerformanceLevel1 { proxy: proxy.clone(), }; let gpu_power_profile = GpuPowerProfile1 { proxy: proxy.clone(), }; let hdmi_cec = HdmiCec1::new(&session).await?; let manager2 = Manager2 { proxy: proxy.clone(), channel: daemon, }; let storage = Storage1 { proxy: proxy.clone(), job_manager: job_manager.clone(), }; let tdp_limit = TdpLimit1 { proxy: proxy.clone(), }; let update_bios = UpdateBios1 { proxy: proxy.clone(), job_manager: job_manager.clone(), }; let update_dock = UpdateDock1 { proxy: proxy.clone(), job_manager: job_manager.clone(), }; let wifi_debug = WifiDebug1 { proxy: proxy.clone(), }; let wifi_power_management = WifiPowerManagement1 { proxy: proxy.clone(), }; let config = platform_config().await?; let object_server = session.object_server(); object_server.at(MANAGER_PATH, manager).await?; if is_deck().await? { object_server.at(MANAGER_PATH, als).await?; } object_server.at(MANAGER_PATH, cpu_scaling).await?; if config .as_ref() .is_some_and(|config| config.factory_reset.is_some()) { object_server.at(MANAGER_PATH, factory_reset).await?; } if config .as_ref() .is_some_and(|config| config.fan_control.is_some()) { object_server.at(MANAGER_PATH, fan_control).await?; } if !get_available_gpu_performance_levels() .await .unwrap_or_default() .is_empty() { object_server .at(MANAGER_PATH, gpu_performance_level) .await?; } if !get_available_gpu_power_profiles() .await .unwrap_or_default() .is_empty() { object_server.at(MANAGER_PATH, gpu_power_profile).await?; } if hdmi_cec.hdmi_cec.get_enabled_state().await.is_ok() { object_server.at(MANAGER_PATH, hdmi_cec).await?; } object_server.at(MANAGER_PATH, manager2).await?; if config .as_ref() .is_some_and(|config| config.storage.is_some()) { object_server.at(MANAGER_PATH, storage).await?; } if get_tdp_limit().await.is_ok() { object_server.at(MANAGER_PATH, tdp_limit).await?; } if config .as_ref() .is_some_and(|config| config.update_bios.is_some()) { object_server.at(MANAGER_PATH, update_bios).await?; } if config .as_ref() .is_some_and(|config| config.update_dock.is_some()) { object_server.at(MANAGER_PATH, update_dock).await?; } if variant().await.unwrap_or_default() == HardwareVariant::Galileo { object_server.at(MANAGER_PATH, wifi_debug).await?; } if !list_wifi_interfaces().await.unwrap_or_default().is_empty() { object_server .at(MANAGER_PATH, wifi_power_management) .await?; } Ok(()) } #[cfg(test)] mod test { use super::*; use crate::daemon::channel; use crate::daemon::user::UserContext; use crate::hardware::test::fake_model; use crate::hardware::HardwareVariant; use crate::platform::{PlatformConfig, ScriptConfig, ServiceConfig, StorageConfig}; use crate::systemd::test::{MockManager, MockUnit}; use crate::{power, testing}; use std::time::Duration; use tokio::sync::mpsc::unbounded_channel; use tokio::time::sleep; use zbus::{Connection, Interface}; struct TestHandle { _handle: testing::TestHandle, connection: Connection, } fn all_config() -> Option { Some(PlatformConfig { factory_reset: Some(ScriptConfig::default()), update_bios: Some(ScriptConfig::default()), update_dock: Some(ScriptConfig::default()), storage: Some(StorageConfig::default()), fan_control: Some(ServiceConfig::Systemd(String::from( "jupiter-fan-control.service", ))), }) } async fn start(platform_config: Option) -> Result { let mut handle = testing::start(); let (tx_ctx, _rx_ctx) = channel::(); let (tx_job, _rx_job) = unbounded_channel::(); handle.test.platform_config.replace(platform_config); let connection = handle.new_dbus().await?; connection.request_name("org.freedesktop.systemd1").await?; sleep(Duration::from_millis(10)).await; { let object_server = connection.object_server(); object_server .at("/org/freedesktop/systemd1", MockManager::default()) .await?; let mut prc = MockUnit::default(); prc.unit_file = String::from("disabled"); object_server .at( "/org/freedesktop/systemd1/unit/plasma_2dremotecontrollers_2eservice", prc, ) .await?; } fake_model(HardwareVariant::Galileo).await?; handle .test .process_cb .set(|_, _| Ok((0, String::from("Interface wlan0")))); power::test::create_nodes().await?; create_interfaces(connection.clone(), connection.clone(), tx_ctx, tx_job).await?; sleep(Duration::from_millis(1)).await; Ok(TestHandle { _handle: handle, connection, }) } #[tokio::test] async fn interface_matches() { let test = start(None).await.expect("start"); let remote = testing::InterfaceIntrospection::from_remote::( &test.connection, MANAGER_PATH, ) .await .expect("remote"); let local = testing::InterfaceIntrospection::from_local( "com.steampowered.SteamOSManager1.Manager.xml", "com.steampowered.SteamOSManager1.Manager", ) .await .expect("local"); assert!(remote.compare(&local)); } async fn test_interface_matches(connection: &Connection) -> Result { let remote = testing::InterfaceIntrospection::from_remote::(connection, MANAGER_PATH).await?; let local = testing::InterfaceIntrospection::from_local( "com.steampowered.SteamOSManager1.xml", I::name().to_string(), ) .await?; Ok(remote.compare(&local)) } async fn test_interface_missing(connection: &Connection) -> bool { let remote = testing::InterfaceIntrospection::from_remote::(connection, MANAGER_PATH).await; remote.is_err() } #[tokio::test] async fn interface_matches_ambient_light_sensor1() { let test = start(all_config()).await.expect("start"); assert!( test_interface_matches::(&test.connection) .await .unwrap() ); } #[tokio::test] async fn interface_matches_cpu_scaling1() { let test = start(all_config()).await.expect("start"); assert!(test_interface_matches::(&test.connection) .await .unwrap()); } #[tokio::test] async fn interface_matches_factory_reset1() { let test = start(all_config()).await.expect("start"); assert!(test_interface_matches::(&test.connection) .await .unwrap()); } #[tokio::test] async fn interface_missing_factory_reset1() { let test = start(None).await.expect("start"); assert!(test_interface_missing::(&test.connection).await); } #[tokio::test] async fn interface_matches_fan_control1() { let test = start(all_config()).await.expect("start"); assert!(test_interface_matches::(&test.connection) .await .unwrap()); } #[tokio::test] async fn interface_missing_fan_control1() { let test = start(None).await.expect("start"); assert!(test_interface_missing::(&test.connection).await); } #[tokio::test] async fn interface_matches_gpu_performance_level1() { let test = start(all_config()).await.expect("start"); assert!( test_interface_matches::(&test.connection) .await .unwrap() ); } #[tokio::test] async fn interface_matches_gpu_power_profile1() { let test = start(all_config()).await.expect("start"); assert!(test_interface_matches::(&test.connection) .await .unwrap()); } #[tokio::test] async fn interface_matches_tdp_limit1() { let test = start(all_config()).await.expect("start"); assert!(test_interface_matches::(&test.connection) .await .unwrap()); } #[tokio::test] async fn interface_matches_hdmi_cec1() { let test = start(all_config()).await.expect("start"); assert!(test_interface_matches::(&test.connection) .await .unwrap()); } #[tokio::test] async fn interface_matches_manager2() { let test = start(all_config()).await.expect("start"); assert!(test_interface_matches::(&test.connection) .await .unwrap()); } #[tokio::test] async fn interface_matches_storage1() { let test = start(all_config()).await.expect("start"); assert!(test_interface_matches::(&test.connection) .await .unwrap()); } #[tokio::test] async fn interface_missing_storage1() { let test = start(None).await.expect("start"); assert!(test_interface_missing::(&test.connection).await); } #[tokio::test] async fn interface_matches_update_bios1() { let test = start(all_config()).await.expect("start"); assert!(test_interface_matches::(&test.connection) .await .unwrap()); } #[tokio::test] async fn interface_missing_update_bios1() { let test = start(None).await.expect("start"); assert!(test_interface_missing::(&test.connection).await); } #[tokio::test] async fn interface_matches_update_dock1() { let test = start(all_config()).await.expect("start"); assert!(test_interface_matches::(&test.connection) .await .unwrap()); } #[tokio::test] async fn interface_missing_update_dock1() { let test = start(None).await.expect("start"); assert!(test_interface_missing::(&test.connection).await); } #[tokio::test] async fn interface_matches_wifi_power_management1() { let test = start(all_config()).await.expect("start"); assert!( test_interface_matches::(&test.connection) .await .unwrap() ); } #[tokio::test] async fn interface_matches_wifi_debug() { let test = start(all_config()).await.expect("start"); assert!(test_interface_matches::(&test.connection) .await .unwrap()); } }