SMSC USB3503 High-Speed Hub Controller

SMSC USB3503 High-Speed hub

GPL-2.0으로 배포되는 이 스키마는 SMSC USB3503 High-Speed Hub Controller를 정의합니다. 관리자는 Dongjin Kim입니다.

GPIO, disabled port와 initial mode

compatible은 `smsc,usb3503`, `smsc,usb3503a`, `smsc,usb3803` 가운데 하나이고 register 영역은 하나입니다. `connect-gpios`, `intn-gpios`, `reset-gpios`는 각각 connect, interrupt, reset 신호를 제어합니다.

`bypass-gpios`는 HUB MODE와 BYPASS MODE를 선택합니다. `disabled-ports`는 사용하지 않을 downstream port 번호 1~3을 최대 세 개 지정하며 모든 port를 쓸 때는 생략합니다. `initial-mode`는 1=hub, 2=standby, 3=bypass이고 bypass에서는 downstream port 3이 낮은 switch resistance `R_on`으로 upstream port에 연결됩니다.

properties:
  compatible:
    enum:
      - smsc,usb3503
      - smsc,usb3503a
      - smsc,usb3803

  reg:
    maxItems: 1

  connect-gpios:
    maxItems: 1
    description: >
      GPIO for connect

  intn-gpios:
    maxItems: 1
    description: >
      GPIO for interrupt

  reset-gpios:
    maxItems: 1
    description: >
      GPIO for reset

  bypass-gpios:
    maxItems: 1
    description: >
      GPIO for bypass.
      Control signal to select between HUB MODE and BYPASS MODE.

  disabled-ports:
    $ref: /schemas/types.yaml#/definitions/uint32-array
    minItems: 1
    maxItems: 3
    items:
      minimum: 1
      maximum: 3
    description: >
      Specifies the ports unused using their port number. Do not describe this
      property if all ports have to be enabled.

  initial-mode:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: >
      Specifies initial mode. 1 for Hub mode, 2 for standby mode and 3 for bypass mode.
      In bypass mode the downstream port 3 is connected to the upstream port with low
      switch resistance R_on.

REFCLK 공급과 주파수

선택적인 clock 하나는 REFCLK 신호를 구동하며 이름은 `refclk`입니다. clock을 제공하지 않으면 driver는 신호가 항상 존재하고 REF_SEL pin이 primary reference clock 표의 주파수를 선택한다고 가정합니다.

`refclk-frequency`는 REF_SEL pin이 정의하는 REFCLK 주파수입니다. 이를 생략하면 driver가 rate를 설정하지 않고 primary reference clock 표의 값을 사용한다고 가정합니다.

clocks:
  maxItems: 1
  description: >
    Clock used for driving REFCLK signal. If not provided the driver assumes
    that clock signal is always available, its rate is specified by REF_SEL
    pins and a value from the primary reference clock frequencies table is
    used.

clock-names:
  const: refclk

refclk-frequency:
  $ref: /schemas/types.yaml#/definitions/uint32
  description: >
    Frequency of the REFCLK signal as defined by REF_SEL pins. If not
    provided, driver will not set rate of the REFCLK signal and assume that a
    value from the primary reference clock frequencies table is used.

모델별 bypass와 mode 제약

공통 필수 속성은 `compatible`뿐입니다. USB3803이 아닌 모델에서는 `bypass-gpios`를 허용하지 않습니다. bypass GPIO가 있으면 initial mode 1·2·3을, 없으면 1·2만 허용합니다. 정의되지 않은 추가 속성은 허용하지 않습니다.

required:
  - compatible

allOf:
  - if:
      not:
        properties:
          compatible:
            enum:
              - smsc,usb3803
    then:
      properties:
        bypass-gpios: false

  - if:
      required:
        - bypass-gpios
    then:
      properties:
        initial-mode:
          enum: [1, 2, 3]
    else:
      properties:
        initial-mode:
          enum: [1, 2]

additionalProperties: false

USB3503·USB3803·비-I2C 예제

첫 I2C 예제 `usb-hub@8`은 USB3503, 주소 0x08, connect·interrupt·reset GPIO, disabled port 2·3, hub initial mode 1과 `refclk` clock을 사용합니다.

둘째 예제는 USB3803에 bypass GPIO와 initial mode 3을 추가해 BYPASS MODE를 선택합니다. 셋째 예제는 I2C가 연결되지 않은 USB3503으로 hub mode 1, disabled port 1, 세 GPIO와 19.2 MHz `refclk-frequency`를 직접 지정합니다.

examples:
  - |
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        usb-hub@8 {
            compatible = "smsc,usb3503";
            reg = <0x08>;
            connect-gpios = <&gpx3 0 1>;
            disabled-ports = <2 3>;
            intn-gpios = <&gpx3 4 1>;
            reset-gpios = <&gpx3 5 1>;
            initial-mode = <1>;
            clocks = <&clks 80>;
            clock-names = "refclk";
        };
    };

  - |
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        usb-hub@8 {
            compatible = "smsc,usb3803";
            reg = <0x08>;
            connect-gpios = <&gpx3 0 1>;
            disabled-ports = <2 3>;
            intn-gpios = <&gpx3 4 1>;
            reset-gpios = <&gpx3 5 1>;
            bypass-gpios = <&gpx3 6 1>;
            initial-mode = <3>;
            clocks = <&clks 80>;
            clock-names = "refclk";
        };
    };

  - |
    #include <dt-bindings/gpio/gpio.h>

    usb-hub {
        /* I2C is not connected */
        compatible = "smsc,usb3503";
        initial-mode = <1>; /* initialize in HUB mode */
        disabled-ports = <1>;
        intn-gpios = <&pio 7 5 GPIO_ACTIVE_HIGH>; /* PH5 */
        reset-gpios = <&pio 4 16 GPIO_ACTIVE_LOW>; /* PE16 */
        connect-gpios = <&pio 4 17 GPIO_ACTIVE_HIGH>; /* PE17 */
        refclk-frequency = <19200000>;
    };

...