Merge branch 'for-next' of git://git.kernel.org/pub/scm/linux/kernel/git/cooloney...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / sound / fsl-asoc-card.txt
1 Freescale Generic ASoC Sound Card with ASRC support
2
3 The Freescale Generic ASoC Sound Card can be used, ideally, for all Freescale
4 SoCs connecting with external CODECs.
5
6 The idea of this generic sound card is a bit like ASoC Simple Card. However,
7 for Freescale SoCs (especially those released in recent years), most of them
8 have ASRC (Documentation/devicetree/bindings/sound/fsl,asrc.txt) inside. And
9 this is a specific feature that might be painstakingly controlled and merged
10 into the Simple Card.
11
12 So having this generic sound card allows all Freescale SoC users to benefit
13 from the simplification of a new card support and the capability of the wide
14 sample rates support through ASRC.
15
16 Note: The card is initially designed for those sound cards who use I2S and
17       PCM DAI formats. However, it'll be also possible to support those non
18       I2S/PCM type sound cards, such as S/PDIF audio and HDMI audio, as long
19       as the driver has been properly upgraded.
20
21
22 The compatible list for this generic sound card currently:
23  "fsl,imx-audio-cs42888"
24
25  "fsl,imx-audio-wm8962"
26  (compatible with Documentation/devicetree/bindings/sound/imx-audio-wm8962.txt)
27
28  "fsl,imx-audio-sgtl5000"
29  (compatible with Documentation/devicetree/bindings/sound/imx-audio-sgtl5000.txt)
30
31 Required properties:
32
33   - compatible          : Contains one of entries in the compatible list.
34
35   - model               : The user-visible name of this sound complex
36
37   - audio-cpu           : The phandle of an CPU DAI controller
38
39   - audio-codec         : The phandle of an audio codec
40
41   - audio-routing       : A list of the connections between audio components.
42                           Each entry is a pair of strings, the first being the
43                           connection's sink, the second being the connection's
44                           source. There're a few pre-designed board connectors:
45                            * Line Out Jack
46                            * Line In Jack
47                            * Headphone Jack
48                            * Mic Jack
49                            * Ext Spk
50                            * AMIC (stands for Analog Microphone Jack)
51                            * DMIC (stands for Digital Microphone Jack)
52
53                           Note: The "Mic Jack" and "AMIC" are redundant while
54                                 coexsiting in order to support the old bindings
55                                 of wm8962 and sgtl5000.
56
57 Optional properties:
58
59   - audio-asrc          : The phandle of ASRC. It can be absent if there's no
60                           need to add ASRC support via DPCM.
61
62 Example:
63 sound-cs42888 {
64         compatible = "fsl,imx-audio-cs42888";
65         model = "cs42888-audio";
66         audio-cpu = <&esai>;
67         audio-asrc = <&asrc>;
68         audio-codec = <&cs42888>;
69         audio-routing =
70                 "Line Out Jack", "AOUT1L",
71                 "Line Out Jack", "AOUT1R",
72                 "Line Out Jack", "AOUT2L",
73                 "Line Out Jack", "AOUT2R",
74                 "Line Out Jack", "AOUT3L",
75                 "Line Out Jack", "AOUT3R",
76                 "Line Out Jack", "AOUT4L",
77                 "Line Out Jack", "AOUT4R",
78                 "AIN1L", "Line In Jack",
79                 "AIN1R", "Line In Jack",
80                 "AIN2L", "Line In Jack",
81                 "AIN2R", "Line In Jack";
82 };