Merge tag 'metag-for-v4.8' of git://git.kernel.org/pub/scm/linux/kernel/git/jhogan...
[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 AC'97, I2S
17       and PCM DAI formats. However, it'll be also possible to support those non
18       AC'97/I2S/PCM type sound cards, such as S/PDIF audio and HDMI audio, as
19       long as the driver has been properly upgraded.
20
21
22 The compatible list for this generic sound card currently:
23  "fsl,imx-audio-ac97"
24
25  "fsl,imx-audio-cs42888"
26
27  "fsl,imx-audio-cs427x"
28  (compatible with CS4271 and CS4272)
29
30  "fsl,imx-audio-wm8962"
31  (compatible with Documentation/devicetree/bindings/sound/imx-audio-wm8962.txt)
32
33  "fsl,imx-audio-sgtl5000"
34  (compatible with Documentation/devicetree/bindings/sound/imx-audio-sgtl5000.txt)
35
36  "fsl,imx-audio-wm8960"
37
38 Required properties:
39
40   - compatible          : Contains one of entries in the compatible list.
41
42   - model               : The user-visible name of this sound complex
43
44   - audio-cpu           : The phandle of an CPU DAI controller
45
46   - audio-codec         : The phandle of an audio codec
47
48   - audio-routing       : A list of the connections between audio components.
49                           Each entry is a pair of strings, the first being the
50                           connection's sink, the second being the connection's
51                           source. There're a few pre-designed board connectors:
52                            * Line Out Jack
53                            * Line In Jack
54                            * Headphone Jack
55                            * Mic Jack
56                            * Ext Spk
57                            * AMIC (stands for Analog Microphone Jack)
58                            * DMIC (stands for Digital Microphone Jack)
59
60                           Note: The "Mic Jack" and "AMIC" are redundant while
61                                 coexisting in order to support the old bindings
62                                 of wm8962 and sgtl5000.
63
64 Optional properties:
65
66   - audio-asrc          : The phandle of ASRC. It can be absent if there's no
67                           need to add ASRC support via DPCM.
68
69 Optional unless SSI is selected as a CPU DAI:
70
71   - mux-int-port        : The internal port of the i.MX audio muxer (AUDMUX)
72
73   - mux-ext-port        : The external port of the i.MX audio muxer
74
75 Example:
76 sound-cs42888 {
77         compatible = "fsl,imx-audio-cs42888";
78         model = "cs42888-audio";
79         audio-cpu = <&esai>;
80         audio-asrc = <&asrc>;
81         audio-codec = <&cs42888>;
82         audio-routing =
83                 "Line Out Jack", "AOUT1L",
84                 "Line Out Jack", "AOUT1R",
85                 "Line Out Jack", "AOUT2L",
86                 "Line Out Jack", "AOUT2R",
87                 "Line Out Jack", "AOUT3L",
88                 "Line Out Jack", "AOUT3R",
89                 "Line Out Jack", "AOUT4L",
90                 "Line Out Jack", "AOUT4R",
91                 "AIN1L", "Line In Jack",
92                 "AIN1R", "Line In Jack",
93                 "AIN2L", "Line In Jack",
94                 "AIN2R", "Line In Jack";
95 };