binman: Expand documentation for entries

[oweals/u-boot.git] / tools / binman / etype / intel_fsp.py

diff --git a/tools/binman/etype/intel_fsp.py b/tools/binman/etype/intel_fsp.py
index cb80a617c32fa39160ede109c723baa9a06467ea..00a78e7083221113ebf0ab7d48dffa63228d2993 100644 (file)
--- a/tools/binman/etype/intel_fsp.py
+++ b/tools/binman/etype/intel_fsp.py
@@ -9,5 +9,19 @@ from entry import Entry
 from blob import Entry_blob
 
 class Entry_intel_fsp(Entry_blob):
+    """Entry containing an Intel Firmware Support Package (FSP) file
+
+    Properties / Entry arguments:
+        - filename: Filename of file to read into entry
+
+    This file contains binary blobs which are used on some devices to make the
+    platform work. U-Boot executes this code since it is not possible to set up
+    the hardware using U-Boot open-source code. Documentation is typically not
+    available in sufficient detail to allow this.
+
+    An example filename is 'FSP/QUEENSBAY_FSP_GOLD_001_20-DECEMBER-2013.fd'
+
+    See README.x86 for information about x86 binary blobs.
+    """
     def __init__(self, section, etype, node):
         Entry_blob.__init__(self, section, etype, node)