Documentation/devicetree/bindings/dma/marvell,xor-v2.yaml

File Facts

System

Linux kernel

Corpus path

Documentation/devicetree/bindings/dma/marvell,xor-v2.yaml

Extension

.yaml

Size

1172 bytes

Lines

62

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.
• Touches IRQ or DMA behavior; this matters for the representative real-device path.

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

# SPDX-License-Identifier: GPL-2.0
%YAML 1.2
---
$id: http://devicetree.org/schemas/dma/marvell,xor-v2.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Marvell XOR v2 engines

maintainers:
  - Andrew Lunn <andrew@lunn.ch>

properties:
  compatible:
    oneOf:
      - const: marvell,xor-v2
      - items:
          - enum:
              - marvell,armada-7k-xor
          - const: marvell,xor-v2

  reg:
    items:
      - description: DMA registers
      - description: global registers

  clocks:
    minItems: 1
    maxItems: 2

  clock-names:
    minItems: 1
    items:
      - const: core
      - const: reg

  msi-parent:
    description:
      Phandle to the MSI-capable interrupt controller used for
      interrupts.
    maxItems: 1

  dma-coherent: true

required:
  - compatible
  - reg
  - msi-parent
  - dma-coherent

additionalProperties: false

examples:
  - |
    xor0@6a0000 {
        compatible = "marvell,armada-7k-xor", "marvell,xor-v2";
        reg = <0x6a0000 0x1000>, <0x6b0000 0x1000>;
        clocks = <&ap_clk 0>, <&ap_clk 1>;
        clock-names = "core", "reg";
        msi-parent = <&gic_v2m0>;
        dma-coherent;
    };

Annotation

• Atlas domain: Support Tooling And Documentation / Documentation.
• Implementation status: atlas-only.
• IRQ or DMA behavior appears here, which is relevant to the selected PCIe/NVMe device path.

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.