Documentation/devicetree/bindings/mtd/mtd.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/mtd/mtd.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/mtd/mtd.yaml
Extension
.yaml
Size
2489 bytes
Lines
114
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/mtd/mtd.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: MTD (Memory Technology Device)

maintainers:
  - Miquel Raynal <miquel.raynal@bootlin.com>
  - Richard Weinberger <richard@nod.at>

select: false

properties:
  $nodename:
    pattern: "^(flash|.*sram|nand)(@.*)?$"

  label:
    description:
      User-defined MTD device name. Can be used to assign user friendly
      names to MTD devices (instead of the flash model or flash controller
      based name) in order to ease flash device identification and/or
      describe what they are used for.

  '#address-cells':
    deprecated: true

  '#size-cells':
    deprecated: true

  partitions:
    type: object

    required:
      - compatible

patternProperties:
  "(^partition)?@[0-9a-f]+$":
    $ref: /schemas/mtd/partitions/partition.yaml#/$defs/partition-node
    deprecated: true

  "^otp(-[0-9]+)?$":
    type: object

    allOf:
      - $ref: /schemas/nvmem/nvmem.yaml#
      - $ref: /schemas/nvmem/nvmem-deprecated-cells.yaml#

    unevaluatedProperties: false

    description: |
      An OTP memory region. Some flashes provide a one-time-programmable
      memory whose content can either be programmed by a user or is already
      pre-programmed by the factory. Some flashes might provide both.

    properties:
      compatible:
        enum:
          - user-otp
          - factory-otp

    required:
      - compatible

# This is a generic file other binding inherit from
additionalProperties: true

examples:
  - |

Annotation

Implementation Notes