xref: /freebsd/sys/contrib/device-tree/Bindings/sound/maxim,max98925.yaml (revision aa1a8ff2d6dbc51ef058f46f3db5a8bb77967145)

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

title: Maxim Integrated MAX98925/MAX98926/MAX98927 speaker amplifier

maintainers:
  - Ryan Lee <ryans.lee@maximintegrated.com>

properties:
  compatible:
    enum:
      - maxim,max98925
      - maxim,max98926
      - maxim,max98927

  reg:
    maxItems: 1

  reset-gpios:
    maxItems: 1

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

  vmon-slot-no:
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 0
    maximum: 30
    default: 0
    description:
      Slot number used to send voltage information or in inteleave mode this
      will be used as interleave slot.

  imon-slot-no:
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 0
    maximum: 30
    default: 0
    description:
      Slot number used to send current information.

  maxim,interleave-mode:
    type: boolean
    description:
      When using two MAX9892X in a system it is possible to create ADC data
      that will overflow the frame size. When enabled, the Digital Audio
      Interleave mode provides a means to output VMON and IMON data from two
      devices on a single DOUT line when running smaller frames sizes such as
      32 BCLKS per LRCLK or 48 BCLKS per LRCLK.

required:
  - compatible
  - reg

allOf:
  - $ref: dai-common.yaml#
  - if:
      properties:
        compatible:
          contains:
            enum:
              - maxim,max98927
    then:
      properties:
        vmon-slot-no:
          minimum: 0
          maximum: 15

        imon-slot-no:
          minimum: 0
          maximum: 15

additionalProperties: false

examples:
  - |
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        #include <dt-bindings/gpio/gpio.h>
        audio-codec@3a {
            compatible = "maxim,max98927";
            reg = <0x3a>;
            #sound-dai-cells = <0>;

            pinctrl-0 = <&speaker_default>;
            pinctrl-names = "default";

            reset-gpios = <&tlmm 69 GPIO_ACTIVE_LOW>;

            vmon-slot-no = <1>;
            imon-slot-no = <0>;
        };
    };