GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / sound / max98504.txt
1 Maxim MAX98504 class D mono speaker amplifier
2
3 This device supports I2C control interface and an IRQ output signal. It features
4 a PCM and PDM digital audio interface (DAI) and a differential analog input.
5
6 Required properties:
7
8  - compatible : "maxim,max98504"
9  - reg : should contain the I2C slave device address
10  - DVDD-supply, DIOVDD-supply, PVDD-supply: power supplies for the device,
11    as covered in ../regulator/regulator.txt
12  - interrupts : should specify the interrupt line the device is connected to,
13    as described in ../interrupt-controller/interrupts.txt
14
15 Optional properties:
16
17  - maxim,brownout-threshold - the PVDD brownout threshold, the value must be
18    from 0, 1...21 range, corresponding to 2.6V, 2.65V...3.65V voltage range
19  - maxim,brownout-attenuation - the brownout attenuation to the speaker gain
20    applied during the "attack hold" and "timed hold" phase, the value must be
21    from 0...6 (dB) range
22  - maxim,brownout-attack-hold-ms - the brownout attack hold phase time in ms,
23    0...255 (VBATBROWN_ATTK_HOLD, register 0x0018)
24  - maxim,brownout-timed-hold-ms - the brownout timed hold phase time in ms,
25    0...255 (VBATBROWN_TIME_HOLD, register 0x0019)
26  - maxim,brownout-release-rate-ms - the brownout release phase step time in ms,
27    0...255 (VBATBROWN_RELEASE, register 0x001A)
28
29 The default value when the above properties are not specified is 0,
30 the maxim,brownout-threshold property must be specified to actually enable
31 the PVDD brownout protection.
32
33 Example:
34
35  max98504@31 {
36         compatible = "maxim,max98504";
37         reg = <0x31>;
38         interrupt-parent = <&gpio_bank_0>;
39         interrupts = <2 0>;
40
41         DVDD-supply = <&regulator>;
42         DIOVDD-supply = <&regulator>;
43         PVDD-supply = <&regulator>;
44 };