Merge remote-tracking branch 'asoc/topic/rcar' into asoc-next
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / sound / cs35l35.txt
1 CS35L35 Boosted Speaker Amplifier
2
3 Required properties:
4
5   - compatible : "cirrus,cs35l35"
6
7   - reg : the I2C address of the device for I2C
8
9   - VA-supply, VP-supply : power supplies for the device,
10     as covered in
11     Documentation/devicetree/bindings/regulator/regulator.txt.
12
13   - interrupt-parent : Specifies the phandle of the interrupt controller to
14     which the IRQs from CS35L35 are delivered to.
15   - interrupts : IRQ line info CS35L35.
16     (See Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
17     for further information relating to interrupt properties)
18
19 Optional properties:
20   - reset-gpios : gpio used to reset the amplifier
21
22   - cirrus,stereo-config : Boolean to determine if there are 2 AMPs for a
23   Stereo configuration
24
25   - cirrus,audio-channel : Set Location of Audio Signal on Serial Port
26   0 = Data Packet received on Left I2S Channel
27   1 = Data Packet received on Right I2S Channel
28
29   - cirrus,advisory-channel : Set Location of Advisory Signal on Serial Port
30   0 = Data Packet received on Left I2S Channel
31   1 = Data Packet received on Right I2S Channel
32
33   - cirrus,shared-boost : Boolean to enable ClassH tracking of Advisory Signal
34   if 2 Devices share Boost BST_CTL
35
36   - cirrus,external-boost : Boolean to specify the device is using an external
37   boost supply, note that sharing a boost from another cs35l35 would constitute
38   using an external supply for the slave device
39
40   - cirrus,sp-drv-strength : Value for setting the Serial Port drive strength
41   Table 3-10 of the datasheet lists drive-strength specifications
42   0 = 1x (Default)
43   1 = .5x
44   - cirrus,sp-drv-unused : Determines how unused slots should be driven on the
45   Serial Port.
46   0 - Hi-Z
47   2 - Drive 0's (Default)
48   3 - Drive 1's
49
50   - cirrus,bst-pdn-fet-on : Boolean to determine if the Boost PDN control
51   powers down with a rectification FET On or Off. If VSPK is supplied
52   externally then FET is off.
53
54   - cirrus,boost-ctl-millivolt : Boost Voltage Value.  Configures the boost
55     converter's output voltage in mV. The range is from 2600mV to 9000mV with
56     increments of 100mV.
57     (Default) VP
58
59   - cirrus,boost-peak-milliamp : Boost-converter peak current limit in mA.
60   Configures the peak current by monitoring the current through the boost FET.
61   Range starts at 1680mA and goes to a maximum of 4480mA with increments of
62   110mA.
63   (Default) 2.46 Amps
64
65   - cirrus,amp-gain-zc : Boolean to determine if to use Amplifier gain-change
66   zero-cross
67
68 Optional H/G Algorithm sub-node:
69
70   The cs35l35 node can have a single "cirrus,classh-internal-algo" sub-node
71   that will disable automatic control of the internal H/G Algorithm.
72
73   It is strongly recommended that the Datasheet be referenced when adjusting
74   or using these Class H Algorithm controls over the internal Algorithm.
75   Serious damage can occur to the Device and surrounding components.
76
77   - cirrus,classh-internal-algo : Sub-node for the Internal Class H Algorithm
78   See Section 4.3 Internal Class H Algorithm in the Datasheet.
79   If not used, the device manages the ClassH Algorithm internally.
80
81 Optional properties for the "cirrus,classh-internal-algo" Sub-node
82
83   Section 7.29 Class H Control
84   - cirrus,classh-bst-overide : Boolean
85   - cirrus,classh-bst-max-limit
86   - cirrus,classh-mem-depth
87
88   Section 7.30 Class H Headroom Control
89   - cirrus,classh-headroom
90
91   Section 7.31 Class H Release Rate
92   - cirrus,classh-release-rate
93
94   Section 7.32 Class H Weak FET Drive Control
95   - cirrus,classh-wk-fet-disable
96   - cirrus,classh-wk-fet-delay
97   - cirrus,classh-wk-fet-thld
98
99   Section 7.34 Class H VP Control
100   - cirrus,classh-vpch-auto
101   - cirrus,classh-vpch-rate
102   - cirrus,classh-vpch-man
103
104 Optional Monitor Signal Format sub-node:
105
106   The cs35l35 node can have a single "cirrus,monitor-signal-format" sub-node
107   for adjusting the Depth, Location and Frame of the Monitoring Signals
108   for Algorithms.
109
110   See Sections 4.8.2 through 4.8.4 Serial-Port Control in the Datasheet
111
112   -cirrus,monitor-signal-format : Sub-node for the Monitor Signaling Formating
113   on the I2S Port. Each of the 3 8 bit values in the array contain the settings
114   for depth, location, and frame.
115
116   If not used, the defaults for the 6 monitor signals is used.
117
118   Sections 7.44 - 7.53 lists values for the depth, location, and frame
119   for each monitoring signal.
120
121   - cirrus,imon : 4 8 bit values to set the depth, location, frame and ADC
122   scale of the IMON monitor signal.
123
124   - cirrus,vmon : 3 8 bit values to set the depth, location, and frame
125   of the VMON monitor signal.
126
127   - cirrus,vpmon : 3 8 bit values to set the depth, location, and frame
128   of the VPMON monitor signal.
129
130   - cirrus,vbstmon : 3 8 bit values to set the depth, location, and frame
131   of the VBSTMON monitor signal
132
133   - cirrus,vpbrstat : 3 8 bit values to set the depth, location, and frame
134   of the VPBRSTAT monitor signal
135
136   - cirrus,zerofill : 3 8 bit values to set the depth, location, and frame\
137   of the ZEROFILL packet in the monitor signal
138
139 Example:
140
141 cs35l35: cs35l35@20 {
142         compatible = "cirrus,cs35l35";
143         reg = <0x20>;
144         VA-supply = <&dummy_vreg>;
145         VP-supply = <&dummy_vreg>;
146         reset-gpios = <&axi_gpio 54 0>;
147         interrupt-parent = <&gpio8>;
148         interrupts = <3 IRQ_TYPE_LEVEL_LOW>;
149         cirrus,boost-ctl-millivolt = <9000>;
150
151         cirrus,stereo-config;
152         cirrus,audio-channel = <0x00>;
153         cirrus,advisory-channel = <0x01>;
154         cirrus,shared-boost;
155
156         cirrus,classh-internal-algo {
157                 cirrus,classh-bst-overide;
158                 cirrus,classh-bst-max-limit = <0x01>;
159                 cirrus,classh-mem-depth = <0x01>;
160                 cirrus,classh-release-rate = <0x08>;
161                 cirrus,classh-headroom-millivolt = <0x0B>;
162                 cirrus,classh-wk-fet-disable = <0x01>;
163                 cirrus,classh-wk-fet-delay = <0x04>;
164                 cirrus,classh-wk-fet-thld = <0x01>;
165                 cirrus,classh-vpch-auto = <0x01>;
166                 cirrus,classh-vpch-rate = <0x02>;
167                 cirrus,classh-vpch-man = <0x05>;
168         };
169
170         /* Depth, Location, Frame */
171         cirrus,monitor-signal-format {
172                 cirrus,imon = /bits/ 8 <0x03 0x00 0x01>;
173                 cirrus,vmon = /bits/ 8 <0x03 0x00 0x00>;
174                 cirrus,vpmon = /bits/ 8 <0x03 0x04 0x00>;
175                 cirrus,vbstmon = /bits/ 8 <0x03 0x04 0x01>;
176                 cirrus,vpbrstat = /bits/ 8 <0x00 0x04 0x00>;
177                 cirrus,zerofill = /bits/ 8 <0x00 0x00 0x00>;
178         };
179
180 };