Documentation/devicetree/bindings/mtd/partitions/redboot-fis.yaml

   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
   7 title: RedBoot FLASH Image System (FIS) Partitions
   8
   9 description: 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
  16 maintainers:
  17   - Linus Walleij <linus.walleij@linaro.org>
  18
  19 properties:
  20   compatible:
  21     const: redboot-fis
  22
  23   fis-index-block:
  24     $ref: /schemas/types.yaml#/definitions/uint32
  25     description: a index to the eraseblock containing the FIS directory on this
  26       device. On a flash memory with 32KB eraseblocks, 0 means the first
  27       eraseblock at 0x00000000, 1 means the second eraseblock at 0x00008000 and so on.
  28
  29 required:
  30   - compatible
  31   - fis-index-block
  32
  33 additionalProperties: false
  34
  35 examples:
  36   - |
  37     flash {
  38       partitions {
  39         compatible = "redboot-fis";
  40         fis-index-block = <0>;
  41       };
  42     };