diff mbox

[RESENT,v9,1/2] ASoC: rt5514: Add devicetree bindings for rt5514-spi

Message ID 20170906025010.10750-1-jeffy.chen@rock-chips.com (mailing list archive)
State Accepted
Headers show

Commit Message

Jeffy Chen Sept. 6, 2017, 2:50 a.m. UTC
Add devicetree bindings documentation file for rt5514 spi dsp codec.

Also update rt5514 i2c dt-binding's compatible to distinguish it from
rt5514 spi.

Signed-off-by: Jeffy Chen <jeffy.chen@rock-chips.com>
---

Changes in v9:
Address comments from Brian.

 .../devicetree/bindings/sound/rt5514-spi.txt       | 29 ++++++++++++++++++++++
 Documentation/devicetree/bindings/sound/rt5514.txt |  4 +--
 2 files changed, 31 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/sound/rt5514-spi.txt

Comments

Rob Herring (Arm) Sept. 13, 2017, 5:24 p.m. UTC | #1
On Wed, Sep 06, 2017 at 10:50:09AM +0800, Jeffy Chen wrote:
> Add devicetree bindings documentation file for rt5514 spi dsp codec.
> 
> Also update rt5514 i2c dt-binding's compatible to distinguish it from
> rt5514 spi.
> 
> Signed-off-by: Jeffy Chen <jeffy.chen@rock-chips.com>
> ---
> 
> Changes in v9:
> Address comments from Brian.
> 
>  .../devicetree/bindings/sound/rt5514-spi.txt       | 29 ++++++++++++++++++++++
>  Documentation/devicetree/bindings/sound/rt5514.txt |  4 +--
>  2 files changed, 31 insertions(+), 2 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/sound/rt5514-spi.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/rt5514-spi.txt b/Documentation/devicetree/bindings/sound/rt5514-spi.txt
> new file mode 100644
> index 000000000000..7911d1adbd29
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/rt5514-spi.txt
> @@ -0,0 +1,29 @@
> +RT5514 SPI audio CODEC
> +
> +This device supports SPI only.
> +
> +Required properties:
> +
> +- compatible : "realtek,rt5514" or "realtek,rt5514", "realtek,rt5514-spi".
> +
> +- reg : The SPI address of the device.

See below.

> +
> +Optional properties:
> +
> +- interrupt-parent: Should be the phandle for the interrupt controller
> +- interrupts: The interrupt number to the cpu. The interrupt specifier format
> +	      depends on the interrupt controller.
> +
> +Example:
> +
> +codec: rt5514-spi@0 {
> +	compatible = "realtek,rt5514", "realtek,rt5514-spi";
> +	reg = <0>;
> +
> +	pinctrl-names = "default";
> +	pinctrl-0 = <&mic_int>;
> +
> +	interrupt-parent = <&gpio1>;
> +	interrupts = <13 IRQ_TYPE_LEVEL_HIGH>;
> +	wakeup-source;

This needs to be documented too.

> +};
> diff --git a/Documentation/devicetree/bindings/sound/rt5514.txt b/Documentation/devicetree/bindings/sound/rt5514.txt
> index 929ca6756b02..841a1159e234 100644
> --- a/Documentation/devicetree/bindings/sound/rt5514.txt
> +++ b/Documentation/devicetree/bindings/sound/rt5514.txt
> @@ -4,7 +4,7 @@ This device supports I2C only.

SPI support should be added to this document.

>  
>  Required properties:
>  
> -- compatible : "realtek,rt5514".
> +- compatible : "realtek,rt5514" or "realtek,rt5514", "realtek,rt5514-i2c".

There's no need for the -spi or -i2c compatibles. This is implied by 
being a child of those controllers.
  
>  - reg : The I2C address of the device.
>  
> @@ -28,6 +28,6 @@ Pins on the device (for linking into audio routes) for RT5514:
>  Example:
>  
>  codec: rt5514@57 {
> -	compatible = "realtek,rt5514";
> +	compatible = "realtek,rt5514", "realtek,rt5514-i2c";
>  	reg = <0x57>;
>  };
> -- 
> 2.11.0
> 
>
Jeffy Chen Sept. 18, 2017, 1:22 a.m. UTC | #2
Hi Rob,

Thanks for your reply.

On 09/14/2017 01:24 AM, Rob Herring wrote:
> On Wed, Sep 06, 2017 at 10:50:09AM +0800, Jeffy Chen wrote:
>> diff --git a/Documentation/devicetree/bindings/sound/rt5514.txt b/Documentation/devicetree/bindings/sound/rt5514.txt
>> index 929ca6756b02..841a1159e234 100644
>> --- a/Documentation/devicetree/bindings/sound/rt5514.txt
>> +++ b/Documentation/devicetree/bindings/sound/rt5514.txt
>> @@ -4,7 +4,7 @@ This device supports I2C only.
>
> SPI support should be added to this document.
ok, will do.
>
>>
>>   Required properties:
>>
>> -- compatible : "realtek,rt5514".
>> +- compatible : "realtek,rt5514" or "realtek,rt5514", "realtek,rt5514-i2c".
>
> There's no need for the -spi or -i2c compatibles. This is implied by
> being a child of those controllers.
heiko mentioned i should add it in the binding in:
https://patchwork.kernel.org/patch/9918987/
Heiko Stübner Sept. 18, 2017, 9:30 a.m. UTC | #3
Hi Jeffy,

Am Montag, 18. September 2017, 09:22:21 CEST schrieb jeffy:
> On 09/14/2017 01:24 AM, Rob Herring wrote:
> > On Wed, Sep 06, 2017 at 10:50:09AM +0800, Jeffy Chen wrote:
> >> diff --git a/Documentation/devicetree/bindings/sound/rt5514.txt b/Documentation/devicetree/bindings/sound/rt5514.txt
> >> index 929ca6756b02..841a1159e234 100644
> >> --- a/Documentation/devicetree/bindings/sound/rt5514.txt
> >> +++ b/Documentation/devicetree/bindings/sound/rt5514.txt
> >> @@ -4,7 +4,7 @@ This device supports I2C only.
> >
> > SPI support should be added to this document.
> ok, will do.
> >
> >>
> >>   Required properties:
> >>
> >> -- compatible : "realtek,rt5514".
> >> +- compatible : "realtek,rt5514" or "realtek,rt5514", "realtek,rt5514-i2c".
> >
> > There's no need for the -spi or -i2c compatibles. This is implied by
> > being a child of those controllers.
> heiko mentioned i should add it in the binding in:
> https://patchwork.kernel.org/patch/9918987/

If you add a new compatible you need to add it to the binding. I think what
Rob means is, that both the i2c and spi side can have the _same_
compatible without the -i2c or -spi, as you can check wether they are
children of either a spi or i2c controller in the code itself.


Heiko
Jeffy Chen Sept. 18, 2017, 11:20 a.m. UTC | #4
Hi Heiko,

Thanks for your reply.

On 09/18/2017 05:30 PM, Heiko Stuebner wrote:
>>>> > >>
>>>> > >>-- compatible : "realtek,rt5514".
>>>> > >>+- compatible : "realtek,rt5514" or "realtek,rt5514", "realtek,rt5514-i2c".
>>> > >
>>> > >There's no need for the -spi or -i2c compatibles. This is implied by
>>> > >being a child of those controllers.
>> >heiko mentioned i should add it in the binding in:
>> >https://patchwork.kernel.org/patch/9918987/
> If you add a new compatible you need to add it to the binding. I think what
> Rob means is, that both the i2c and spi side can have the_same_
> compatible without the -i2c or -spi, as you can check wether they are
> children of either a spi or i2c controller in the code itself.
>
ok, got it.

i sent a new patch to check the bus_type instead :)
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/sound/rt5514-spi.txt b/Documentation/devicetree/bindings/sound/rt5514-spi.txt
new file mode 100644
index 000000000000..7911d1adbd29
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/rt5514-spi.txt
@@ -0,0 +1,29 @@ 
+RT5514 SPI audio CODEC
+
+This device supports SPI only.
+
+Required properties:
+
+- compatible : "realtek,rt5514" or "realtek,rt5514", "realtek,rt5514-spi".
+
+- reg : The SPI address of the device.
+
+Optional properties:
+
+- interrupt-parent: Should be the phandle for the interrupt controller
+- interrupts: The interrupt number to the cpu. The interrupt specifier format
+	      depends on the interrupt controller.
+
+Example:
+
+codec: rt5514-spi@0 {
+	compatible = "realtek,rt5514", "realtek,rt5514-spi";
+	reg = <0>;
+
+	pinctrl-names = "default";
+	pinctrl-0 = <&mic_int>;
+
+	interrupt-parent = <&gpio1>;
+	interrupts = <13 IRQ_TYPE_LEVEL_HIGH>;
+	wakeup-source;
+};
diff --git a/Documentation/devicetree/bindings/sound/rt5514.txt b/Documentation/devicetree/bindings/sound/rt5514.txt
index 929ca6756b02..841a1159e234 100644
--- a/Documentation/devicetree/bindings/sound/rt5514.txt
+++ b/Documentation/devicetree/bindings/sound/rt5514.txt
@@ -4,7 +4,7 @@  This device supports I2C only.
 
 Required properties:
 
-- compatible : "realtek,rt5514".
+- compatible : "realtek,rt5514" or "realtek,rt5514", "realtek,rt5514-i2c".
 
 - reg : The I2C address of the device.
 
@@ -28,6 +28,6 @@  Pins on the device (for linking into audio routes) for RT5514:
 Example:
 
 codec: rt5514@57 {
-	compatible = "realtek,rt5514";
+	compatible = "realtek,rt5514", "realtek,rt5514-i2c";
 	reg = <0x57>;
 };