Qualcomm Universal Flash Storage Controller

Qualcomm UFS controller

GPL-2.0-only 또는 BSD-2-Clause 이중 라이선스의 이 스키마는 여러 세대의 Qualcomm Universal Flash Storage(UFS) controller를 정의합니다. 관리자는 Bjorn Andersson과 Andy Gross입니다.

적용되는 8개 Qualcomm SoC

이 스키마는 `qcom,msm8994-ufshc`, `qcom,msm8996-ufshc`, `qcom,qcs615-ufshc`, `qcom,sdm845-ufshc`, `qcom,sm6115-ufshc`, `qcom,sm6125-ufshc`, `qcom,sm6350-ufshc`, `qcom,sm8150-ufshc` 가운데 하나가 `compatible`에 포함된 node만 선택합니다. 모든 `jedec,ufs-2.0` node에 적용되는 것은 아니며 `compatible`은 필수입니다.

# Select only our matches, not all jedec,ufs-2.0
select:
  properties:
    compatible:
      contains:
        enum:
          - qcom,msm8994-ufshc
          - qcom,msm8996-ufshc
          - qcom,qcs615-ufshc
          - qcom,sdm845-ufshc
          - qcom,sm6115-ufshc
          - qcom,sm6125-ufshc
          - qcom,sm6350-ufshc
          - qcom,sm8150-ufshc
  required:
    - compatible

기본 compatible, ICE 및 register

`compatible`은 SoC별 값, `qcom,ufshc`, `jedec,ufs-2.0`의 세 단계 chain입니다. `qcom,ice`는 Inline Crypto Engine node의 phandle입니다. `reg`는 1~2개이고 이름은 표준 UFS register `std`와 별도 crypto register `ice` 순서입니다. 필수 속성은 `compatible`과 `reg`이며 Qualcomm 공통 속성은 `qcom,ufs-common.yaml`을 참조합니다.

properties:
  compatible:
    items:
      - enum:
          - qcom,msm8994-ufshc
          - qcom,msm8996-ufshc
          - qcom,qcs615-ufshc
          - qcom,sdm845-ufshc
          - qcom,sm6115-ufshc
          - qcom,sm6125-ufshc
          - qcom,sm6350-ufshc
          - qcom,sm8150-ufshc
      - const: qcom,ufshc
      - const: jedec,ufs-2.0

  qcom,ice:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: phandle to the Inline Crypto Engine node

  reg:
    minItems: 1
    maxItems: 2

  reg-names:
    items:
      - const: std
      - const: ice

required:
  - compatible
  - reg

allOf:
  - $ref: qcom,ufs-common.yaml

SDM845·SM6350·SM8150 9-clock 구성

`qcom,sdm845-ufshc`, `qcom,sm6350-ufshc`, `qcom,sm8150-ufshc`는 정확히 9개 clock을 사용합니다. 이름은 `core_clk`, `bus_aggr_clk`, `iface_clk`, `core_clk_unipro`, `ref_clk`, `tx_lane0_sync_clk`, `rx_lane0_sync_clk`, `rx_lane1_sync_clk`, `ice_core_clk` 순서입니다. Register는 정확히 2개이고 `reg-names`도 2개가 필요하므로 `reg-names`가 필수입니다.

- if:
    properties:
      compatible:
        contains:
          enum:
            - qcom,sdm845-ufshc
            - qcom,sm6350-ufshc
            - qcom,sm8150-ufshc
  then:
    properties:
      clocks:
        minItems: 9
        maxItems: 9
      clock-names:
        items:
          - const: core_clk
          - const: bus_aggr_clk
          - const: iface_clk
          - const: core_clk_unipro
          - const: ref_clk
          - const: tx_lane0_sync_clk
          - const: rx_lane0_sync_clk
          - const: rx_lane1_sync_clk
          - const: ice_core_clk
      reg:
        minItems: 2
        maxItems: 2
      reg-names:
        minItems: 2
    required:
      - reg-names

MSM8996 전용 9-clock 구성

`qcom,msm8996-ufshc`도 정확히 9개 clock을 사용하지만 순서는 `core_clk`, `bus_clk`, `bus_aggr_clk`, `iface_clk`, `core_clk_unipro`, `core_clk_ice`, `ref_clk`, `tx_lane0_sync_clk`, `rx_lane0_sync_clk`입니다. Register와 register name은 각각 최대 한 개이므로 별도 `ice` register 영역을 두지 않습니다.

- if:
    properties:
      compatible:
        contains:
          enum:
            - qcom,msm8996-ufshc
  then:
    properties:
      clocks:
        minItems: 9
        maxItems: 9
      clock-names:
        items:
          - const: core_clk
          - const: bus_clk
          - const: bus_aggr_clk
          - const: iface_clk
          - const: core_clk_unipro
          - const: core_clk_ice
          - const: ref_clk
          - const: tx_lane0_sync_clk
          - const: rx_lane0_sync_clk
      reg:
        minItems: 1
        maxItems: 1
      reg-names:
        maxItems: 1

QCS615·SM6115·SM6125 8-clock 구성

`qcom,qcs615-ufshc`, `qcom,sm6115-ufshc`, `qcom,sm6125-ufshc`는 정확히 8개 clock을 사용합니다. 이름은 `core_clk`, `bus_aggr_clk`, `iface_clk`, `core_clk_unipro`, `ref_clk`, `tx_lane0_sync_clk`, `rx_lane0_sync_clk`, `ice_core_clk` 순서입니다. Register와 register name은 각각 2개이고 `reg-names`가 필수입니다. `qcom,msm8994-ufshc`의 clock binding은 아직 TODO로 남아 있습니다.

- if:
    properties:
      compatible:
        contains:
          enum:
            - qcom,qcs615-ufshc
            - qcom,sm6115-ufshc
            - qcom,sm6125-ufshc
  then:
    properties:
      clocks:
        minItems: 8
        maxItems: 8
      clock-names:
        items:
          - const: core_clk
          - const: bus_aggr_clk
          - const: iface_clk
          - const: core_clk_unipro
          - const: ref_clk
          - const: tx_lane0_sync_clk
          - const: rx_lane0_sync_clk
          - const: ice_core_clk
      reg:
        minItems: 2
        maxItems: 2
      reg-names:
        minItems: 2
    required:
      - reg-names

  # TODO: define clock bindings for qcom,msm8994-ufshc

qcom,ice 유무에 따른 resource 수

`qcom,ice` phandle을 제공하면 Inline Crypto Engine register를 phandle 대상에서 찾으므로 이 node의 `reg`는 최대 한 개, clock은 7~8개입니다. `qcom,ice`가 없으면 legacy 별도 ICE resource를 포함할 수 있어 `reg`는 1~2개, clock은 7~9개입니다. 평가되지 않은 추가 속성은 허용하지 않습니다.

  - if:
      required:
        - qcom,ice
    then:
      properties:
        reg:
          maxItems: 1
        clocks:
          minItems: 7
          maxItems: 8
    else:
      properties:
        reg:
          minItems: 1
          maxItems: 2
        clocks:
          minItems: 7
          maxItems: 9

unevaluatedProperties: false

SM8150 UFS와 별도 ICE register 예제

예제 `ufs@1d84000`은 `qcom,sm8150-ufshc`, `qcom,ufshc`, `jedec,ufs-2.0`을 선언합니다. `std` register는 0x2500 bytes, `ice` register는 0x8000 bytes이며 level-high GIC SPI interrupt 265를 사용합니다. PHY는 `ufs_mem_phy_lanes`, 방향당 lane은 2개이고 `GCC_UFS_PHY_BCR` reset과 active-low TLMM GPIO 210 reset을 선언합니다.

`vcc`와 `vccq` supply의 최대 전류는 각각 1,100,000 및 1,200,000 microamps입니다. `UFS_PHY_GDSC` power domain과 Apps SMMU stream 0x300을 사용합니다. Clock 9개는 SDM845·SM6350·SM8150 구성 순서와 일치하고, frequency table에서 `core_clk`와 `core_clk_unipro` 범위는 37.5~300 MHz, `ice_core_clk` 최대값은 300 MHz이며 나머지는 `<0 0>`입니다.

examples:
  - |
    #include <dt-bindings/clock/qcom,gcc-sm8150.h>
    #include <dt-bindings/clock/qcom,rpmh.h>
    #include <dt-bindings/gpio/gpio.h>
    #include <dt-bindings/interconnect/qcom,sm8150.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>

    soc {
        #address-cells = <2>;
        #size-cells = <2>;

        ufs@1d84000 {
            compatible = "qcom,sm8150-ufshc", "qcom,ufshc",
                         "jedec,ufs-2.0";
            reg = <0x0 0x01d84000 0x0 0x2500>,
                  <0x0 0x01d90000 0x0 0x8000>;
            reg-names = "std", "ice";

            interrupts = <GIC_SPI 265 IRQ_TYPE_LEVEL_HIGH>;
            phys = <&ufs_mem_phy_lanes>;
            phy-names = "ufsphy";
            lanes-per-direction = <2>;
            #reset-cells = <1>;
            resets = <&gcc GCC_UFS_PHY_BCR>;
            reset-names = "rst";
            reset-gpios = <&tlmm 210 GPIO_ACTIVE_LOW>;

            vcc-supply = <&vreg_l7b_2p5>;
            vcc-max-microamp = <1100000>;
            vccq-supply = <&vreg_l9b_1p2>;
            vccq-max-microamp = <1200000>;

            power-domains = <&gcc UFS_PHY_GDSC>;
            iommus = <&apps_smmu 0x300 0>;

            clocks = <&gcc GCC_UFS_PHY_AXI_CLK>,
                     <&gcc GCC_AGGRE_UFS_PHY_AXI_CLK>,
                     <&gcc GCC_UFS_PHY_AHB_CLK>,
                     <&gcc GCC_UFS_PHY_UNIPRO_CORE_CLK>,
                     <&rpmhcc RPMH_CXO_CLK>,
                     <&gcc GCC_UFS_PHY_TX_SYMBOL_0_CLK>,
                     <&gcc GCC_UFS_PHY_RX_SYMBOL_0_CLK>,
                     <&gcc GCC_UFS_PHY_RX_SYMBOL_1_CLK>,
                     <&gcc GCC_UFS_PHY_ICE_CORE_CLK>;
            clock-names = "core_clk",
                          "bus_aggr_clk",
                          "iface_clk",
                          "core_clk_unipro",
                          "ref_clk",
                          "tx_lane0_sync_clk",
                          "rx_lane0_sync_clk",
                          "rx_lane1_sync_clk",
                          "ice_core_clk";
            freq-table-hz = <37500000 300000000>,
                            <0 0>,
                            <0 0>,
                            <37500000 300000000>,
                            <0 0>,
                            <0 0>,
                            <0 0>,
                            <0 0>,
                            <0 300000000>;
        };
    };