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