[PATCH v5] dt-bindings: misc: add schema for USB hub on Kirin devices

Mauro Carvalho Chehab
2021-09-28T07:40:16Z

From: Yu Chen <chenyu56@huawei.com>

This patch adds binding documentation to support USB HUB and
USB data role switch of HiSilicon HiKey960 and HiKey970 boards.

[mchehab: updated OF schema and added HiKey970 example]
Signed-off-by: Yu Chen <chenyu56@huawei.com>
Signed-off-by: John Stultz <john.stultz@linaro.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
.../bindings/misc/hisilicon,hikey-usb.yaml | 87 +++++++++++++++++++
1 file changed, 87 insertions(+)
create mode 100644 Documentation/devicetree/bindings/misc/hisilicon,hikey-usb.yaml

diff --git a/Documentation/devicetree/bindings/misc/hisilicon,hikey-usb.yaml b/Documentation/devicetree/bindings/misc/hisilicon,hikey-usb.yaml
new file mode 100644
index 000000000000..761ab686121a
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/hisilicon,hikey-usb.yaml
@@ -0,0 +1,87 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2019 Linaro Ltd.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/misc/hisilicon,hikey-usb.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: HiKey960/970 onboard USB GPIO Hub
+
+maintainers:
+ - John Stultz <john.stultz@linaro.org>
+
+description: |
+ Supports the onboard USB GPIO hubs found on HiKey960/970.
+ Such hubs require a power supply for the USB I/O. Depending on the
+ exact hub model, after USB I/O is powered up, a reset should be needed.
+
+ It also acts as a role-switch intermediary to detect the state of
+ the USB-C port, to switch the hub into dual-role USB-C or host mode,
+ which enables and powers up the onboard USB-A host ports.
+
+ Schematics about such hubs can be found here:
+ https://github.com/96boards/documentation/raw/master/consumer/hikey/hikey960/hardware-docs/HiKey960_Schematics.pdf
+ https://www.96boards.org/documentation/consumer/hikey/hikey970/hardware-docs/files/hikey970-schematics.pdf
+
+properties:
+ compatible:
+ enum:
+ - hisilicon,usbhub
+
+ typec-vbus-gpios:
+ $ref: /schemas/types.yaml#/definitions/phandle-array
+ description: phandle to the typec-vbus gpio
+
+ otg-switch-gpios:
+ $ref: /schemas/types.yaml#/definitions/phandle-array
+ description: phandle to the otg-switch gpio
+
+ hub-reset-en-gpios:
+ $ref: /schemas/types.yaml#/definitions/phandle-array
+ description: phandle to the hub reset gpio
+
+ usb-role-switch:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description: Support role switch.
+
+ hub-vdd-supply:
+ description: regulator for hub power
+
+ port:
+ description: |
+ describe hadware connections between USB endpoints.
+ Two ports are supported: the first being the endpoint that will
+ be notified by this driver, and the second being the endpoint
+ that notifies this driver of a role switch.
+
+required:
+ - compatible
+ - hub-vdd-supply
+ - port
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+
+ usb-hub {
+ compatible = "hisilicon,usbhub";
+ typec-vbus-gpios = <&gpio25 2 GPIO_ACTIVE_HIGH>;
+ otg-switch-gpios = <&gpio25 6 GPIO_ACTIVE_HIGH>;
+ hub-reset-en-gpios = <&gpio0 3 GPIO_ACTIVE_HIGH>;
+ hub-vdd-supply = <&usb_hub_vdd>;
+ usb-role-switch;
+ port {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ usb_ep0: endpoint@0 {
+ reg = <0>;
+ remote-endpoint = <&dwc3_role_switch>;
+ };
+ usb_ep1: endpoint@1 {
+ reg = <1>;
+ remote-endpoint = <&rt1711h_ep>;
+ };
+ };
+ };
--
2.31.1