Unverified Commit b87ee706 authored by Mark Brown's avatar Mark Brown
Browse files

ASoC: dt-bindings: atmel-classd: Convert to

Merge series from Ryan.Wanner@microchip.com <Ryan.Wanner@microchip.com>:

This patch series converts atmel-classd and atmel-pdmic device tree
bindings to json-schema.
parents a6229b53 ca0e30b1
Loading
Loading
Loading
Loading
+100 −0
Original line number Diff line number Diff line
# 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-classd.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Atmel ClassD Amplifier

maintainers:
  - Nicolas Ferre <nicolas.ferre@microchip.com>
  - Alexandre Belloni <alexandre.belloni@bootlin.com>
  - Claudiu Beznea <claudiu.beznea@microchip.com>

description:
  The Audio Class D Amplifier (CLASSD) is a digital input, Pulse Width
  Modulated (PWM) output stereo Class D amplifier.

properties:
  compatible:
    const: atmel,sama5d2-classd

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  dmas:
    maxItems: 1

  dma-names:
    const: tx

  clocks:
    maxItems: 2

  clock-names:
    items:
      - const: pclk
      - const: gclk

  atmel,model:
    $ref: /schemas/types.yaml#/definitions/string
    default: CLASSD
    description: The user-visible name of this sound complex.

  atmel,pwm-type:
    $ref: /schemas/types.yaml#/definitions/string
    enum:
      - single
      - diff
    default: single
    description: PWM modulation type.

  atmel,non-overlap-time:
    $ref: /schemas/types.yaml#/definitions/uint32
    enum:
      - 5
      - 10
      - 15
      - 20
    default: 10
    description:
      Set non-overlapping time, the unit is nanosecond(ns).
      Non-overlapping will be disabled if not specified.

required:
  - compatible
  - reg
  - interrupts
  - dmas
  - dma-names
  - clock-names
  - clocks

additionalProperties: false

examples:
  - |
    #include <dt-bindings/dma/at91.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>

    classd: sound@fc048000 {
        compatible = "atmel,sama5d2-classd";
        reg = <0xfc048000 0x100>;
        interrupts = <59 IRQ_TYPE_LEVEL_HIGH 7>;
        dmas = <&dma0
            (AT91_XDMAC_DT_MEM_IF(0) | AT91_XDMAC_DT_PER_IF(1)
            | AT91_XDMAC_DT_PERID(47))>;
        dma-names = "tx";
        clocks = <&classd_clk>, <&classd_gclk>;
        clock-names = "pclk", "gclk";
        assigned-clocks = <&classd_gclk>;
        pinctrl-names = "default";
        pinctrl-0 = <&pinctrl_classd_default>;
        atmel,model = "classd @ SAMA5D2-Xplained";
        atmel,pwm-type = "diff";
        atmel,non-overlap-time = <10>;
    };
+98 −0
Original line number Diff line number Diff line
# 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>;
    };
+0 −55
Original line number Diff line number Diff line
* Atmel ClassD driver under ALSA SoC architecture

Required properties:
- compatible
	Should be "atmel,sama5d2-classd".
- reg
	Should contain ClassD registers location and length.
- interrupts
	Should contain the IRQ line for the ClassD.
- dmas
	One DMA specifiers as described in atmel-dma.txt and dma.txt files.
- dma-names
	Must be "tx".
- clock-names
	Tuple listing input clock names.
	Required elements: "pclk" and "gclk".
- clocks
	Please refer to clock-bindings.txt.
- assigned-clocks
	Should be <&classd_gclk>.

Optional properties:
- pinctrl-names, pinctrl-0
	Please refer to pinctrl-bindings.txt.
- atmel,model
	The user-visible name of this sound complex.
	The default value is "CLASSD".
- atmel,pwm-type
	PWM modulation type, "single" or "diff".
	The default value is "single".
- atmel,non-overlap-time
	Set non-overlapping time, the unit is nanosecond(ns).
	There are four values,
	<5>, <10>, <15>, <20>, the default value is <10>.
	Non-overlapping will be disabled if not specified.

Example:
classd: classd@fc048000 {
		compatible = "atmel,sama5d2-classd";
		reg = <0xfc048000 0x100>;
		interrupts = <59 IRQ_TYPE_LEVEL_HIGH 7>;
		dmas = <&dma0
			(AT91_XDMAC_DT_MEM_IF(0) | AT91_XDMAC_DT_PER_IF(1)
			| AT91_XDMAC_DT_PERID(47))>;
		dma-names = "tx";
		clocks = <&classd_clk>, <&classd_gclk>;
		clock-names = "pclk", "gclk";
		assigned-clocks = <&classd_gclk>;

		pinctrl-names = "default";
		pinctrl-0 = <&pinctrl_classd_default>;
		atmel,model = "classd @ SAMA5D2-Xplained";
		atmel,pwm-type = "diff";
		atmel,non-overlap-time = <10>;
};
+0 −55
Original line number Diff line number Diff line
* 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>;
	};