[PATCH v2 14/17] binman: add a new entry type for packing DDR PHY firmware images

[Alice Guo]

From: Alice Guo <alice.guo at nxp.com>

i.MX95 needs to combine DDR PHY firmware images and their byte counts
together, so add a new entry type nxp-append-ddrfw for this requirement.

Signed-off-by: Alice Guo <alice.guo at nxp.com>
---
 tools/binman/entries.rst               | 14 ++++++
 tools/binman/etype/nxp_append_ddrfw.py | 78 ++++++++++++++++++++++++++++++++++
 2 files changed, 92 insertions(+)

diff --git a/tools/binman/entries.rst b/tools/binman/entries.rst
index 83068ba6d39d9a5b586312fd4a062b0da31eb595..061bd2f1da9812d36c90b1fb10a919667e36ceaa 100644
--- a/tools/binman/entries.rst
+++ b/tools/binman/entries.rst
@@ -1658,6 +1658,20 @@ Properties / Entry arguments:
 
 
 
+.. _etype_nxp_append_ddrfw:
+
+Entry: nxp-append-ddrfw: pack NXP LPDDR firmware
+---------------------------------------------------
+
+Properties / Entry arguments:
+    - oei_m33_ddr_image - M33 DDR IMAGE
+    - lpddr_imem - Synopsys LPDDR PHY firmware
+    - lpddr_dmem - Synopsys LPDDR PHY firmware
+    - lpddr_imem_qb - Synopsys LPDDR quick boot firmware
+    - lpddr_dmem_qb - Synopsys LPDDR quick boot firmware
+
+
+
 .. _etype_opensbi:
 
 Entry: opensbi: RISC-V OpenSBI fw_dynamic blob
diff --git a/tools/binman/etype/nxp_append_ddrfw.py b/tools/binman/etype/nxp_append_ddrfw.py
new file mode 100644
index 0000000000000000000000000000000000000000..bc23a7611eaf823651a8fcbc9898c9140c277d7f
--- /dev/null
+++ b/tools/binman/etype/nxp_append_ddrfw.py
@@ -0,0 +1,78 @@
+# SPDX-License-Identifier: GPL-2.0+
+#
+# Copyright 2024 NXP
+
+from binman.etype.section import Entry_section
+from dtoc import fdt_util
+import os
+
+class Entry_nxp_append_ddrfw(Entry_section):
+    """NXP M33 OEI DDRFW
+
+    Properties / Entry arguments:
+        - oei_m33_ddr_image: M33 DDR IMAGE
+        - lpddr_imem: Synopsys LPDDR PHY firmware
+        - lpddr_dmem: Synopsys LPDDR PHY firmware
+        - lpddr_imem_qb: Synopsys LPDDR quick boot firmware
+        - lpddr_dmem_qb: Synopsys LPDDR quick boot firmware
+    """
+
+    def __init__(self, section, etype, node):
+        super().__init__(section, etype, node)
+        self.required_props = ['oei_m33_ddr_image', 'lpddr_imem', 'lpddr_dmem',
+                               'lpddr_imem_qb', 'lpddr_dmem_qb']
+
+    def ReadNode(self):
+        super().ReadNode()
+        self.oei_m33_ddr_image = fdt_util.GetString(self._node, 'oei_m33_ddr_image')
+        self.lpddr_imem = fdt_util.GetString(self._node, 'lpddr_imem')
+        self.lpddr_dmem = fdt_util.GetString(self._node, 'lpddr_dmem')
+        self.lpddr_imem_qb = fdt_util.GetString(self._node, 'lpddr_imem_qb')
+        self.lpddr_dmem_qb = fdt_util.GetString(self._node, 'lpddr_dmem_qb')
+        self.ReadEntries()
+
+    def BuildSectionData(self, required):
+        u_boot_path = os.path.abspath('.')
+
+        oei_m33_ddr_image_path = os.path.join(u_boot_path, self.oei_m33_ddr_image)
+        lpddr_imem_path = os.path.join(u_boot_path, self.lpddr_imem)
+        lpddr_dmem_path = os.path.join(u_boot_path, self.lpddr_dmem)
+        lpddr_imem_qb_path = os.path.join(u_boot_path, self.lpddr_imem_qb)
+        lpddr_dmem_qb_path = os.path.join(u_boot_path, self.lpddr_dmem_qb)
+
+        if (not (os.path.exists(oei_m33_ddr_image_path) and
+            os.path.exists(lpddr_imem_path) and os.path.exists(lpddr_dmem_path) and
+            os.path.exists(lpddr_imem_qb_path) and os.path.exists(lpddr_dmem_qb_path))):
+            print("Please check if there are any external blobs that do not exist.")
+            return b''
+
+        lpddr_imem_size = os.path.getsize(lpddr_imem_path)
+        lpddr_dmem_size = os.path.getsize(lpddr_dmem_path)
+        lpddr_imem_qb_size = os.path.getsize(lpddr_imem_qb_path)
+        lpddr_dmem_qb_size = os.path.getsize(lpddr_dmem_qb_path)
+
+        with open(oei_m33_ddr_image_path, 'rb') as file:
+            oei_m33_ddr_image = file.read()
+
+        length = len(oei_m33_ddr_image)
+        if (length % 4 != 0):
+            oei_m33_ddr_image += bytes(4 - length % 4)
+
+        fw_header = lpddr_imem_size.to_bytes(4, 'little') + lpddr_dmem_size.to_bytes(4, 'little')
+        with open(lpddr_imem_path, 'rb') as file:
+            lpddr_imem = file.read()
+        with open(lpddr_dmem_path, 'rb') as file:
+            lpddr_dmem = file.read()
+
+        fw_header_qb = lpddr_imem_qb_size.to_bytes(4, 'little') + lpddr_dmem_qb_size.to_bytes(4, 'little')
+        with open(lpddr_imem_qb_path, 'rb') as file:
+            lpddr_imem_qb = file.read()
+        with open(lpddr_dmem_qb_path, 'rb') as file:
+            lpddr_dmem_qb = file.read()
+
+        data = oei_m33_ddr_image + fw_header + lpddr_imem + lpddr_dmem + fw_header_qb + lpddr_imem_qb + lpddr_dmem_qb
+        length = len(data)
+        if (length % 8 != 0):
+            data += bytes(8 - length % 8)
+
+        return data

-- 
2.34.1