Documentation/devicetree/bindings/sound/imx-audio-hdmi.yaml

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

title: NXP i.MX audio complex with HDMI

maintainers:
  - Shengjiu Wang <shengjiu.wang@nxp.com>

properties:
  compatible:
    enum:
      - fsl,imx-audio-hdmi
      - fsl,imx-audio-sii902x

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

  audio-cpu:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: The phandle of an CPU DAI controller

  hdmi-out:
    type: boolean
    description: |
      This is a boolean property. If present, the transmitting function
      of HDMI will be enabled, indicating there's a physical HDMI out
      connector or jack on the board or it's connecting to some other IP
      block, such as an HDMI encoder or display-controller.

  hdmi-in:
    type: boolean
    description: |
      This is a boolean property. If present, the receiving function of
      HDMI will be enabled, indicating there is a physical HDMI in
      connector/jack on the board.

required:
  - compatible
  - model
  - audio-cpu

additionalProperties: false

examples:
  - |
    sound-hdmi {
        compatible = "fsl,imx-audio-hdmi";
        model = "audio-hdmi";
        audio-cpu = <&aud2htx>;
        hdmi-out;
    };