Renesas USB 3.0 Peripheral Controller

Renesas USB 3.0 peripheral controller

GPL-2.0-only로 배포되는 이 스키마는 Renesas USB 3.0 Peripheral controller를 정의합니다. 관리자는 Yoshihiro Shimoda입니다.

compatible, clock과 role switch

RZ/G2 및 R-Car Gen3 SoC별 compatible은 `renesas,rcar-gen3-usb3-peri`로 fallback합니다. RZ/V2M과 RZ/V2MA의 SoC별 compatible은 `renesas,rzv2m-usb3-peri`로 fallback합니다.

register와 interrupt는 각각 하나입니다. clock은 main `axi`와 register access `reg` 순서이며 최소 하나를 사용합니다. 선택 가능한 PHY는 하나이고 이름은 `usb`입니다. power domain과 reset도 각각 하나입니다.

`usb-role-switch`는 role switching 지원 flag이고, `companion`은 함께 동작하는 controller를 가리키는 phandle입니다.

properties:
  compatible:
    oneOf:
      - items:
          - enum:
              - renesas,r8a774a1-usb3-peri # RZ/G2M
              - renesas,r8a774b1-usb3-peri # RZ/G2N
              - renesas,r8a774c0-usb3-peri # RZ/G2E
              - renesas,r8a774e1-usb3-peri # RZ/G2H
              - renesas,r8a7795-usb3-peri  # R-Car H3
              - renesas,r8a7796-usb3-peri  # R-Car M3-W
              - renesas,r8a77961-usb3-peri # R-Car M3-W+
              - renesas,r8a77965-usb3-peri # R-Car M3-N
              - renesas,r8a77990-usb3-peri # R-Car E3
          - const: renesas,rcar-gen3-usb3-peri

      - items:
          - enum:
              - renesas,r9a09g011-usb3-peri # RZ/V2M
              - renesas,r9a09g055-usb3-peri # RZ/V2MA
          - const: renesas,rzv2m-usb3-peri

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    minItems: 1
    items:
      - description: Main clock
      - description: Register access clock

  clock-names:
    minItems: 1
    items:
      - const: axi
      - const: reg

  phys:
    maxItems: 1

  phy-names:
    const: usb

  power-domains:
    maxItems: 1

  resets:
    maxItems: 1

  usb-role-switch:
    $ref: /schemas/types.yaml#/definitions/flag
    description: Support role switch.

  companion:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: phandle of a companion.

HS·SS graph port와 필수 속성

`usb-role-switch`를 사용할 때 controller data bus의 connector는 OF graph로 표현해야 합니다. `port@0`은 High Speed(HS) data bus, `port@1`은 Super Speed(SS) data bus이며 두 port 모두 필수입니다.

controller 자체의 필수 속성은 `compatible`, `interrupts`, `clocks`입니다.

  ports:
    $ref: /schemas/graph.yaml#/properties/ports
    description: |
      any connector to the data bus of this controller should be modelled
      using the OF graph bindings specified, if the "usb-role-switch"
      property is used.

    properties:
      port@0:
        $ref: /schemas/graph.yaml#/properties/port
        description: High Speed (HS) data bus.

      port@1:
        $ref: /schemas/graph.yaml#/properties/port
        description: Super Speed (SS) data bus.

    required:
      - port@0
      - port@1

required:
  - compatible
  - interrupts
  - clocks

RZ/V2M clock·reset 조건

`renesas,rzv2m-usb3-peri`가 포함되면 clock 두 개와 이름 두 개가 필요하며 `clock-names`와 `resets`가 필수입니다. 그 밖의 compatible은 clock을 최대 하나만 사용합니다. 정의되지 않은 추가 속성은 허용하지 않습니다.

allOf:
  - if:
      properties:
        compatible:
          contains:
            enum:
              - renesas,rzv2m-usb3-peri
    then:
      properties:
        clocks:
          minItems: 2
        clock-names:
          minItems: 2
      required:
        - clock-names
        - resets
    else:
      properties:
        clocks:
          maxItems: 1

additionalProperties: false

RZ/G2E USB3 peripheral 예제

예제 `usb3_peri0: usb@ee020000`은 RZ/G2E compatible과 R-Car Gen3 fallback, 0x400-byte register 영역, level-high GIC SPI 104, CPG clock 328을 사용합니다. `companion`은 `xhci0`이고 role switch를 활성화합니다.

graph의 `port@0` HS endpoint는 `hs_ep`에, `port@1` SS endpoint `usb3_role_switch`는 `hd3ss3220_out_ep`에 연결됩니다.

examples:
  - |
    #include <dt-bindings/clock/r8a774c0-cpg-mssr.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>
    #include <dt-bindings/power/r8a774c0-sysc.h>

    usb3_peri0: usb@ee020000 {
        compatible = "renesas,r8a774c0-usb3-peri", "renesas,rcar-gen3-usb3-peri";
        reg = <0xee020000 0x400>;
        interrupts = <GIC_SPI 104 IRQ_TYPE_LEVEL_HIGH>;
        clocks = <&cpg CPG_MOD 328>;
        companion = <&xhci0>;
        usb-role-switch;

        ports {
            #address-cells = <1>;
            #size-cells = <0>;
            port@0 {
                reg = <0>;
                usb3_hs_ep: endpoint {
                    remote-endpoint = <&hs_ep>;
                };
            };
            port@1 {
                reg = <1>;
                usb3_role_switch: endpoint {
                    remote-endpoint = <&hd3ss3220_out_ep>;
                };
            };
        };
    };