diff mbox

[06/17] Documentation: Define the MOP500 Audio Machine Driver Device Tree bindings

Message ID 1345816913-4113-7-git-send-email-lee.jones@linaro.org (mailing list archive)
State New, archived
Headers show

Commit Message

Lee Jones Aug. 24, 2012, 2:01 p.m. UTC
Here we add the required documentation for the new Device Tree
bindings pertaining to the MOP500 Audio Machine driver.

CC: alsa-devel@alsa-project.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 .../devicetree/bindings/sound/ux500-mop500.txt     |   39 ++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/ux500-mop500.txt

Comments

Lee Jones Sept. 10, 2012, 4:44 p.m. UTC | #1
Ola poke.

On Fri, Aug 24, 2012 at 03:01:42PM +0100, Lee Jones wrote:
> Here we add the required documentation for the new Device Tree
> bindings pertaining to the MOP500 Audio Machine driver.
> 
> CC: alsa-devel@alsa-project.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
>  .../devicetree/bindings/sound/ux500-mop500.txt     |   39 ++++++++++++++++++++
>  1 file changed, 39 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/ux500-mop500.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/ux500-mop500.txt b/Documentation/devicetree/bindings/sound/ux500-mop500.txt
> new file mode 100644
> index 0000000..48e071c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/ux500-mop500.txt
> @@ -0,0 +1,39 @@
> +* MOP500 Audio Machine Driver
> +
> +This node is responsible for linking together all ux500 Audio Driver components.
> +
> +Required properties:
> + - compatible              : "stericsson,snd-soc-mop500"
> +
> +Non-standard properties:
> + - stericsson,cpu-dai      : Phandle to the CPU-side DAI
> + - stericsson,audio-codec  : Phandle to the Audio CODEC
> + - stericsson,card-name    : Over-ride default card name
> +
> +Example:
> +
> +	sound {
> +		compatible = "stericsson,snd-soc-mop500";
> +
> +		stericsson,cpu-dai = <&msp1 &msp3>;
> +		stericsson,audio-codec = <&codec>;
> +	};
> +
> +	msp1: msp@80124000 {
> +		compatible = "stericsson,ux500-msp-i2s";
> +		reg = <0x80124000 0x1000>;
> +		interrupts = <0 62 0x4>;
> +		v-ape-supply = <&db8500_vape_reg>;
> +	};
> +
> +	msp3: msp@80125000 {
> +		compatible = "stericsson,ux500-msp-i2s";
> +		reg = <0x80125000 0x1000>;
> +		interrupts = <0 62 0x4>;
> +		v-ape-supply = <&db8500_vape_reg>;
> +	};
> +
> +	codec: ab8500-codec {
> +		compatible = "stericsson,ab8500-codec";
> +		stericsson,earpeice-cmv = <950>; /* Units in mV. */
> +	};
> -- 
> 1.7.9.5
>
Ola Lilja Sept. 11, 2012, 9:06 a.m. UTC | #2
On 09/10/2012 06:44 PM, Lee Jones wrote:

> Ola poke.
> 
> On Fri, Aug 24, 2012 at 03:01:42PM +0100, Lee Jones wrote:
>> Here we add the required documentation for the new Device Tree
>> bindings pertaining to the MOP500 Audio Machine driver.
>> 
>> CC: alsa-devel@alsa-project.org
>> Signed-off-by: Lee Jones <lee.jones@linaro.org>
>> ---
>>  .../devicetree/bindings/sound/ux500-mop500.txt     |   39 ++++++++++++++++++++
>>  1 file changed, 39 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/sound/ux500-mop500.txt
>> 
>> diff --git a/Documentation/devicetree/bindings/sound/ux500-mop500.txt b/Documentation/devicetree/bindings/sound/ux500-mop500.txt
>> new file mode 100644
>> index 0000000..48e071c
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/sound/ux500-mop500.txt
>> @@ -0,0 +1,39 @@
>> +* MOP500 Audio Machine Driver
>> +
>> +This node is responsible for linking together all ux500 Audio Driver components.
>> +
>> +Required properties:
>> + - compatible              : "stericsson,snd-soc-mop500"
>> +
>> +Non-standard properties:
>> + - stericsson,cpu-dai      : Phandle to the CPU-side DAI
>> + - stericsson,audio-codec  : Phandle to the Audio CODEC
>> + - stericsson,card-name    : Over-ride default card name
>> +
>> +Example:
>> +
>> +	sound {
>> +		compatible = "stericsson,snd-soc-mop500";
>> +
>> +		stericsson,cpu-dai = <&msp1 &msp3>;
>> +		stericsson,audio-codec = <&codec>;
>> +	};
>> +
>> +	msp1: msp@80124000 {
>> +		compatible = "stericsson,ux500-msp-i2s";
>> +		reg = <0x80124000 0x1000>;
>> +		interrupts = <0 62 0x4>;
>> +		v-ape-supply = <&db8500_vape_reg>;


I'm no DT-expert, but why are you adding MSP-stuff in the machine-driver? They
are also added in the next patch.

>> +	};
>> +
>> +	msp3: msp@80125000 {
>> +		compatible = "stericsson,ux500-msp-i2s";
>> +		reg = <0x80125000 0x1000>;
>> +		interrupts = <0 62 0x4>;
>> +		v-ape-supply = <&db8500_vape_reg>;
>> +	};
>> +
>> +	codec: ab8500-codec {
>> +		compatible = "stericsson,ab8500-codec";
>> +		stericsson,earpeice-cmv = <950>; /* Units in mV. */


Only four voltages are allowed here. Maybe enumerate them in the comment?

>> +	};
>> -- 
>> 1.7.9.5
>> 
>
Mark Brown Sept. 11, 2012, 9:08 a.m. UTC | #3
On Tue, Sep 11, 2012 at 11:06:00AM +0200, Ola Lilja wrote:
> On 09/10/2012 06:44 PM, Lee Jones wrote:

> >> +	msp1: msp@80124000 {
> >> +		compatible = "stericsson,ux500-msp-i2s";
> >> +		reg = <0x80124000 0x1000>;
> >> +		interrupts = <0 62 0x4>;
> >> +		v-ape-supply = <&db8500_vape_reg>;

> I'm no DT-expert, but why are you adding MSP-stuff in the machine-driver? They
> are also added in the next patch.

This is context for the example - the example is just informative and
tends to include other things so they can be referenced by the main bit
of the example, it's the documentation at the top that's the bindings
themselves.
Lee Jones Sept. 14, 2012, 10:02 a.m. UTC | #4
On Tue, Sep 11, 2012 at 11:06:00AM +0200, Ola Lilja wrote:
> On 09/10/2012 06:44 PM, Lee Jones wrote:
> 
> > Ola poke.
> > 
> > On Fri, Aug 24, 2012 at 03:01:42PM +0100, Lee Jones wrote:
> >> Here we add the required documentation for the new Device Tree
> >> bindings pertaining to the MOP500 Audio Machine driver.
> >> 
> >> CC: alsa-devel@alsa-project.org
> >> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> >> ---
> >>  .../devicetree/bindings/sound/ux500-mop500.txt     |   39 ++++++++++++++++++++
> >>  1 file changed, 39 insertions(+)
> >>  create mode 100644 Documentation/devicetree/bindings/sound/ux500-mop500.txt
> >> 
> >> diff --git a/Documentation/devicetree/bindings/sound/ux500-mop500.txt b/Documentation/devicetree/bindings/sound/ux500-mop500.txt
> >> new file mode 100644
> >> index 0000000..48e071c
> >> --- /dev/null
> >> +++ b/Documentation/devicetree/bindings/sound/ux500-mop500.txt
> >> @@ -0,0 +1,39 @@
> >> +* MOP500 Audio Machine Driver
> >> +
> >> +This node is responsible for linking together all ux500 Audio Driver components.
> >> +
> >> +Required properties:
> >> + - compatible              : "stericsson,snd-soc-mop500"
> >> +
> >> +Non-standard properties:
> >> + - stericsson,cpu-dai      : Phandle to the CPU-side DAI
> >> + - stericsson,audio-codec  : Phandle to the Audio CODEC
> >> + - stericsson,card-name    : Over-ride default card name
> >> +
> >> +Example:
> >> +
> >> +	sound {
> >> +		compatible = "stericsson,snd-soc-mop500";
> >> +
> >> +		stericsson,cpu-dai = <&msp1 &msp3>;
> >> +		stericsson,audio-codec = <&codec>;
> >> +	};
> >> +
> >> +	msp1: msp@80124000 {
> >> +		compatible = "stericsson,ux500-msp-i2s";
> >> +		reg = <0x80124000 0x1000>;
> >> +		interrupts = <0 62 0x4>;
> >> +		v-ape-supply = <&db8500_vape_reg>;
> 
> 
> I'm no DT-expert, but why are you adding MSP-stuff in the machine-driver? They
> are also added in the next patch.

This is a documentation file. Duplication is not important, as it's only there
for reference.

> >> +	};
> >> +
> >> +	msp3: msp@80125000 {
> >> +		compatible = "stericsson,ux500-msp-i2s";
> >> +		reg = <0x80125000 0x1000>;
> >> +		interrupts = <0 62 0x4>;
> >> +		v-ape-supply = <&db8500_vape_reg>;
> >> +	};
> >> +
> >> +	codec: ab8500-codec {
> >> +		compatible = "stericsson,ab8500-codec";
> >> +		stericsson,earpeice-cmv = <950>; /* Units in mV. */
> 
> 
> Only four voltages are allowed here. Maybe enumerate them in the comment?

This isn't the ab8500-codec documentation. For valid earpiece values please
see the documentation in patch "Documentation: Add the AB8500 CODEC device
to the MFD AB8500 doc"

Apart from these comments does the patch looks okay?
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/sound/ux500-mop500.txt b/Documentation/devicetree/bindings/sound/ux500-mop500.txt
new file mode 100644
index 0000000..48e071c
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/ux500-mop500.txt
@@ -0,0 +1,39 @@ 
+* MOP500 Audio Machine Driver
+
+This node is responsible for linking together all ux500 Audio Driver components.
+
+Required properties:
+ - compatible              : "stericsson,snd-soc-mop500"
+
+Non-standard properties:
+ - stericsson,cpu-dai      : Phandle to the CPU-side DAI
+ - stericsson,audio-codec  : Phandle to the Audio CODEC
+ - stericsson,card-name    : Over-ride default card name
+
+Example:
+
+	sound {
+		compatible = "stericsson,snd-soc-mop500";
+
+		stericsson,cpu-dai = <&msp1 &msp3>;
+		stericsson,audio-codec = <&codec>;
+	};
+
+	msp1: msp@80124000 {
+		compatible = "stericsson,ux500-msp-i2s";
+		reg = <0x80124000 0x1000>;
+		interrupts = <0 62 0x4>;
+		v-ape-supply = <&db8500_vape_reg>;
+	};
+
+	msp3: msp@80125000 {
+		compatible = "stericsson,ux500-msp-i2s";
+		reg = <0x80125000 0x1000>;
+		interrupts = <0 62 0x4>;
+		v-ape-supply = <&db8500_vape_reg>;
+	};
+
+	codec: ab8500-codec {
+		compatible = "stericsson,ab8500-codec";
+		stericsson,earpeice-cmv = <950>; /* Units in mV. */
+	};