Documentation/devicetree/bindings/phy/spacemit,k1-pcie-phy.yaml
Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/phy/spacemit,k1-pcie-phy.yaml
File Facts
- System
- Linux kernel
- Corpus path
Documentation/devicetree/bindings/phy/spacemit,k1-pcie-phy.yaml- Extension
.yaml- Size
- 1678 bytes
- Lines
- 72
- 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/spacemit,k1-syscon.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/phy/spacemit,k1-pcie-phy.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#
title: SpacemiT K1 PCIe PHY
maintainers:
- Alex Elder <elder@riscstar.com>
description: >
Two PHYs on the SpacemiT K1 SoC used for only for PCIe. These
PHYs must be configured using calibration values that are
determined by a third "combo PHY". The combo PHY determines
these calibration values during probe so they can be used for
the two PCIe-only PHYs.
The PHY uses an external oscillator as a reference clock. During
normal operation, the PCIe host driver is responsible for ensuring
all other clocks needed by a PHY are enabled, and all resets
affecting the PHY are deasserted.
properties:
compatible:
const: spacemit,k1-pcie-phy
reg:
items:
- description: PHY control registers
clocks:
items:
- description: External oscillator used by the PHY PLL
clock-names:
const: refclk
resets:
items:
- description: PHY reset; remains deasserted after initialization
reset-names:
const: phy
"#phy-cells":
const: 0
required:
- compatible
- reg
- clocks
- clock-names
- resets
- reset-names
- "#phy-cells"
additionalProperties: false
examples:
- |
#include <dt-bindings/clock/spacemit,k1-syscon.h>
phy@c0c10000 {
compatible = "spacemit,k1-pcie-phy";
reg = <0xc0c10000 0x1000>;
clocks = <&vctcxo_24m>;
clock-names = "refclk";
resets = <&syscon_apmu RESET_PCIE1_GLOBAL>;
reset-names = "phy";
#phy-cells = <0>;
Annotation
- Immediate include surface: `dt-bindings/clock/spacemit,k1-syscon.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.