From 822c72791f791d26e233df0c15a655c3dbd8b117 Mon Sep 17 00:00:00 2001
From: J-Alves <joao.alves@arm.com>
Date: Tue, 22 Mar 2022 16:28:51 +0000
Subject: [PATCH] feat(sptool): use python version of sptool

Change-Id: I567ef0b977c69c38323740a592dd9451e261a407
Signed-off-by: J-Alves <joao.alves@arm.com>
---
 .gitignore                      |  1 +
 Makefile                        |  5 ++---
 tools/sptool/sp_mk_generator.py | 30 +++++++++++++++++++++---------
 3 files changed, 24 insertions(+), 12 deletions(-)

diff --git a/.gitignore b/.gitignore
index f52465811..3b0a5ce63 100644
--- a/.gitignore
+++ b/.gitignore
@@ -32,6 +32,7 @@ tools/stm32image/stm32image
 tools/stm32image/stm32image.exe
 tools/sptool/sptool
 tools/sptool/sptool.exe
+tools/sptool/__pycache__/
 
 # GNU GLOBAL files
 GPATH
diff --git a/Makefile b/Makefile
index 0f045e541..ac4624fb1 100644
--- a/Makefile
+++ b/Makefile
@@ -918,7 +918,7 @@ FIPTOOL			?=	${FIPTOOLPATH}/fiptool${BIN_EXT}
 
 # Variables for use with sptool
 SPTOOLPATH		?=	tools/sptool
-SPTOOL			?=	${SPTOOLPATH}/sptool${BIN_EXT}
+SPTOOL			?=	${SPTOOLPATH}/sptool.py
 SP_MK_GEN		?=	${SPTOOLPATH}/sp_mk_generator.py
 
 # Variables for use with ROMLIB
@@ -1336,8 +1336,7 @@ endif
 ifeq (${NEED_SP_PKG},yes)
 $(BUILD_PLAT)/sp_gen.mk: ${SP_MK_GEN} ${SP_LAYOUT_FILE} | ${BUILD_PLAT}
 	${Q}${PYTHON} "$<" "$@" $(filter-out $<,$^) $(BUILD_PLAT) ${COT}
-sp: $(SPTOOL) $(DTBS) $(BUILD_PLAT)/sp_gen.mk
-	${Q}$(SPTOOL) $(SPTOOL_ARGS)
+sp: $(DTBS) $(BUILD_PLAT)/sp_gen.mk $(SP_PKGS)
 	@${ECHO_BLANK_LINE}
 	@echo "Built SP Images successfully"
 	@${ECHO_BLANK_LINE}
diff --git a/tools/sptool/sp_mk_generator.py b/tools/sptool/sp_mk_generator.py
index 2cc96cb21..f4045d340 100644
--- a/tools/sptool/sp_mk_generator.py
+++ b/tools/sptool/sp_mk_generator.py
@@ -46,7 +46,6 @@ A typical SP_LAYOUT_FILE file will look like
 }
 
 """
-
 import json
 import os
 import re
@@ -59,7 +58,6 @@ UUID_LEN = 4
 
 # Some helper functions to access args propagated to the action functions in
 # SpSetupActions framework.
-
 def check_sp_mk_gen(args :dict):
     if "sp_gen_mk" not in args.keys():
         raise Exception(f"Path to file sp_gen.mk needs to be in 'args'.")
@@ -129,15 +127,29 @@ def gen_fdt_sources(sp_layout, sp, args :dict):
     return args
 
 @SpSetupActions.sp_action
-def gen_sptool_args(sp_layout, sp, args):
-    ''' Generate sptool arguments to generate SP Pkg for a given SP. '''
-    check_out_dir(args)
-    check_sp_layout_dir(args)
+def gen_sptool_args(sp_layout, sp, args :dict):
+    ''' Generate Sp Pkgs rules. '''
     sp_pkg = get_sp_pkg(sp, args)
-    sp_dtb_name = os.path.basename(sp_layout[sp]["pm"])[:-1] + "b"
+    sp_dtb_name = os.path.basename(get_file_from_layout(sp_layout[sp]["pm"]))[:-1] + "b"
     sp_dtb = os.path.join(args["out_dir"], f"fdts/{sp_dtb_name}")
-    sp_bin = os.path.join(args["sp_layout_dir"], sp_layout[sp]["image"])
-    write_to_sp_mk_gen(f"SPTOOL_ARGS += -i {sp_bin}:{sp_dtb} -o {sp_pkg}\n", args)
+
+    # Do not generate rule if already there.
+    if is_line_in_sp_gen(f'{sp_pkg}:', args):
+        return args
+    write_to_sp_mk_gen(f"SP_PKGS += {sp_pkg}\n", args)
+
+    sptool_args = f" -i {get_sp_img_full_path(sp_layout[sp], args)}:{sp_dtb}"
+    pm_offset = get_pm_offset(sp_layout[sp])
+    sptool_args += f" --pm-offset {pm_offset}" if pm_offset is not None else ""
+    image_offset = get_image_offset(sp_layout[sp])
+    sptool_args += f" --img-offset {image_offset}" if image_offset is not None else ""
+    sptool_args += f" -o {sp_pkg}"
+    sppkg_rule = f'''
+{sp_pkg}:
+\t$(Q)echo Generating {sp_pkg}
+\t$(Q)$(PYTHON) $(SPTOOL) {sptool_args}
+'''
+    write_to_sp_mk_gen(sppkg_rule, args)
     return args
 
 @SpSetupActions.sp_action(global_action=True, exec_order=1)