diff mbox series

[v1,2/7] dt-bindings: usb: hpe,gxp-udc: Add binding for gxp gadget

Message ID 20221103160625.15574-3-richard.yu@hpe.com
State New
Headers show
Series Add USB Driver for HPE GXP Architecture | expand

Commit Message

Yu, Richard Nov. 3, 2022, 4:06 p.m. UTC
From: Richard Yu <richard.yu@hpe.com>

Create documentation for the hpe,gxp-udc binding to support access to
the virtual USB device.

Signed-off-by: Richard Yu <richard.yu@hpe.com>
---
 .../devicetree/bindings/usb/hpe,gxp-udc.yaml  | 57 +++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/usb/hpe,gxp-udc.yaml
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/usb/hpe,gxp-udc.yaml b/Documentation/devicetree/bindings/usb/hpe,gxp-udc.yaml
new file mode 100644
index 000000000000..f1ec4df8c3d3
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/hpe,gxp-udc.yaml
@@ -0,0 +1,57 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/hpe,gxp-udc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: HPE GXP Gadget Universal Device Controller (UDC)
+
+maintainers:
+  - Richard Yu <richard.yu@hpe.com>
+  - Jean-Marie Verdun <verdun@hpe.com>
+  - Nick Hawkins <nick.hawkins@hpe.com>
+
+properties:
+  compatible:
+    const: hpe,gxp-udc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  vdevnum:
+    description:
+      virtual device number.
+
+  fepnum:
+    description:
+      number of the flexible end-points this device is needed.
+
+  hpe,syscon-phandle:
+    $ref: '/schemas/types.yaml#/definitions/phandle'
+    description:
+      Phandle to the gxp vEHCI controller access vDevice registers.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - vdevnum
+  - fepnum
+  - hpe,syscon-phandle
+
+additionalProperties: false
+
+examples:
+  - |
+    udc@80401000 {
+      compatible = "hpe,gxp-udc";
+      reg = <0x80401000 0x1000>;
+      interrupts = <13>;
+      interrupt-parent = <&vic1>;
+      vdevnum = <0>;
+      fepnum = <7>;
+      hpe,syscon-phandle = <&udc_system_controller>;
+    };