Documentation/devicetree/bindings/nvme/apple,nvme-ans.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/nvme/apple,nvme-ans.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/nvme/apple,nvme-ans.yaml
Extension
.yaml
Size
2761 bytes
Lines
120
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.

Dependency Surface

Detected Declarations

Annotated Snippet

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

title: Apple ANS NVM Express host controller

maintainers:
  - Sven Peter <sven@svenpeter.dev>

properties:
  compatible:
    oneOf:
      - const: apple,t8015-nvme-ans2
      - items:
          - const: apple,t6020-nvme-ans2
          - const: apple,t8103-nvme-ans2
      - items:
          - enum:
              # Do not add additional SoC to this list.
              - apple,t8103-nvme-ans2
              - apple,t8112-nvme-ans2
              - apple,t6000-nvme-ans2
          - const: apple,nvme-ans2

  reg:
    items:
      - description: NVMe and NVMMU registers
      - description: ANS2 co-processor control registers

  reg-names:
    items:
      - const: nvme
      - const: ans

  resets:
    maxItems: 1

  power-domains:
    # two domains for t8103, three for t6000
    minItems: 2
    items:
      - description: power domain for the NVMe controller.
      - description: power domain for the first PCIe bus connecting the NVMe
          controller to the storage modules.
      - description: optional power domain for the second PCIe bus
          connecting the NVMe controller to the storage modules.

  power-domain-names:
    minItems: 2
    items:
      - const: ans
      - const: apcie0
      - const: apcie1

  mboxes:
    maxItems: 1
    description: Mailbox of the ANS2 co-processor

  interrupts:
    maxItems: 1

  apple,sart:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: |
      Reference to the SART address filter.

      The SART address filter is documented in iommu/apple,sart.yaml.

Annotation

Implementation Notes