Linux 6.7-rc7
[linux-modified.git] / Documentation / devicetree / bindings / sound / tas27xx.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 # Copyright (C) 2020-2022 Texas Instruments Incorporated
3 %YAML 1.2
4 ---
5 $id: http://devicetree.org/schemas/sound/tas27xx.yaml#
6 $schema: http://devicetree.org/meta-schemas/core.yaml#
7
8 title: Texas Instruments TAS2764/TAS2780 Smart PA
9
10 maintainers:
11   - Shenghao Ding <shenghao-ding@ti.com>
12
13 description: |
14   The TAS2764/TAS2780 is a mono, digital input Class-D audio amplifier
15   optimized for efficiently driving high peak power into small
16   loudspeakers. Integrated speaker voltage and current sense provides
17   for real time monitoring of loudspeaker behavior.
18
19 allOf:
20   - $ref: dai-common.yaml#
21
22 properties:
23   compatible:
24     enum:
25       - ti,tas2764
26       - ti,tas2780
27
28   reg:
29     maxItems: 1
30     description: |
31        I2C address of the device can be between 0x38 to 0x45.
32
33   reset-gpios:
34     maxItems: 1
35     description: GPIO used to reset the device.
36
37   shutdown-gpios:
38     maxItems: 1
39     description: GPIO used to control the state of the device.
40
41   interrupts:
42     maxItems: 1
43
44   ti,imon-slot-no:
45     $ref: /schemas/types.yaml#/definitions/uint32
46     description: TDM TX current sense time slot.
47
48   ti,vmon-slot-no:
49     $ref: /schemas/types.yaml#/definitions/uint32
50     description: TDM TX voltage sense time slot.
51
52   '#sound-dai-cells':
53     # The codec has a single DAI, the #sound-dai-cells=<1>; case is left in for backward
54     # compatibility but is deprecated.
55     enum: [0, 1]
56
57 required:
58   - compatible
59   - reg
60
61 unevaluatedProperties: false
62
63 examples:
64   - |
65    #include <dt-bindings/gpio/gpio.h>
66    i2c {
67      #address-cells = <1>;
68      #size-cells = <0>;
69      codec: codec@38 {
70        compatible = "ti,tas2764";
71        reg = <0x38>;
72        #sound-dai-cells = <0>;
73        interrupt-parent = <&gpio1>;
74        interrupts = <14>;
75        reset-gpios = <&gpio1 15 0>;
76        shutdown-gpios = <&gpio1 15 0>;
77        ti,imon-slot-no = <0>;
78        ti,vmon-slot-no = <2>;
79      };
80    };
81
82 ...