sound_card_init: Refactor for CalibData and VPD

CalibData and VPD previously worked on the assumption that all smart
amps just requires an r0 and temp value, and the initialization was
similarly hard coded.

Adjusted CalibData to use the VPDTrait interface instead, which only
requires the channel count to adapt to TAS2563 and other smart amps
better. VPD is adjusted to implement the VPDTrait interface.

BUG=b:346949244
TEST=tast run $DUT audio.SoundCardInit.*
TEST=sound_card_init debug --id sofrt5682 --amp $(cros_config /audio/main speaker-amp) --conf $(cros_config /audio/main sound-card-init-conf) on delbin and redrix

Change-Id: I73d6c3c904beea3c1b0ce6c68bf1dfa3e71bf343
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/third_party/adhd/+/5743138
Tested-by: [email protected] <[email protected]>
Commit-Queue: Baili Deng <[email protected]>
Reviewed-by: Judy Hsiao <[email protected]>

Author: baili0411

.gitignore

@@ -5,6 +5,7 @@ compile_commands.json
 .cache
 # vscode
 *.code-workspace
+*.vscode
 
 # bazel
 /external

sound_card_init/amp/src/alc1011/mod.rs

@@ -14,6 +14,7 @@ use std::path::Path;
 
 use cros_alsa::Card;
 use cros_alsa::IntControl;
+use dsm::vpd::VPD;
 use dsm::CalibData;
 use dsm::Error;
 use dsm::RDCRange;
@@ -41,9 +42,7 @@ struct ALC1011CalibData {
 }
 
 impl CalibData for ALC1011CalibData {
-    fn new(rdc: i32, temp: f32) -> Self {
-        Self { rdc, temp }
-    }
+    type VPDType = VPD;
 
     fn rdc(&self) -> i32 {
         self.rdc
@@ -65,6 +64,15 @@ impl CalibData for ALC1011CalibData {
     }
 }
 
+impl From<VPD> for ALC1011CalibData {
+    fn from(vpd: VPD) -> Self {
+        Self {
+            rdc: vpd.dsm_calib_r0,
+            temp: vpd.dsm_calib_temp as f32, //  // ALC1011 VPD stores the temperature in celsius.
+        }
+    }
+}
+
 impl ALC1011CalibData {
     /// Converts the ambient temperature from celsius to the DSM unit.
     #[inline]

sound_card_init/amp/src/cs35l41/mod.rs

@@ -23,6 +23,7 @@ use cros_alsa::Ctl;
 use cros_alsa::ElemId;
 use cros_alsa::SimpleEnumControl;
 use cros_alsa::SwitchControl;
+use dsm::vpd::VPD;
 use dsm::CalibData;
 use dsm::RDCRange;
 use dsm::ZeroPlayer;
@@ -108,9 +109,7 @@ struct CS35L41CalibData {
 }
 
 impl CalibData for CS35L41CalibData {
-    fn new(rdc: i32, temp: f32) -> Self {
-        Self { rdc, temp }
-    }
+    type VPDType = VPD;
 
     fn rdc(&self) -> i32 {
         self.rdc
@@ -132,6 +131,15 @@ impl CalibData for CS35L41CalibData {
     }
 }
 
+impl From<VPD> for CS35L41CalibData {
+    fn from(vpd: VPD) -> Self {
+        Self {
+            rdc: vpd.dsm_calib_r0,
+            temp: vpd.dsm_calib_temp as f32, //  // CS35L41 VPD stores the temperature in celsius.
+        }
+    }
+}
+
 impl fmt::Debug for CS35L41CalibData {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         write!(f, "rdc: {} ohm", self.rdc_ohm(),)

sound_card_init/amp/src/max98373d/mod.rs

@@ -21,6 +21,7 @@ use cros_alsa::Card;
 use cros_alsa::IntControl;
 use dsm::metrics::log_uma_enum;
 use dsm::metrics::UMACalibrationResult;
+use dsm::vpd::VPD;
 use dsm::CalibData;
 use dsm::RDCRange;
 use dsm::SpeakerStatus;
@@ -51,9 +52,7 @@ struct Max98373CalibData {
 }
 
 impl CalibData for Max98373CalibData {
-    fn new(rdc: i32, temp: f32) -> Self {
-        Self { rdc, temp }
-    }
+    type VPDType = VPD;
 
     fn rdc(&self) -> i32 {
         self.rdc
@@ -76,6 +75,15 @@ impl CalibData for Max98373CalibData {
     }
 }
 
+impl From<VPD> for Max98373CalibData {
+    fn from(vpd: VPD) -> Self {
+        Self {
+            rdc: vpd.dsm_calib_r0,
+            temp: vpd.dsm_calib_temp as f32, //  // 98373 VPD stores the temperature in celsius.
+        }
+    }
+}
+
 impl Max98373CalibData {
     /// Converts the ambient temperature from celsius to the DsmSetAPI::DsmAmbientTemp unit.
     #[inline]

sound_card_init/amp/src/max98390d/mod.rs

@@ -20,6 +20,7 @@ use cros_alsa::IntControl;
 use cros_alsa::SwitchControl;
 use dsm::metrics::log_uma_enum;
 use dsm::metrics::UMACalibrationResult;
+use dsm::vpd::VPD;
 use dsm::CalibData;
 use dsm::RDCRange;
 use dsm::SpeakerStatus;
@@ -61,9 +62,7 @@ struct Max98390CalibData {
 }
 
 impl CalibData for Max98390CalibData {
-    fn new(rdc: i32, temp: f32) -> Self {
-        Self { rdc, temp }
-    }
+    type VPDType = VPD;
 
     fn rdc(&self) -> i32 {
         self.rdc
@@ -86,6 +85,15 @@ impl CalibData for Max98390CalibData {
     }
 }
 
+impl From<VPD> for Max98390CalibData {
+    fn from(vpd: VPD) -> Self {
+        Self {
+            rdc: vpd.dsm_calib_r0,
+            temp: Self::dsm_unit_to_celsius(vpd.dsm_calib_temp), // 98390 VPD stores the temperature in raw data.
+        }
+    }
+}
+
 impl Max98390CalibData {
     /// Converts the ambient temperature from celsius to the DSM unit.
     #[inline]

sound_card_init/dsm/src/error.rs

@@ -11,8 +11,6 @@ use std::time;
 use remain::sorted;
 use thiserror::Error as ThisError;
 
-use crate::CalibData;
-
 pub type Result<T> = std::result::Result<T, Error>;
 
 #[sorted]
@@ -36,8 +34,6 @@ pub enum Error {
     InvalidDatastore,
     #[error("invalid shutdown time")]
     InvalidShutDownTime,
-    #[error("calibration difference is too large, calib: {0:?}")]
-    LargeCalibrationDiff(Box<dyn CalibData>),
     #[error("mutex is poisoned")]
     MutexPoisonError,
     #[error("{0}")]

sound_card_init/dsm/src/lib.rs

@@ -7,7 +7,7 @@ mod datastore;
 mod error;
 pub mod metrics;
 pub mod utils;
-mod vpd;
+pub mod vpd;
 mod zero_player;
 
 use std::fmt;
@@ -29,7 +29,6 @@ pub use crate::error::Result;
 use crate::metrics::*;
 use crate::utils::run_time;
 use crate::utils::shutdown_time;
-use crate::vpd::VPD;
 pub use crate::zero_player::ZeroPlayer;
 
 #[derive(Debug, Default, PartialEq, Serialize, Deserialize, Clone, Copy)]
@@ -39,13 +38,8 @@ pub struct RDCRange {
 }
 
 /// `CalibData` is the trait for the calibration data.
-pub trait CalibData: Send + fmt::Debug {
-    /// Creates `CalibData`. rdc is the DC resistance in raw data.
-    /// temp is the ambient temperature in celsius unit at which the
-    /// rdc is measured.
-    fn new(rdc: i32, temp: f32) -> Self
-    where
-        Self: Sized;
+pub trait CalibData: Send + fmt::Debug + From<Self::VPDType> {
+    type VPDType: VPDTrait;
     /// The function to convert the rdc to ohm unit.
     fn rdc_to_ohm(rdc: i32) -> f32
     where
@@ -82,6 +76,16 @@ pub trait CalibData: Send + fmt::Debug {
     }
 }
 
+// `VPDTrait` defines that any VPD can be created by giving the channel number.
+pub trait VPDTrait {
+    fn new(channel: usize) -> Result<Self>
+    where
+        Self: Sized;
+    fn new_from_datastore(datastore: Datastore, channel: usize) -> Result<Self>
+    where
+        Self: Sized;
+}
+
 /// `TempConverter` converts the temperature value between celsius and unit in VPD::dsm_calib_temp.
 pub struct TempConverter {
     vpd_to_celsius: fn(i32) -> f32,
@@ -224,7 +228,6 @@ impl DSM {
     /// logic:
     /// * Returns the previous value if the ambient temperature is not within a valid range.
     ///   If previous value does not exist, use VPD value instead.
-    /// * Returns Error::LargeCalibrationDiff if rdc is not within the `rdc_range`.
     /// * Returns the previous value if the rdc difference is smaller than `CALI_ERROR_LOWER_LIMIT`.
     /// * Returns the boot time calibration value and updates the datastore value if the rdc
     ///   difference is within the `rdc_range`and larger than the `CALI_ERROR_LOWER_LIMIT`.
@@ -398,20 +401,10 @@ impl DSM {
 
     fn get_previous_calibration_value<T: CalibData>(&self, ch: usize) -> Result<T> {
         let sci_calib = Datastore::from_file(&self.snd_card, ch)?;
-        match sci_calib {
-            Datastore::UseVPD => self.get_vpd_calibration_value(ch),
-            Datastore::DSM { rdc, temp } => Ok(CalibData::new(
-                rdc,
-                (self.temp_converter.vpd_to_celsius)(temp),
-            )),
-        }
+        Ok(T::from(T::VPDType::new_from_datastore(sci_calib, ch)?))
     }
 
     fn get_vpd_calibration_value<T: CalibData>(&self, channel: usize) -> Result<T> {
-        let vpd = VPD::new(channel)?;
-        Ok(CalibData::new(
-            vpd.dsm_calib_r0,
-            (self.temp_converter.vpd_to_celsius)(vpd.dsm_calib_temp),
-        ))
+        Ok(T::from(T::VPDType::new(channel)?))
     }
 }

sound_card_init/dsm/src/vpd.rs

@@ -8,6 +8,8 @@ use std::path::PathBuf;
 
 use crate::error::Error;
 use crate::error::Result;
+use crate::Datastore;
+use crate::VPDTrait;
 
 const VPD_DIR: &str = "/sys/firmware/vpd/ro/vpdfile";
 
@@ -18,17 +20,28 @@ pub struct VPD {
     pub dsm_calib_temp: i32,
 }
 
-impl VPD {
+impl VPDTrait for VPD {
     /// Creates a `VPD` and initializes its fields from VPD_DIR/dsm_calib_r0_{channel}.
     /// # Arguments
     ///
     /// * `channel` - channel number.
-    pub fn new(channel: usize) -> Result<VPD> {
+    fn new(channel: usize) -> Result<VPD> {
         let mut vpd: VPD = Default::default();
         vpd.dsm_calib_r0 = read_vpd_files(&format!("dsm_calib_r0_{}", channel))?;
         vpd.dsm_calib_temp = read_vpd_files(&format!("dsm_calib_temp_{}", channel))?;
         Ok(vpd)
     }
+    fn new_from_datastore(datastore: Datastore, channel: usize) -> Result<VPD> {
+        match datastore {
+            Datastore::UseVPD => VPD::new(channel),
+            Datastore::DSM { rdc, temp } => {
+                let mut vpd: VPD = Default::default();
+                vpd.dsm_calib_r0 = rdc;
+                vpd.dsm_calib_temp = temp as i32;
+                Ok(vpd)
+            }
+        }
+    }
 }
 
 fn read_vpd_files(file: &str) -> Result<i32> {