[PATCH v2 1/1] dt-bindings: usb: convert lpc32xx-udc.txt to yaml format

[PATCH v2 1/1] dt-bindings: usb: convert lpc32xx-udc.txt to yaml format

[Frank Li]

Convert lpc32xx-udc.txt to yaml format.

Additional changes:
- add clocks and put it into required list to match existed lp32xx.dtsi.
- remove usb-transceiver@2c at examples.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
changes in v2
- update commit message by add "additional changes"
- add clocks to required list
---
 .../devicetree/bindings/usb/lpc32xx-udc.txt   | 28 ----------
 .../bindings/usb/nxp,lpc3220-udc.yaml         | 54 +++++++++++++++++++
 2 files changed, 54 insertions(+), 28 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/usb/lpc32xx-udc.txt
 create mode 100644 Documentation/devicetree/bindings/usb/nxp,lpc3220-udc.yaml

diff --git a/Documentation/devicetree/bindings/usb/lpc32xx-udc.txt b/Documentation/devicetree/bindings/usb/lpc32xx-udc.txt
deleted file mode 100644
index 29f12a533f666..0000000000000
--- a/Documentation/devicetree/bindings/usb/lpc32xx-udc.txt
+++ /dev/null
@@ -1,28 +0,0 @@
-* NXP LPC32xx SoC USB Device Controller (UDC)
-
-Required properties:
-- compatible: Must be "nxp,lpc3220-udc"
-- reg: Physical base address of the controller and length of memory mapped
-  region.
-- interrupts: The USB interrupts:
-              * USB Device Low Priority Interrupt
-              * USB Device High Priority Interrupt
-              * USB Device DMA Interrupt
-              * External USB Transceiver Interrupt (OTG ATX)
-- transceiver: phandle of the associated ISP1301 device - this is necessary for
-               the UDC controller for connecting to the USB physical layer
-
-Example:
-
-	isp1301: usb-transceiver@2c {
-		compatible = "nxp,isp1301";
-		reg = <0x2c>;
-	};
-
-	usbd@31020000 {
-		compatible = "nxp,lpc3220-udc";
-		reg = <0x31020000 0x300>;
-		interrupt-parent = <&mic>;
-		interrupts = <0x3d 0>, <0x3e 0>, <0x3c 0>, <0x3a 0>;
-		transceiver = <&isp1301>;
-	};
diff --git a/Documentation/devicetree/bindings/usb/nxp,lpc3220-udc.yaml b/Documentation/devicetree/bindings/usb/nxp,lpc3220-udc.yaml
new file mode 100644
index 0000000000000..e580575274f60
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/nxp,lpc3220-udc.yaml
@@ -0,0 +1,54 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/nxp,lpc3220-udc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP LPC32xx SoC USB Device Controller (UDC)
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    const: nxp,lpc3220-udc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    items:
+      - description: USB Device Low Priority Interrupt
+      - description: USB Device High Priority Interrupt
+      - description: USB Device DMA Interrupt
+      - description: External USB Transceiver Interrupt (OTG ATX)
+
+  clocks:
+    maxItems: 1
+
+  transceiver:
+    description:
+      phandle of the associated ISP1301 device - this is necessary for
+      the UDC controller for connecting to the USB physical layer
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - transceiver
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/lpc32xx-clock.h>
+
+    usbd@31020000 {
+        compatible = "nxp,lpc3220-udc";
+        reg = <0x31020000 0x300>;
+        interrupt-parent = <&mic>;
+        interrupts = <0x3d 0>, <0x3e 0>, <0x3c 0>, <0x3a 0>;
+        clocks = <&usbclk LPC32XX_USB_CLK_DEVICE>;
+        transceiver = <&isp1301>;
+    };
-- 
2.34.1

Re: [PATCH v2 1/1] dt-bindings: usb: convert lpc32xx-udc.txt to yaml format

[Rob Herring (Arm)]

On Wed, 25 Jun 2025 17:43:53 -0400, Frank Li wrote:
> Convert lpc32xx-udc.txt to yaml format.
> 
> Additional changes:
> - add clocks and put it into required list to match existed lp32xx.dtsi.
> - remove usb-transceiver@2c at examples.
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
> changes in v2
> - update commit message by add "additional changes"
> - add clocks to required list
> ---
>  .../devicetree/bindings/usb/lpc32xx-udc.txt   | 28 ----------
>  .../bindings/usb/nxp,lpc3220-udc.yaml         | 54 +++++++++++++++++++
>  2 files changed, 54 insertions(+), 28 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/usb/lpc32xx-udc.txt
>  create mode 100644 Documentation/devicetree/bindings/usb/nxp,lpc3220-udc.yaml
> 

Reviewed-by: Rob Herring (Arm) <robh@kernel.org>

Re: [PATCH v2 1/1] dt-bindings: usb: convert lpc32xx-udc.txt to yaml format

[Vladimir Zapolskiy]

Hi Frank.

On 6/26/25 00:43, Frank Li wrote:
> Convert lpc32xx-udc.txt to yaml format.
> 
> Additional changes:
> - add clocks and put it into required list to match existed lp32xx.dtsi.
> - remove usb-transceiver@2c at examples.
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>

Thank you a lot for doing this massive conversion work of NXP LPC
device tree bindings, I would appreciate, if you put me to CC for
all such changes.

While you do one-to-one conversion, you do bring a lot of errors,
because the .txt descriptions are broken.

Please always reference to arch/arm/boot/dts/nxp/lpc/lpc32xx.dtsi
and arch/arm/boot/dts/nxp/lpc/lpc18xx.dtsi, that's the correct
version of NXP LPC DT bindings, otherwise something important
can be missed by occasion.

<snip>

> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/lpc32xx-clock.h>
> +
> +    usbd@31020000 {
> +        compatible = "nxp,lpc3220-udc";
> +        reg = <0x31020000 0x300>;
> +        interrupt-parent = <&mic>;

interrupt-parent = <sic1>;

> +        interrupts = <0x3d 0>, <0x3e 0>, <0x3c 0>, <0x3a 0>;

Should subscribe 32 and correct the type:

interrupts = <29 4>, <30 4>, <28 4>, <26 8>;

> +        clocks = <&usbclk LPC32XX_USB_CLK_DEVICE>;
> +        transceiver = <&isp1301>;
> +    };

-- 
Best wishes,
Vladimir

Re: [PATCH v2 1/1] dt-bindings: usb: convert lpc32xx-udc.txt to yaml format

[Frank Li]

On Sat, Jun 28, 2025 at 03:57:44AM +0300, Vladimir Zapolskiy wrote:
> Hi Frank.
>
> On 6/26/25 00:43, Frank Li wrote:
> > Convert lpc32xx-udc.txt to yaml format.
> >
> > Additional changes:
> > - add clocks and put it into required list to match existed lp32xx.dtsi.
> > - remove usb-transceiver@2c at examples.
> >
> > Signed-off-by: Frank Li <Frank.Li@nxp.com>
>
> Thank you a lot for doing this massive conversion work of NXP LPC
> device tree bindings, I would appreciate, if you put me to CC for
> all such changes.
>
> While you do one-to-one conversion, you do bring a lot of errors,
> because the .txt descriptions are broken.
>
> Please always reference to arch/arm/boot/dts/nxp/lpc/lpc32xx.dtsi
> and arch/arm/boot/dts/nxp/lpc/lpc18xx.dtsi, that's the correct
> version of NXP LPC DT bindings, otherwise something important
> can be missed by occasion.

Okay, I dependent on CHECK_DTBS but omit the factor the node with status
="disabled" will skip check.

Frank

>
> <snip>
>
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/clock/lpc32xx-clock.h>
> > +
> > +    usbd@31020000 {
> > +        compatible = "nxp,lpc3220-udc";
> > +        reg = <0x31020000 0x300>;
> > +        interrupt-parent = <&mic>;
>
> interrupt-parent = <sic1>;
>
> > +        interrupts = <0x3d 0>, <0x3e 0>, <0x3c 0>, <0x3a 0>;
>
> Should subscribe 32 and correct the type:
>
> interrupts = <29 4>, <30 4>, <28 4>, <26 8>;
>
> > +        clocks = <&usbclk LPC32XX_USB_CLK_DEVICE>;
> > +        transceiver = <&isp1301>;
> > +    };
>
> --
> Best wishes,
> Vladimir