Summary¶

The high-level summary of this document is:

If you have a laptop that uses CS35L54/56/57/63 amplifiers but audio is notworking, DO NOT ATTEMPT TO USE FIRMWARE AND SETTINGS FROM ANOTHER LAPTOP,EVEN IF THAT LAPTOP SEEMS SIMILAR.

The CS35L54/56/57/63 amplifiers must be correctly configured for the powersupply voltage, speaker impedance, maximum speaker voltage/current, andother external hardware connections.

The amplifiers feature advanced boost technology that increases the voltageused to drive the speakers, while proprietary speaker protection algorithmsallow these boosted amplifiers to push the limits of the speakers withoutcausing damage. Thesemust be configured correctly.

Firmware¶

The amplifier is controlled and managed by firmware running on the internalDSP. Firmware files are essential to enable the full capabilities of theamplifier.

Firmware is distributed in the linux-firmware repository:https://gitlab.com/kernel-firmware/linux-firmware.git

On most SoundWire systems the amplifier has a default minimum capability toproduce audio. However this will be

• at low volume, to protect the speakers, since the speaker specificationsand power supply voltages are unknown.

• a mono mix of left and right channels.

On some SoundWire systems that have both CS42L43 and CS35L56/57 the CS35L56/57receive their audio from the CS42L43 instead of directly from the hostSoundWire interface. These systems can be identified by the CS42L43 showingin dmesg as a SoundWire device, but the CS35L56/57 as SPI. On these systemsthe firmware ismandatory to enable receiving the audio from the CS42L43.

On HDA systems the firmware ismandatory to enable HDA bridge mode. Therewill not be any audio from the amplifiers without firmware.

lspci -v -nn | grep -A2 -i audio0000:00:1f.3 Audio device [0403]: Intel Corporation Meteor Lake-P HD Audio Controller [8086:7e28]Subsystem: Dell Meteor Lake-P HD Audio Controller [1028:0c63]

Kernel log messages¶

[ 7.568374] cs35l56 sdw:0:0:01fa:3556:01:0: supply VDD_P not found, using dummy regulator[ 7.605208] cs35l56 sdw:0:0:01fa:3556:01:0: supply VDD_IO not found, using dummy regulator[ 7.605313] cs35l56 sdw:0:0:01fa:3556:01:0: supply VDD_A not found, using dummy regulator[ 7.939279] cs35l56 sdw:0:0:01fa:3556:01:0: Cirrus Logic CS35L56 Rev B0 OTP3 fw:3.4.4 (patched=0)[ 7.947844] cs35l56 sdw:0:0:01fa:3556:01:0: Slave 4 state check1: UNATTACHED, status was 1[ 8.740280] cs35l56 sdw:0:0:01fa:3556:01:0: supply VDD_B not found, using dummy regulator[ 8.740552] cs35l56 sdw:0:0:01fa:3556:01:0: supply VDD_AMP not found, using dummy regulator[ 9.242164] cs35l56 sdw:0:0:01fa:3556:01:0: DSP1: cirrus/cs35l56-b0-dsp1-misc-xxxxxxxx.wmfw: format 3 timestamp 0x66b2b872[ 9.242173] cs35l56 sdw:0:0:01fa:3556:01:0: DSP1: cirrus/cs35l56-b0-dsp1-misc-xxxxxxxx.wmfw: Tue 05 Dec 2023 21:37:21 GMT Standard Time[ 9.991709] cs35l56 sdw:0:0:01fa:3556:01:0: DSP1: Firmware: 1a00d6 vendor: 0x2 v3.11.23, 41 algorithms[10.039098] cs35l56 sdw:0:0:01fa:3556:01:0: DSP1: cirrus/cs35l56-b0-dsp1-misc-xxxxxxxx-amp1.bin: v3.11.23[10.879235] cs35l56 sdw:0:0:01fa:3556:01:0: Slave 4 state check1: UNATTACHED, status was 1[11.401536] cs35l56 sdw:0:0:01fa:3556:01:0: Calibration applied

[ 6.306475] cs35l56-hda i2c-CSC3556:00-cs35l56-hda.0: Cirrus Logic CS35L56 Rev B0 OTP3 fw:3.4.4 (patched=0)[ 6.613892] cs35l56-hda i2c-CSC3556:00-cs35l56-hda.0: DSP system name: 'xxxxxxxx', amp name: 'AMP1'[ 8.266660] snd_hda_codec_cs8409 ehdaudio0D0: bound i2c-CSC3556:00-cs35l56-hda.0 (ops cs35l56_hda_comp_ops [snd_hda_scodec_cs35l56])[ 8.287525] cs35l56-hda i2c-CSC3556:00-cs35l56-hda.0: DSP1: cirrus/cs35l56-b0-dsp1-misc-xxxxxxxx.wmfw: format 3 timestamp 0x66b2b872[ 8.287528] cs35l56-hda i2c-CSC3556:00-cs35l56-hda.0: DSP1: cirrus/cs35l56-b0-dsp1-misc-xxxxxxxx.wmfw: Tue 05 Dec 2023 21:37:21 GMT Standard Time[ 9.984335] cs35l56-hda i2c-CSC3556:00-cs35l56-hda.0: DSP1: Firmware: 1a00d6 vendor: 0x2 v3.11.23, 41 algorithms[10.085797] cs35l56-hda i2c-CSC3556:00-cs35l56-hda.0: DSP1: cirrus/cs35l56-b0-dsp1-misc-xxxxxxxx-amp1.bin: v3.11.23[10.655237] cs35l56-hda i2c-CSC3556:00-cs35l56-hda.0: Calibration applied

Error messages¶

This section explains some of the error messages that the driver can log.

Algorithm coefficient version %d.%d.%d but expected %d.%d.%d

The version of the .bin file content does not match the loaded firmware.Caused by mismatched .wmfw and .bin file, or .bin file was found but.wmfw was not.

No %s for algorithm %x

The version of the .bin file content does not match the loaded firmware.Caused by mismatched .wmfw and .bin file, or .bin file was found but.wmfw was not.

.bin file required but not found

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:

• The driver did not find a suitable wmfw for this hardware, or

• The amplifier has already been patched with firmware by somethingpreviously, and the driver does not have control of a hard RESET lineto be able to reset the amplifier and download the firmware files itfound. This situation is indicated by the device identificationstring in the kernel log shows “(patched=1)”

Failed to write calibration

Same meaning and cause as “Calibration disabled due to missing firmwarecontrols”

Failed to read calibration data from EFI

Factory calibration data in EFI is missing, empty or corrupt.This is most likely to be cause by accidentally deleting the file fromthe EFI filesystem.

No calibration for silicon ID

The factory calibration data in EFI does not match this hardware.The most likely cause is that an amplifier has been replaced on themotherboard without going through manufacturer calibration process togenerate calibration data for the new amplifier.

Did not find any buses for CSCxxxx

Only on HDA systems. The HDA codec driver found an ACPI entry forCirrus Logic companion amps, but could not enumerate the ACPI entries forthe I2C/SPI buses. The most likely cause of this is that:

• The relevant bus driver (I2C or SPI) is not part of the kernel.

• The HDA codec driver was built-in to the kernel but the I2C/SPIbus driver is a module and so the HDA codec driver cannot call thebus driver functions.

init_completion timed out

The SoundWire bus controller (host end) did not enumerate the amplifier.In other words, the ACPI says there is an amplifier but for some reasonit was not detected on the bus.

No AF01 node

Indicates an error in ACPI. A SoundWire system should have aDevice()node named “AF01” but it was not found.

Failed to get spk-id-gpios

ACPI says that the driver should request a GPIO but the driver was notable to get that GPIO. The most likely cause is that the kernel does notinclude the correct GPIO or PINCTRL driver for this system.

Failed to read spk-id

ACPI says that the driver should request a GPIO but the driver was notable to read that GPIO.

Unexpected spk-id element count

AF01 contains more speaker ID GPIO entries than the driver supports

Overtemp error

Amplifier overheat protection was triggered and the amplifier shut downto protect itself.

Amp short error

Amplifier detected a short-circuit on the speaker output pins and shutdown for protection. This would normally indicate a damaged speaker.

Hibernate wake failed

The driver tried to wake the amplifier from its power-saving state butdid not see the expected responses from the amplifier. This can be causedby using firmware that does not match the hardware.