summaryrefslogtreecommitdiff
path: root/tools/binman/README.entries
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2018-07-17 13:25:39 -0600
committerSimon Glass <sjg@chromium.org>2018-08-01 16:30:48 -0600
commitec127af0429ad6f9818297f9c3ee77edb2154182 (patch)
tree4a4f1425abc9d36139844d53811dd8af7db653a0 /tools/binman/README.entries
parent11e36ccea174043229319263f9d0b5b7f7cca654 (diff)
binman: Add support for a cros_ec image
Add an entry type which can hold a Chrome OS EC. To make this work a new entry type is created, which supports getting a blob filename from the command line. Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'tools/binman/README.entries')
-rw-r--r--tools/binman/README.entries29
1 files changed, 29 insertions, 0 deletions
diff --git a/tools/binman/README.entries b/tools/binman/README.entries
index 0b3be69f5ea..147dd40bfff 100644
--- a/tools/binman/README.entries
+++ b/tools/binman/README.entries
@@ -26,6 +26,35 @@ example the 'u_boot' entry which provides the filename 'u-boot.bin'.
+Entry: blob-named-by-arg: A blob entry which gets its filename property from its subclass
+-----------------------------------------------------------------------------------------
+
+Properties / Entry arguments:
+ - <xxx>-path: Filename containing the contents of this entry (optional,
+ defaults to 0)
+
+where <xxx> is the blob_fname argument to the constructor.
+
+This entry cannot be used directly. Instead, it is used as a parent class
+for another entry, which defined blob_fname. This parameter is used to
+set the entry-arg or property containing the filename. The entry-arg or
+property is in turn used to set the actual filename.
+
+See cros_ec_rw for an example of this.
+
+
+
+Entry: cros-ec-rw: A blob entry which contains a Chromium OS read-write EC image
+--------------------------------------------------------------------------------
+
+Properties / Entry arguments:
+ - cros-ec-rw-path: Filename containing the EC image
+
+This entry holds a Chromium OS EC (embedded controller) image, for use in
+updating the EC on startup via software sync.
+
+
+
Entry: fmap: An entry which contains an Fmap section
----------------------------------------------------