xref: /linux/Documentation/devicetree/bindings/usb/aspeed,usb-vhub.yaml (revision 9e8238020c5beba64e7ffafbb7ea0fb02fe68270) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2# Copyright (c) 2020 Facebook Inc.
3%YAML 1.2
4---
5$id: http://devicetree.org/schemas/usb/aspeed,usb-vhub.yaml#
6$schema: http://devicetree.org/meta-schemas/core.yaml#
7
8title: ASPEED USB 2.0 Virtual Hub Controller
9
10maintainers:
11  - Benjamin Herrenschmidt <benh@kernel.crashing.org>
12
13description: |+
14  The ASPEED USB 2.0 Virtual Hub Controller implements 1 set of USB Hub
15  register and several sets of Device and Endpoint registers to support
16  the Virtual Hub's downstream USB devices.
17
18  Supported number of devices and endpoints vary depending on hardware
19  revisions. AST2400 and AST2500 Virtual Hub supports 5 downstream devices
20  and 15 generic endpoints, while AST2600 Virtual Hub supports 7 downstream
21  devices and 21 generic endpoints.
22
23properties:
24  compatible:
25    enum:
26      - aspeed,ast2400-usb-vhub
27      - aspeed,ast2500-usb-vhub
28      - aspeed,ast2600-usb-vhub
29
30  reg:
31    maxItems: 1
32
33  clocks:
34    maxItems: 1
35
36  interrupts:
37    maxItems: 1
38
39  aspeed,vhub-downstream-ports:
40    description: Number of downstream ports supported by the Virtual Hub
41    allOf:
42      - $ref: /schemas/types.yaml#/definitions/uint32
43      - default: 5
44        minimum: 1
45        maximum: 7
46
47  aspeed,vhub-generic-endpoints:
48    description: Number of generic endpoints supported by the Virtual Hub
49    allOf:
50      - $ref: /schemas/types.yaml#/definitions/uint32
51      - default: 15
52        minimum: 1
53        maximum: 21
54
55required:
56  - compatible
57  - reg
58  - clocks
59  - interrupts
60  - aspeed,vhub-downstream-ports
61  - aspeed,vhub-generic-endpoints
62
63additionalProperties: false
64
65examples:
66  - |
67    #include <dt-bindings/clock/aspeed-clock.h>
68    vhub: usb-vhub@1e6a0000 {
69            compatible = "aspeed,ast2500-usb-vhub";
70            reg = <0x1e6a0000 0x300>;
71            interrupts = <5>;
72            clocks = <&syscon ASPEED_CLK_GATE_USBPORT1CLK>;
73            aspeed,vhub-downstream-ports = <5>;
74            aspeed,vhub-generic-endpoints = <15>;
75            pinctrl-names = "default";
76            pinctrl-0 = <&pinctrl_usb2ad_default>;
77    };
78