Documentation/devicetree/bindings/remoteproc/st-rproc.txt
Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/remoteproc/st-rproc.txt
File Facts
- System
- Linux kernel
- Corpus path
Documentation/devicetree/bindings/remoteproc/st-rproc.txt- Extension
.txt- Size
- 1357 bytes
- Lines
- 42
- Domain
- Support Tooling And Documentation
- Bucket
- Documentation
- Inferred role
- Support Tooling And Documentation: documentation
- 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
- No C-style include directives detected by the generator.
Detected Declarations
- No top-level syscall, struct, function, initcall, or export declaration detected by the generator.
Annotated Snippet
STMicroelectronics Co-Processor Bindings
----------------------------------------
This binding provides support for adjunct processors found on ST SoCs.
Co-processors can be controlled from the bootloader or the primary OS. If
the bootloader starts a co-processor, the primary OS must detect its state
and act accordingly.
Required properties:
- compatible Should be one of:
"st,st231-rproc"
"st,st40-rproc"
- memory-region Reserved memory (See: ../reserved-memory/reserved-memory.txt)
- resets Reset lines (See: ../reset/reset.txt)
- reset-names Must be "sw_reset" and "pwr_reset"
- clocks Clock for co-processor (See: ../clock/clock-bindings.txt)
- clock-frequency Clock frequency to set co-processor at if the bootloader
hasn't already done so
- st,syscfg System configuration register which holds the boot vector
for the co-processor
1st cell: Phandle to syscon block
2nd cell: Boot vector register offset
Example:
audio_reserved: rproc@42000000 {
compatible = "shared-dma-pool";
reg = <0x42000000 0x01000000>;
no-map;
};
st231-audio {
compatible = "st,st231-rproc";
memory-region = <&audio_reserved>;
resets = <&softreset STIH407_ST231_AUD_SOFTRESET>;
reset-names = "sw_reset";
clocks = <&clk_s_c0_flexgen CLK_ST231_AUD_0>;
clock-frequency = <600000000>;
st,syscfg = <&syscfg_core 0x228>;
};
Annotation
- 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.