Skip to contentSkip to conversation

Support reading Subsystem ID from Device Tree

PATCH Superseded Stefan Binding 3 participants 7 messages Sep 12, 2025 – Sep 26, 2025

Subsystems (4)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

cover Support reading Subsystem ID from Device Tree

In PC systems using ACPI, the driver is able to read back an SSID from the _SUB property. This SSID uniquely identifies the system, which enables the driver to read the correct firmware and tuning for that system from linux-firmware. Currently there is no way of reading this property from device tree. Add an equivalent property in device tree to perform the same role.

Stefan Binding (2):
ASoC: dt-bindings: cirrus,cs35l41: Document the cirrus,subsystem-id
property
ASoC: cs35l41: Fallback to reading Subsystem ID property if not ACPI

 .../bindings/sound/cirrus,cs35l41.yaml        |  6 ++
 sound/soc/codecs/cs35l41.c                    | 77 +++++++++++--------
 2 files changed, 50 insertions(+), 33 deletions(-)
Signature · 1 line
2.43.0
#1 lore raw

PATCH 1/2 ASoC: dt-bindings: cirrus,cs35l41: Document the cirrus,subsystem-id property

Add new property: cirrus,subsystem-id
This new property is used to uniquely identify the system if device tree is used, to allow the driver to select the correct firmware and tuning for the system.

---
 Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml +6 -0
index 14dea1feefc5..a9eb9bd7ad9c 100644
@@ -151,6 +151,12 @@ properties:
     minimum: 0
     maximum: 5
 
+  cirrus,subsystem-id:
+    description:
+      Subsystem ID. If this property is present, it sets the system name,
+      used to identify the firmware and tuning to load.
+    type: string
+
 required:
   - compatible
   - reg
Signature · 1 line
2.43.0
#2 lore raw

Re: [PATCH v1 1/2] ASoC: dt-bindings: cirrus,cs35l41: Document the cirrus,subsystem-id property

Quoted 10 lines · Stefan Binding

Add new property: cirrus,subsystem-id
This new property is used to uniquely identify the system if device tree is used, to allow the driver to select the correct firmware and tuning for the system.

---
 Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml | 6 ++++++
 1 file changed, 6 insertions(+)

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml: cirrus,subsystem-id: missing type definition /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml: properties:cirrus,subsystem-id:type: 'string' is not one of ['boolean', 'object']
from schema $id: http://devicetree.org/meta-schemas/core.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml: properties:cirrus,subsystem-id:type: 'boolean' was expected
hint: A vendor boolean property can use "type: boolean"
from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/[email protected]

The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.

maintainer
#3 lore raw

Re: [PATCH v1 1/2] ASoC: dt-bindings: cirrus,cs35l41: Document the cirrus,subsystem-id property

In reply to Stefan Binding
Quoted 15 lines · Stefan Binding

Add new property: cirrus,subsystem-id
This new property is used to uniquely identify the system if device tree is used, to allow the driver to select the correct firmware and tuning for the system.

---
 Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml +0 -0
index 14dea1feefc5..a9eb9bd7ad9c 100644

Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml properties: · line 158

Quoted 8 lines
Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml +5 -0
@@ -151,6 +151,12 @@ properties:
     minimum: 0
     maximum: 5
 
+  cirrus,subsystem-id:
+    description:
+      Subsystem ID. If this property is present, it sets the system name,
+      used to identify the firmware and tuning to load.
+    type: string

Why not use standard 'firmware-name' to just say exactly what firmware to load?

Rob

#4 lore raw

Re: [PATCH v1 1/2] ASoC: dt-bindings: cirrus,cs35l41: Document the cirrus,subsystem-id property

Quoted 19 lines · Rob Herring
Quoted 18 lines · Stefan Binding

Add new property: cirrus,subsystem-id
This new property is used to uniquely identify the system if device tree is used, to allow the driver to select the correct firmware and tuning for the system.

---
 Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml +0 -0
index 14dea1feefc5..a9eb9bd7ad9c 100644
@@ -151,6 +151,12 @@ properties:
     minimum: 0
     maximum: 5
 
Quoted 7 lines

Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml properties: · line 158

Quoted 5 lines
Documentation/devicetree/bindings/sound/cirrus,cs35l41.yaml +5 -0
+  cirrus,subsystem-id:
+    description:
+      Subsystem ID. If this property is present, it sets the system name,
+      used to identify the firmware and tuning to load.
+    type: string

Why not use standard 'firmware-name' to just say exactly what firmware to load?

The DSP driver searches for a compatible firmware (and tuning) based on what it is able to read from the hardware.
However, the SSID is based on the system, and cannot be read from the hardware, therefore it needs to be read from the Device Tree.
On ACPI-based systems, it is able to read this from the ACPI _SUB property, and to maintain compatibility with the driver between ACPI and Device Tree systems we need an equivalent property. In addition, the driver actually loads 2 files, firmware and tuning, and the SSID is used to determine the file name of both files.

Thanks,

Stefan

Quoted 2 lines

Rob

#5 lore raw

PATCH 2/2 ASoC: cs35l41: Fallback to reading Subsystem ID property if not ACPI

In reply to Stefan Binding

If ACPI is not used, then there is currently no way of reading a Subsystem ID property used for a system name to uniquely identify the system in order to load the correct firmware and tuning. Add a new property which can be read from device tree to be able to set the system name.

---
 sound/soc/codecs/cs35l41.c | 77 ++++++++++++++++++++++----------------
 1 file changed, 44 insertions(+), 33 deletions(-)
sound/soc/codecs/cs35l41.c +44 -33
index 224d65987a8d..d7e3d89de652 100644
@@ -7,6 +7,7 @@
 // Author: David Rhodes <[email protected]>
 
 #include <linux/acpi.h>
+#include <acpi/acpi_bus.h>
 #include <linux/delay.h>
 #include <linux/err.h>
 #include <linux/init.h>
@@ -1147,45 +1148,55 @@ static int cs35l41_dsp_init(struct cs35l41_private *cs35l41)
 	return ret;
 }
 
-#ifdef CONFIG_ACPI
-static int cs35l41_acpi_get_name(struct cs35l41_private *cs35l41)
+static int cs35l41_get_system_name(struct cs35l41_private *cs35l41)
 {
 	struct acpi_device *adev = ACPI_COMPANION(cs35l41->dev);
-	acpi_handle handle = acpi_device_handle(adev);
-	const char *hid;
-	const char *sub;
-
-	/* If there is no acpi_device, there is no ACPI for this system, return 0 */
-	if (!adev)
-		return 0;
+	const char *sub = NULL;
+	const char *tmp;
+	int ret = 0;
 
-	sub = acpi_get_subsystem_id(handle);
-	if (IS_ERR(sub)) {
-		/* If no _SUB, fallback to _HID, otherwise fail */
-		if (PTR_ERR(sub) == -ENODATA) {
-			hid = acpi_device_hid(adev);
-			/* If dummy hid, return 0 and fallback to legacy firmware path */
-			if (!strcmp(hid, "device"))
-				return 0;
-			sub = kstrdup(hid, GFP_KERNEL);
-			if (!sub)
-				sub = ERR_PTR(-ENOMEM);
-
-		} else
-			return PTR_ERR(sub);
+	/* If there is no acpi_device, there is no ACPI for this system, skip checking ACPI */
+	if (adev) {
+		acpi_handle handle = acpi_device_handle(adev);
+
+		sub = acpi_get_subsystem_id(handle);
+		ret = PTR_ERR(sub);
+		if (ret) {
+			sub = NULL;
+			/* If no _SUB, fallback to _HID, otherwise fail */
+			if (ret == -ENODATA) {
+				tmp = acpi_device_hid(adev);
+				/* If dummy hid, return 0 and fallback to legacy firmware path */
+				if (!strcmp(tmp, "device")) {
+					ret = 0;
+					goto err;
+				}
+				sub = kstrdup(tmp, GFP_KERNEL);
+				if (!sub) {
+					ret = -ENOMEM;
+					goto err;
+				}
+			}
+		}
+	} else {
+		if (!device_property_read_string(cs35l41->dev, "cirrus,subsystem-id", &tmp)) {
+			sub = kstrdup(tmp, GFP_KERNEL);
+			if (!sub) {
+				ret = -ENOMEM;
+				goto err;
+			}
+		}
 	}
 
-	cs35l41->dsp.system_name = sub;
-	dev_dbg(cs35l41->dev, "Subsystem ID: %s\n", cs35l41->dsp.system_name);
+err:
+	if (sub) {
+		cs35l41->dsp.system_name = sub;
+		dev_info(cs35l41->dev, "Subsystem ID: %s\n", cs35l41->dsp.system_name);
+	} else
+		dev_warn(cs35l41->dev, "Subsystem ID not found\n");
 
-	return 0;
-}
-#else
-static int cs35l41_acpi_get_name(struct cs35l41_private *cs35l41)
-{
-	return 0;
+	return ret;
 }
-#endif /* CONFIG_ACPI */
 
 int cs35l41_probe(struct cs35l41_private *cs35l41, const struct cs35l41_hw_cfg *hw_cfg)
 {
@@ -1317,7 +1328,7 @@ int cs35l41_probe(struct cs35l41_private *cs35l41, const struct cs35l41_hw_cfg *
 		goto err;
 	}
 
-	ret = cs35l41_acpi_get_name(cs35l41);
+	ret = cs35l41_get_system_name(cs35l41);
 	if (ret < 0)
 		goto err;
 
Signature · 1 line
2.43.0
maintainer
#6 lore raw
In reply to Stefan Binding
Quoted 8 lines · Stefan Binding

In PC systems using ACPI, the driver is able to read back an SSID from the _SUB property. This SSID uniquely identifies the system, which enables the driver to read the correct firmware and tuning for that system from linux-firmware. Currently there is no way of reading this property from device tree. Add an equivalent property in device tree to perform the same role.

[...]

Applied to

https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next

Thanks!

[1/2] ASoC: dt-bindings: cirrus,cs35l41: Document the cirrus,subsystem-id property

      commit: f8673e4069b2032bf9f854bae818a7bdbdca7520
[2/2] ASoC: cs35l41: Fallback to reading Subsystem ID property if not ACPI
      commit: 46c8b4d2a693eca69a2191436cffa44f489e98c7

All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying to this mail.

Thanks,
Mark