xref: /linux/Documentation/devicetree/bindings/mtd/partitions/partition.yaml (revision 118f3fbe517f49e17877f34fd677f7374970d92e)
164185220SRafał Miłecki# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
264185220SRafał Miłecki%YAML 1.2
364185220SRafał Miłecki---
464185220SRafał Miłecki$id: http://devicetree.org/schemas/mtd/partitions/partition.yaml#
564185220SRafał Miłecki$schema: http://devicetree.org/meta-schemas/core.yaml#
664185220SRafał Miłecki
764185220SRafał Miłeckititle: Partition
864185220SRafał Miłecki
964185220SRafał Miłeckidescription: |
1064185220SRafał Miłecki  This binding describes a single flash partition. Each partition must have its
1164185220SRafał Miłecki  relative offset and size specified. Depending on partition function extra
1264185220SRafał Miłecki  properties can be used.
1364185220SRafał Miłecki
14*118f3fbeSChristian Marangi  A partition may be dynamically allocated by a specific parser at runtime.
15*118f3fbeSChristian Marangi  In this specific case, a specific suffix is required to the node name.
16*118f3fbeSChristian Marangi  Everything after 'partition-' will be used as the partition name to compare
17*118f3fbeSChristian Marangi  with the one dynamically allocated by the specific parser.
18*118f3fbeSChristian Marangi  If the partition contains invalid char a label can be provided that will
19*118f3fbeSChristian Marangi  be used instead of the node name to make the comparison.
20*118f3fbeSChristian Marangi  This is used to assign an OF node to the dynamiccally allocated partition
21*118f3fbeSChristian Marangi  so that subsystem like NVMEM can provide an OF node and declare NVMEM cells.
22*118f3fbeSChristian Marangi  The OF node will be assigned only if the partition label declared match the
23*118f3fbeSChristian Marangi  one assigned by the parser at runtime.
24*118f3fbeSChristian Marangi
2564185220SRafał Miłeckimaintainers:
2664185220SRafał Miłecki  - Rafał Miłecki <rafal@milecki.pl>
2764185220SRafał Miłecki
2864185220SRafał Miłeckiproperties:
2964185220SRafał Miłecki  reg:
3064185220SRafał Miłecki    description: partition's offset and size within the flash
3164185220SRafał Miłecki    maxItems: 1
3264185220SRafał Miłecki
3364185220SRafał Miłecki  label:
3464185220SRafał Miłecki    description: The label / name for this partition. If omitted, the label
3564185220SRafał Miłecki      is taken from the node name (excluding the unit address).
3664185220SRafał Miłecki
3764185220SRafał Miłecki  read-only:
3864185220SRafał Miłecki    description: This parameter, if present, is a hint that this partition
3964185220SRafał Miłecki      should only be mounted read-only. This is usually used for flash
4064185220SRafał Miłecki      partitions containing early-boot firmware images or data which should
4164185220SRafał Miłecki      not be clobbered.
4264185220SRafał Miłecki    type: boolean
4364185220SRafał Miłecki
4464185220SRafał Miłecki  lock:
4564185220SRafał Miłecki    description: Do not unlock the partition at initialization time (not
4664185220SRafał Miłecki      supported on all devices)
4764185220SRafał Miłecki    type: boolean
4864185220SRafał Miłecki
4964185220SRafał Miłecki  slc-mode:
5064185220SRafał Miłecki    description: This parameter, if present, allows one to emulate SLC mode
5164185220SRafał Miłecki      on a partition attached to an MLC NAND thus making this partition
5264185220SRafał Miłecki      immune to paired-pages corruptions
5364185220SRafał Miłecki    type: boolean
5464185220SRafał Miłecki
55*118f3fbeSChristian Marangiif:
56*118f3fbeSChristian Marangi  not:
57*118f3fbeSChristian Marangi    required: [ reg ]
58*118f3fbeSChristian Marangithen:
59*118f3fbeSChristian Marangi  properties:
60*118f3fbeSChristian Marangi    $nodename:
61*118f3fbeSChristian Marangi      pattern: '^partition-.*$'
6264185220SRafał Miłecki
6364185220SRafał MiłeckiadditionalProperties: true
64