Documentation/devicetree/bindings/ata/sata-common.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/ata/sata-common.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/ata/sata-common.yaml
Extension
.yaml
Size
1559 bytes
Lines
61
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-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/ata/sata-common.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Common Properties for Serial AT attachment (SATA) controllers

maintainers:
  - Linus Walleij <linusw@kernel.org>

description: |
  This document defines device tree properties common to most Serial
  AT attachment (SATA) storage devices. It doesn't constitute a device tree
  binding specification by itself but is meant to be referenced by device
  tree bindings.

  The SATA controller-specific device tree bindings are responsible for
  defining whether each property is required or optional.

properties:
  $nodename:
    pattern: "^sata(@.*)?$"
    description:
      Specifies the host controller node. SATA host controller nodes are named
      "sata"

  "#address-cells":
    const: 1

  "#size-cells":
    const: 0

  dma-coherent: true

patternProperties:
  "^sata-port@[0-9a-e]$":
    $ref: '#/$defs/sata-port'
    description: |
      DT nodes for ports connected on the SATA host. The SATA port
      nodes will be named "sata-port".

additionalProperties: true

$defs:
  sata-port:
    type: object

    properties:
      reg:
        minimum: 0
        description:
          The ID number of the SATA port. Aside with being directly used,
          each port can have a Port Multiplier attached thus allowing to
          access more than one drive by means of a single SATA port.

      port:
        $ref: /schemas/graph.yaml#/properties/port

...

Annotation

Implementation Notes