Documentation/devicetree/bindings/sound/mt8195-mt6359.yaml

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

title: MediaTek MT8195 ASoC sound card driver

maintainers:
  - Trevor Wu <trevor.wu@mediatek.com>

description:
  This binding describes the MT8195 sound card.

allOf:
  - $ref: sound-card-common.yaml#

properties:
  compatible:
    enum:
      - mediatek,mt8195_mt6359_rt1019_rt5682
      - mediatek,mt8195_mt6359_rt1011_rt5682
      - mediatek,mt8195_mt6359_max98390_rt5682

  model:
    $ref: /schemas/types.yaml#/definitions/string
    description: User specified audio sound card name

  audio-routing:
    description:
      A list of the connections between audio components. Each entry is a
      pair of strings, the first being the connection's sink, the second
      being the connection's source.
      Valid names could be the input or output widgets of audio components,
      power supplies, MicBias of codec and the software switch.
    minItems: 2
    items:
      enum:
        # Sinks
        - Ext Spk
        - Headphone
        - IN1P
        - Left Spk
        - Right Spk

        # Sources
        - Headset Mic
        - HPOL
        - HPOR
        - Left BE_OUT
        - Left SPO
        - Right BE_OUT
        - Right SPO
        - Speaker

  mediatek,platform:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: The phandle of MT8195 ASoC platform.

  mediatek,dptx-codec:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: The phandle of MT8195 Display Port Tx codec node.
    deprecated: true

  mediatek,hdmi-codec:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: The phandle of MT8195 HDMI codec node.
    deprecated: true

  mediatek,adsp:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: The phandle of MT8195 ADSP platform.

  mediatek,dai-link:
    $ref: /schemas/types.yaml#/definitions/string-array
    description:
      A list of the desired dai-links in the sound card. Each entry is a
      name defined in the machine driver.

patternProperties:
  ".*-dai-link$":
    type: object
    additionalProperties: false
    description:
      Container for dai-link level properties and CODEC sub-nodes.

    properties:
      link-name:
        description: Indicates dai-link name and PCM stream name
        enum:
          - DPTX_BE
          - ETDM1_IN_BE
          - ETDM2_IN_BE
          - ETDM1_OUT_BE
          - ETDM2_OUT_BE
          - ETDM3_OUT_BE
          - PCM1_BE

      codec:
        description: Holds subnode which indicates codec dai.
        type: object
        additionalProperties: false
        properties:
          sound-dai:
            minItems: 1
            maxItems: 2
        required:
          - sound-dai

      dai-format:
        description: audio format
        enum: [ i2s, right_j, left_j, dsp_a, dsp_b ]

      mediatek,clk-provider:
        $ref: /schemas/types.yaml#/definitions/string
        description: Indicates dai-link clock master.
        enum: [ cpu, codec ]

    required:
      - link-name

additionalProperties: false

required:
  - compatible
  - mediatek,platform

# Disallow legacy properties if xxx-dai-link nodes are specified
if:
  not:
    patternProperties:
      ".*-dai-link$": false
then:
  properties:
    mediatek,dptx-codec: false
    mediatek,hdmi-codec: false

examples:
  - |

    sound: mt8195-sound {
        compatible = "mediatek,mt8195_mt6359_rt1019_rt5682";
        model = "mt8195_r1019_5682";
        mediatek,platform = <&afe>;
        pinctrl-names = "default";
        pinctrl-0 = <&aud_pins_default>;

        audio-routing =
                "Headphone", "HPOL",
                "Headphone", "HPOR",
                "IN1P", "Headset Mic",
                "Ext Spk", "Speaker";

        mm-dai-link {
                link-name = "ETDM1_IN_BE";
                mediatek,clk-provider = "cpu";
        };

        hs-playback-dai-link {
                link-name = "ETDM1_OUT_BE";
                mediatek,clk-provider = "cpu";
                codec {
                        sound-dai = <&headset_codec>;
                };
        };

        hs-capture-dai-link {
                link-name = "ETDM2_IN_BE";
                mediatek,clk-provider = "cpu";
                codec {
                        sound-dai = <&headset_codec>;
                };
        };

        spk-playback-dai-link {
                link-name = "ETDM2_OUT_BE";
                mediatek,clk-provider = "cpu";
                codec {
                        sound-dai = <&spk_amplifier>;
                };
        };

        hdmi-dai-link {
                link-name = "ETDM3_OUT_BE";
                codec {
                        sound-dai = <&hdmi_tx>;
                };
        };

        displayport-dai-link {
                link-name = "DPTX_BE";
                codec {
                        sound-dai = <&dp_tx>;
                };
        };
    };

...