Documentation/devicetree/bindings/ufs/qcom,ufs.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/ufs/qcom,ufs.yaml

File Facts

System: Linux kernel
Corpus path: Documentation/devicetree/bindings/ufs/qcom,ufs.yaml
Extension: .yaml
Size: 6259 bytes
Lines: 241
Domain: Support Tooling And Documentation
Bucket: Documentation
Inferred role: Support Tooling And Documentation: configuration, schema, or hardware description
Status: atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

dt-bindings/clock/qcom,gcc-sm8150.h
dt-bindings/clock/qcom,rpmh.h
dt-bindings/gpio/gpio.h
dt-bindings/interconnect/qcom,sm8150.h
dt-bindings/interrupt-controller/arm-gic.h

Detected Declarations

No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
%YAML 1.2
---
$id: http://devicetree.org/schemas/ufs/qcom,ufs.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Qualcomm Universal Flash Storage (UFS) Controller

maintainers:
  - Bjorn Andersson <bjorn.andersson@linaro.org>
  - Andy Gross <agross@kernel.org>

# 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

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

  - if:
      properties:
        compatible:
          contains:
            enum:
              - qcom,sdm845-ufshc

Annotation

Immediate include surface: `dt-bindings/clock/qcom,gcc-sm8150.h`, `dt-bindings/clock/qcom,rpmh.h`, `dt-bindings/gpio/gpio.h`, `dt-bindings/interconnect/qcom,sm8150.h`, `dt-bindings/interrupt-controller/arm-gic.h`.
Atlas domain: Support Tooling And Documentation / Documentation.
Implementation status: atlas-only.

Implementation Notes

This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.