Documentation/devicetree/bindings/sound/adi,max98396.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/sound/adi,max98396.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Analog Devices MAX98396 Speaker Amplifier Device Tree Bindings
   8
   9 maintainers:
  10   - Ryan Lee <ryans.lee@analog.com>
  11
  12 description:
  13   The MAX98396 is a mono Class-DG speaker amplifier with I/V sense.
  14   The device provides a PCM interface for audio data and a standard
  15   I2C interface for control data communication.
  16   The MAX98397 is a variant of MAX98396 with wide input supply range.
  17
  18 properties:
  19   compatible:
  20     enum:
  21       - adi,max98396
  22       - adi,max98397
  23   reg:
  24     maxItems: 1
  25     description: I2C address of the device.
  26
  27   adi,vmon-slot-no:
  28     description: slot number of the voltage sense monitor
  29     $ref: "/schemas/types.yaml#/definitions/uint32"
  30     minimum: 0
  31     maximum: 15
  32     default: 0
  33
  34   adi,imon-slot-no:
  35     description: slot number of the current sense monitor
  36     $ref: "/schemas/types.yaml#/definitions/uint32"
  37     minimum: 0
  38     maximum: 15
  39     default: 0
  40
  41   adi,spkfb-slot-no:
  42     description: slot number of speaker DSP monitor
  43     $ref: "/schemas/types.yaml#/definitions/uint32"
  44     minimum: 0
  45     maximum: 15
  46     default: 0
  47
  48   adi,interleave-mode:
  49     description:
  50       For cases where a single combined channel for the I/V sense data
  51       is not sufficient, the device can also be configured to share
  52       a single data output channel on alternating frames.
  53       In this configuration, the current and voltage data will be frame
  54       interleaved on a single output channel.
  55     type: boolean
  56
  57   reset-gpios:
  58     maxItems: 1
  59
  60 required:
  61   - compatible
  62   - reg
  63
  64 additionalProperties: false
  65
  66 examples:
  67   - |
  68     #include <dt-bindings/gpio/gpio.h>
  69     i2c {
  70         #address-cells = <1>;
  71         #size-cells = <0>;
  72         max98396: amplifier@39 {
  73             compatible = "adi,max98396";
  74             reg = <0x39>;
  75             adi,vmon-slot-no = <0>;
  76             adi,imon-slot-no = <1>;
  77             reset-gpios = <&gpio 4 GPIO_ACTIVE_LOW>;
  78         };
  79     };