diff options
Diffstat (limited to 'util/cbfstool/README.fmaptool')
| -rw-r--r-- | util/cbfstool/README.fmaptool | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/util/cbfstool/README.fmaptool b/util/cbfstool/README.fmaptool index f806c43d78..86fc3b2192 100644 --- a/util/cbfstool/README.fmaptool +++ b/util/cbfstool/README.fmaptool @@ -9,12 +9,12 @@ scanner, parser, semantic analyser, and flashmap converter. Here's an informal l # <line comment> <image name>[@<memory-mapped address>] <image size> { - <section name>[@<offset from start of image>] [<section size>] [{ + <section name>[(flags)][@<offset from start of image>] [<section size>] [{ <subsection name>[@<offset from start of parent section>] [<subsection size>] [{ # Sections can be nested as deeply as desired - <subsubsection name>[(CBFS)][@...] [...] [{...}] + <subsubsection name>[(flags)][@...] [...] [{...}] }] - [<subsection name>[(CBFS)][@...] [...] [{...}]] + [<subsection name>[(flags)][@...] [...] [{...}]] # There can be many subsections at each level of nesting: they will be inserted # sequentially, and although gaps are allowed, any provided offsets are always # relative to the closest parent node's and must be strictly increasing with neither @@ -33,9 +33,11 @@ neither meaning nor place in a real file. The <.*> s indicate placeholders for p The [.*] s indicate that a portion of the file could be omitted altogether: - Just because something is noted as optional doesn't mean it is in every case: the answer might actually depend on which other information is---or isn't---provided. - - In particular, it is only legal to place a (CBFS) annotation on a leaf section; that is, choosing + - The "flag" specifies the attribute or type for given section. The most + important supported flag is "CBFS", which indicates the section will contain a CBFS structure. + - In particular, it is only legal to place a (CBFS) flag on a leaf section; that is, choosing to add child sections excludes the possibility of putting a CBFS in their parent. Such - annotations are only used to decide where CBFS empty file headers should be created, and do not + flags are only used to decide where CBFS empty file headers should be created, and do not result in the storage of any additional metadata in the resulting FMAP section. Additionally, it's important to note these properties of the overall file and its values: - Other than within would-be strings and numbers, whitespace is ignored. It goes without saying |