Merge branch 'spectre' of git://git.armlinux.org.uk/~rmk/linux-arm
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / sound / cs35l34.txt
1 CS35L34 Speaker Amplifier
2
3 Required properties:
4
5   - compatible : "cirrus,cs35l34"
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   - cirrus,boost-vtge-millivolt : Boost Voltage Value.  Configures the boost
14     converter's output voltage in mV. The range is from VP to 8V with
15     increments of 100mV.
16
17   - cirrus,boost-nanohenry: Inductor value for boost converter. The value is
18     in nH and they can be values of 1000nH, 1100nH, 1200nH, 1500nH, and 2200nH.
19
20 Optional properties:
21
22   - reset-gpios: GPIO used to reset the amplifier.
23
24   - interrupts : IRQ line info CS35L34.
25     (See Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
26     for further information relating to interrupt properties)
27
28   - cirrus,boost-peak-milliamp : Boost converter peak current limit in mA. The
29     range starts at 1200mA and goes to a maximum of 3840mA with increments of
30     80mA. The default value is 2480mA.
31
32   - cirrus,i2s-sdinloc : ADSP SDIN I2S channel location. Indicates whether the
33     received mono data is in the left or right portion of the I2S frame
34     according to the AD0 pin or directly via this configuration.
35     0x0 (Default) = Selected by AD0 input (if AD0 = LOW, use left channel),
36     0x2 = Left,
37     0x1 = Selected by the inversion of the AD0 input (if AD0 = LOW, use right
38     channel),
39     0x3 = Right.
40
41   - cirrus,gain-zc-disable: Boolean property. If set, the gain change will take
42     effect without waiting for a zero cross.
43
44   - cirrus,tdm-rising-edge: Boolean property. If set, data is on the rising edge of
45     SCLK. Otherwise, data is on the falling edge of SCLK.
46
47
48 Example:
49
50 cs35l34: cs35l34@40 {
51         compatible = "cirrus,cs35l34";
52         reg = <0x40>;
53
54         interrupt-parent = <&gpio8>;
55         interrupts = <3 IRQ_TYPE_LEVEL_LOW>;
56
57         reset-gpios = <&gpio 10 0>;
58
59         cirrus,boost-vtge-milltvolt = <8000>; /* 8V */
60         cirrus,boost-ind-nanohenry = <1000>; /* 1uH */
61         cirrus,boost-peak-milliamp = <3000>; /* 3A */
62 };