[PATCH v2 1/2] ASoC: dt-bindings: ti,pcm1754: add binding documentation

Stefan Kerkmann posted 2 patches 3 weeks, 1 day ago
[PATCH v2 1/2] ASoC: dt-bindings: ti,pcm1754: add binding documentation
Posted by Stefan Kerkmann 3 weeks, 1 day ago
The Texas Instruments PCM1754 is a simple stereo DAC without any digital
management interface but soft mute, PCM input format and 44.1 kHz
digital de-emphasis can be configured via strapping pins. Only soft mute
and PCM input format selection is currently exposed via optional GPIOs
in the driver.

Signed-off-by: Stefan Kerkmann <s.kerkmann@pengutronix.de>
---
 .../devicetree/bindings/sound/ti,pcm1754.yaml      | 55 ++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/Documentation/devicetree/bindings/sound/ti,pcm1754.yaml b/Documentation/devicetree/bindings/sound/ti,pcm1754.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..a757f737690c18c1db192258472752a4f6a519d6
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/ti,pcm1754.yaml
@@ -0,0 +1,55 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/ti,pcm1754.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments PCM1754 Stereo DAC
+
+description:
+  The PCM1754 is a simple stereo DAC that is controlled via hardware gpios.
+
+maintainers:
+  - Stefan Kerkmann <s.kerkmann@pengutronix.de>
+
+allOf:
+  - $ref: dai-common.yaml#
+
+properties:
+  compatible:
+    enum:
+      - ti,pcm1754
+
+  vcc-supply: true
+
+  '#sound-dai-cells':
+    const: 0
+
+  format-gpios:
+    maxItems: 1
+    description:
+      GPIO used to select the PCM format
+
+  mute-gpios:
+    maxItems: 1
+    description:
+      GPIO used to mute all outputs
+
+required:
+  - compatible
+  - '#sound-dai-cells'
+  - vcc-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    codec {
+      compatible = "ti,pcm1754";
+      #sound-dai-cells = <0>;
+
+      vcc-supply = <&vcc_reg>;
+      mute-gpios = <&gpio 0 GPIO_ACTIVE_HIGH>;
+      format-gpios = <&gpio 1 GPIO_ACTIVE_HIGH>;
+    };

-- 
2.47.3
Re: [PATCH v2 1/2] ASoC: dt-bindings: ti,pcm1754: add binding documentation
Posted by Krzysztof Kozlowski 3 weeks ago
On Wed, Sep 10, 2025 at 11:34:05AM +0200, Stefan Kerkmann wrote:
> The Texas Instruments PCM1754 is a simple stereo DAC without any digital
> management interface but soft mute, PCM input format and 44.1 kHz
> digital de-emphasis can be configured via strapping pins. Only soft mute
> and PCM input format selection is currently exposed via optional GPIOs
> in the driver.

Ah, and if you resend for any reason, then:

A nit, subject: drop second/last, redundant "binding documentation". The
"dt-bindings" prefix is already stating that these are bindings.
See also:
https://elixir.bootlin.com/linux/v6.17-rc3/source/Documentation/devicetree/bindings/submitting-patches.rst#L18

Instead: "add TI PCM1754 Stereo DAC"

Best regards,
Krzysztof
Re: [PATCH v2 1/2] ASoC: dt-bindings: ti,pcm1754: add binding documentation
Posted by Krzysztof Kozlowski 3 weeks ago
On Wed, Sep 10, 2025 at 11:34:05AM +0200, Stefan Kerkmann wrote:
> +  vcc-supply: true
> +
> +  '#sound-dai-cells':
> +    const: 0
> +
> +  format-gpios:
> +    maxItems: 1
> +    description:
> +      GPIO used to select the PCM format
> +
> +  mute-gpios:
> +    maxItems: 1
> +    description:
> +      GPIO used to mute all outputs
> +
> +required:
> +  - compatible
> +  - '#sound-dai-cells'
> +  - vcc-supply

If there is going to be a new version then:

Keep same order as in properties, so supply before cells.

> +
> +additionalProperties: false

and this should be probably unevaluatedProperties: false.

Regardless,

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Best regards,
Krzysztof