Documentation/devicetree/bindings/sound/tas2562.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 # Copyright (C) 2019 Texas Instruments Incorporated
   3 %YAML 1.2
   4 ---
   5 $id: "http://devicetree.org/schemas/sound/tas2562.yaml#"
   6 $schema: "http://devicetree.org/meta-schemas/core.yaml#"
   7
   8 title: Texas Instruments TAS2562 Smart PA
   9
  10 maintainers:
  11   - Dan Murphy <dmurphy@ti.com>
  12
  13 description: |
  14   The TAS2562 is a mono, digital input Class-D audio amplifier optimized for
  15   efficiently driving high peak power into small loudspeakers.
  16   Integrated speaker voltage and current sense provides for
  17   real time monitoring of loudspeaker behavior.
  18
  19   Specifications about the audio amplifier can be found at:
  20     https://www.ti.com/lit/gpn/tas2562
  21     https://www.ti.com/lit/gpn/tas2563
  22     https://www.ti.com/lit/gpn/tas2564
  23     https://www.ti.com/lit/gpn/tas2110
  24
  25 properties:
  26   compatible:
  27     enum:
  28       - ti,tas2562
  29       - ti,tas2563
  30       - ti,tas2564
  31       - ti,tas2110
  32
  33   reg:
  34     maxItems: 1
  35     description: |
  36        I2C address of the device can be one of these 0x4c, 0x4d, 0x4e or 0x4f
  37
  38   shut-down-gpios:
  39     maxItems: 1
  40     description: GPIO used to control the state of the device.
  41     deprecated: true
  42
  43   shutdown-gpios:
  44     maxItems: 1
  45     description: GPIO used to control the state of the device.
  46
  47   interrupts:
  48     maxItems: 1
  49
  50   ti,imon-slot-no:
  51     $ref: /schemas/types.yaml#/definitions/uint32
  52     description: TDM TX current sense time slot.
  53
  54   '#sound-dai-cells':
  55     const: 1
  56
  57 required:
  58   - compatible
  59   - reg
  60
  61 additionalProperties: false
  62
  63 examples:
  64   - |
  65    #include <dt-bindings/gpio/gpio.h>
  66    i2c0 {
  67      #address-cells = <1>;
  68      #size-cells = <0>;
  69      codec: codec@4c {
  70        compatible = "ti,tas2562";
  71        reg = <0x4c>;
  72        #sound-dai-cells = <1>;
  73        interrupt-parent = <&gpio1>;
  74        interrupts = <14>;
  75        shutdown-gpios = <&gpio1 15 0>;
  76        ti,imon-slot-no = <0>;
  77      };
  78    };
  79