Merge tag 'powerpc-5.3-5' of git://git.kernel.org/pub/scm/linux/kernel/git/powerpc...
[linux-2.6-microblaze.git] / Documentation / devicetree / bindings / sound / wlf,arizona.txt
1 Cirrus Logic Arizona class audio SoCs
2
3 These devices are audio SoCs with extensive digital capabilities and a range
4 of analogue I/O.
5
6 This document lists sound specific bindings, see the primary binding
7 document:
8   ../mfd/arizona.txt
9
10 Optional properties:
11
12   - wlf,inmode : A list of INn_MODE register values, where n is the number
13     of input signals. Valid values are 0 (Differential), 1 (Single-ended) and
14     2 (Digital Microphone). If absent, INn_MODE registers set to 0 by default.
15     If present, values must be specified less than or equal to the number of
16     input signals. If values less than the number of input signals, elements
17     that have not been specified are set to 0 by default. Entries are:
18     <IN1, IN2, IN3, IN4> (wm5102, wm5110, wm8280, wm8997)
19     <IN1A, IN2A, IN1B, IN2B> (wm8998, wm1814)
20   - wlf,out-mono : A list of boolean values indicating whether each output is
21     mono or stereo. Position within the list indicates the output affected
22     (eg. First entry in the list corresponds to output 1). A non-zero value
23     indicates a mono output. If present, the number of values should be less
24     than or equal to the number of outputs, if less values are supplied the
25     additional outputs will be treated as stereo.
26
27   - wlf,dmic-ref : DMIC reference voltage source for each input, can be
28     selected from either MICVDD or one of the MICBIAS's, defines
29     (ARIZONA_DMIC_xxxx) are provided in <dt-bindings/mfd/arizona.txt>. If
30     present, the number of values should be less than or equal to the
31     number of inputs, unspecified inputs will use the chip default.
32
33   - wlf,max-channels-clocked : The maximum number of channels to be clocked on
34     each AIF, useful for I2S systems with multiple data lines being mastered.
35     Specify one cell for each AIF to be configured, specify zero for AIFs that
36     should be handled normally.
37     If present, number of cells must be less than or equal to the number of
38     AIFs. If less than the number of AIFs, for cells that have not been
39     specified the corresponding AIFs will be treated as default setting.
40
41   - wlf,spk-fmt : PDM speaker data format, must contain 2 cells (OUT5 and OUT6).
42     See the datasheet for values.
43     The second cell is ignored for codecs that do not have OUT6 (wm5102, wm8997,
44       wm8998, wm1814)
45
46   - wlf,spk-mute : PDM speaker mute setting, must contain 2 cells (OUT5 and OUT6).
47     See the datasheet for values.
48     The second cell is ignored for codecs that do not have OUT6 (wm5102, wm8997,
49     wm8998, wm1814)
50
51   - wlf,out-volume-limit : The volume limit value that should be applied to each
52     output channel. See the datasheet for exact values. Channels are specified
53     in the order OUT1L, OUT1R, OUT2L, OUT2R, etc.