Documentation/devicetree/bindings/phy/spacemit,k1-combo-phy.yaml
Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/phy/spacemit,k1-combo-phy.yaml
File Facts
- System
- Linux kernel
- Corpus path
Documentation/devicetree/bindings/phy/spacemit,k1-combo-phy.yaml- Extension
.yaml- Size
- 3513 bytes
- Lines
- 115
- 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-combo-phy.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#
title: SpacemiT K1 PCIe/USB3 Combo PHY
maintainers:
- Alex Elder <elder@riscstar.com>
description: >
Of the three PHYs on the SpacemiT K1 SoC capable of being used for
PCIe, one is a combo PHY that can also be configured for use by a
USB 3 controller. Using PCIe or USB 3 is a board design decision.
The combo PHY is also the only PCIe PHY that is able to determine
PCIe calibration values to use, and this must be determined before
the other two PCIe PHYs can be used. This calibration must be
performed with the combo PHY in PCIe mode, and is this is done
when the combo PHY is probed.
The combo PHY uses an external oscillator as a reference clock.
During normal operation, the PCIe or USB port driver is responsible
for ensuring all other clocks needed by a PHY are enabled, and all
resets affecting the PHY are deasserted. However, for the combo
PHY to perform calibration independent of whether it's later used
for PCIe or USB, all PCIe mode clocks and resets must be defined.
properties:
compatible:
const: spacemit,k1-combo-phy
reg:
items:
- description: PHY control registers
clocks:
items:
- description: External oscillator used by the PHY PLL
- description: DWC PCIe Data Bus Interface (DBI) clock
- description: DWC PCIe application AXI-bus Master interface clock
- description: DWC PCIe application AXI-bus slave interface clock
clock-names:
items:
- const: refclk
- const: dbi
- const: mstr
- const: slv
resets:
items:
- description: PHY reset; remains deasserted after initialization
- description: DWC PCIe Data Bus Interface (DBI) reset
- description: DWC PCIe application AXI-bus Master interface reset
- description: DWC PCIe application AXI-bus slave interface reset
reset-names:
items:
- const: phy
- const: dbi
- const: mstr
- const: slv
spacemit,apmu:
description:
A phandle that refers to the APMU system controller, whose
regmap is used in setting the mode
$ref: /schemas/types.yaml#/definitions/phandle
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.