xref: /freebsd/sys/contrib/device-tree/Bindings/mtd/partitions/partition.yaml (revision e1e636193db45630c7881246d25902e57c43d24e)
1# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/mtd/partitions/partition.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Partition
8
9description: |
10  This binding describes a single flash partition. Each partition must have its
11  relative offset and size specified. Depending on partition function extra
12  properties can be used.
13
14  A partition may be dynamically allocated by a specific parser at runtime.
15  In this specific case, a specific suffix is required to the node name.
16  Everything after 'partition-' will be used as the partition name to compare
17  with the one dynamically allocated by the specific parser.
18  If the partition contains invalid char a label can be provided that will
19  be used instead of the node name to make the comparison.
20  This is used to assign an OF node to the dynamiccally allocated partition
21  so that subsystem like NVMEM can provide an OF node and declare NVMEM cells.
22  The OF node will be assigned only if the partition label declared match the
23  one assigned by the parser at runtime.
24
25maintainers:
26  - Rafał Miłecki <rafal@milecki.pl>
27
28properties:
29  reg:
30    description: partition's offset and size within the flash
31    maxItems: 1
32
33  label:
34    description: The label / name for this partition. If omitted, the label
35      is taken from the node name (excluding the unit address).
36
37  read-only:
38    description: This parameter, if present, is a hint that this partition
39      should only be mounted read-only. This is usually used for flash
40      partitions containing early-boot firmware images or data which should
41      not be clobbered.
42    type: boolean
43
44  lock:
45    description: Do not unlock the partition at initialization time (not
46      supported on all devices)
47    type: boolean
48
49  slc-mode:
50    description: This parameter, if present, allows one to emulate SLC mode
51      on a partition attached to an MLC NAND thus making this partition
52      immune to paired-pages corruptions
53    type: boolean
54
55  linux,rootfs:
56    description: Marks partition that contains root filesystem to mount and boot
57      user space from
58    type: boolean
59
60if:
61  not:
62    required: [ reg ]
63then:
64  properties:
65    $nodename:
66      pattern: '^partition-.*$'
67
68# This is a generic file other binding inherit from and extend
69additionalProperties: true
70