xref: /linux/Documentation/devicetree/bindings/sound/awinic,aw8738.yaml (revision 24bce201d79807b668bf9d9e0aca801c5c0d5f78) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/sound/awinic,aw8738.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Awinic AW8738 Audio Amplifier
8
9maintainers:
10  - Stephan Gerhold <stephan@gerhold.net>
11
12description:
13  The Awinic AW8738 is a simple audio amplifier with different operation modes
14  (set using one-wire pulse control). The mode configures the speaker-guard
15  function (primarily the power limit for the amplifier).
16
17allOf:
18  - $ref: name-prefix.yaml#
19
20properties:
21  compatible:
22    const: awinic,aw8738
23
24  mode-gpios:
25    description:
26      GPIO used for one-wire pulse control. The pin is typically called SHDN
27      (active-low), but this is misleading since it is actually more than
28      just a simple shutdown/enable control.
29    maxItems: 1
30
31  awinic,mode:
32    description: Operation mode (number of pulses for one-wire pulse control)
33    $ref: /schemas/types.yaml#/definitions/uint32
34    minimum: 1
35    maximum: 7
36
37  sound-name-prefix: true
38
39required:
40  - compatible
41  - mode-gpios
42  - awinic,mode
43
44additionalProperties: false
45
46examples:
47  - |
48    #include <dt-bindings/gpio/gpio.h>
49    audio-amplifier {
50        compatible = "awinic,aw8738";
51        mode-gpios = <&msmgpio 114 GPIO_ACTIVE_HIGH>;
52        awinic,mode = <5>;
53        sound-name-prefix = "Speaker Amp";
54    };
55