Documentation/devicetree/bindings/sound/amlogic,axg-pdm.yaml

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/sound/amlogic,axg-pdm.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Amlogic Audio AXG PDM input

maintainers:
  - Jerome Brunet <jbrunet@baylibre.com>

properties:
  compatible:
    oneOf:
      - items:
          - enum:
              - amlogic,g12a-pdm
              - amlogic,sm1-pdm
          - const: amlogic,axg-pdm
      - const: amlogic,axg-pdm

  reg:
    maxItems: 1

  "#sound-dai-cells":
    const: 0

  clocks:
    items:
      - description: Peripheral clock
      - description: PDM digital clock
      - description: DSP system clock

  clock-names:
    items:
      - const: pclk
      - const: dclk
      - const: sysclk

  resets:
    maxItems: 1

required:
  - compatible
  - reg
  - "#sound-dai-cells"
  - clocks
  - clock-names

allOf:
  - $ref: dai-common.yaml#

  - if:
      properties:
        compatible:
          contains:
            enum:
              - amlogic,g12a-pdm
              - amlogic,sm1-pdm
    then:
      required:
        - resets

    else:
      properties:
        resets: false

unevaluatedProperties: false

examples:
  - |
    #include <dt-bindings/clock/axg-audio-clkc.h>

    audio-controller@ff632000 {
        compatible = "amlogic,axg-pdm";
        reg = <0xff632000 0x34>;
        #sound-dai-cells = <0>;
        clocks = <&clkc_audio AUD_CLKID_PDM>,
                 <&clkc_audio AUD_CLKID_PDM_DCLK>,
                 <&clkc_audio AUD_CLKID_PDM_SYSCLK>;
        clock-names = "pclk", "dclk", "sysclk";
    };