GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / sound / imx-audio-es8328.txt
1 Freescale i.MX audio complex with ES8328 codec
2
3 Required properties:
4 - compatible       : "fsl,imx-audio-es8328"
5 - model            : The user-visible name of this sound complex
6 - ssi-controller   : The phandle of the i.MX SSI controller
7 - jack-gpio        : Optional GPIO for headphone jack
8 - audio-amp-supply : Power regulator for speaker amps
9 - audio-codec      : The phandle of the ES8328 audio codec
10 - audio-routing    : A list of the connections between audio components.
11                      Each entry is a pair of strings, the first being the
12                      connection's sink, the second being the connection's
13                      source. Valid names could be power supplies, ES8328
14                      pins, and the jacks on the board:
15
16                         Power supplies:
17                            * audio-amp
18
19                         ES8328 pins:
20                            * LOUT1
21                            * LOUT2
22                            * ROUT1
23                            * ROUT2
24                            * LINPUT1
25                            * LINPUT2
26                            * RINPUT1
27                            * RINPUT2
28                            * Mic PGA
29
30                         Board connectors:
31                            * Headphone
32                            * Speaker
33                            * Mic Jack
34 - mux-int-port     : The internal port of the i.MX audio muxer (AUDMUX)
35 - mux-ext-port     : The external port of the i.MX audio muxer (AUDMIX)
36
37 Note: The AUDMUX port numbering should start at 1, which is consistent with
38 hardware manual.
39
40 Example:
41
42 sound {
43         compatible = "fsl,imx-audio-es8328";
44         model = "imx-audio-es8328";
45         ssi-controller = <&ssi1>;
46         audio-codec = <&codec>;
47         jack-gpio = <&gpio5 15 0>;
48         audio-amp-supply = <&reg_audio_amp>;
49         audio-routing =
50                 "Speaker", "LOUT2",
51                 "Speaker", "ROUT2",
52                 "Speaker", "audio-amp",
53                 "Headphone", "ROUT1",
54                 "Headphone", "LOUT1",
55                 "LINPUT1", "Mic Jack",
56                 "RINPUT1", "Mic Jack",
57                 "Mic Jack", "Mic Bias";
58         mux-int-port = <1>;
59         mux-ext-port = <3>;
60 };