Documentation/devicetree/bindings/sound/renesas,idt821034.yaml

# 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: 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'

unevaluatedProperties: false

examples:
  - |
    spi {
        #address-cells = <1>;
        #size-cells = <0>;
        audio-codec@0 {
            compatible = "renesas,idt821034";
            reg = <0>;
            spi-max-frequency = <8192000>;
            spi-cpha;
            #sound-dai-cells = <0>;
            gpio-controller;
            #gpio-cells = <2>;
        };
    };