Generic USB OHCI Controller

USB OHCI controller

GPL-2.0으로 배포되는 이 schema는 USB OHCI controller를 정의합니다. 관리자는 Greg Kroah-Hartman입니다.

Platform별 OHCI compatible과 fallback

`generic-ohci` fallback 그룹에는 Allwinner Sun4i·Sun5i·Sun6i·Sun7i·Sun8i·Sun9i·Sun20i·Sun50i·Sun55i 계열, Broadcom BCM3384·63268·6328·6358·6362·6368·7125·7346·7358·7360·7362·7420·7425·7435가 포함됩니다.

같은 그룹에는 HPE GXP, IBM 476GTR, Ingenic JZ4740, Rockchip RK3588, Synopsys HSDK v1.0도 포함됩니다. standalone 값은 `generic-ohci`와 `ti,ohci-omap3`입니다.

`usb-ohci` fallback 그룹은 Cavium Octeon 6335, Nintendo Hollywood, NXP OHCI, ST SPEAr600입니다. 모든 compatible 문자열은 원문 block에 그대로 보존됩니다.

properties:
  compatible:
    oneOf:
      - items:
          - enum:
              - allwinner,sun4i-a10-ohci
              - allwinner,sun50i-a100-ohci
              - allwinner,sun50i-a64-ohci
              - allwinner,sun50i-h6-ohci
              - allwinner,sun50i-h616-ohci
              - allwinner,sun55i-a523-ohci
              - allwinner,sun5i-a13-ohci
              - allwinner,sun6i-a31-ohci
              - allwinner,sun7i-a20-ohci
              - allwinner,sun8i-a23-ohci
              - allwinner,sun8i-a83t-ohci
              - allwinner,sun8i-h3-ohci
              - allwinner,sun8i-r40-ohci
              - allwinner,sun8i-v3s-ohci
              - allwinner,sun9i-a80-ohci
              - allwinner,sun20i-d1-ohci
              - brcm,bcm3384-ohci
              - brcm,bcm63268-ohci
              - brcm,bcm6328-ohci
              - brcm,bcm6358-ohci
              - brcm,bcm6362-ohci
              - brcm,bcm6368-ohci
              - brcm,bcm7125-ohci
              - brcm,bcm7346-ohci
              - brcm,bcm7358-ohci
              - brcm,bcm7360-ohci
              - brcm,bcm7362-ohci
              - brcm,bcm7420-ohci
              - brcm,bcm7425-ohci
              - brcm,bcm7435-ohci
              - hpe,gxp-ohci
              - ibm,476gtr-ohci
              - ingenic,jz4740-ohci
              - rockchip,rk3588-ohci
              - snps,hsdk-v1.0-ohci
          - const: generic-ohci
      - enum:
          - generic-ohci
          - ti,ohci-omap3
      - items:
          - enum:
              - cavium,octeon-6335-ohci
              - nintendo,hollywood-usb-ohci
              - nxp,ohci-nxp
              - st,spear600-ohci
          - const: usb-ohci

Register, reset, clock과 power domain

register 영역과 interrupt는 각각 최대 하나, reset은 1~2개, clock은 1~4개, power domain은 최대 하나입니다.

Renesas R-Car Gen3에서 host-only channel의 첫 clock은 host입니다. USB DRD channel은 첫 clock이 host, 둘째 clock이 peripheral이어야 합니다.

reg:
  maxItems: 1

interrupts:
  maxItems: 1

resets:
  minItems: 1
  maxItems: 2

clocks:
  minItems: 1
  maxItems: 4
  description: |
    In case the Renesas R-Car Gen3 SoCs:
      - if a host only channel: first clock should be host.
      - if a USB DRD channel: first clock should be host and second
        one should be peripheral

power-domains:
  maxItems: 1

Endian, wakeup, port와 transceiver

`big-endian`, `big-endian-desc`, `big-endian-regs`는 각각 descriptor와 register 모두, descriptor만, register만 big-endian인 controller를 표시합니다.

`remote-wakeup-connected`는 platform에 remote wakeup이 배선됐음을 뜻합니다. `no-big-frame-no`는 `frame_no`가 HCCA bit [15:0]에 있음을 표시하고 `num-ports`는 감지된 port 수를 덮어씁니다.

PHY는 1~3개이고 이름은 `usb`입니다. IOMMU는 최대 하나, `dr_mode`는 `host` 또는 `otg`입니다. `transceiver`는 연결된 ISP1301 device phandle이며 UDC controller를 USB physical layer에 연결할 때 필요합니다.

big-endian:
  $ref: /schemas/types.yaml#/definitions/flag
  description:
    Set this flag for HCDs with big endian descriptors and big
    endian registers.

big-endian-desc:
  $ref: /schemas/types.yaml#/definitions/flag
  description:
    Set this flag for HCDs with big endian descriptors.

big-endian-regs:
  $ref: /schemas/types.yaml#/definitions/flag
  description:
    Set this flag for HCDs with big endian registers.

remote-wakeup-connected:
  $ref: /schemas/types.yaml#/definitions/flag
  description:
    Remote wakeup is wired on the platform.

no-big-frame-no:
  $ref: /schemas/types.yaml#/definitions/flag
  description:
    Set if frame_no lives in bits [15:0] of HCCA

num-ports:
  $ref: /schemas/types.yaml#/definitions/uint32
  description:
    Overrides the detected port count

phys:
  minItems: 1
  maxItems: 3

phy-names:
  const: usb

iommus:
  maxItems: 1

dr_mode:
  enum:
    - host
    - otg

transceiver:
  $ref: /schemas/types.yaml#/definitions/phandle
  description:
    The associated ISP1301 device. Necessary for the UDC controller for
    connecting to the USB physical layer.

필수 속성과 platform 조건

필수 속성은 `compatible`, `reg`, `interrupts`이고 공통 `usb-hcd.yaml`을 상속합니다.

NXP `nxp,ohci-nxp` compatible이 아닌 controller에는 `transceiver`를 허용하지 않습니다. Rockchip RK3588 OHCI는 clock을 최소 4개 요구하고, 그 밖의 controller는 1~3개를 허용합니다.

상속 schema까지 평가한 뒤 남는 추가 속성은 허용하지 않습니다.

required:
  - compatible
  - reg
  - interrupts

allOf:
  - $ref: usb-hcd.yaml
  - if:
      not:
        properties:
          compatible:
            contains:
              const: nxp,ohci-nxp
    then:
      properties:
        transceiver: false
  - if:
      properties:
        compatible:
          contains:
            const: rockchip,rk3588-ohci
    then:
      properties:
        clocks:
          minItems: 4
    else:
      properties:
        clocks:
          minItems: 1
          maxItems: 3

unevaluatedProperties: false

Allwinner OHCI 예제

예제 `usb@1c14400`은 Allwinner Sun4i A10과 `generic-ohci` fallback, 0x100-byte register 영역, interrupt 64, USB clock과 AHB gate clock, USB PHY와 `usb` PHY 이름을 사용합니다.

examples:
  - |
      ohci0: usb@1c14400 {
          compatible = "allwinner,sun4i-a10-ohci", "generic-ohci";
          reg = <0x01c14400 0x100>;
          interrupts = <64>;
          clocks = <&usb_clk 6>, <&ahb_gates 2>;
          phys = <&usbphy 1>;
          phy-names = "usb";
      };

...