GNU Linux-libre 5.15.137-gnu
[releases.git] / Documentation / devicetree / bindings / sound / tas2764.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 # Copyright (C) 2020 Texas Instruments Incorporated
3 %YAML 1.2
4 ---
5 $id: "http://devicetree.org/schemas/sound/tas2764.yaml#"
6 $schema: "http://devicetree.org/meta-schemas/core.yaml#"
7
8 title: Texas Instruments TAS2764 Smart PA
9
10 maintainers:
11   - Dan Murphy <dmurphy@ti.com>
12
13 description: |
14   The TAS2764 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 properties:
20   compatible:
21     enum:
22       - ti,tas2764
23
24   reg:
25     maxItems: 1
26     description: |
27        I2C address of the device can be between 0x38 to 0x45.
28
29   reset-gpios:
30     maxItems: 1
31     description: GPIO used to reset the device.
32
33   shutdown-gpios:
34     maxItems: 1
35     description: GPIO used to control the state of the device.
36
37   interrupts:
38     maxItems: 1
39
40   ti,imon-slot-no:
41     $ref: /schemas/types.yaml#/definitions/uint32
42     description: TDM TX current sense time slot.
43
44   ti,vmon-slot-no:
45     $ref: /schemas/types.yaml#/definitions/uint32
46     description: TDM TX voltage sense time slot.
47
48   '#sound-dai-cells':
49     # The codec has a single DAI, the #sound-dai-cells=<1>; case is left in for backward
50     # compatibility but is deprecated.
51     enum: [0, 1]
52
53 required:
54   - compatible
55   - reg
56
57 additionalProperties: false
58
59 examples:
60   - |
61    #include <dt-bindings/gpio/gpio.h>
62    i2c0 {
63      #address-cells = <1>;
64      #size-cells = <0>;
65      codec: codec@38 {
66        compatible = "ti,tas2764";
67        reg = <0x38>;
68        #sound-dai-cells = <0>;
69        interrupt-parent = <&gpio1>;
70        interrupts = <14>;
71        reset-gpios = <&gpio1 15 0>;
72        shutdown-gpios = <&gpio1 15 0>;
73        ti,imon-slot-no = <0>;
74        ti,vmon-slot-no = <2>;
75      };
76    };
77
78 ...