Amlogic Meson G12A DWC3 USB SoC Controller Glue

Amlogic Meson USB controller glue

GPL-2.0 또는 BSD-2-Clause 라이선스의 이 schema는 Amlogic Meson G12A DWC3 USB SoC controller glue를 정의합니다. Copyright는 2019 BayLibre, SAS이고 관리자는 Neil Armstrong입니다.

G12A에는 USB2와 USB3의 host-only mode로 구성한 DWC3 IP core와 USB2 peripheral-only mode로 구성한 DWC2 IP core가 들어갑니다. Glue는 DWC3 core를 USB2 PHY들과 선택적인 USB3 PHY에 연결하며, USB2 PHY 하나를 peripheral mode에서 DWC2 IP로 다시 경로 설정할 수 있습니다.

DWC3 glue는 PHY 경로와 전원을 제어하고 OTG ID 변경을 감지하는 interrupt line을 받습니다. A1은 USB2 host-only mode의 DWC3 core를 포함합니다. GXL, GXM, AXG SoC에는 USB3 PHY가 없습니다.

공통 resource와 PHY

지원 `compatible`은 `amlogic,meson-gxl-usb-ctrl`, `amlogic,meson-gxm-usb-ctrl`, `amlogic,meson-axg-usb-ctrl`, `amlogic,meson-g12a-usb-ctrl`, `amlogic,meson-a1-usb-ctrl`입니다. `ranges`를 사용하며 `#address-cells`와 `#size-cells`는 각각 1 또는 2입니다.

Clock은 1~3개이고 `clock-names`도 1~3개입니다. Reset은 최소 1개, `reg`와 `interrupts`는 각각 최대 1개입니다. `phys`와 `phy-names`는 각각 1~3개이며 `dr_mode`를 지원합니다. `power-domains`는 최대 한 항목이고 `vbus-supply`는 OTG 전환 가능 mode에서 쓰는 VBUS 전원입니다.

properties:
  compatible:
    enum:
      - amlogic,meson-gxl-usb-ctrl
      - amlogic,meson-gxm-usb-ctrl
      - amlogic,meson-axg-usb-ctrl
      - amlogic,meson-g12a-usb-ctrl
      - amlogic,meson-a1-usb-ctrl

  ranges: true

  "#address-cells":
    enum: [ 1, 2 ]

  "#size-cells":
    enum: [ 1, 2 ]

  clocks:
    minItems: 1
    maxItems: 3

  clock-names:
    minItems: 1
    maxItems: 3

  resets:
    minItems: 1

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  phy-names:
    minItems: 1
    maxItems: 3

  phys:
    minItems: 1
    maxItems: 3

  dr_mode: true

  power-domains:
    maxItems: 1

  vbus-supply:
    description: VBUS power supply when used in OTG switchable mode

DWC2·DWC3 child와 필수 속성

이름이 `usb@[0-9a-f]+` pattern과 일치하는 child node는 `dwc2.yaml` 또는 `snps,dwc3.yaml` 중 하나를 따라야 합니다. 정의되지 않은 추가 속성은 허용하지 않습니다.

필수 속성은 `compatible`, `#address-cells`, `#size-cells`, `ranges`, `clocks`, `resets`, `reg`, `interrupts`, `phy-names`, `phys`, `dr_mode`입니다.

patternProperties:
  "^usb@[0-9a-f]+$":
    oneOf:
      - $ref: dwc2.yaml#
      - $ref: snps,dwc3.yaml#

additionalProperties: false

required:
  - compatible
  - "#address-cells"
  - "#size-cells"
  - ranges
  - clocks
  - resets
  - reg
  - interrupts
  - phy-names
  - phys
  - dr_mode

G12A PHY 이름

G12A compatible에서는 PHY가 최소 2개입니다. 순서대로 USBHOST_A port용 `usb2-phy0`, USBOTG_B port용 `usb2-phy1`을 두고, USB3_0을 사용하면 세 번째 `usb3-phy0`을 둡니다.

allOf:
  - if:
      properties:
        compatible:
          enum:
            - amlogic,meson-g12a-usb-ctrl

    then:
      properties:
        phy-names:
          minItems: 2
          items:
            - const: usb2-phy0 # USB2 PHY0 if USBHOST_A port is used
            - const: usb2-phy1 # USB2 PHY1 if USBOTG_B port is used
            - const: usb3-phy0 # USB3 PHY if USB3_0 is used
  - if:

GXL clock과 PHY

GXL compatible에서는 clock이 최소 2개이며 이름은 `usb_ctrl`, `ddr` 순서입니다. PHY 이름은 USBHOST_A용 `usb2-phy0`, USBOTG_B용 `usb2-phy1` 순서이고 `clock-names`가 필수입니다.

    properties:
      compatible:
        enum:
          - amlogic,meson-gxl-usb-ctrl

  then:
    properties:
      clocks:
        minItems: 2
      clock-names:
        items:
          - const: usb_ctrl
          - const: ddr
      phy-names:
        items:
          - const: usb2-phy0 # USB2 PHY0 if USBHOST_A port is used
          - const: usb2-phy1 # USB2 PHY1 if USBOTG_B port is used
    required:
      - clock-names
- if:

GXM clock과 세 USB2 PHY

GXM compatible에서도 clock은 최소 2개이고 이름은 `usb_ctrl`, `ddr`입니다. PHY 이름은 USBHOST_A의 `usb2-phy0`, USBOTG_B의 `usb2-phy1`, USBOTG_C의 `usb2-phy2` 순서이며 `clock-names`가 필수입니다.

    properties:
      compatible:
        enum:
          - amlogic,meson-gxm-usb-ctrl

  then:
    properties:
      clocks:
        minItems: 2
      clock-names:
        items:
          - const: usb_ctrl
          - const: ddr
      phy-names:
        items:
          - const: usb2-phy0 # USB2 PHY0 if USBHOST_A port is used
          - const: usb2-phy1 # USB2 PHY1 if USBOTG_B port is used
          - const: usb2-phy2 # USB2 PHY2 if USBOTG_C port is used

    required:
      - clock-names
- if:

AXG clock과 PHY

AXG compatible의 PHY 이름은 USBOTG_B용 `usb2-phy1` 하나입니다. Clock은 최소 2개이고 이름은 `usb_ctrl`, `ddr` 순서이며 `clock-names`가 필수입니다.

    properties:
      compatible:
        enum:
          - amlogic,meson-axg-usb-ctrl

  then:
    properties:
      phy-names:
        items:
          - const: usb2-phy1 # USB2 PHY1 if USBOTG_B port is used
      clocks:
        minItems: 2
      clock-names:
        items:
          - const: usb_ctrl
          - const: ddr
    required:
      - clock-names
- if:

A1의 세 clock

A1 compatible의 PHY 이름은 USBOTG_B용 `usb2-phy1`입니다. Clock은 최소 3개이고 이름은 `usb_ctrl`, `usb_bus`, `xtal_usb_ctrl` 순서이며 `clock-names`가 필수입니다.

  properties:
    compatible:
      enum:
        - amlogic,meson-a1-usb-ctrl

then:
  properties:
    phy-names:
      items:
        - const: usb2-phy1 # USB2 PHY1 if USBOTG_B port is used
    clocks:
      minItems: 3
    clock-names:
      items:
        - const: usb_ctrl
        - const: usb_bus
        - const: xtal_usb_ctrl
  required:
    - clock-names

G12A glue 예제

예제 `usb: usb@ffe09000` wrapper는 G12A compatible, 0xa0-byte register 영역, interrupt 16, 한 개의 address/size cell과 빈 `ranges`를 사용합니다. `clkc_usb` clock과 `reset_usb` reset을 연결하고 mode는 `otg`입니다.

PHY는 `usb2_phy0`, `usb2_phy1`, `usb3_phy0`을 순서대로 연결하며 이름도 `usb2-phy0`, `usb2-phy1`, `usb3-phy0` 순서입니다.

examples:
  - |
    usb: usb@ffe09000 {
          compatible = "amlogic,meson-g12a-usb-ctrl";
          reg = <0xffe09000 0xa0>;
          interrupts = <16>;
          #address-cells = <1>;
          #size-cells = <1>;
          ranges;

          clocks = <&clkc_usb>;
          resets = <&reset_usb>;

          dr_mode = "otg";

          phys = <&usb2_phy0>, <&usb2_phy1>, <&usb3_phy0>;
          phy-names = "usb2-phy0", "usb2-phy1", "usb3-phy0";

DWC2 peripheral과 DWC3 host child

DWC2 child `usb@ff400000`은 Amlogic G12A USB와 Synopsys DWC2 compatible을 함께 사용하고 0x40000-byte 영역, interrupt 31, `otg` 이름의 `clkc_usb1` clock, 두 번째 USB2 PHY를 연결합니다. Mode는 `peripheral`이며 RX FIFO 192, non-periodic TX FIFO 128, TX FIFO 배열 128·128·16·16·16을 지정합니다.

DWC3 child `usb@ff500000`은 Synopsys DWC3 compatible, 0x100000-byte 영역, interrupt 30, `host` mode를 사용합니다. USB2 suspend PHY quirk를 끄고 frame length 조정값을 0x20으로 지정합니다.

      dwc2: usb@ff400000 {
          compatible = "amlogic,meson-g12a-usb", "snps,dwc2";
          reg = <0xff400000 0x40000>;
          interrupts = <31>;
          clocks = <&clkc_usb1>;
          clock-names = "otg";
          phys = <&usb2_phy1>;
          dr_mode = "peripheral";
          g-rx-fifo-size = <192>;
          g-np-tx-fifo-size = <128>;
          g-tx-fifo-size = <128 128 16 16 16>;
      };

      dwc3: usb@ff500000 {
          compatible = "snps,dwc3";
          reg = <0xff500000 0x100000>;
          interrupts = <30>;
          dr_mode = "host";
          snps,dis_u2_susphy_quirk;
          snps,quirk-frame-length-adjustment = <0x20>;
      };
};