diff mbox

[PATCHv1,8/8] Documentation: Add device tree bindings for Freescale VF610 sound.

Message ID 1382000477-17304-9-git-send-email-Li.Xiubo@freescale.com (mailing list archive)
State Not Applicable
Headers show

Commit Message

Xiubo Li Oct. 17, 2013, 9:01 a.m. UTC
This adds the Document for Freescale VF610 sound driver under
Documentation/devicetree/bindings/sound/.

Signed-off-by: Xiubo Li <Li.Xiubo@freescale.com>
---
 .../devicetree/bindings/sound/fsl-sgtl5000.txt     | 52 ++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt

Comments

Lucas Stach Oct. 17, 2013, 9:46 a.m. UTC | #1
Am Donnerstag, den 17.10.2013, 17:01 +0800 schrieb Xiubo Li:
> This adds the Document for Freescale VF610 sound driver under
> Documentation/devicetree/bindings/sound/.
> 
> Signed-off-by: Xiubo Li <Li.Xiubo@freescale.com>
> ---
>  .../devicetree/bindings/sound/fsl-sgtl5000.txt     | 52 ++++++++++++++++++++++
>  1 file changed, 52 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt b/Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt
> new file mode 100644
> index 0000000..43e350f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt

This document name is overly generic, there are more than one FSL
platforms with SGTL5000 codecs. Please include the vf610 here.

> @@ -0,0 +1,52 @@
> +Freescale VF610 audio complex with SGTL5000 codec
> +
> +Required properties:
> +- compatible: "fsl,vf610-sgtl5000"
> +- model: The user-visible name of this sound complex.
> +- saif-controllers: The phandle list of the SAI controller.
> +- audio-codec: The phandle of the SGTL5000 audio codec.
> +- audio-routing : A list of the connections between audio components.
> +  Each entry is a pair of strings, the first being the connection's sink,
> +  the second being the connection's source. Valid names could be power
> +  supplies, SGTL5000 pins, and the jacks on the board:
> +
> +  -- Power supplies:
> +     * Mic Bias
> +
> +  -- SGTL5000 pins:
> +     * MIC_IN
> +     * LINE_IN
> +     * HP_OUT
> +     * LINE_OUT
> +
> +  -- Board connectors:
> +     * Mic Jack
> +     * Line In Jack
> +     * Headphone Jack
> +     * Line Out Jack
> +     * Ext Spk
> +
> +Example:
> +
> +sound {
> +	compatible = "fsl,vf610-sgtl5000";
> +	model = "vf610-sgtl5000";
> +	saif-controller = <&sai2>;
> +	audio-codec = <&codec>;
> +	audio-routing =
> +		"MIC_IN", "Mic Jack",
> +		"Mic Jack", "Mic Bias",
> +		"LINE_IN", "Line In Jack",
> +		"Headphone Jack", "HP_OUT",
> +		"Ext Spk", "LINE_OUT";
> +};
> +
> +&i2c0 {
> +	...
> +
> +	codec: sgtl5000@0a {
> +	       compatible = "fsl,sgtl5000";
> +	       reg = <0x0a>;
> +	       clocks = <&clks VF610_CLK_SAI2>;
> +       };
> +};
Xiubo Li-B47053 Oct. 18, 2013, 3:27 a.m. UTC | #2
Hi,



> > Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt
> >
> > diff --git a/Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt
> > b/Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt
> > new file mode 100644
> > index 0000000..43e350f
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt
> 
> This document name is overly generic, there are more than one FSL
> platforms with SGTL5000 codecs. Please include the vf610 here.
> 

Yes, it is.

This will be renamed to "fsl_vf610_audio_sgt15000.txt" or others.


Thanks,
--
BRS,
Xiubo
Xiubo Li-B47053 Oct. 21, 2013, 7:24 a.m. UTC | #3
> > +  -- Power supplies:
> > +     * Mic Bias
> > +
> > +  -- SGTL5000 pins:
> > +     * MIC_IN
> > +     * LINE_IN
> > +     * HP_OUT
> > +     * LINE_OUT
> 
> Things that are part of the CODEC should be part of the CODEC binding and
> this binding should reference that - this way the information doesn't
> have to be replicated by all boards using the CODEC and if new devices
> are supported by the CODEC driver then only that needs updating hopefully.
>

Yes, the "-- SGTL5000 pins:" should be in the CODEC binding.
But, actually the CODEC binding hasn't any reference about this.

So I added it here, but not very sure.
Mark Brown Oct. 22, 2013, 9:47 a.m. UTC | #4
On Mon, Oct 21, 2013 at 07:24:56AM +0000, Xiubo Li-B47053 wrote:

> Yes, the "-- SGTL5000 pins:" should be in the CODEC binding.
> But, actually the CODEC binding hasn't any reference about this.

> So I added it here, but not very sure.

Please add them to the CODEC binding instead.
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt b/Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt
new file mode 100644
index 0000000..43e350f
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/fsl-sgtl5000.txt
@@ -0,0 +1,52 @@ 
+Freescale VF610 audio complex with SGTL5000 codec
+
+Required properties:
+- compatible: "fsl,vf610-sgtl5000"
+- model: The user-visible name of this sound complex.
+- saif-controllers: The phandle list of the SAI controller.
+- audio-codec: The phandle of the SGTL5000 audio codec.
+- audio-routing : A list of the connections between audio components.
+  Each entry is a pair of strings, the first being the connection's sink,
+  the second being the connection's source. Valid names could be power
+  supplies, SGTL5000 pins, and the jacks on the board:
+
+  -- Power supplies:
+     * Mic Bias
+
+  -- SGTL5000 pins:
+     * MIC_IN
+     * LINE_IN
+     * HP_OUT
+     * LINE_OUT
+
+  -- Board connectors:
+     * Mic Jack
+     * Line In Jack
+     * Headphone Jack
+     * Line Out Jack
+     * Ext Spk
+
+Example:
+
+sound {
+	compatible = "fsl,vf610-sgtl5000";
+	model = "vf610-sgtl5000";
+	saif-controller = <&sai2>;
+	audio-codec = <&codec>;
+	audio-routing =
+		"MIC_IN", "Mic Jack",
+		"Mic Jack", "Mic Bias",
+		"LINE_IN", "Line In Jack",
+		"Headphone Jack", "HP_OUT",
+		"Ext Spk", "LINE_OUT";
+};
+
+&i2c0 {
+	...
+
+	codec: sgtl5000@0a {
+	       compatible = "fsl,sgtl5000";
+	       reg = <0x0a>;
+	       clocks = <&clks VF610_CLK_SAI2>;
+       };
+};