doc: FIT image: clarify usage of "compression" property
authorSimon Goldschmidt <sgoldschmidt@de.pepperl-fuchs.com>
Mon, 30 Jul 2018 10:53:18 +0000 (12:53 +0200)
committerTom Rini <trini@konsulko.com>
Fri, 10 Aug 2018 17:45:33 +0000 (13:45 -0400)
Compressed images should have their compression property
set to "none" if U-Boot should leave them compressed.

This is especially the case for compressed ramdisks that
should be uncompressed by the kernel only.

Signed-off-by: Simon Goldschmidt <sgoldschmidt@de.pepperl-fuchs.com>
doc/uImage.FIT/source_file_format.txt

index d2793a195dcfc904f176ce2fe38287a5f22191b2..d701b9bb760999af228658fd9d0b9a2fdc4fbe33 100644 (file)
@@ -164,7 +164,9 @@ the '/images' node should have the following layout:
   - data : Path to the external file which contains this node's binary data.
   - compression : Compression used by included data. Supported compressions
     are "gzip" and "bzip2". If no compression is used compression property
-    should be set to "none".
+    should be set to "none". If the data is compressed but it should not be
+    uncompressed by U-Boot (e.g. compressed ramdisk), this should also be set
+    to "none".
 
   Conditionally mandatory property:
   - os : OS name, mandatory for types "kernel" and "ramdisk". Valid OS names