Add bindings doc for Sunplus EHCI driver
Signed-off-by: Vincent Shih <[email protected]>
---
.../bindings/usb/sunplus,sp7021-usb-ehci.yaml | 97 ++++++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 98 insertions(+)
create mode 100644 Documentation/devicetree/bindings/usb/sunplus,sp7021-usb-ehci.yaml
diff --git a/Documentation/devicetree/bindings/usb/sunplus,sp7021-usb-ehci.yaml b/Documentation/devicetree/bindings/usb/sunplus,sp7021-usb-ehci.yaml
new file mode 100644
index 0000000..e492f7a
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/sunplus,sp7021-usb-ehci.yaml
@@ -0,0 +1,97 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) Sunplus Co., Ltd. 2021
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/sunplus,sp7021-usb-ehci.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Sunplus SP7021 EHCI Device Tree bindings for ehci0/ehci1
+
+maintainers:
+ - Vincent Shih <[email protected]>
+
+allOf:
+ - $ref: usb-hcd.yaml#
+
+properties:
+ compatible:
+ enum:
+ - sunplus,sp7021-usb-ehci0
+ - sunplus,sp7021-usb-ehci1
+
+ clocks:
+ maxItems: 2
+
+ clock-names:
+ items:
+ - const: usbc_clk
+ - const: uphy_clk
+
+ resets:
+ maxItems: 2
+
+ reset-names:
+ items:
+ - const: usbc_rst
+ - const: uphy_rst
+
+ reg:
+ items:
+ - description: USBC register region
+ - description: UPHY register region
+ - description: MOON4 register region
+
+ reg-names:
+ items:
+ - const: usbc
+ - const: uphy
+ - const: moon4
+
+ interrupts:
+ maxItems: 1
+
+ nvmem-cell-names:
+ description: names corresponding to the nvmem cells of disconnect voltage
+ const: disc_vol
+
+ nvmem-cells:
+ description: nvmem cell address of disconnect voltage
+ maxItems: 1
+
+ port-num:
+ description: identify ehci0 (port0) and ehci1 (port1)
+
+required:
+ - compatible
+ - clocks
+ - clock-names
+ - resets
+ - reset-names
+ - reg
+ - reg-names
+ - interrupts
+ - nvmem-cell-names
+ - nvmem-cells
+ - port-num
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/irq.h>
+
+ sp_ehci0: usb@9c102100 {
+ compatible = "sunplus,sp7021-usb-ehci";
+ clocks = <&clkc 0x3a>, <&clkc 0x3d>;
+ clock-names = "usbc_clk", "uphy_clk";
+ resets = <&rstc 0x2a>, <&rstc 0x2d>;
+ reset-names = "usbc_rst", "uphy_rst";
+ reg = <0x9c102100 0x68>, <0x9c004a80 0x80>, <0x9c000200 0x80>;
+ reg-names = "usbc", "uphy", "moon4";
+ interrupt-parent = <&intc>;
+ interrupts = <14 IRQ_TYPE_LEVEL_HIGH>;
+ nvmem-cell-names = "disc_vol";
+ nvmem-cells = <&disc_vol>;
+ port-num = <0>;
+ };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index 6c2faf3..49702c4 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -17951,6 +17951,7 @@ SUNPLUS USB EHCI DRIVER
M: Vincent Shih <[email protected]>
L: [email protected]
S: Maintained
+F: Documentation/devicetree/bindings/nvmem/sunplus,sp7021-ocotp.yaml
F: drivers/usb/host/ehci-sunplus.c
SUPERH
--
2.7.4
On Sun, 27 Feb 2022 17:50:41 +0800, Vincent Shih wrote:
> Add bindings doc for Sunplus EHCI driver
>
> Signed-off-by: Vincent Shih <[email protected]>
> ---
> .../bindings/usb/sunplus,sp7021-usb-ehci.yaml | 97 ++++++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 98 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/usb/sunplus,sp7021-usb-ehci.yaml
>
My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):
yamllint warnings/errors:
./Documentation/devicetree/bindings/usb/sunplus,sp7021-usb-ehci.yaml:62:18: [warning] too many spaces after colon (colons)
dtschema/dtc warnings/errors:
Documentation/devicetree/bindings/usb/sunplus,sp7021-usb-ehci.example.dt.yaml:0:0: /example-0/usb@9c102100: failed to match any schema with compatible: ['sunplus,sp7021-usb-ehci']
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/patch/1598222
This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.
If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:
pip3 install dtschema --upgrade
Please check and re-submit.