Documentation/devicetree/bindings/usb/aspeed,usb-vhub.yaml

   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
   8 title: ASPEED USB 2.0 Virtual Hub Controller
   9
  10 maintainers:
  11   - Benjamin Herrenschmidt <benh@kernel.crashing.org>
  12
  13 description: |+
  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
  23 properties:
  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     $ref: /schemas/types.yaml#/definitions/uint32
  42     default: 5
  43     minimum: 1
  44     maximum: 7
  45
  46   aspeed,vhub-generic-endpoints:
  47     description: Number of generic endpoints supported by the Virtual Hub
  48     $ref: /schemas/types.yaml#/definitions/uint32
  49     default: 15
  50     minimum: 1
  51     maximum: 21
  52
  53 required:
  54   - compatible
  55   - reg
  56   - clocks
  57   - interrupts
  58   - aspeed,vhub-downstream-ports
  59   - aspeed,vhub-generic-endpoints
  60
  61 additionalProperties: false
  62
  63 examples:
  64   - |
  65     #include <dt-bindings/clock/aspeed-clock.h>
  66     vhub: usb-vhub@1e6a0000 {
  67             compatible = "aspeed,ast2500-usb-vhub";
  68             reg = <0x1e6a0000 0x300>;
  69             interrupts = <5>;
  70             clocks = <&syscon ASPEED_CLK_GATE_USBPORT1CLK>;
  71             aspeed,vhub-downstream-ports = <5>;
  72             aspeed,vhub-generic-endpoints = <15>;
  73             pinctrl-names = "default";
  74             pinctrl-0 = <&pinctrl_usb2ad_default>;
  75     };