binman: Record the parent section of each section
[oweals/u-boot.git] / tools / binman / etype / u_boot_dtb.py
index 1122c9581023fba14888c487f30f5797b54ff12b..6263c4ebee31d4f069433f69fe83ff66478ec02d 100644 (file)
@@ -1,17 +1,28 @@
+# SPDX-License-Identifier: GPL-2.0+
 # Copyright (c) 2016 Google, Inc
 # Written by Simon Glass <sjg@chromium.org>
 #
-# SPDX-License-Identifier:      GPL-2.0+
-#
 # Entry-type module for U-Boot device tree
 #
 
 from entry import Entry
-from blob import Entry_blob
+from blob_dtb import Entry_blob_dtb
+
+class Entry_u_boot_dtb(Entry_blob_dtb):
+    """U-Boot device tree
+
+    Properties / Entry arguments:
+        - filename: Filename of u-boot.dtb (default 'u-boot.dtb')
+
+    This is the U-Boot device tree, containing configuration information for
+    U-Boot. U-Boot needs this to know what devices are present and which drivers
+    to activate.
 
-class Entry_u_boot_dtb(Entry_blob):
-    def __init__(self, image, etype, node):
-        Entry_blob.__init__(self, image, etype, node)
+    Note: This is mostly an internal entry type, used by others. This allows
+    binman to know which entries contain a device tree.
+    """
+    def __init__(self, section, etype, node):
+        Entry_blob_dtb.__init__(self, section, etype, node)
 
     def GetDefaultFilename(self):
         return 'u-boot.dtb'