diff mbox series

[v3] dt-bindings: i2c: nxp,lpc1788-i2c: convert to dt schema

Message ID 20240625065939.6146-1-kanakshilledar@gmail.com (mailing list archive)
State New
Headers show
Series [v3] dt-bindings: i2c: nxp,lpc1788-i2c: convert to dt schema | expand

Commit Message

Kanak Shilledar June 25, 2024, 6:59 a.m. UTC 
Convert the NXP I2C controller for LPC2xxx/178x/18xx/43xx
to newer DT schema. Created DT schema based on the .txt file
which had `compatible`, `reg`, `interrupts`, `clocks`,
`#address-cells` and `#size-cells` as required properties.

Additional changes to the original .txt binding
- added maintainer from the MAINTAINERS file.
- added resets property required by the corresponding DTS files.

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Signed-off-by: Kanak Shilledar <kanakshilledar@gmail.com>
---
Changes in v3:
- removed "address-cells" and "size-cells" as per feedback.
Changes in v2:
- updated subject line to include device name.
- changed removed description from properties except `clock-frequency`.
- updated MAINTAINERS to track this file.
---
 .../devicetree/bindings/i2c/i2c-lpc2k.txt     | 33 ------------
 .../bindings/i2c/nxp,lpc1788-i2c.yaml         | 54 +++++++++++++++++++
 MAINTAINERS                                   |  2 +-
 3 files changed, 55 insertions(+), 34 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-lpc2k.txt
 create mode 100644 Documentation/devicetree/bindings/i2c/nxp,lpc1788-i2c.yaml

Comments

Krzysztof Kozlowski June 25, 2024, 7:02 a.m. UTC | #1 
On 25/06/2024 08:59, Kanak Shilledar wrote:
> Convert the NXP I2C controller for LPC2xxx/178x/18xx/43xx
> to newer DT schema. Created DT schema based on the .txt file
> which had `compatible`, `reg`, `interrupts`, `clocks`,
> `#address-cells` and `#size-cells` as required properties.
> 
> Additional changes to the original .txt binding
> - added maintainer from the MAINTAINERS file.
> - added resets property required by the corresponding DTS files.
> 
> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Signed-off-by: Kanak Shilledar <kanakshilledar@gmail.com>
> ---
> Changes in v3:
> - removed "address-cells" and "size-cells" as per feedback.

you already sent v3 so this is rather v4. What happened here? Why are
you resending this?

<form letter>
This is a friendly reminder during the review process.

Please add Acked-by/Reviewed-by/Tested-by tags when posting new
versions, under or above your Signed-off-by tag. Tag is "received", when
provided in a message replied to you on the mailing list. Tools like b4
can help here. However, there's no need to repost patches *only* to add
the tags. The upstream maintainer will do that for tags received on the
version they apply.

https://elixir.bootlin.com/linux/v6.5-rc3/source/Documentation/process/submitting-patches.rst#L577

If a tag was not added on purpose, please state why and what changed.
</form letter>


Best regards,
Krzysztof
Krzysztof Kozlowski June 25, 2024, 7:02 a.m. UTC | #2 
On 25/06/2024 09:02, Krzysztof Kozlowski wrote:
> On 25/06/2024 08:59, Kanak Shilledar wrote:
>> Convert the NXP I2C controller for LPC2xxx/178x/18xx/43xx
>> to newer DT schema. Created DT schema based on the .txt file
>> which had `compatible`, `reg`, `interrupts`, `clocks`,
>> `#address-cells` and `#size-cells` as required properties.
>>
>> Additional changes to the original .txt binding
>> - added maintainer from the MAINTAINERS file.
>> - added resets property required by the corresponding DTS files.
>>
>> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>> Signed-off-by: Kanak Shilledar <kanakshilledar@gmail.com>
>> ---
>> Changes in v3:
>> - removed "address-cells" and "size-cells" as per feedback.
> 
> you already sent v3 so this is rather v4. What happened here? Why are
> you resending this?

Ah, I see the changes - you dropped the incorrect tags. It's fine but it
should have been v4. Not sure how b4 or other tools will handle this.

Best regards,
Krzysztof
Kanak Shilledar June 25, 2024, 11:07 a.m. UTC | #3 
On Tue, Jun 25, 2024 at 12:33 PM Krzysztof Kozlowski <krzk@kernel.org> wrote:
>
> On 25/06/2024 09:02, Krzysztof Kozlowski wrote:
> > On 25/06/2024 08:59, Kanak Shilledar wrote:
> >> Convert the NXP I2C controller for LPC2xxx/178x/18xx/43xx
> >> to newer DT schema. Created DT schema based on the .txt file
> >> - added maintainer from the MAINTAINERS file.
> >> - added resets property required by the corresponding DTS files.
> >>
> >> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> >> Signed-off-by: Kanak Shilledar <kanakshilledar@gmail.com>
> >> ---
> >> Changes in v3:
> > you already sent v3 so this is rather v4. What happened here? Why are
> > you resending this?
>
> Ah, I see the changes - you dropped the incorrect tags. It's fine but it
> should have been v4. Not sure how b4 or other tools will handle this.

I thought there is no need to bump up the version just for changing tags.
Shall I resend it as v4 and update the commit message with the change
log to include
the removal of kernel bot tags and addition of your review tag?

> Best regards,
> Krzysztof

Thanks and Regards,
Kanak Shilledar
Andi Shyti June 25, 2024, 8:54 p.m. UTC | #4 
On Tue, Jun 25, 2024 at 04:37:47PM GMT, Kanak Shilledar wrote:
> On Tue, Jun 25, 2024 at 12:33 PM Krzysztof Kozlowski <krzk@kernel.org> wrote:
> > On 25/06/2024 09:02, Krzysztof Kozlowski wrote:
> > > On 25/06/2024 08:59, Kanak Shilledar wrote:
> > >> Convert the NXP I2C controller for LPC2xxx/178x/18xx/43xx
> > >> to newer DT schema. Created DT schema based on the .txt file
> > >> - added maintainer from the MAINTAINERS file.
> > >> - added resets property required by the corresponding DTS files.
> > >>
> > >> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> > >> Signed-off-by: Kanak Shilledar <kanakshilledar@gmail.com>
> > >> ---
> > >> Changes in v3:
> > > you already sent v3 so this is rather v4. What happened here? Why are
> > > you resending this?
> >
> > Ah, I see the changes - you dropped the incorrect tags. It's fine but it
> > should have been v4. Not sure how b4 or other tools will handle this.

why should b4 complain? I fetch it from the mail-id. And even if
b4 complains, good old git-am still works :-)

> I thought there is no need to bump up the version just for changing tags.

You should increase the version number for every single change,
even trivial changes in the commit log. If you are sending again
the same patch (which means that you are git-sending the same
.patch file without any change), then you should tag it as [PATCH
RESEND].

> Shall I resend it as v4 and update the commit message with the change
> log to include
> the removal of kernel bot tags and addition of your review tag?

No need, your patch has been added to i2c/i2c-host.

Thanks,
Andi

> > Best regards,
> > Krzysztof
> 
> Thanks and Regards,
> Kanak Shilledar
Kanak Shilledar June 26, 2024, 6:29 a.m. UTC | #5 
On Wed, Jun 26, 2024 at 2:24 AM Andi Shyti <andi.shyti@kernel.org> wrote:
>
> On Tue, Jun 25, 2024 at 04:37:47PM GMT, Kanak Shilledar wrote:
> > On Tue, Jun 25, 2024 at 12:33 PM Krzysztof Kozlowski <krzk@kernel.org> wrote:
> > > On 25/06/2024 09:02, Krzysztof Kozlowski wrote:
> > > > On 25/06/2024 08:59, Kanak Shilledar wrote:
> > > >> Convert the NXP I2C controller for LPC2xxx/178x/18xx/43xx
> > > >> to newer DT schema. Created DT schema based on the .txt file
> > > >> - added maintainer from the MAINTAINERS file.
> > > >> - added resets property required by the corresponding DTS files.
> > > >>
> > > >> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> > > >> Signed-off-by: Kanak Shilledar <kanakshilledar@gmail.com>
> > > >> ---
> > > >> Changes in v3:
> > > > you already sent v3 so this is rather v4. What happened here? Why are
> > > > you resending this?
> > >
> > > Ah, I see the changes - you dropped the incorrect tags. It's fine but it
> > > should have been v4. Not sure how b4 or other tools will handle this.
>
> why should b4 complain? I fetch it from the mail-id. And even if
> b4 complains, good old git-am still works :-)
>
> > I thought there is no need to bump up the version just for changing tags.
>
> You should increase the version number for every single change,
> even trivial changes in the commit log. If you are sending again
> the same patch (which means that you are git-sending the same
> .patch file without any change), then you should tag it as [PATCH
> RESEND].
>
> > Shall I resend it as v4 and update the commit message with the change
> > log to include
> > the removal of kernel bot tags and addition of your review tag?
>
> No need, your patch has been added to i2c/i2c-host.

Thanks for the clarification

> Thanks,
> Andi
>
> > > Best regards,
> > > Krzysztof
> >
> > Thanks and Regards,
> > Kanak Shilledar

Thanks and Regards,
Kanak Shilledar
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/i2c/i2c-lpc2k.txt b/Documentation/devicetree/bindings/i2c/i2c-lpc2k.txt
deleted file mode 100644
index 4101aa621ad4..000000000000
--- a/Documentation/devicetree/bindings/i2c/i2c-lpc2k.txt
+++ /dev/null
@@ -1,33 +0,0 @@ 
-NXP I2C controller for LPC2xxx/178x/18xx/43xx
-
-Required properties:
- - compatible: must be "nxp,lpc1788-i2c"
- - reg: physical address and length of the device registers
- - interrupts: a single interrupt specifier
- - clocks: clock for the device
- - #address-cells: should be <1>
- - #size-cells: should be <0>
-
-Optional properties:
-- clock-frequency: the desired I2C bus clock frequency in Hz; in
-  absence of this property the default value is used (100 kHz).
-
-Example:
-i2c0: i2c@400a1000 {
-	compatible = "nxp,lpc1788-i2c";
-	reg = <0x400a1000 0x1000>;
-	interrupts = <18>;
-	clocks = <&ccu1 CLK_APB1_I2C0>;
-	#address-cells = <1>;
-	#size-cells = <0>;
-};
-
-&i2c0 {
-	clock-frequency = <400000>;
-
-	lm75@48 {
-		compatible = "nxp,lm75";
-		reg = <0x48>;
-	};
-};
-
diff --git a/Documentation/devicetree/bindings/i2c/nxp,lpc1788-i2c.yaml b/Documentation/devicetree/bindings/i2c/nxp,lpc1788-i2c.yaml
new file mode 100644
index 000000000000..9a1b95c2d03c
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/nxp,lpc1788-i2c.yaml
@@ -0,0 +1,54 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/i2c/nxp,lpc1788-i2c.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP I2C controller for LPC2xxx/178x/18xx/43xx
+
+maintainers:
+  - Vladimir Zapolskiy <vz@mleia.com>
+
+allOf:
+  - $ref: /schemas/i2c/i2c-controller.yaml#
+
+properties:
+  compatible:
+    const: nxp,lpc1788-i2c
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-frequency:
+    description: the desired I2C bus clock frequency in Hz
+    default: 100000
+
+  resets:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include "dt-bindings/clock/lpc18xx-ccu.h"
+
+    i2c@400a1000 {
+        compatible = "nxp,lpc1788-i2c";
+        reg = <0x400a1000 0x1000>;
+        interrupts = <18>;
+        clocks = <&ccu1 CLK_APB1_I2C0>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index cf9c9221c388..920e4f28b5ae 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -2374,7 +2374,7 @@  ARM/LPC18XX ARCHITECTURE
 M:	Vladimir Zapolskiy <vz@mleia.com>
 L:	linux-arm-kernel@lists.infradead.org (moderated for non-subscribers)
 S:	Maintained
-F:	Documentation/devicetree/bindings/i2c/i2c-lpc2k.txt
+F:	Documentation/devicetree/bindings/i2c/nxp,lpc1788-i2c.yaml
 F:	arch/arm/boot/dts/nxp/lpc/lpc43*
 F:	drivers/i2c/busses/i2c-lpc2k.c
 F:	drivers/memory/pl172.c