xref: /kernel/linux/linux-6.6/Documentation/devicetree/bindings/sound/maxim,max98357a.yaml

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

title: Maxim Integrated MAX98357A/MAX98360A amplifier

maintainers:
  - Tzung-Bi Shih <tzungbi@kernel.org>

description:
  Maxim Integrated MAX98357A/MAX98360A is a digital pulse-code modulation (PCM)
  input Class D amplifier.

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

properties:
  compatible:
    enum:
      - maxim,max98357a
      - maxim,max98360a

  '#sound-dai-cells':
    const: 0

  sdmode-gpios:
    maxItems: 1
    description:
      Chip's SD_MODE pin.  If missing the chip is always on.

  sdmode-delay:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      Delay time for SD_MODE pin changes intended to make I2S clocks ready
      before SD_MODE is unmuted in order to avoid the speaker pop noise.

required:
  - compatible

unevaluatedProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>

    amplifier {
        compatible = "maxim,max98360a";
        #sound-dai-cells = <0>;
        sdmode-gpios = <&qcom_pinmux 25 GPIO_ACTIVE_HIGH>;
    };