ASoC: dt-bindings: atmel-classd: PDMIC convert to json-schema

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries

%YAML 1.2

---

$id: http://devicetree.org/schemas/sound/atmel,sama5d2-pdmic.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Atmel PDMIC decoder

maintainers:

  - Claudiu Beznea <claudiu.beznea@microchip.com>

description:

  Atmel Pulse Density Modulation Interface Controller

  (PDMIC) peripheral is a mono PDM decoder module

  that decodes an incoming PDM sample stream.

properties:

  compatible:

    const: atmel,sama5d2-pdmic

  reg:

    maxItems: 1

  interrupts:

    maxItems: 1

  clocks:

    items:

      - description: peripheral clock

      - description: generated clock

  clock-names:

    items:

      - const: pclk

      - const: gclk

  dmas:

    maxItems: 1

  dma-names:

    const: rx

  atmel,mic-min-freq:

    $ref: /schemas/types.yaml#/definitions/uint32

    description:

      The minimal frequency that the microphone supports.

  atmel,mic-max-freq:

    $ref: /schemas/types.yaml#/definitions/uint32

    description:

      The maximal frequency that the microphone supports.

  atmel,model:

    $ref: /schemas/types.yaml#/definitions/string

    default: PDMIC

    description: The user-visible name of this sound card.

  atmel,mic-offset:

    $ref: /schemas/types.yaml#/definitions/int32

    default: 0

    description: The offset that should be added.

required:

  - compatible

  - reg

  - interrupts

  - dmas

  - dma-names

  - clock-names

  - clocks

  - atmel,mic-min-freq

  - atmel,mic-max-freq

additionalProperties: false

examples:

  - |

    #include <dt-bindings/dma/at91.h>

    #include <dt-bindings/interrupt-controller/arm-gic.h>

    pdmic: sound@f8018000 {

        compatible = "atmel,sama5d2-pdmic";

        reg = <0xf8018000 0x124>;

        interrupts = <48 IRQ_TYPE_LEVEL_HIGH 7>;

        dmas = <&dma0

                (AT91_XDMAC_DT_MEM_IF(0) | AT91_XDMAC_DT_PER_IF(1)

                | AT91_XDMAC_DT_PERID(50))>;

        dma-names = "rx";

        clocks = <&pdmic_clk>, <&pdmic_gclk>;

        clock-names = "pclk", "gclk";

        pinctrl-names = "default";

        pinctrl-0 = <&pinctrl_pdmic_default>;

        atmel,model = "PDMIC@sama5d2_xplained";

        atmel,mic-min-freq = <1000000>;

        atmel,mic-max-freq = <3246000>;

        atmel,mic-offset = <0x0>;

    };

* Atmel PDMIC driver under ALSA SoC architecture

Required properties:

- compatible

	Should be "atmel,sama5d2-pdmic".

- reg

	Should contain PDMIC registers location and length.

- interrupts

	Should contain the IRQ line for the PDMIC.

- dmas

	One DMA specifiers as described in atmel-dma.txt and dma.txt files.

- dma-names

	Must be "rx".

- clock-names

	Required elements:

	- "pclk"	peripheral clock

	- "gclk"	generated clock

- clocks

	Must contain an entry for each required entry in clock-names.

	Please refer to clock-bindings.txt.

- atmel,mic-min-freq

	The minimal frequency that the micphone supports.

- atmel,mic-max-freq

	The maximal frequency that the micphone supports.

Optional properties:

- pinctrl-names, pinctrl-0

	Please refer to pinctrl-bindings.txt.

- atmel,model

	The user-visible name of this sound card.

	The default value is "PDMIC".

- atmel,mic-offset

	The offset that should be added.

	The range is from -32768 to 32767.

	The default value is 0.

Example:

	pdmic@f8018000 {

				compatible = "atmel,sama5d2-pdmic";

				reg = <0xf8018000 0x124>;

				interrupts = <48 IRQ_TYPE_LEVEL_HIGH 7>;

				dmas = <&dma0

					(AT91_XDMAC_DT_MEM_IF(0) | AT91_XDMAC_DT_PER_IF(1)

					| AT91_XDMAC_DT_PERID(50))>;

				dma-names = "rx";

				clocks = <&pdmic_clk>, <&pdmic_gclk>;

				clock-names = "pclk", "gclk";

				pinctrl-names = "default";

				pinctrl-0 = <&pinctrl_pdmic_default>;

				atmel,model = "PDMIC @ sama5d2_xplained";

				atmel,mic-min-freq = <1000000>;

				atmel,mic-max-freq = <3246000>;

				atmel,mic-offset = <0x0>;

	};