xref: /freebsd/sys/contrib/device-tree/Bindings/sound/fsl-asoc-card.txt (revision c9ccf3a32da427475985b85d7df023ccfb138c27)
1Freescale Generic ASoC Sound Card with ASRC support
2
3The Freescale Generic ASoC Sound Card can be used, ideally, for all Freescale
4SoCs connecting with external CODECs.
5
6The idea of this generic sound card is a bit like ASoC Simple Card. However,
7for Freescale SoCs (especially those released in recent years), most of them
8have ASRC (Documentation/devicetree/bindings/sound/fsl,asrc.txt) inside. And
9this is a specific feature that might be painstakingly controlled and merged
10into the Simple Card.
11
12So having this generic sound card allows all Freescale SoC users to benefit
13from the simplification of a new card support and the capability of the wide
14sample rates support through ASRC.
15
16Note: 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
22The 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
32 "fsl,imx-audio-sgtl5000"
33 (compatible with Documentation/devicetree/bindings/sound/imx-audio-sgtl5000.txt)
34
35 "fsl,imx-audio-wm8960"
36
37 "fsl,imx-audio-mqs"
38
39 "fsl,imx-audio-wm8524"
40
41 "fsl,imx-audio-tlv320aic32x4"
42
43 "fsl,imx-audio-tlv320aic31xx"
44
45 "fsl,imx-audio-si476x"
46
47 "fsl,imx-audio-wm8958"
48
49Required properties:
50
51  - compatible		: Contains one of entries in the compatible list.
52
53  - model		: The user-visible name of this sound complex
54
55  - audio-cpu		: The phandle of an CPU DAI controller
56
57  - audio-codec		: The phandle of an audio codec
58
59Optional properties:
60
61  - audio-asrc		: The phandle of ASRC. It can be absent if there's no
62			  need to add ASRC support via DPCM.
63
64  - audio-routing	: A list of the connections between audio components.
65			  Each entry is a pair of strings, the first being the
66			  connection's sink, the second being the connection's
67			  source. There're a few pre-designed board connectors:
68			   * Line Out Jack
69			   * Line In Jack
70			   * Headphone Jack
71			   * Mic Jack
72			   * Ext Spk
73			   * AMIC (stands for Analog Microphone Jack)
74			   * DMIC (stands for Digital Microphone Jack)
75
76			  Note: The "Mic Jack" and "AMIC" are redundant while
77			        coexisting in order to support the old bindings
78				of wm8962 and sgtl5000.
79
80  - hp-det-gpio		: The GPIO that detect headphones are plugged in
81  - mic-det-gpio	: The GPIO that detect microphones are plugged in
82  - bitclock-master	: Indicates dai-link bit clock master; for details see simple-card.yaml.
83  - frame-master	: Indicates dai-link frame master; for details see simple-card.yaml.
84  - dai-format		: audio format, for details see simple-card.yaml.
85  - frame-inversion	: dai-link uses frame clock inversion, for details see simple-card.yaml.
86  - bitclock-inversion	: dai-link uses bit clock inversion, for details see simple-card.yaml.
87  - mclk-id		: main clock id, specific for each card configuration.
88
89Optional unless SSI is selected as a CPU DAI:
90
91  - mux-int-port	: The internal port of the i.MX audio muxer (AUDMUX)
92
93  - mux-ext-port	: The external port of the i.MX audio muxer
94
95Example:
96sound-cs42888 {
97	compatible = "fsl,imx-audio-cs42888";
98	model = "cs42888-audio";
99	audio-cpu = <&esai>;
100	audio-asrc = <&asrc>;
101	audio-codec = <&cs42888>;
102	audio-routing =
103		"Line Out Jack", "AOUT1L",
104		"Line Out Jack", "AOUT1R",
105		"Line Out Jack", "AOUT2L",
106		"Line Out Jack", "AOUT2R",
107		"Line Out Jack", "AOUT3L",
108		"Line Out Jack", "AOUT3R",
109		"Line Out Jack", "AOUT4L",
110		"Line Out Jack", "AOUT4R",
111		"AIN1L", "Line In Jack",
112		"AIN1R", "Line In Jack",
113		"AIN2L", "Line In Jack",
114		"AIN2R", "Line In Jack";
115};
116