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