diff mbox

[4/6] i2c: sh_mobile: add devicetree documentation

Message ID 1398896470-24663-5-git-send-email-wsa@the-dreams.de (mailing list archive)
State Superseded
Headers show

Commit Message

Wolfram Sang April 30, 2014, 10:21 p.m. UTC
From: Wolfram Sang <wsa+renesas@sang-engineering.com>

Reported-by: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
 .../devicetree/bindings/i2c/i2c-sh_mobile.txt      | 26 ++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt

Comments

Geert Uytterhoeven April 30, 2014, 10:32 p.m. UTC | #1
Hi Wolfram,

CC devicetree

On Thu, May 1, 2014 at 12:21 AM, Wolfram Sang <wsa@the-dreams.de> wrote:
> From: Wolfram Sang <wsa+renesas@sang-engineering.com>
>
> Reported-by: Geert Uytterhoeven <geert+renesas@glider.be>
> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
> ---
>  .../devicetree/bindings/i2c/i2c-sh_mobile.txt      | 26 ++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt
>
> diff --git a/Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt b/Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt
> new file mode 100644
> index 000000000000..d2153ce36fa8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt
> @@ -0,0 +1,26 @@
> +Device tree configuration for Renesas IIC (sh_mobile) driver
> +
> +Required properties:
> +- compatible      : "renesas,iic-<soctype>". "renesas,rmobile-iic" as fallback

Please also list all supported values, so checkpatch can validate DTS compatible
properties against this binding document.

> +- reg             : address start and address range size of device
> +- interrupts      : interrupt of device
> +- clocks          : clock for device
> +- #address-cells  : should be <1>
> +- #size-cells     : should be <0>
> +
> +Optional properties:
> +- clock-frequency : frequency of bus clock in Hz. Default 100kHz if unset.
> +
> +Pinctrl properties might be needed, too. See there.
> +
> +Example:
> +
> +       iic0: i2c@e6500000 {
> +               compatible = "renesas,iic-r8a7790", "renesas,rmobile-iic";
> +               reg = <0 0xe6500000 0 0x425>;
> +               interrupts = <0 174 IRQ_TYPE_LEVEL_HIGH>;
> +               clocks = <&mstp3_clks R8A7790_CLK_IIC0>;
> +               clock-frequency = <400000>;
> +               #address-cells = <1>;
> +               #size-cells = <0>;
> +       };

Gr{oetje,eeting}s,

                        Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds
--
To unsubscribe from this list: send the line "unsubscribe linux-sh" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Rob Herring May 1, 2014, 1:02 a.m. UTC | #2
On Wed, Apr 30, 2014 at 5:32 PM, Geert Uytterhoeven
<geert@linux-m68k.org> wrote:
> Hi Wolfram,
>
> CC devicetree
>
> On Thu, May 1, 2014 at 12:21 AM, Wolfram Sang <wsa@the-dreams.de> wrote:
>> From: Wolfram Sang <wsa+renesas@sang-engineering.com>
>>
>> Reported-by: Geert Uytterhoeven <geert+renesas@glider.be>
>> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
>> ---
>>  .../devicetree/bindings/i2c/i2c-sh_mobile.txt      | 26 ++++++++++++++++++++++
>>  1 file changed, 26 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt
>>
>> diff --git a/Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt b/Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt
>> new file mode 100644
>> index 000000000000..d2153ce36fa8
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt
>> @@ -0,0 +1,26 @@
>> +Device tree configuration for Renesas IIC (sh_mobile) driver
>> +
>> +Required properties:
>> +- compatible      : "renesas,iic-<soctype>". "renesas,rmobile-iic" as fallback
>
> Please also list all supported values, so checkpatch can validate DTS compatible
> properties against this binding document.

You could add this pattern to checkpatch as well. I really wish
Renesas would follow normal convention of <vendor>,<chip>-<device>.

Rob
--
To unsubscribe from this list: send the line "unsubscribe linux-sh" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Wolfram Sang May 2, 2014, 7:23 a.m. UTC | #3
On Wed, Apr 30, 2014 at 08:02:10PM -0500, Rob Herring wrote:
> On Wed, Apr 30, 2014 at 5:32 PM, Geert Uytterhoeven
> <geert@linux-m68k.org> wrote:
> > Hi Wolfram,
> >
> > CC devicetree

Yes. Thanks, Geert.

> >> +Required properties:
> >> +- compatible      : "renesas,iic-<soctype>". "renesas,rmobile-iic" as fallback
> >
> > Please also list all supported values, so checkpatch can validate DTS compatible
> > properties against this binding document.
> 
> You could add this pattern to checkpatch as well. I really wish
> Renesas would follow normal convention of <vendor>,<chip>-<device>.

The binding is already applied and this patch just adds forgotten
documentation. Can we keep this documentation describing the current
state for now and discuss the binding convention seperately?
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt b/Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt
new file mode 100644
index 000000000000..d2153ce36fa8
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/i2c-sh_mobile.txt
@@ -0,0 +1,26 @@ 
+Device tree configuration for Renesas IIC (sh_mobile) driver
+
+Required properties:
+- compatible      : "renesas,iic-<soctype>". "renesas,rmobile-iic" as fallback
+- reg             : address start and address range size of device
+- interrupts      : interrupt of device
+- clocks          : clock for device
+- #address-cells  : should be <1>
+- #size-cells     : should be <0>
+
+Optional properties:
+- clock-frequency : frequency of bus clock in Hz. Default 100kHz if unset.
+
+Pinctrl properties might be needed, too. See there.
+
+Example:
+
+	iic0: i2c@e6500000 {
+		compatible = "renesas,iic-r8a7790", "renesas,rmobile-iic";
+		reg = <0 0xe6500000 0 0x425>;
+		interrupts = <0 174 IRQ_TYPE_LEVEL_HIGH>;
+		clocks = <&mstp3_clks R8A7790_CLK_IIC0>;
+		clock-frequency = <400000>;
+		#address-cells = <1>;
+		#size-cells = <0>;
+	};