Merge greybus driver tree into 4.8-rc6
[linux-2.6-microblaze.git] / Documentation / devicetree / bindings / sound / st,sta32x.txt
1 STA32X audio CODEC
2
3 The driver for this device only supports I2C.
4
5 Required properties:
6
7   - compatible: "st,sta32x"
8   - reg: the I2C address of the device for I2C
9   - reset-gpios: a GPIO spec for the reset pin. If specified, it will be
10                  deasserted before communication to the codec starts.
11
12   - power-down-gpios: a GPIO spec for the power down pin. If specified,
13                       it will be deasserted before communication to the codec
14                       starts.
15
16   - Vdda-supply: regulator spec, providing 3.3V
17   - Vdd3-supply: regulator spec, providing 3.3V
18   - Vcc-supply: regulator spec, providing 5V - 26V
19
20 Optional properties:
21
22   -  st,output-conf: number, Selects the output configuration:
23         0: 2-channel (full-bridge) power, 2-channel data-out
24         1: 2 (half-bridge). 1 (full-bridge) on-board power
25         2: 2 Channel (Full-Bridge) Power, 1 Channel FFX
26         3: 1 Channel Mono-Parallel
27         If parameter is missing, mode 0 will be enabled.
28         This property has to be specified as '/bits/ 8' value.
29
30   -  st,ch1-output-mapping: Channel 1 output mapping
31   -  st,ch2-output-mapping: Channel 2 output mapping
32   -  st,ch3-output-mapping: Channel 3 output mapping
33         0: Channel 1
34         1: Channel 2
35         2: Channel 3
36         If parameter is missing, channel 1 is chosen.
37         This properties have to be specified as '/bits/ 8' values.
38
39   -  st,thermal-warning-recover:
40         If present, thermal warning recovery is enabled.
41
42   -  st,thermal-warning-adjustment:
43         If present, thermal warning adjustment is enabled.
44
45   -  st,fault-detect-recovery:
46         If present, then fault recovery will be enabled.
47
48   -  st,drop-compensation-ns: number
49         Only required for "st,ffx-power-output-mode" ==
50         "variable-drop-compensation".
51         Specifies the drop compensation in nanoseconds.
52         The value must be in the range of 0..300, and only
53         multiples of 20 are allowed. Default is 140ns.
54
55   -  st,max-power-use-mpcc:
56         If present, then MPCC bits are used for MPC coefficients,
57         otherwise standard MPC coefficients are used.
58
59   -  st,max-power-corr:
60         If present, power bridge correction for THD reduction near maximum
61         power output is enabled.
62
63   -  st,am-reduction-mode:
64         If present, FFX mode runs in AM reduction mode, otherwise normal
65         FFX mode is used.
66
67   -  st,odd-pwm-speed-mode:
68         If present, PWM speed mode run on odd speed mode (341.3 kHz) on all
69         channels. If not present, normal PWM spped mode (384 kHz) will be used.
70
71   -  st,invalid-input-detect-mute:
72         If present, automatic invalid input detect mute is enabled.
73
74 Example:
75
76 codec: sta32x@38 {
77         compatible = "st,sta32x";
78         reg = <0x1c>;
79         reset-gpios = <&gpio1 19 0>;
80         power-down-gpios = <&gpio1 16 0>;
81         st,output-conf = /bits/ 8  <0x3>;       // set output to 2-channel
82                                                 // (full-bridge) power,
83                                                 // 2-channel data-out
84         st,ch1-output-mapping = /bits/ 8 <0>;   // set channel 1 output ch 1
85         st,ch2-output-mapping = /bits/ 8 <0>;   // set channel 2 output ch 1
86         st,ch3-output-mapping = /bits/ 8 <0>;   // set channel 3 output ch 1
87         st,max-power-correction;                // enables power bridge
88                                                 // correction for THD reduction
89                                                 // near maximum power output
90         st,invalid-input-detect-mute;           // mute if no valid digital
91                                                 // audio signal is provided.
92 };