Unverified Commit 4d37c72e authored by Jerome Brunet's avatar Jerome Brunet Committed by Mark Brown
Browse files

ASoC: dt-bindings: meson: convert axg pdm to schema



Convert the DT binding documentation for the Amlogic axg PDM device to
schema.

Signed-off-by: default avatarJerome Brunet <jbrunet@baylibre.com>
Reviewed-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20230206153449.596326-4-jbrunet@baylibre.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent c5536e7b
Loading
Loading
Loading
Loading
+0 −29
Original line number Diff line number Diff line
* Amlogic Audio PDM input

Required properties:
- compatible: 'amlogic,axg-pdm' or
	      'amlogic,g12a-pdm' or
	      'amlogic,sm1-pdm'
- reg: physical base address of the controller and length of memory
       mapped region.
- clocks: list of clock phandle, one for each entry clock-names.
- clock-names: should contain the following:
  * "pclk"   : peripheral clock.
  * "dclk"   : pdm digital clock
  * "sysclk" : dsp system clock
- #sound-dai-cells: must be 0.

Optional property:
- resets: phandle to the dedicated reset line of the pdm input.

Example of PDM on the A113 SoC:

pdm: audio-controller@ff632000 {
	compatible = "amlogic,axg-pdm";
	reg = <0x0 0xff632000 0x0 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";
};
+82 −0
Original line number Diff line number Diff line
# 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";
    };