[1/3] dt-bindings: sound: Add Renesas IDT821034 codec
Commit Message
The Renesas IDT821034 codec is a quad PCM codec with
programmable gain.
Signed-off-by: Herve Codina <herve.codina@bootlin.com>
---
.../bindings/sound/renesas,idt821034.yaml | 97 +++++++++++++++++++
1 file changed, 97 insertions(+)
create mode 100644 Documentation/devicetree/bindings/sound/renesas,idt821034.yaml
Comments
On 11/01/2023 14:49, Herve Codina wrote:
> The Renesas IDT821034 codec is a quad PCM codec with
> programmable gain.
>
> Signed-off-by: Herve Codina <herve.codina@bootlin.com>
> ---
> .../bindings/sound/renesas,idt821034.yaml | 97 +++++++++++++++++++
> 1 file changed, 97 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/sound/renesas,idt821034.yaml
>
> diff --git a/Documentation/devicetree/bindings/sound/renesas,idt821034.yaml b/Documentation/devicetree/bindings/sound/renesas,idt821034.yaml
> new file mode 100644
> index 000000000000..2c29b770e3f7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/renesas,idt821034.yaml
> @@ -0,0 +1,97 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/renesas,idt821034.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Renesas IDT821034 codec device
> +
> +maintainers:
> + - Herve Codina <herve.codina@bootlin.com>
> +
> +description: |
> + The IDT821034 codec is a four channel PCM codec with onchip filters and
> + programmable gain setting.
> +
> + The time-slots used by the codec must be set and so, the properties
> + 'dai-tdm-slot-num', 'dai-tdm-slot-width', 'dai-tdm-slot-tx-mask' and
> + 'dai-tdm-slot-rx-mask' must be present in the ALSA sound card node for
> + sub-nodes that involve the codec. The codec uses one 8bit time-slot per
> + channel.
> + 'dai-tdm-tdm-slot-with' must be set to 8.
> +
> + The IDT821034 codec also supports 5 gpios (SLIC signals) per channel.
> +
> +allOf:
> + - $ref: /schemas/spi/spi-peripheral-props.yaml#
> + - $ref: /schemas/gpio/gpio.yaml#
This one is never needed. Drop.
> + - $ref: dai-common.yaml#
> +
> +properties:
> + compatible:
> + const: renesas,idt821034
> +
> + reg:
> + description:
> + SPI device address.
> + maxItems: 1
> +
> + spi-max-frequency:
> + maximum: 8192000
> +
> + spi-cpha: true
> +
> + '#sound-dai-cells':
> + const: 0
> +
> + '#gpio-cells':
> + const: 2
> +
> + gpio-controller: true
> +
> +required:
> + - compatible
> + - reg
> + - spi-cpha
> + - '#sound-dai-cells'
> + - gpio-controller
> + - '#gpio-cells'
> +
> +additionalProperties: false
This should be rather unevaluatedProperties: false, so other properties
from spi-props and dai-common will work.
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> + spi0 {
> + #address-cells = <1>;
> + #size-cells = <0>;
> + codec: idt821034@0 {
Node names should be generic, so "audio-codec"
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
> + compatible = "renesas,idt821034";
> + reg = <0>;
> + spi-max-frequency = <8192000>;
> + spi-cpha;
> + #sound-dai-cells = <0>;
> + gpio-controller;
> + #gpio-cells = <2>;
> + };
> + };
> + sound {
> + compatible = "simple-audio-card";
Drop sound{} node. Not relevant to the case here and it's the same in
every case of audio codec... unless something here is specific. But even
the dai-tdm properties are sound card specific.
Best regards,
Krzysztof
On Wed, 11 Jan 2023 17:28:11 +0100
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> On 11/01/2023 14:49, Herve Codina wrote:
> > The Renesas IDT821034 codec is a quad PCM codec with
> > programmable gain.
> >
> > Signed-off-by: Herve Codina <herve.codina@bootlin.com>
> > ---
> > .../bindings/sound/renesas,idt821034.yaml | 97 +++++++++++++++++++
> > 1 file changed, 97 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/sound/renesas,idt821034.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/sound/renesas,idt821034.yaml b/Documentation/devicetree/bindings/sound/renesas,idt821034.yaml
> > new file mode 100644
> > index 000000000000..2c29b770e3f7
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/sound/renesas,idt821034.yaml
> > @@ -0,0 +1,97 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/sound/renesas,idt821034.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Renesas IDT821034 codec device
> > +
> > +maintainers:
> > + - Herve Codina <herve.codina@bootlin.com>
> > +
> > +description: |
> > + The IDT821034 codec is a four channel PCM codec with onchip filters and
> > + programmable gain setting.
> > +
> > + The time-slots used by the codec must be set and so, the properties
> > + 'dai-tdm-slot-num', 'dai-tdm-slot-width', 'dai-tdm-slot-tx-mask' and
> > + 'dai-tdm-slot-rx-mask' must be present in the ALSA sound card node for
> > + sub-nodes that involve the codec. The codec uses one 8bit time-slot per
> > + channel.
> > + 'dai-tdm-tdm-slot-with' must be set to 8.
> > +
> > + The IDT821034 codec also supports 5 gpios (SLIC signals) per channel.
> > +
> > +allOf:
> > + - $ref: /schemas/spi/spi-peripheral-props.yaml#
> > + - $ref: /schemas/gpio/gpio.yaml#
>
> This one is never needed. Drop.
Ok, I will drop it in v2.
>
> > + - $ref: dai-common.yaml#
> > +
> > +properties:
> > + compatible:
> > + const: renesas,idt821034
> > +
> > + reg:
> > + description:
> > + SPI device address.
> > + maxItems: 1
> > +
> > + spi-max-frequency:
> > + maximum: 8192000
> > +
> > + spi-cpha: true
> > +
> > + '#sound-dai-cells':
> > + const: 0
> > +
> > + '#gpio-cells':
> > + const: 2
> > +
> > + gpio-controller: true
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - spi-cpha
> > + - '#sound-dai-cells'
> > + - gpio-controller
> > + - '#gpio-cells'
> > +
> > +additionalProperties: false
>
> This should be rather unevaluatedProperties: false, so other properties
> from spi-props and dai-common will work.
Ok, I will change in v2.
>
> > +
> > +examples:
> > + - |
> > + #include <dt-bindings/gpio/gpio.h>
> > + spi0 {
> > + #address-cells = <1>;
> > + #size-cells = <0>;
> > + codec: idt821034@0 {
>
> Node names should be generic, so "audio-codec"
> https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
>
> > + compatible = "renesas,idt821034";
> > + reg = <0>;
> > + spi-max-frequency = <8192000>;
> > + spi-cpha;
> > + #sound-dai-cells = <0>;
> > + gpio-controller;
> > + #gpio-cells = <2>;
> > + };
> > + };
> > + sound {
> > + compatible = "simple-audio-card";
>
> Drop sound{} node. Not relevant to the case here and it's the same in
> every case of audio codec... unless something here is specific. But even
> the dai-tdm properties are sound card specific.
Indeed, I wanted to show the dai-tdm properties.
But ok, I will drop the node.
>
>
> Best regards,
> Krzysztof
>
Thanks for the review.
Best regards,
Hervé
new file mode 100644
@@ -0,0 +1,97 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/renesas,idt821034.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Renesas IDT821034 codec device
+
+maintainers:
+ - Herve Codina <herve.codina@bootlin.com>
+
+description: |
+ The IDT821034 codec is a four channel PCM codec with onchip filters and
+ programmable gain setting.
+
+ The time-slots used by the codec must be set and so, the properties
+ 'dai-tdm-slot-num', 'dai-tdm-slot-width', 'dai-tdm-slot-tx-mask' and
+ 'dai-tdm-slot-rx-mask' must be present in the ALSA sound card node for
+ sub-nodes that involve the codec. The codec uses one 8bit time-slot per
+ channel.
+ 'dai-tdm-tdm-slot-with' must be set to 8.
+
+ The IDT821034 codec also supports 5 gpios (SLIC signals) per channel.
+
+allOf:
+ - $ref: /schemas/spi/spi-peripheral-props.yaml#
+ - $ref: /schemas/gpio/gpio.yaml#
+ - $ref: dai-common.yaml#
+
+properties:
+ compatible:
+ const: renesas,idt821034
+
+ reg:
+ description:
+ SPI device address.
+ maxItems: 1
+
+ spi-max-frequency:
+ maximum: 8192000
+
+ spi-cpha: true
+
+ '#sound-dai-cells':
+ const: 0
+
+ '#gpio-cells':
+ const: 2
+
+ gpio-controller: true
+
+required:
+ - compatible
+ - reg
+ - spi-cpha
+ - '#sound-dai-cells'
+ - gpio-controller
+ - '#gpio-cells'
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+ spi0 {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ codec: idt821034@0 {
+ compatible = "renesas,idt821034";
+ reg = <0>;
+ spi-max-frequency = <8192000>;
+ spi-cpha;
+ #sound-dai-cells = <0>;
+ gpio-controller;
+ #gpio-cells = <2>;
+ };
+ };
+ sound {
+ compatible = "simple-audio-card";
+ #address-cells = <1>;
+ #size-cells = <0>;
+ simple-audio-card,dai-link@0 {
+ reg = <0>;
+ format = "dsp_b";
+ cpu {
+ sound-dai = <&cpu_dai>;
+ };
+ codec {
+ sound-dai = <&codec>;
+ dai-tdm-slot-num = <4>;
+ dai-tdm-slot-width = <8>;
+ /* TS 2, 3, 5, 7 */
+ dai-tdm-slot-tx-mask = <0 0 1 1 0 1 0 1>;
+ dai-tdm-slot-rx-mask = <0 0 1 1 0 1 0 1>;
+ };
+ };
+ };