Add device tree binding documentation for the Aspeed USB2.0 Device
Controller.
Signed-off-by: Neal Liu <[email protected]>
---
.../bindings/usb/aspeed,ast2600-udc.yaml | 52 +++++++++++++++++++
1 file changed, 52 insertions(+)
create mode 100644 Documentation/devicetree/bindings/usb/aspeed,ast2600-udc.yaml
diff --git a/Documentation/devicetree/bindings/usb/aspeed,ast2600-udc.yaml b/Documentation/devicetree/bindings/usb/aspeed,ast2600-udc.yaml
new file mode 100644
index 000000000000..2e91d5179359
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/aspeed,ast2600-udc.yaml
@@ -0,0 +1,52 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (c) 2020 Facebook Inc.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/aspeed,ast2600-udc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ASPEED USB 2.0 Device Controller
+
+maintainers:
+ - Neal Liu <[email protected]>
+
+description: |+
+ The ASPEED USB 2.0 Device Controller implements 1 control endpoint and
+ 4 generic endpoints for AST260x.
+
+ Supports independent DMA channel for each generic endpoint.
+ Supports 32/256 stages descriptor mode for all generic endpoints.
+
+properties:
+ compatible:
+ enum:
+ - aspeed,ast2600-udc
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - interrupts
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/clock/aspeed-clock.h>
+ usb: usb@1e6a2000 {
+ compatible = "aspeed,ast2600-udc";
+ reg = <0x1e6a2000 0x300>;
+ interrupts = <9>;
+ clocks = <&syscon ASPEED_CLK_GATE_USBPORT2CLK>;
+ pinctrl-names = "default";
+ pinctrl-0 = <&pinctrl_usb2bd_default>;
+ };
--
2.25.1
On 17/05/2022 10:25, Neal Liu wrote:
> +
> + interrupts:
> + maxItems: 1
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - interrupts
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/clock/aspeed-clock.h>
> + usb: usb@1e6a2000 {
> + compatible = "aspeed,ast2600-udc";
Sorry for not noticing it earlier - slipped through the cracks. You use
here unusual indentation (not matching the rest of the example - above
is 4 spaces, here is 7 or 8).
Just keep 4 spaces for DTS example.
Reviewed-by: Krzysztof Kozlowski <[email protected]>
Best regards,
Krzysztof
> -----Original Message-----
> From: Krzysztof Kozlowski <[email protected]>
> Sent: Tuesday, May 17, 2022 8:04 PM
> To: Neal Liu <[email protected]>; Greg Kroah-Hartman
> <[email protected]>; Rob Herring <[email protected]>; Krzysztof
> Kozlowski <[email protected]>; Joel Stanley <[email protected]>;
> Andrew Jeffery <[email protected]>; Felipe Balbi <[email protected]>; Sumit
> Semwal <[email protected]>; Christian König
> <[email protected]>; Geert Uytterhoeven <[email protected]>;
> Li Yang <[email protected]>
> Cc: [email protected]; [email protected];
> [email protected]; [email protected];
> [email protected]; [email protected];
> [email protected]; [email protected]
> Subject: Re: [PATCH v2 3/3] dt-bindings: usb: add documentation for aspeed
> udc
>
> On 17/05/2022 10:25, Neal Liu wrote:
> > +
> > + interrupts:
> > + maxItems: 1
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - clocks
> > + - interrupts
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > + - |
> > + #include <dt-bindings/clock/aspeed-clock.h>
> > + usb: usb@1e6a2000 {
> > + compatible = "aspeed,ast2600-udc";
>
> Sorry for not noticing it earlier - slipped through the cracks. You use here
> unusual indentation (not matching the rest of the example - above is 4 spaces,
> here is 7 or 8).
>
> Just keep 4 spaces for DTS example.
>
> Reviewed-by: Krzysztof Kozlowski <[email protected]>
>
Got it. I'll revise it for next patch.
Thanks for your review.
> Best regards,
> Krzysztof