Documentation/lib/flashmap.md

   1 # Flashmap and Flashmap Descriptor in coreboot
   2
   3 ## Flashmap
   4
   5 [Flashmap](https://code.google.com/p/flashmap) (FMAP) is a binary format to
   6 describe partitions in a flash chip. It was added to coreboot to support the
   7 requirements of Chromium OS firmware but then was also used in other scenarios
   8 where precise placement of data in flash was necessary, or for data that is
   9 written to at runtime, as CBFS is considered too fragile for such situations.
  10 The Flashmap implementation inside coreboot is the de facto standard today.
  11
  12 Flashmap partitions the image into clearly delimited sections and some of those
  13 sections may be CBFSes that can hold arbitrary-length files (at least one, the
  14 default CBFS, called `COREBOOT`). General guidance is that everything with
  15 strict layout requirements (e.g. must be aligned to erase blocks or
  16 something else) should have its own Flashmap section, and everything else should
  17 normally go into CBFS.
  18
  19 The Flashmap itself starts with a header `struct fmap` and followed by a list of
  20 section descriptions in `struct fmap_area`.
  21
  22 ### Header
  23 The header `struct fmap` has following fields:
  24 * `signature`: 8 characters as `"__FMAP__"`.
  25 * `ver_major`: one byte for major version (currently only 1).
  26 * `ver_minor`: one byte for minor version (current value is 1).
  27 * `base`: 64 bit integer for the address of the firmware binary.
  28 * `size`: 32 bit integer for the size of firmware binary in bytes.
  29 * `name`: 32 characters for the name of the firmware binary.
  30 * `nareas`: 16 bit integer for the number of area definitions (i.e., how many
  31   sections are in this firmware image) following the header.
  32
  33 ### Area Definition
  34 The section is defined by `struct fmap_area` with following fields:
  35 * `offset`: 32 bit integer for where the area starts (relative to `base` in
  36   header).
  37 * `size`: 32 bit integer for the size of area in bytes.
  38 * `name`: 32 characters for a descriptive name of this area. Should be unique to
  39   all sections inside same Flashmap.
  40 * `flags`: 16 bit integer for attributes of this area (see below).
  41
  42 ### Area Flags
  43 Currently the defined values for `flags` in `struct fmap_area` are:
  44 * `FMAP_AREA_PRESERVE`: suggesting the section should be preserved when
  45   updating firmware, usually for product data like serial number, MAC address,
  46   or calibration and cache data.
  47 * `FMAP_AREA_STATIC`: Not really used today.
  48 * `FMAP_AREA_COMPRESSED`: Not really used today.
  49 * `FMAP_AREA_RO`: Not really used today.
  50
  51 ### FMAP section
  52 The whole Flashmap (`struct fmap` and list of `struct fmap_area`) should be
  53 stored in a standalone section named as `FMAP` (which should be also described
  54 by the Flashmap itself in `struct fmap_area`). There's no restriction for where
  55 it should be located (or how large), but usually we need to do a linear or
  56 binary search on whole firmware binary image to find Flashmap so a properly
  57 aligned address would be better.
  58
  59 ### COREBOOT section
  60 coreboot firmware images (`coreboot.rom`) should have at least one Flashmap
  61 section that is reserved for CBFS. Usually it is named as `COREBOOT`.
  62
  63 ## Flashmap Descriptor
  64
  65 Since coreboot is starting to use a "partition" of Flashmap to describe the
  66 flash chip layout (both at runtime and when flashing a new image onto a
  67 chip), the project needs a reasonably expressive plain text format for
  68 representing such sections in the source tree.
  69
  70 Flashmap Descriptor (FMD) is a [language and
  71 compiler](https://chromium-review.googlesource.com/#/c/255031) inside coreboot
  72 utility folder that can be used to generate final firmware images (i.e.
  73 `coreboot.rom`) formatted by Flashmap.
  74
  75 The FMD implementation is in coreboot `utils/cbfstool` folder. Here's an
  76 informal language description:
  77
  78 ```
  79 # <line comment>
  80 <image name>[@<memory-mapped address>] <image size> {
  81     <section name>[(flags)][@<offset from start of image>] [<section size>] [{
  82         <subsection name>[@<offset from start of parent section>] [<subsection size>] [{
  83             # Sections can be nested as deeply as desired
  84             <subsubsection name>[(flags)][@...] [...] [{...}]
  85         }]
  86         [<subsection name>[(flags)][@...] [...] [{...}]]
  87         # There can be many subsections at each level of nesting: they will be inserted
  88         # sequentially, and although gaps are allowed, any provided offsets are always
  89         # relative to the closest parent node's and must be strictly increasing with neither
  90         # overlapping nor degenerate-size sections.
  91     }]
  92 }
  93 ```
  94
  95 Note that the above example contains a few symbols that are actually meta
  96 syntax, and therefore have neither meaning nor place in a real file. The `<.*>`s
  97 indicate placeholders for parameters:
  98
  99 * The names are strings, which are provided as single-word (no white space)
 100   groups of syntactically unimportant symbols (i.e. every thing except `@`, `{`,
 101   and `}`): they are not surrounded by quotes or any other form of delimiter.
 102 * The other fields are non-negative integers, which may be given as decimal or
 103   hexadecimal; in either case, a `K`, `M`, or `G` may be appended (without
 104   intermediate white space) as a multiplier.
 105 * Comments consist of anything one manages to enter, provided it doesn't start a
 106   new line.
 107
 108 The `[.*]`s indicate that a portion of the file could be omitted altogether:
 109
 110 * Just because something is noted as optional doesn't mean it is in every case:
 111   the answer might actually depend on which other information is---or
 112   isn't---provided.
 113 * The "flag" specifies the attribute or type for given section. The most
 114   important supported flag is "CBFS", which indicates the section will contain
 115   a CBFS structure.
 116 * In particular, it is only legal to place a (CBFS) flag on a leaf section; that
 117   is, choosing to add child sections excludes the possibility of putting a CBFS
 118   in their parent. Such flags are only used to decide where CBFS empty file
 119   headers should be created, and do not result in the storage of any additional
 120   metadata in the resulting FMAP section.
 121
 122 Additionally, it's important to note these properties of the overall file and
 123 its values:
 124
 125 * Other than within would-be strings and numbers, white space is ignored. It
 126   goes without saying that such power comes with responsibility, which is why
 127   this sentence is here.
 128 * Although the `section name` must be globally unique, one of them may (but is
 129   not required to) match the image name.
 130 * It is a syntax error to supply a number (besides 0) that begins with the
 131   character `0`, as there is no intention of adding octals to the mix.
 132 * The image's memory address should be present on (and only on) layouts for
 133   memory-mapped chips.
 134 * Although it may be evident from above, all `section` offsets are relative only
 135   to the immediate parent. There is no way to include an absolute offset (i.e.
 136   from the beginning of flash), which means that it is "safe" to reorder the
 137   sections within a particular level of nesting, as long as the change doesn't
 138   cause their positions and sizes to necessitate overlap or zero sizes.
 139 * A `section` with omitted offset is assumed to start at as low a position as
 140   possible (with no consideration of alignment) and one with omitted size is
 141   assumed to fill the remaining space until the next sibling or before the end
 142   of its parent.
 143 * It's fine to omit any `section`'s offset, size, or both, provided its position
 144   and size are still unambiguous in the context of its *sibling* sections and
 145   its parent's *size*. In particular, knowledge of one .*section 's children or
 146   the `section`s' common parent's siblings will not be used for this purpose.
 147 * Although `section`s are not required to have children, the flash chip as a
 148   whole must have at least one.
 149 * Though the braces after `section`s may be omitted for those that have no
 150   children, if they are present, they must contain at least one child.
 151
 152 To see the formal description of the language, please refer to the Lex and Yacc
 153 files: `fmd_scanner.l` and `fmd_scanner.y`.