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

ASoC: dt-bindings: meson: convert axg tdm formatters to schema



Convert the DT binding documentation for the Amlogic tdm formatters 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-3-jbrunet@baylibre.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent cdff9112
Loading
Loading
Loading
Loading
+0 −36
Original line number Diff line number Diff line
* Amlogic Audio TDM formatters

Required properties:
- compatible: 'amlogic,axg-tdmin' or
	      'amlogic,axg-tdmout' or
	      'amlogic,g12a-tdmin' or
	      'amlogic,g12a-tdmout' or
	      'amlogic,sm1-tdmin' or
	      'amlogic,sm1-tdmout
- 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.
  * "sclk"     : bit clock.
  * "sclk_sel" : bit clock input multiplexer.
  * "lrclk"    : sample clock
  * "lrclk_sel": sample clock input multiplexer

Optional property:
- resets: phandle to the dedicated reset line of the tdm formatter.

Example of TDMOUT_A on the S905X2 SoC:

tdmout_a: audio-controller@500 {
	compatible = "amlogic,axg-tdmout";
	reg = <0x0 0x500 0x0 0x40>;
	resets = <&clkc_audio AUD_RESET_TDMOUT_A>;
	clocks = <&clkc_audio AUD_CLKID_TDMOUT_A>,
		 <&clkc_audio AUD_CLKID_TDMOUT_A_SCLK>,
		 <&clkc_audio AUD_CLKID_TDMOUT_A_SCLK_SEL>,
		 <&clkc_audio AUD_CLKID_TDMOUT_A_LRCLK>,
		 <&clkc_audio AUD_CLKID_TDMOUT_A_LRCLK>;
	clock-names = "pclk", "sclk", "sclk_sel",
		      "lrclk", "lrclk_sel";
};
+88 −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-tdm-formatters.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Amlogic Audio AXG TDM formatters

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

properties:
  compatible:
    enum:
      - amlogic,g12a-tdmout
      - amlogic,sm1-tdmout
      - amlogic,axg-tdmout
      - amlogic,g12a-tdmin
      - amlogic,sm1-tdmin
      - amlogic,axg-tdmin

  clocks:
    items:
      - description: Peripheral clock
      - description: Bit clock
      - description: Bit clock input multiplexer
      - description: Sample clock
      - description: Sample clock input multiplexer

  clock-names:
    items:
      - const: pclk
      - const: sclk
      - const: sclk_sel
      - const: lrclk
      - const: lrclk_sel

  reg:
    maxItems: 1

  resets:
    maxItems: 1

required:
  - compatible
  - reg
  - clocks
  - clock-names

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

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

    else:
      properties:
        resets: false

unevaluatedProperties: false

examples:
  - |
    #include <dt-bindings/clock/axg-audio-clkc.h>
    #include <dt-bindings/reset/amlogic,meson-g12a-audio-reset.h>

    audio-controller@500 {
        compatible = "amlogic,g12a-tdmout";
        reg = <0x500 0x40>;
        resets = <&clkc_audio AUD_RESET_TDMOUT_A>;
        clocks = <&clkc_audio AUD_CLKID_TDMOUT_A>,
                 <&clkc_audio AUD_CLKID_TDMOUT_A_SCLK>,
                 <&clkc_audio AUD_CLKID_TDMOUT_A_SCLK_SEL>,
                 <&clkc_audio AUD_CLKID_TDMOUT_A_LRCLK>,
                 <&clkc_audio AUD_CLKID_TDMOUT_A_LRCLK>;
        clock-names = "pclk", "sclk", "sclk_sel",
                      "lrclk", "lrclk_sel";
    };