xref: /freebsd/sys/contrib/device-tree/Bindings/mtd/partitions/redboot-fis.yaml (revision fe75646a0234a261c0013bf1840fdac4acaf0cec)
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/redboot-fis.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: RedBoot FLASH Image System (FIS) Partitions
8
9description: The FLASH Image System (FIS) directory is a flash description
10    format closely associated with the RedBoot boot loader.
11    It uses one single flash eraseblock in the flash to store an index of
12    all images in the flash.
13    This block size will vary depending on flash but is typically
14    32 KB in size.
15
16maintainers:
17  - Linus Walleij <linus.walleij@linaro.org>
18
19select: false
20
21properties:
22  compatible:
23    const: redboot-fis
24
25  fis-index-block:
26    $ref: /schemas/types.yaml#/definitions/uint32
27    description: a index to the eraseblock containing the FIS directory on this
28      device. On a flash memory with 32KB eraseblocks, 0 means the first
29      eraseblock at 0x00000000, 1 means the second eraseblock at 0x00008000 and so on.
30
31  '#address-cells': false
32
33  '#size-cells': false
34
35required:
36  - compatible
37  - fis-index-block
38
39additionalProperties: false
40
41examples:
42  - |
43    flash {
44      partitions {
45        compatible = "redboot-fis";
46        fis-index-block = <0>;
47      };
48    };
49