Merge remote-tracking branch 'refs/remotes/origin/main'

Cargo.lock

@@ -23,6 +23,56 @@ dependencies = [
  "memchr",
 ]
 
+[[package]]
+name = "anstream"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "824a212faf96e9acacdbd09febd34438f8f711fb84e09a8916013cd7815ca28d"
+dependencies = [
+ "anstyle",
+ "anstyle-parse",
+ "anstyle-query",
+ "anstyle-wincon",
+ "colorchoice",
+ "is_terminal_polyfill",
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle"
+version = "1.0.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "940b3a0ca603d1eade50a4846a2afffd5ef57a9feac2c0e2ec2e14f9ead76000"
+
+[[package]]
+name = "anstyle-parse"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "52ce7f38b242319f7cabaa6813055467063ecdc9d355bbb4ce0c68908cd8130e"
+dependencies = [
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle-query"
+version = "1.1.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "40c48f72fd53cd289104fc64099abca73db4166ad86ea0b4341abe65af83dadc"
+dependencies = [
+ "windows-sys",
+]
+
+[[package]]
+name = "anstyle-wincon"
+version = "3.0.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "291e6a250ff86cd4a820112fb8898808a366d8f9f58ce16d1f538353ad55747d"
+dependencies = [
+ "anstyle",
+ "once_cell_polyfill",
+ "windows-sys",
+]
+
 [[package]]
 name = "async-hid"
 version = "0.5.1"
@@ -233,17 +283,87 @@ dependencies = [
  "inout",
 ]
 
+[[package]]
+name = "clap"
+version = "4.6.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1ddb117e43bbf7dacf0a4190fef4d345b9bad68dfc649cb349e7d17d28428e51"
+dependencies = [
+ "clap_builder",
+ "clap_derive",
+]
+
+[[package]]
+name = "clap_builder"
+version = "4.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "714a53001bf66416adb0e2ef5ac857140e7dc3a0c48fb28b2f10762fc4b5069f"
+dependencies = [
+ "anstream",
+ "anstyle",
+ "clap_lex",
+ "strsim",
+]
+
+[[package]]
+name = "clap_derive"
+version = "4.6.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2ce8604710f6733aa641a2b3731eaa1e8b3d9973d5e3565da11800813f997a9"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "clap_lex"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c8d4a3bb8b1e0c1050499d1815f5ab16d04f0959b233085fb31653fbfc9d98f9"
+
 [[package]]
 name = "cli"
 version = "0.1.0"
 dependencies = [
  "async-hid",
+ "clap",
+ "colog",
+ "csv",
  "deku",
  "futures-lite",
+ "log",
  "pollster",
  "shared",
 ]
 
+[[package]]
+name = "colog"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "df62599ba6adc9c6c04a54278c8209125343dc4775f57b9d76c9a4287e58f2bd"
+dependencies = [
+ "colored",
+ "env_logger",
+ "log",
+]
+
+[[package]]
+name = "colorchoice"
+version = "1.0.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570"
+
+[[package]]
+name = "colored"
+version = "3.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "faf9468729b8cbcea668e36183cb69d317348c2e08e994829fb56ebfdfbaac34"
+dependencies = [
+ "windows-sys",
+]
+
 [[package]]
 name = "concurrent-queue"
 version = "2.5.0"
@@ -333,6 +453,27 @@ dependencies = [
  "typenum",
 ]
 
+[[package]]
+name = "csv"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "52cd9d68cf7efc6ddfaaee42e7288d3a99d613d4b50f76ce9827ae0c6e14f938"
+dependencies = [
+ "csv-core",
+ "itoa",
+ "ryu",
+ "serde_core",
+]
+
+[[package]]
+name = "csv-core"
+version = "0.1.13"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "704a3c26996a80471189265814dbc2c257598b96b8a7feae2d31ace646bb9782"
+dependencies = [
+ "memchr",
+]
+
 [[package]]
 name = "darling"
 version = "0.21.3"
@@ -491,6 +632,29 @@ dependencies = [
  "num",
 ]
 
+[[package]]
+name = "env_filter"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "32e90c2accc4b07a8456ea0debdc2e7587bdd890680d71173a15d4ae604f6eef"
+dependencies = [
+ "log",
+ "regex",
+]
+
+[[package]]
+name = "env_logger"
+version = "0.11.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0621c04f2196ac3f488dd583365b9c09be011a4ab8b9f37248ffcc8f6198b56a"
+dependencies = [
+ "anstream",
+ "anstyle",
+ "env_filter",
+ "jiff",
+ "log",
+]
+
 [[package]]
 name = "equivalent"
 version = "1.0.2"
@@ -672,6 +836,12 @@ dependencies = [
  "stable_deref_trait",
 ]
 
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
 [[package]]
 name = "hermit-abi"
 version = "0.5.2"
@@ -703,6 +873,42 @@ dependencies = [
  "generic-array 0.14.7",
 ]
 
+[[package]]
+name = "is_terminal_polyfill"
+version = "1.70.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695"
+
+[[package]]
+name = "itoa"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
+
+[[package]]
+name = "jiff"
+version = "0.2.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f00b5dbd620d61dfdcb6007c9c1f6054ebd75319f163d886a9055cec1155073d"
+dependencies = [
+ "jiff-static",
+ "log",
+ "portable-atomic",
+ "portable-atomic-util",
+ "serde_core",
+]
+
+[[package]]
+name = "jiff-static"
+version = "0.2.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e000de030ff8022ea1da3f466fbb0f3a809f5e51ed31f6dd931c35181ad8e6d7"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "lazy_static"
 version = "1.5.0"
@@ -1020,6 +1226,12 @@ version = "1.21.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
 
+[[package]]
+name = "once_cell_polyfill"
+version = "1.70.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe"
+
 [[package]]
 name = "panic-halt"
 version = "1.0.0"
@@ -1108,6 +1320,15 @@ version = "1.13.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
 
+[[package]]
+name = "portable-atomic-util"
+version = "0.2.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c2a106d1259c23fac8e543272398ae0e3c0b8d33c88ed73d0cc71b0f1d902618"
+dependencies = [
+ "portable-atomic",
+]
+
 [[package]]
 name = "proc-macro-crate"
 version = "3.5.0"
@@ -1169,6 +1390,18 @@ version = "0.6.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c"
 
+[[package]]
+name = "regex"
+version = "1.12.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e10754a14b9137dd7b1e3e5b0493cc9171fdd105e0ab477f51b72e7f3ac0e276"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-automata",
+ "regex-syntax",
+]
+
 [[package]]
 name = "regex-automata"
 version = "0.4.14"
@@ -1223,6 +1456,12 @@ version = "1.0.22"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
 
+[[package]]
+name = "ryu"
+version = "1.0.23"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9774ba4a74de5f7b1c1451ed6cd5285a32eddb5cccb8cc655a4e50009e06477f"
+
 [[package]]
 name = "scoped-tls"
 version = "1.0.1"
@@ -1263,6 +1502,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e"
 dependencies = [
  "serde_core",
+ "serde_derive",
 ]
 
 [[package]]
@@ -1299,6 +1539,7 @@ name = "shared"
 version = "0.0.0"
 dependencies = [
  "deku",
+ "serde",
  "usbd-hid",
 ]
 
@@ -1565,6 +1806,12 @@ dependencies = [
  "usb-device",
 ]
 
+[[package]]
+name = "utf8parse"
+version = "0.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
+
 [[package]]
 name = "valuable"
 version = "0.1.1"

cli/Cargo.toml

@@ -5,7 +5,11 @@ edition = "2024"
 
 [dependencies]
 async-hid = "0.5.1"
+clap = { version = "4.6.1", features = ["derive"] }
+colog = "1.4.0"
+csv = "1.4.0"
 deku = "0.20.3"
 futures-lite = "2.6.1"
+log = { version = "0.4.29", features = ["std"] }
 pollster = { version = "0.4.0", features = ["macro"] }
-shared = { path = "../shared" }
+shared = { path = "../shared", features = ["serde"] }

cli/src/main.rs

@@ -1,10 +1,67 @@
+use std::io;
+
 use async_hid::{AsyncHidRead, HidBackend, HidResult};
+use clap::{Parser, ValueEnum};
 use deku::DekuContainerRead;
 use futures_lite::StreamExt;
 use shared::hid::AudioTelemetryReport;
 
+#[derive(Clone, Copy, Debug, ValueEnum)]
+enum Format {
+    Debug,
+    Csv,
+}
+
+#[derive(Parser, Debug)]
+#[command(version, about)]
+struct Args {
+    #[arg(short, long, default_value = "debug")]
+    format: Format,
+}
+
+trait StateEmitter<W: io::Write> {
+    fn from_writer(writer: W) -> Self
+    where
+        Self: Sized;
+    fn emit(&mut self, r: &AudioTelemetryReport);
+}
+
+struct DebugEmitter<T: io::Write> {
+    writer: T,
+}
+
+impl<W: io::Write> StateEmitter<W> for DebugEmitter<W> {
+    fn from_writer(writer: W) -> Self {
+        Self { writer }
+    }
+    fn emit(&mut self, r: &AudioTelemetryReport) {
+        writeln!(self.writer, "{r:?}");
+    }
+}
+
+struct CsvEmitter<W: io::Write> {
+    csv: csv::Writer<W>,
+}
+
+impl<W: io::Write> StateEmitter<W> for CsvEmitter<W> {
+    fn from_writer(writer: W) -> Self {
+        Self {
+            csv: csv::Writer::from_writer(writer),
+        }
+    }
+    fn emit(&mut self, r: &AudioTelemetryReport) {
+        if let Err(e) = self.csv.serialize(r) {
+            eprintln!("Serialization error: {e:?}");
+        } else {
+            self.csv.flush().ok();
+        }
+    }
+}
+
 #[pollster::main]
 async fn main() -> HidResult<()> {
+    colog::init();
+    let args = Args::parse();
     let usbhid = HidBackend::default();
     let dev = usbhid
         .enumerate()
@@ -13,12 +70,17 @@ async fn main() -> HidResult<()> {
         .await
         .expect("GUAC device not found or not accessible (try as root?)");
     let mut reader = dev.open_readable().await?;
+    let mut writer: Box<dyn StateEmitter<_>> = match args.format {
+        Format::Debug => Box::new(DebugEmitter::from_writer(io::stdout())),
+        Format::Csv => Box::new(CsvEmitter::from_writer(io::stdout())),
+    };
 
     let mut buf = [0u8; core::mem::size_of::<AudioTelemetryReport>()];
     while let Ok(r) = reader.read_input_report(&mut buf).await {
+        log::debug!("read {}: {:?}", r, &buf[..r]);
         let buf = &buf[..r];
         match AudioTelemetryReport::from_bytes((buf, 0)) {
-            Ok((_, r)) => println!("{:?}", r),
+            Ok((_, r)) => writer.emit(&r),
             Err(e) => eprintln!("Unable to parse report: {:?}", e),
         }
     }

firmware/Cargo.toml

@@ -8,7 +8,9 @@ default = ["nodac", "hid"]
 ak4490 = []
 cs4398 = []
 nodac = []
+wm8904 = []
 hid = [ "dep:usbd-hid", "dep:shared" ]
+evk = [ "wm8904" ]
 
 [dependencies]
 shared = { path="../shared", optional = true }

firmware/src/dac/ak4490.rs

@@ -24,6 +24,7 @@ enum RegisterAddress {
 pub struct Ak4490Dac<T> {
     i2c: T,
     pins: CodecPins, // this dependency is unfortunate, but non trivial to generalize
+    volume: (u8, u8),
 }
 
 impl<T> Ak4490Dac<T>
@@ -43,6 +44,10 @@ where
             _ => 5,
         }
     }
+    fn set_volume_impl(&mut self, left: u8, right: u8) {
+        self.write_reg(RegisterAddress::LeftAtt, left);
+        self.write_reg(RegisterAddress::RightAtt, right);
+    }
 }
 
 impl<T> Dac<T> for Ak4490Dac<T>
@@ -50,7 +55,11 @@ where
     T: _embedded_hal_blocking_i2c_WriteRead + _embedded_hal_blocking_i2c_Write,
 {
     fn new(i2c: T, pins: CodecPins) -> Self {
-        Self { i2c, pins }
+        Self {
+            i2c,
+            pins,
+            volume: (0xff, 0xff),
+        }
     }
     fn init(&mut self) {
         // bring out of reset
@@ -66,7 +75,13 @@ where
         self.write_reg(RegisterAddress::Control4, (dfs & 0x4) >> 1);
     }
     fn set_volume(&mut self, left: u8, right: u8) {
-        self.write_reg(RegisterAddress::LeftAtt, left);
+        self.set_volume_impl(left, right);
-        self.write_reg(RegisterAddress::RightAtt, right);
+        self.volume = (left, right);
+    }
+    fn mute(&mut self) {
+        self.set_volume_impl(0, 0);
+    }
+    fn unmute(&mut self) {
+        self.set_volume_impl(self.volume.0, self.volume.1);
     }
 }

firmware/src/dac/wm8904.rs

@@ -0,0 +1,253 @@
+use crate::{CodecPins, traits::Dac};
+use embedded_hal::prelude::{
+    _embedded_hal_blocking_i2c_Write, _embedded_hal_blocking_i2c_WriteRead,
+};
+const WM8904_I2C_ADDRESS: u8 = 0b0011010;
+const MCLK: u32 = 24576000 / 2; // assume EVK TODO: better
+
+#[repr(u8)]
+#[derive(Clone, Copy)]
+#[allow(dead_code)]
+enum RegisterAddress {
+    SwResetId = 0x00,
+    BiasControl0 = 0x04,
+    VmidControl = 0x05,
+    MicBiasControl0 = 0x06,
+    MicBiasControl1 = 0x07,
+    AnaAdc0 = 0x0a,
+    PowerMgmt0 = 0x0c,
+    PowerMgmt2 = 0x0e,
+    PowerMgmt3 = 0x0f,
+    PowerMgmt6 = 0x12,
+    ClockRates0 = 0x14,
+    ClockRates1 = 0x15,
+    ClockRates2 = 0x16,
+    AudioInterface0 = 0x18,
+    AudioInterface1 = 0x19,
+    AudioInterface2 = 0x1a,
+    AudioInterface3 = 0x1b,
+    DacDigiVolLeft = 0x1e,
+    DacDigiVolRight = 0x1f,
+    DacDigital0 = 0x20,
+    DacDigi1 = 0x21,
+    AdcDigiVolLeft = 0x24,
+    AdcDigiVolRight = 0x25,
+    AdcDigital0 = 0x26,
+    DigiMic0 = 0x27,
+    Drc0 = 0x28,
+    Drc1 = 0x29,
+    Drc2 = 0x2a,
+    Drc3 = 0x2b,
+    AnaLeftIn0 = 0x2c,
+    AnaRightIn0 = 0x2d,
+    AnaLeftIn1 = 0x2e,
+    AnaRightIn1 = 0x2f,
+    AnaOut1Left = 0x39,
+    AnaOut1Right = 0x3a,
+    AnaOut2Left = 0x3b,
+    AnaOut2Right = 0x3c,
+    AnaOut12Zc = 0x3d,
+    DcServo0 = 0x43,
+    DcServo1 = 0x44,
+    DcServo2 = 0x45,
+    DcServo4 = 0x47,
+    DcServo5 = 0x48,
+    DcServo6 = 0x49,
+    DcServo7 = 0x4a,
+    DcServo8 = 0x4b,
+    DcServo9 = 0x4c,
+    DcServoRb0 = 0x4d,
+    AnaHp0 = 0x5a,
+    AnaLineOut0 = 0x5e,
+    ChargePump0 = 0x62,
+    ClassW = 0x68,
+    WriteSeq0 = 0x6c,
+    WriteSeq1 = 0x6d,
+    WriteSeq2 = 0x6e,
+    WriteSeq3 = 0x6f,
+    WriteSeq4 = 0x70,
+    FllControl1 = 0x74,
+    FllControl2 = 0x75,
+    FllControl3 = 0x76,
+    FllControl4 = 0x77,
+    FllControl5 = 0x78,
+    GpioControl1 = 0x79,
+    GpioControl2 = 0x7a,
+    GpioControl3 = 0x7b,
+    GpioControl4 = 0x7c,
+    DigiPulls = 0x7e,
+    IntStatus = 0x7f,
+    IntStatusMask = 0x80,
+    IntPriority = 0x81,
+    IntDebounce = 0x82,
+    Eq1 = 0x86,
+    Eq2 = 0x87,
+    Eq3 = 0x88,
+    Eq4 = 0x89,
+    Eq5 = 0x8a,
+    Eq6 = 0x8b,
+    Eq7 = 0x8c,
+    Eq8 = 0x8d,
+    Eq9 = 0x8e,
+    Eq10 = 0x8f,
+    Eq11 = 0x90,
+    Eq12 = 0x91,
+    Eq13 = 0x92,
+    Eq14 = 0x93,
+    Eq15 = 0x94,
+    Eq16 = 0x95,
+    Eq17 = 0x96,
+    Eq18 = 0x97,
+    Eq19 = 0x98,
+    Eq20 = 0x99,
+    Eq21 = 0x9a,
+    Eq22 = 0x9b,
+    Eq23 = 0x9c,
+    Eq24 = 0x9d,
+    AdcTest0 = 0xc6,
+    FllNcoTest0 = 0xf7,
+    FllNcoTest1 = 0xf8,
+}
+
+pub struct Wm8904Dac<T> {
+    i2c: T,
+    pins: CodecPins,
+    mclk: u32,
+}
+
+impl<T> Wm8904Dac<T>
+where
+    T: _embedded_hal_blocking_i2c_WriteRead + _embedded_hal_blocking_i2c_Write,
+{
+    #[inline]
+    fn write_reg(&mut self, reg: RegisterAddress, val: u16) {
+        let b = val.to_be_bytes();
+        defmt::info!("i2c w [{:?}]", &[reg as u8, b[0], b[1]]);
+        self.i2c
+            .write(WM8904_I2C_ADDRESS, &[reg as u8, b[0], b[1]])
+            .ok();
+    }
+    fn cr1_for_rate(&self, rate: u32) -> u16 {
+        let fs_ratio = self.mclk / rate;
+        if !self.mclk.is_multiple_of(rate) {
+            defmt::warn!("sample rate should be a multiple of mclk");
+        }
+        let clk_sys_rate: u16 = match fs_ratio {
+            64 => 0,
+            128 => 1,
+            192 => 2,
+            256 => 3,
+            384 => 4,
+            512 => 5,
+            768 => 6,
+            1024 => 7,
+            1408 => 8,
+            1536 => 9,
+            _ => {
+                defmt::warn!("unsupport ratio {}", fs_ratio);
+                0
+            }
+        };
+        let sample_rate: u16 = match rate {
+            r if r < 11025 => 0, // 0-11024
+            r if r < 16000 => 1, // 11025 - 15999
+            r if r < 22050 => 2, // 16000 - 22049
+            r if r < 32000 => 3, // 22050 - 31999
+            r if r < 44100 => 4, // 32000 - 44099
+            _ => 5,              // 44100+
+        };
+        (clk_sys_rate << 10) | sample_rate
+    }
+    fn blck_div_for_rate(&self, rate: u32) -> u16 {
+        let bits_per_frame = 64;
+        let bits_per_second = bits_per_frame * rate;
+        (self.mclk / bits_per_second) as u16
+    }
+}
+
+impl<T> Dac<T> for Wm8904Dac<T>
+where
+    T: _embedded_hal_blocking_i2c_WriteRead + _embedded_hal_blocking_i2c_Write,
+{
+    fn new(i2c: T, pins: CodecPins) -> Self {
+        Self {
+            i2c,
+            pins,
+            mclk: MCLK,
+        }
+    }
+    fn init(&mut self) {
+        let mut buf = [0u8; 2];
+        match self.i2c.write_read(WM8904_I2C_ADDRESS, &[0], &mut buf) {
+            Ok(_) => {
+                let chip_id = ((buf[0] as u16) << 8) | buf[1] as u16;
+                defmt::info!("Read chip ID: {:x}", chip_id)
+            }
+            Err(_) => defmt::error!("Error reading I2C"),
+        }
+
+        self.write_reg(RegisterAddress::ClockRates2, 0x000f); // OPCLK_ENA | CLK_SYS_ENA | CLK_DSP_ENA | TOCLK_ENA
+        self.write_reg(RegisterAddress::WriteSeq0, 0x0100); // write sequencer 0 ENA
+        self.write_reg(RegisterAddress::WriteSeq3, 0x0100); // write sequencer 3 START, INDEX=0
+        // wait on write sequencer
+        defmt::info!("[codec] waiting on write seq");
+        loop {
+            let mut buf = [0; 2];
+            self.i2c
+                .write_read(WM8904_I2C_ADDRESS, &[0x70], &mut buf)
+                .ok();
+            if buf[1] & 1 == 0 {
+                break;
+            }
+        }
+        defmt::debug!("[codec] write seq done");
+        self.write_reg(RegisterAddress::ClockRates0, 0);
+        self.write_reg(RegisterAddress::PowerMgmt0, 0); // IN PGAs disabled
+        self.write_reg(RegisterAddress::PowerMgmt2, 0x0003); // HPL_PGA_ENA | HPR_PGA_ENA
+        self.write_reg(RegisterAddress::PowerMgmt3, 0); //line outs disabled
+
+        self.write_reg(RegisterAddress::PowerMgmt6, 0x000c); // power management 6 = DACL_ENA | DACR_ENA
+        self.write_reg(RegisterAddress::AudioInterface0, 0x0050); // audio if 0 = AIFADCR_SRC | AIFDACR_SRC
+        self.write_reg(RegisterAddress::DacDigi1, 0x0040); // dac digital 1 = DAC_OSR128
+        self.write_reg(RegisterAddress::AnaLeftIn0, 0x0005);
+        self.write_reg(RegisterAddress::AnaRightIn0, 0x0005);
+        self.write_reg(RegisterAddress::AnaOut1Left, 0x0039); // analog out1 left = vol=0dB
+        self.write_reg(RegisterAddress::AnaOut1Right, 0x0039); // analog out1 right = vol=0dB
+        self.write_reg(RegisterAddress::AnaOut2Left, 0x0039); // analog out2 left = vol=0dB
+        self.write_reg(RegisterAddress::AnaOut2Right, 0x0039); // analog out2 right = vol=0dB
+        self.write_reg(RegisterAddress::DcServo0, 0x0003); // dc servo 0 = HPOUTL_ENA | HPOUTR_ENA
+        self.write_reg(RegisterAddress::AnaHp0, 0x00ff); // analog hp 0 = remove all shorts etc
+        self.write_reg(RegisterAddress::AnaLineOut0, 0x00ff); // analog lineout 0 = remove all shorts etc
+        self.write_reg(RegisterAddress::ClassW, 0x0001); // enable class w charge pump
+        self.write_reg(RegisterAddress::ChargePump0, 0x0001); // enable charge pump
+        self.write_reg(RegisterAddress::AudioInterface1, (3 << 2) | 2); // audio if 1 = i2s, 32 bit per sample
+
+        self.write_reg(RegisterAddress::ClockRates1, self.cr1_for_rate(96000)); // Set up for 48k, impl will change if needed
+        self.write_reg(RegisterAddress::ClockRates2, 0x000f); // clock rates 2 = CLK_SYS_ENA
+
+        self.write_reg(
+            RegisterAddress::AudioInterface2,
+            self.blck_div_for_rate(96000),
+        );
+
+        self.write_reg(RegisterAddress::AudioInterface3, 0); // audio interface 3 = input lrclock
+        self.write_reg(RegisterAddress::AnaOut12Zc, 0); // analog out12 zc = play source = dac
+        self.write_reg(RegisterAddress::DacDigiVolLeft, 0x01ff); // dac vol left = update left/right = 0dB
+    }
+    fn change_rate(&mut self, new_rate: u32) {
+        // TODO: mute, stop clocks etc.
+        defmt::info!("dac rate -> {}", new_rate);
+        self.write_reg(RegisterAddress::ClockRates1, self.cr1_for_rate(new_rate));
+        self.write_reg(
+            RegisterAddress::AudioInterface2,
+            self.blck_div_for_rate(new_rate),
+        );
+    }
+    fn mute(&mut self) {
+        // self.write_reg(RegisterAddress::DacDigiVolLeft, 0x0100);
+    }
+    fn unmute(&mut self) {
+        // TODO: restore previous volume
+        // self.write_reg(RegisterAddress::DacDigiVolLeft, 0x01ff);
+    }
+}

firmware/src/hid.rs

@@ -1,20 +0,0 @@
-use usbd_hid::descriptor::generator_prelude::*;
-
-#[gen_hid_descriptor(
-    (collection = APPLICATION, usage_page = VENDOR_DEFINED_START, usage = 0x01, ) = {
-        average_buffer_fill=input;
-        frame_count=input;
-        dac_underflow_count=input;
-        usb_underflow_count=input;
-        dac_overflow_count=input;
-    }
-)]
-#[repr(C)]
-// Note these are all actually u32
-pub struct AudioTelemetryReport {
-    pub average_buffer_fill: i32,
-    pub frame_count: i32,
-    pub dac_underflow_count: i32,
-    pub usb_underflow_count: i32,
-    pub dac_overflow_count: i32,
-}

firmware/src/hw.rs

@@ -1,5 +1,5 @@
 use crate::pac;
-use defmt::debug;
+use defmt::{debug, info};
 
 pub(crate) struct PllConstants {
     pub m: u16,   // 1-65535
@@ -112,3 +112,75 @@ pub(crate) fn init_sys_pll1() {
     syscon.fmccr.modify(|_, w| w.flashtim().flashtim11());
     syscon.mainclkselb.modify(|_, w| w.sel().enum_0x2()); // pll1
 }
+
+// Fo = M/(N*2*P) * Fin
+// Fo = 3072/(125*2*8) * 16MHz = 24.576MHz
+const AUDIO_PLL: PllConstants = PllConstants::new(125, 3072, 8);
+
+// Set PLL0 to 24.576MHz, start, and wait for lock
+// This is not exposed by lpc55-hal, unfortunately. Copy their implementation here.
+pub(crate) fn init_audio_pll() {
+    let syscon = unsafe { &*pac::SYSCON::ptr() };
+    let pmc = unsafe { &*pac::PMC::ptr() };
+    let anactrl = unsafe { &*pac::ANACTRL::ptr() };
+
+    debug!("start clk_in");
+    pmc.pdruncfg0
+        .modify(|_, w| w.pden_xtal32m().poweredon().pden_ldoxo32m().poweredon());
+    syscon.clock_ctrl.modify(|_, w| w.clkin_ena().enable());
+    anactrl
+        .xo32m_ctrl
+        .modify(|_, w| w.enable_system_clk_out().enable());
+
+    debug!("init pll0: {}", AUDIO_PLL);
+    pmc.pdruncfg0
+        .modify(|_, w| w.pden_pll0().poweredoff().pden_pll0_sscg().poweredoff());
+    syscon.pll0clksel.write(|w| w.sel().enum_0x1()); // clk_in
+    syscon.pll0ctrl.write(|w| unsafe {
+        w.clken()
+            .enable()
+            .seli()
+            .bits(AUDIO_PLL.seli)
+            .selp()
+            .bits(AUDIO_PLL.selp)
+    });
+
+    syscon
+        .pll0ndec
+        .write(|w| unsafe { w.ndiv().bits(AUDIO_PLL.n) });
+    syscon.pll0ndec.write(|w| unsafe {
+        w.ndiv().bits(AUDIO_PLL.n).nreq().set_bit() // latch
+    });
+
+    syscon
+        .pll0pdec
+        .write(|w| unsafe { w.pdiv().bits(AUDIO_PLL.p) });
+    syscon.pll0pdec.write(|w| unsafe {
+        w.pdiv().bits(AUDIO_PLL.p).preq().set_bit() // latch
+    });
+
+    syscon.pll0sscg0.write(|w| unsafe { w.md_lbs().bits(0) });
+
+    syscon
+        .pll0sscg1
+        .write(|w| unsafe { w.mdiv_ext().bits(AUDIO_PLL.m).sel_ext().set_bit() });
+    syscon.pll0sscg1.write(|w| unsafe {
+        w.mdiv_ext()
+            .bits(AUDIO_PLL.m)
+            .sel_ext()
+            .set_bit()
+            .mreq()
+            .set_bit() // latch
+            .md_req()
+            .set_bit() // latch
+    });
+
+    pmc.pdruncfg0
+        .modify(|_, w| w.pden_pll0().poweredon().pden_pll0_sscg().poweredon());
+    info!("pll0 wait for lock");
+    let mut i = 0usize;
+    while syscon.pll0stat.read().lock().bit_is_clear() {
+        i += 1;
+    }
+    info!("pll0 locked after {} loops", i);
+}

firmware/src/main.rs

@@ -9,6 +9,7 @@ fn panic() -> ! {
 
 use atomic::Atomic;
 use bytemuck::NoUninit;
+use core::error;
 use core::sync::atomic::{AtomicBool, AtomicI32, AtomicUsize, Ordering};
 use cortex_m_rt::entry;
 use defmt;
@@ -57,28 +58,35 @@ pub mod dac {
     mod noop;
     pub use self::noop::NoopDac as DacImpl;
 }
+#[cfg(feature = "wm8904")]
+pub mod dac {
+    mod wm8904;
+    pub use self::wm8904::Wm8904Dac as DacImpl;
+}
 
 mod dma;
-#[cfg(feature = "hid")]
-mod hid;
 mod hw;
 mod traits;
 
 const BYTES_PER_SAMPLE: usize = 4; // 32 bit samples
 const BYTES_PER_FRAME: usize = BYTES_PER_SAMPLE * 2; // 2 channels
-const FRAMES_PER_SLOT: usize = SAMPLE_RATE as usize / 2000; // run the DMA at 2khz
+const FRAMES_PER_SLOT: usize = SAMPLE_RATE as usize / 4000; // run the DMA at 4khz
 const BYTES_PER_SLOT: usize = FRAMES_PER_SLOT * BYTES_PER_FRAME;
 const N_SLOTS: usize = 8;
 const FILL_TARGET_BYTES: i32 = (BYTES_PER_SLOT * N_SLOTS) as i32 / 2;
 const USB_FRAME_RATE: u32 = 8000; // microframe rate: 8000 for HS, 1000 for FS
 
 // In frames
-const QUEUE_RUNNING_UP: usize = ((FRAMES_PER_SLOT * N_SLOTS) * 4) / 10; // 40%
+const QUEUE_RUNNING_UP: usize = ((FRAMES_PER_SLOT * N_SLOTS) * 5) / 10; // 50%
 const QUEUE_RUNNING_DOWN: usize = ((FRAMES_PER_SLOT * N_SLOTS) * 2) / 10; // 20%
 const NODATA_TIMEOUT_FRAMES: usize = SAMPLE_RATE as usize / 100; // ~100ms
+#[cfg(not(feature = "evk"))]
 const MCLK_FREQ: u32 = 24576000;
+#[cfg(feature = "evk")]
+const MCLK_FREQ: u32 = 24576000 / 2;
+
 const SAMPLE_RATE: u32 = 192000;
-const HID_INTERVAL_MS: u8 = 100;
+const HID_INTERVAL_MS: u8 = 10;
 
 struct CodecPins {
     reset: Pin<pins::Pio0_3, Gpio<Output>>,
@@ -91,6 +99,7 @@ struct ClockSelPins {
 
 #[derive(Default)]
 struct PerfCounters {
+    state: Atomic<AudioState>,
     received_frames: AtomicUsize,
     played_frames: AtomicUsize,
     min_fill: AtomicUsize,
@@ -98,6 +107,10 @@ struct PerfCounters {
     queue_underflows: AtomicUsize,
     queue_overflows: AtomicUsize,
     audio_underflows: AtomicUsize,
+    integrator: AtomicI32,
+    p: AtomicI32,
+    i: AtomicI32,
+    fb: AtomicI32,
 }
 
 impl PerfCounters {
@@ -111,14 +124,22 @@ impl PerfCounters {
         self.queue_underflows.store(0, Ordering::Relaxed);
         self.queue_overflows.store(0, Ordering::Relaxed);
         self.audio_underflows.store(0, Ordering::Relaxed);
+        self.p.store(0, Ordering::Relaxed);
+        self.i.store(0, Ordering::Relaxed);
+        // FB loop will have to take care of the fb value
     }
     fn build_report(&self) -> AudioTelemetryReport {
         AudioTelemetryReport {
-            average_buffer_fill: self.avg_fill.load(Ordering::Relaxed) as i32,
+            state: self.state.load(Ordering::Relaxed) as u8,
+            average_buffer_fill: self.avg_fill.load(Ordering::Relaxed) as u16,
             frame_count: self.played_frames.load(Ordering::Relaxed) as i32,
-            dac_underflow_count: self.audio_underflows.load(Ordering::Relaxed) as i32,
+            dac_underflow_count: self.audio_underflows.load(Ordering::Relaxed) as u16,
-            usb_underflow_count: self.queue_underflows.load(Ordering::Relaxed) as i32,
+            usb_underflow_count: self.queue_underflows.load(Ordering::Relaxed) as u16,
-            dac_overflow_count: self.queue_overflows.load(Ordering::Relaxed) as i32,
+            dac_overflow_count: self.queue_overflows.load(Ordering::Relaxed) as u16,
+            integrator: self.integrator.load(Ordering::Relaxed),
+            p: self.p.load(Ordering::Relaxed),
+            i: self.i.load(Ordering::Relaxed),
+            fb: self.fb.load(Ordering::Relaxed) as i32,
         }
     }
 }
@@ -140,6 +161,7 @@ impl defmt::Format for PerfCounters {
 }
 
 static PERF: PerfCounters = PerfCounters {
+    state: Atomic::new(AudioState::Stopped),
     received_frames: AtomicUsize::new(0), // received from USB
     played_frames: AtomicUsize::new(0),   // played audio frames
     min_fill: AtomicUsize::new(0), // not recording this for now, need to figure out how to make it meaningful, since the queue starts empty
@@ -147,6 +169,10 @@ static PERF: PerfCounters = PerfCounters {
     queue_underflows: AtomicUsize::new(0), // ditto here, since we underflow at startup, but we record this one as it can be trended
     queue_overflows: AtomicUsize::new(0),
     audio_underflows: AtomicUsize::new(0),
+    integrator: AtomicI32::new(0),
+    p: AtomicI32::new(0),
+    i: AtomicI32::new(0),
+    fb: AtomicI32::new(0),
 };
 
 static DMA_RING: StaticCell<DmaRing<N_SLOTS, BYTES_PER_SLOT>> = StaticCell::new();
@@ -246,6 +272,11 @@ enum AudioState {
     ///  AltSetting = 0 -> STOPPED
     NoData,
 }
+impl Default for AudioState {
+    fn default() -> Self {
+        AudioState::Stopped
+    }
+}
 impl defmt::Format for AudioState {
     fn format(&self, fmt: defmt::Formatter) {
         defmt::write!(
@@ -319,6 +350,7 @@ impl<D: Dac<I>, I> Audio<'_, D, I> {
             AudioState::NoData => self.nodata(),
         }
         self.state.store(state, Ordering::SeqCst);
+        PERF.state.store(state, Ordering::Relaxed);
     }
 
     fn init(&mut self) {
@@ -559,28 +591,43 @@ impl<D: Dac<I>, I, B: bus::UsbBus> AudioHandler<'_, B> for Audio<'_, D, I> {
             PERF.queue_underflows.fetch_add(1, Ordering::Relaxed);
             return Some(nominal_rate);
         }
+
         PERF.avg_fill
             .fetch_update(Ordering::SeqCst, Ordering::SeqCst, |v| {
                 Some(((v << 6) - v + current_bytes as usize) >> 6)
             })
             .ok();
 
-        // normalize error wrt. frame size etc.
+        let raw_error = current_bytes - FILL_TARGET_BYTES;
-        let error_permille = ((current_bytes - FILL_TARGET_BYTES) * 1000) / FILL_TARGET_BYTES;
+        let i_error = if raw_error.abs() <= 4 { 0 } else { raw_error }; // deadband
+        let current_i = self.fb.integrator.load(Ordering::Relaxed);
+        let leak = current_i >> 7;
+        let new_i = current_i
+            .saturating_sub(leak)
+            .saturating_add(i_error)
+            .clamp(-5000, 5000);
+        self.fb.integrator.store(new_i, Ordering::Relaxed);
+        PERF.integrator.store(new_i, Ordering::Relaxed);
 
         let nominal_v = nominal_rate.to_u32_12_13() as i32;
+        let max_allowed_deviation = nominal_v / 500; // 0.2%
 
-        // 0.2% which is a huge clock error
+        // 3. SEPARATE GAINS FOR P AND I
-        let max_allowed_deviation = nominal_v / 500;
+        // For P: Keep your working math (converting raw error to a permille equivalent scale)
+        let error_permille = (raw_error * 1000) / FILL_TARGET_BYTES;
+        let p_term = (-((error_permille as i64) * (nominal_v as i64)) / (10 * 256000)) as i32;
+        let i_term = (-((new_i as i64) * (nominal_v as i64)) / (256000 * 1000)) as i32;
+        let i_term = 0;
 
-        let p_term = -(error_permille * nominal_v) / 256000; // this works reasonably well to keep the buffer
+        PERF.p.store(p_term, Ordering::Relaxed);
-        let i_term = 0; // placeholder
+        PERF.i.store(i_term, Ordering::Relaxed);
 
         let mut v = nominal_v + p_term + i_term;
         v = v.clamp(
             nominal_v - max_allowed_deviation,
             nominal_v + max_allowed_deviation,
         );
+        PERF.fb.store(v, Ordering::Relaxed);
 
         Some(UsbIsochronousFeedback::new(v as u32))
     }
@@ -611,11 +658,6 @@ pub fn init_i2s(mut fc7: pac::FLEXCOMM7, i2s7: pac::I2S7, syscon: &mut Syscon) -
                 .od()
                 .normal()
         });
-        pac::SYSCON::ptr()
-            .as_ref()
-            .unwrap()
-            .mclkio
-            .modify(|_, w| w.mclkio().input());
         pac::SYSCON::ptr()
             .as_ref()
             .unwrap()
@@ -623,6 +665,33 @@ pub fn init_i2s(mut fc7: pac::FLEXCOMM7, i2s7: pac::I2S7, syscon: &mut Syscon) -
             .modify(|_, w| w.sel().enum_0x5()); // MCLK
     };
 
+    #[cfg(not(feature = "evk"))]
+    unsafe {
+        pac::SYSCON::ptr()
+            .as_ref()
+            .unwrap()
+            .mclkio
+            .modify(|_, w| w.mclkio().input());
+    }
+    #[cfg(feature = "evk")]
+    unsafe {
+        pac::SYSCON::ptr()
+            .as_ref()
+            .unwrap()
+            .mclkclksel
+            .modify(|_, w| w.sel().enum_0x1()); // PLL0
+        pac::SYSCON::ptr()
+            .as_ref()
+            .unwrap()
+            .mclkdiv
+            .modify(|_, w| w.div().bits(1).halt().run().reset().released()); // div by 2 = PLL0 fout / 2 = 12.288MHz, max for WM8904 @ 96k
+        pac::SYSCON::ptr()
+            .as_ref()
+            .unwrap()
+            .mclkio
+            .modify(|_, w| w.mclkio().output());
+    }
+
     // Select I2S TX function
     fc7.pselid.write(|w| w.persel().i2s_transmit());
 
@@ -646,10 +715,17 @@ fn main() -> ! {
     let usb0_vbus_pin = pins::Pio0_22::take()
         .unwrap()
         .into_usb0_vbus_pin(&mut iocon);
+
+    #[cfg(not(feature = "evk"))]
     let codec_i2c_pins = (
         pins::Pio0_16::take().unwrap().into_i2c4_scl_pin(&mut iocon),
         pins::Pio0_5::take().unwrap().into_i2c4_sda_pin(&mut iocon),
     );
+    #[cfg(feature = "evk")]
+    let codec_i2c_pins = (
+        pins::Pio1_20::take().unwrap().into_i2c4_scl_pin(&mut iocon),
+        pins::Pio1_21::take().unwrap().into_i2c4_sda_pin(&mut iocon),
+    );
     let codec_i2s_pins = (
         pins::Pio0_21::take().unwrap().into_spi7_sck_pin(&mut iocon),
         pins::Pio0_20::take().unwrap().into_i2s7_sda_pin(&mut iocon),
@@ -691,6 +767,9 @@ fn main() -> ! {
         .configure(&mut anactrl, &mut pmc, &mut syscon)
         .unwrap();
     hw::init_sys_pll1();
+    #[cfg(feature = "evk")]
+    hw::init_audio_pll();
+
     let mut delay_timer = Timer::new(
         hal.ctimer
             .0
@@ -779,15 +858,15 @@ fn main() -> ! {
         hid_update_timer.start(Microseconds::new(HID_INTERVAL_MS as u32 * 1000));
 
         move || {
-            let active = usb_dev.poll(&mut [&mut uac2, &mut hid]);
+            usb_dev.poll(&mut [&mut uac2, &mut hid]);
-            if active && hid_update_timer.wait().is_ok() {
+            if hid_update_timer.wait().is_ok() {
                 let report = PERF.build_report();
                 match hid.push_input(&report) {
                     Ok(_) => {}
                     Err(UsbError::WouldBlock) => {}
                     Err(e) => defmt::error!("Failed to send HID report: {:?}", e),
                 }
-                // lpc55 timer is not Periodic, so restart it
+                // lpc55 ctimer is not Periodic, so restart it
                 hid_update_timer.start(Microseconds::new(HID_INTERVAL_MS as u32 * 1000));
             }
         }

scripts/guac-stats.py

@@ -1,39 +0,0 @@
-from dataclasses import dataclass
-import struct
-from time import sleep
-from typing import Self
-import hid
-
-VID = 0x1209
-PID = 0xCC1D
-INTERVAL = 0.1
-
-
-@dataclass
-class AudioTelemetry:
-    STRUCT = "<LLLLL"
-    LEN = struct.calcsize(STRUCT)
-
-    average_buffer_fill: int
-    frame_count: int
-    dac_underflow_count: int
-    usb_underflow_count: int
-    dac_overflow_count: int
-
-    def from_bytes(b: bytes) -> Self:
-        if len(b) != AudioTelemetry.LEN:
-            raise ValueError(f"wrong size report ({len(b)} != {AudioTelemetry.LEN})")
-        fields = struct.unpack(AudioTelemetry.STRUCT, b)
-        return AudioTelemetry(*fields)
-
-
-def main():
-    with hid.Device(VID, PID) as h:
-        while True:
-            report = AudioTelemetry.from_bytes(h.read(AudioTelemetry.LEN))
-            print(f"{report}")
-            sleep(INTERVAL)
-
-
-if __name__ == "__main__":
-    main()

scripts/pyproject.toml

@@ -1,10 +0,0 @@
-[project]
-name = "guac-scripts"
-version = "0.1.0"
-description = "Scripts to work with GUAC devices"
-readme = "README.md"
-requires-python = ">=3.12"
-dependencies = [
-    "hid>=1.0.9",
-    "rich-click>=1.9.7",
-]

shared/Cargo.toml

@@ -2,6 +2,10 @@
 name = "shared"
 edition = "2024"
 
+[features]
+serde = ["dep:serde"]
+
 [dependencies]
 deku = { version = "0.20.3", default-features = false }
+serde = { version = "1.0.228", optional = true, features = ["derive"] }
 usbd-hid = { version = "0.10.0" }

shared/src/lib.rs

@@ -2,26 +2,39 @@
 
 pub mod hid {
     use deku::DekuRead;
+    #[cfg(feature = "serde")]
+    use serde::{Deserialize, Serialize};
     use usbd_hid::descriptor::generator_prelude::*;
 
     #[derive(DekuRead)]
     #[deku(endian = "little")]
+    #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
     #[gen_hid_descriptor(
         (collection = APPLICATION, usage_page = VENDOR_DEFINED_START, usage = 0x01, ) = {
+            state=input;
             average_buffer_fill=input;
             frame_count=input;
             dac_underflow_count=input;
             usb_underflow_count=input;
             dac_overflow_count=input;
+            p=input;
+            i=input;
+            fb=input;
+            integrator=input;
         }
     )]
-    #[repr(C)]
+    #[repr(C, packed)]
-    // Note these are all actually u32
+    // TODO: Fix that most of these values are actually u32, but usbd_hid macro doesn't work properly on u32
     pub struct AudioTelemetryReport {
-        pub average_buffer_fill: i32,
+        pub state: u8,
+        pub average_buffer_fill: u16,
         pub frame_count: i32,
-        pub dac_underflow_count: i32,
+        pub dac_underflow_count: u16,
-        pub usb_underflow_count: i32,
+        pub usb_underflow_count: u16,
-        pub dac_overflow_count: i32,
+        pub dac_overflow_count: u16,
+        pub p: i32,
+        pub i: i32,
+        pub fb: i32,
+        pub integrator: i32,
     }
 }