[PATCH] ALSA: doc: cs35l56: Update calibration write failure message info

[PATCH] ALSA: doc: cs35l56: Update calibration write failure message info

[Richard Fitzgerald]

Update the descriptions of the "Failed to write calibration" and
"Calibration disabled due to missing firmware controls" error messages.

Originally "Failed to write calibration" was described as having the same
cause as "Calibration disabled due to missing firmware controls". This
was _typically_ true because the most likely cause of the write failure
was missing controls (because both messages would be logged in that case).
But it wasn't clear from the description that this was referring to the
_typical_ root cause being the same.

Reword the "Failed to write calibration" info to describe the possible
other reasons for this error.

Also slightly reword the description of "Calibration disabled due to
missing firmware controls" to say "firmware wmfw file" instead of only
"wmfw" and fix a missing "the" in the second bullet point. Also note
that this is not necessarily an error, only information.

Signed-off-by: Richard Fitzgerald <rf@opensource.cirrus.com>
---
 Documentation/sound/codecs/cs35l56.rst | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/Documentation/sound/codecs/cs35l56.rst b/Documentation/sound/codecs/cs35l56.rst
index b3f8c1c238518..ffbfbaed12714 100644
--- a/Documentation/sound/codecs/cs35l56.rst
+++ b/Documentation/sound/codecs/cs35l56.rst
@@ -235,19 +235,28 @@ No %s for algorithm %x
   HDA driver did not find a .bin file that matches this hardware.
 
 Calibration disabled due to missing firmware controls
-  Driver was not able to write EFI calibration data to firmware registers.
-  This typically means that either:
+  This isn't necessarily an error, only informative. The amplifier can
+  operate without calibration, as the firmware contains a default
+  calibration for the speakers, but it will tend to over-protect the
+  speakers.
 
-    * The driver did not find a suitable wmfw for this hardware, or
+  This message typically means that either:
+    * The driver did not find a suitable firmware .wmfw file for this
+      hardware, or
     * The amplifier has already been patched with firmware by something
       previously, and the driver does not have control of a hard RESET line
       to be able to reset the amplifier and download the firmware files it
       found. This situation is indicated by the device identification
-      string in the kernel log shows "(patched=1)"
+      string in the kernel log showing "(patched=1)"
 
 Failed to write calibration
-  Same meaning and cause as "Calibration disabled due to missing firmware
-  controls"
+  If the error code is -2 (ENOENT):
+    * The driver has been unbound and rebound without reprobing.
+    * The wrong firmware .wmfw file was loaded for this hardware so the
+      algorithm IDs in the firmware do not match what the driver is
+      looking for.
+
+  Other error codes likely indicate a problem communicating with the hardware.
 
 Failed to read calibration data from EFI
   Factory calibration data in EFI is missing, empty or corrupt.
-- 
2.47.3

Re: [PATCH] ALSA: doc: cs35l56: Update calibration write failure message info

[Takashi Iwai]

On Wed, 04 Nov 2026 12:36:10 +0100,
Richard Fitzgerald wrote:
> 
> Update the descriptions of the "Failed to write calibration" and
> "Calibration disabled due to missing firmware controls" error messages.
> 
> Originally "Failed to write calibration" was described as having the same
> cause as "Calibration disabled due to missing firmware controls". This
> was _typically_ true because the most likely cause of the write failure
> was missing controls (because both messages would be logged in that case).
> But it wasn't clear from the description that this was referring to the
> _typical_ root cause being the same.
> 
> Reword the "Failed to write calibration" info to describe the possible
> other reasons for this error.
> 
> Also slightly reword the description of "Calibration disabled due to
> missing firmware controls" to say "firmware wmfw file" instead of only
> "wmfw" and fix a missing "the" in the second bullet point. Also note
> that this is not necessarily an error, only information.
> 
> Signed-off-by: Richard Fitzgerald <rf@opensource.cirrus.com>

Applied now.  Thanks.


Takashi