Merge branch 'pm-cpufreq'
[cascardo/linux.git] / Documentation / devicetree / bindings / mfd / twl6040.txt
1 Texas Instruments TWL6040 family
2
3 The TWL6040s are 8-channel high quality low-power audio codecs providing audio,
4 vibra and GPO functionality on OMAP4+ platforms.
5 They are connected ot the host processor via i2c for commands, McPDM for audio
6 data and commands.
7
8 Required properties:
9 - compatible : "ti,twl6040" for twl6040, "ti,twl6041" for twl6041
10 - reg: must be 0x4b for i2c address
11 - interrupts: twl6040 has one interrupt line connecteded to the main SoC
12 - interrupt-parent: The parent interrupt controller
13 - gpio-controller:
14 - #gpio-cells = <1>: twl6040 provides GPO lines.
15 - #clock-cells = <0>; twl6040 is a provider of pdmclk which is used by McPDM
16 - twl6040,audpwron-gpio: Power on GPIO line for the twl6040
17
18 - vio-supply: Regulator for the twl6040 VIO supply
19 - v2v1-supply: Regulator for the twl6040 V2V1 supply
20
21 Optional properties, nodes:
22 - enable-active-high: To power on the twl6040 during boot.
23 - clocks: phandle to the clk32k and/or to mclk clock provider
24 - clock-names: Must be "clk32k" for the 32K clock and "mclk" for the MCLK.
25
26 Vibra functionality
27 Required properties:
28 - vddvibl-supply: Regulator for the left vibra motor
29 - vddvibr-supply: Regulator for the right vibra motor
30 - vibra { }: Configuration section for vibra parameters containing the following
31              properties:
32 - ti,vibldrv-res: Resistance parameter for left driver
33 - ti,vibrdrv-res: Resistance parameter for right driver
34 - ti,viblmotor-res: Resistance parameter for left motor
35 - ti,viblmotor-res: Resistance parameter for right motor
36
37 Optional properties within vibra { } section:
38 - vddvibl_uV: If the vddvibl default voltage need to be changed
39 - vddvibr_uV: If the vddvibr default voltage need to be changed
40
41 Example:
42 &i2c1 {
43         twl6040: twl@4b {
44                 compatible = "ti,twl6040";
45
46                 interrupts = <0 119 4>;
47                 interrupt-parent = <&gic>;
48                 twl6040,audpwron-gpio = <&gpio4 31 0>;
49
50                 vio-supply = <&v1v8>;
51                 v2v1-supply = <&v2v1>;
52                 enable-active-high;
53
54                 /* regulators for vibra motor */
55                 vddvibl-supply = <&vbat>;
56                 vddvibr-supply = <&vbat>;
57
58                 vibra {
59                         /* Vibra driver, motor resistance parameters */
60                         ti,vibldrv-res = <8>;
61                         ti,vibrdrv-res = <3>;
62                         ti,viblmotor-res = <10>;
63                         ti,vibrmotor-res = <10>;
64                 };
65         };
66 };
67
68 /include/ "twl6040.dtsi"