xref: /freebsd/sys/contrib/device-tree/Bindings/sound/maxim,max98504.yaml (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7) 
1# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/sound/maxim,max98504.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Maxim Integrated MAX98504 class D mono speaker amplifier
8
9maintainers:
10  - Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
11
12description:
13  Maxim Integrated MAX98504 speaker amplifier supports I2C control interface
14  with an IRQ output signal, PCM and PDM digital audio interface (DAI) and a
15  differential analog input.
16
17properties:
18  compatible:
19    const: maxim,max98504
20
21  reg:
22    maxItems: 1
23
24  interrupts:
25    maxItems: 1
26
27  DIOVDD-supply: true
28  DVDD-supply: true
29  PVDD-supply: true
30
31  maxim,brownout-threshold:
32    $ref: /schemas/types.yaml#/definitions/uint32
33    maximum: 21
34    default: 0
35    description:
36      PVDD brownout threshold, where values correspond to 2.6V, 2.65V...3.65V
37      voltage range.  Property also enables the PVDD brownout protection.
38
39  maxim,brownout-attenuation:
40    $ref: /schemas/types.yaml#/definitions/uint32
41    maximum: 6
42    default: 0
43    description:
44      Brownout attenuation to the speaker gain applied during the "attack hold"
45      and "timed hold" phase, the value must be from 0...6 (dB) range.
46
47  maxim,brownout-attack-hold-ms:
48    maximum: 255
49    default: 0
50    description:
51      Brownout attack hold phase time in ms, VBATBROWN_ATTK_HOLD, register 0x0018.
52
53  maxim,brownout-timed-hold-ms:
54    maximum: 255
55    default: 0
56    description:
57      Brownout timed hold phase time in ms, VBATBROWN_TIME_HOLD, register 0x0019.
58
59  maxim,brownout-release-rate-ms:
60    maximum: 255
61    default: 0
62    description:
63      Brownout release phase step time in ms, VBATBROWN_RELEASE, register 0x001A.
64
65required:
66  - compatible
67  - reg
68
69additionalProperties: false
70
71examples:
72  - |
73    #include <dt-bindings/gpio/gpio.h>
74
75    i2c {
76        #address-cells = <1>;
77        #size-cells = <0>;
78
79        amplifier@31 {
80            compatible = "maxim,max98504";
81            reg = <0x31>;
82
83            DIOVDD-supply = <&ldo3_reg>;
84            DVDD-supply = <&ldo3_reg>;
85        };
86    };
87