From b0e3a6481b5bacadc3d538f571d21f96b274934e Mon Sep 17 00:00:00 2001
From: vinsynth <1.5vhunt@gmail.com>
Date: Mon, 3 Feb 2025 22:52:38 -0500
Subject: [PATCH] document clock settings in examples/stm32f4/.../i2s_dma.rs

---
 examples/stm32f4/src/bin/i2s_dma.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/examples/stm32f4/src/bin/i2s_dma.rs b/examples/stm32f4/src/bin/i2s_dma.rs
index 618717cc9..db5103d0f 100644
--- a/examples/stm32f4/src/bin/i2s_dma.rs
+++ b/examples/stm32f4/src/bin/i2s_dma.rs
@@ -36,6 +36,8 @@ async fn main(_spawner: Spawner) {
         config.rcc.apb1_pre = APBPrescaler::DIV2;
         config.rcc.apb2_pre = APBPrescaler::DIV1;
 
+        // reference your chip's manual for proper clock settings; this config
+        // is recommended for a 32 bit frame at 48 kHz sample rate
         config.rcc.plli2s = Some(Pll {
             prediv: PllPreDiv::DIV25,
             mul: PllMul::MUL384,