scripts: sysfw_boardcfg_blob_creator: Add support for combining board configurations files

The sysfw data in the new Combined ROM image format should be a single
file containing all the four board configurations. Add support for
combining all the four board configurations.

Signed-off-by: Anand Balagopalakrishnan <anandb@ti.com>
Signed-off-by: Lokesh Vutla <lokeshvutla@ti.com>

2 files changed, 108 insertions, 0 deletions

diff --git a/Makefile b/Makefile
index 9ca6646ec..7ef72b49c 100644
--- a/Makefile
+++ b/Makefile
@@ -109,6 +109,7 @@ SOC_BIN_NAMES += $(SOURCES:%.c=%.bin)
 
 ITB ?= $(binroot)/sysfw-$(SOC)-$(CONFIG).itb
 ITS ?= $(soc_objroot)/$(basename $(notdir $(ITB))).its
+COMBINED_BRDCFG ?= $(soc_objroot)/combined-cfg.bin
 
 vpath %.itb $(soc_objroot)
 vpath %.bin $(soc_objroot)
@@ -172,6 +173,8 @@ sysfw.itb: $(ITB)
 
 soc_objs: $(SOC_OBJS)
 
+$(COMBINED_BRDCFG): $(SOC_BINS)
+        python3 ./scripts/sysfw_boardcfg_blob_creator.py -b $(soc_objroot)/board-cfg.bin -s $(soc_objroot)/sec-cfg.bin -p $(soc_objroot)/pm-cfg.bin -r $(soc_objroot)/rm-cfg.bin -o $@
 
 $(soc_objroot)/%.o: %.c
         $(CROSS_COMPILE)gcc $(CFLAGS) -c -o $@-pre-validated $<
diff --git a/scripts/sysfw_boardcfg_blob_creator.py b/scripts/sysfw_boardcfg_blob_creator.py
new file mode 100755
index 000000000..1f2fdc094
--- /dev/null
+++ b/scripts/sysfw_boardcfg_blob_creator.py
@@ -0,0 +1,105 @@
+#!/usr/bin/env python3
+import argparse
+import logging
+import os
+import struct
+import tempfile
+from shutil import copyfileobj
+from shutil import rmtree
+
+BOARDCFG = 0xB
+BOARDCFG_SEC = 0xD
+BOARDCFG_PM = 0xE
+BOARDCFG_RM = 0xC
+BOARDCFG_NUM_ELEMS = 4
+
+class BoardCfgDesc():
+    """Get board config descriptor for a given file """
+
+    fmt = '<HHHBB'
+    index = 0
+    offset = 0
+
+    def __init__(self, outfile, devgrp,
+                    sw_rev = 0,
+                    num_elems = BOARDCFG_NUM_ELEMS):
+        self.devgrp = devgrp
+        try:
+            self.fh = open(outfile, 'wb')
+            bytes = self.fh.write(struct.pack('<BB', num_elems, sw_rev))
+            self.offset += bytes
+            self.offset += 4 * struct.calcsize(self.fmt)
+            self.tmpdir = tempfile.mkdtemp()
+            descfile = os.path.join(self.tmpdir, "desc")
+            bcfgfile = os.path.join(self.tmpdir, "bcfg")
+            self.desc_fh = open(descfile, "wb+")
+            self.bcfg_fh = open(bcfgfile, "wb+")
+        except:
+            raise Exception("File Error")
+
+    def add_boardcfg(self, bcfgtype, bcfgfile):
+        with open(bcfgfile, 'rb') as bfh:
+            bcfg = bfh.read()
+            size = len(bcfg)
+            desc = struct.pack(self.fmt, bcfgtype, self.offset, size, self.devgrp, 0)
+            self.desc_fh.write(desc)
+            self.bcfg_fh.write(bcfg)
+            logging.debug("Packing boardcfg data of size [%d bytes] from file %s", size, bcfgfile)
+            self.offset += size
+            self.index += 1
+
+    def finalize(self):
+        try:
+            self.desc_fh.seek(0)
+            self.bcfg_fh.seek(0)
+            copyfileobj(self.desc_fh, self.fh)
+            copyfileobj(self.bcfg_fh, self.fh)
+        except:
+            logging.error("**** Error in finalizing boardcfg file ****")
+            raise Exception("File Error")
+        finally:
+            self.fh.close()
+            self.desc_fh.close()
+            self.bcfg_fh.close()
+            rmtree(self.tmpdir)
+
+def create_sysfw_blob(args):
+    """Create a SYSFW data blob to be used as a component in combined image """
+
+    if args.boardcfg is None or args.boardcfg_sec is None or args.boardcfg_pm is None or args.boardcfg_rm is None:
+        logging.error("**** All 4 boardcfg binaries need to be provided ****")
+        raise Exception("Insufficient arguments")
+
+    logging.info("#### Creating SYSFW data blob - %s ####", args.output_file.name)
+    logging.info("#### SW Rev = %d", args.sw_rev)
+    logging.info("#### Device Group = %d", args.devgrp)
+    logging.info("#### Board config binary - %s", args.boardcfg.name)
+    logging.info("#### Board config security binary - %s", args.boardcfg_sec.name)
+    logging.info("#### Board config PM binary - %s", args.boardcfg_pm.name)
+    logging.info("#### Board config RM binary - %s", args.boardcfg_rm.name)
+
+    blob = BoardCfgDesc(args.output_file.name, args.devgrp, args.sw_rev)
+    blob.add_boardcfg(BOARDCFG, args.boardcfg.name)
+    blob.add_boardcfg(BOARDCFG_SEC, args.boardcfg_sec.name)
+    blob.add_boardcfg(BOARDCFG_PM, args.boardcfg_pm.name)
+    blob.add_boardcfg(BOARDCFG_RM, args.boardcfg_rm.name)
+
+    blob.finalize()
+
+# options -> device, sw_rev, boardcfg, security boardcfg, pm boardcfg, rm boardcfg, output file
+
+# parser for mandatory arguments
+pp = argparse.ArgumentParser(add_help=False)
+pp.add_argument('-l', '--log-level', type=str, default="INFO", choices=["INFO", "DEBUG"])
+pp.add_argument('--sw-rev', type=int, default=0)
+pp.add_argument('-o', '--output-file', type=argparse.FileType('wb'), default="./sysfw-data.bin")
+pp.add_argument('-d', '--devgrp', type=int, default=0)
+pp.add_argument('-b', '--boardcfg', type=argparse.FileType('rb'))
+pp.add_argument('-s', '--boardcfg-sec', type=argparse.FileType('rb'))
+pp.add_argument('-p', '--boardcfg-pm', type=argparse.FileType('rb'))
+pp.add_argument('-r', '--boardcfg-rm', type=argparse.FileType('rb'))
+
+args = pp.parse_args()
+logging.getLogger().setLevel(args.log_level)
+logging.debug(args)
+create_sysfw_blob(args)