Documentation/devicetree/bindings/sound/ti,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/ti,tas2562.yaml#
   6 $schema: http://devicetree.org/meta-schemas/core.yaml#
   7
   8 title: Texas Instruments TAS2562 Smart PA
   9
  10 maintainers:
  11   - Andrew Davis <afd@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/tas2564
  22     https://www.ti.com/lit/gpn/tas2110
  23
  24 allOf:
  25   - $ref: dai-common.yaml#
  26
  27 properties:
  28   compatible:
  29     enum:
  30       - ti,tas2562
  31       - ti,tas2564
  32       - ti,tas2110
  33
  34   reg:
  35     maxItems: 1
  36     description: |
  37        I2C address of the device can be one of these 0x4c, 0x4d, 0x4e or 0x4f
  38
  39   shut-down-gpios:
  40     maxItems: 1
  41     description: GPIO used to control the state of the device.
  42     deprecated: true
  43
  44   shutdown-gpios:
  45     maxItems: 1
  46     description: GPIO used to control the state of the device.
  47
  48   interrupts:
  49     maxItems: 1
  50
  51   ti,imon-slot-no:
  52     $ref: /schemas/types.yaml#/definitions/uint32
  53     description: TDM TX current sense time slot.
  54
  55   '#sound-dai-cells':
  56     # The codec has a single DAI, the #sound-dai-cells=<1>; case is left in for backward
  57     # compatibility but is deprecated.
  58     enum: [0, 1]
  59
  60 required:
  61   - compatible
  62   - reg
  63
  64 unevaluatedProperties: false
  65
  66 examples:
  67   - |
  68     #include <dt-bindings/gpio/gpio.h>
  69
  70     i2c {
  71         #address-cells = <1>;
  72         #size-cells = <0>;
  73
  74         codec@4c {
  75             compatible = "ti,tas2562";
  76             reg = <0x4c>;
  77             #sound-dai-cells = <0>;
  78             interrupt-parent = <&gpio1>;
  79             interrupts = <14>;
  80             shutdown-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
  81             ti,imon-slot-no = <0>;
  82         };
  83     };