GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / mfd / twl4030-audio.txt
1 Texas Instruments TWL family (twl4030) audio module
2
3 The audio module inside the TWL family consist of an audio codec and a vibra
4 driver.
5
6 Required properties:
7 - compatible : must be "ti,twl4030-audio"
8
9 Optional properties, nodes:
10
11 Audio functionality:
12 - codec { }: Need to be present if the audio functionality is used. Within this
13              section the following options can be used:
14 - ti,digimic_delay: Delay need after enabling the digimic to reduce artifacts
15                     from the start of the recorded sample (in ms)
16 -ti,ramp_delay_value: HS ramp delay configuration to reduce pop noise
17 -ti,hs_extmute: Use external mute for HS pop reduction
18 -ti,hs_extmute_gpio: Use external GPIO to control the external mute
19 -ti,offset_cncl_path: Offset cancellation path selection, refer to TRM for the
20                       valid values.
21
22 Vibra functionality
23 - ti,enable-vibra: Need to be set to <1> if the vibra functionality is used. if
24                    missing or it is 0, the vibra functionality is disabled.
25
26 Example:
27 &i2c1 {
28         clock-frequency = <2600000>;
29
30         twl: twl@48 {
31                 reg = <0x48>;
32                 interrupts = <7>; /* SYS_NIRQ cascaded to intc */
33                 interrupt-parent = <&intc>;
34
35                 twl_audio: audio {
36                         compatible = "ti,twl4030-audio";
37
38                         ti,enable-vibra = <1>;
39
40                         codec {
41                                 ti,ramp_delay_value = <3>;
42                         };
43
44                 };
45         };
46 };