toolkit: Allow tools to run from any location.

Signed-off-by: Damien George <[email protected]>

Author: dpgeorge

toolkit/app-gen-toc.py

@@ -22,14 +22,26 @@
 from pathlib import Path
 import zlib
 import json
-from utils import toc_common
-from utils.config import *
-from utils.toc_common import *
-from json.decoder import JSONDecodeError
+import utils
+from utils.config import load_global_config, read_global_config
 from utils.device_config import gen_device_config
 from utils.sign_image_util import sign_image
-from printInfo import *
-from utils.gen_fw_cfg import *
+from utils.printInfo import printInfo, verboseModeSet
+from utils import paths
+from utils.toc_common import (
+    addContentCertificate,
+    cleanBuild,
+    compressImage,
+    createContentCerts,
+    getBlob,
+    getCPUID,
+    getImageSize,
+    getObjectFlags,
+    getObjectType,
+    getObjectVersion,
+    read_json_file,
+    validateOptions,
+)
 
 # Define Version constant for each separate tool
 # 0.30.000      includes image signing
@@ -80,9 +92,6 @@
 cpuid_switcher = {"A32_0": 0, "A32_1": 1, "M55_HP": 2, "M55_HE": 3}
 
 
-certPath = Path("cert/")
-imagePath = Path("build/images")
-
 # sizes of Certificates
 CERT_CHAIN_SIZE = utils.toc_common.CERT_CHAIN_SIZE
 CONT_CERT_SIZE = utils.toc_common.CONT_CERT_SIZE
@@ -102,6 +111,8 @@ def createOemTocPackage(fwsections, outputFile):
     global otocStartAddress
     global unmanaged
 
+    certPath = paths.CERT_INPUT_DIR
+
     print("Creating APP TOC Package...")
     # Start by loading the Key1/Key2 Certificates for later on
     printInfo("Loading Key1 Cert...")
@@ -113,7 +124,7 @@ def createOemTocPackage(fwsections, outputFile):
     outf = open(outputFile, "wb")
 
     # create a memory layout map for debugging
-    mapf = open("build/app-package-map.txt", "w")
+    mapf = open(paths.OUTPUT_DIR / "app-package-map.txt", "w")
     mapf.write("* * * User managed MRAM locations* * * \n")
 
     debugScript = ""
@@ -128,8 +139,8 @@ def createOemTocPackage(fwsections, outputFile):
 
         printInfo(img)
         mapf.write(f"{img[1]}\t{hex(img[2])}\t{img[2]}\t{img[3]}\t{imgFile}\n")
-        debugScript += "../build/images/" + imgFile + " " + img[1] + " "
-        sign_image("build/images/" + imgFile, int(img[1], 16), 0xFFFFFFFF, "OEM")
+        debugScript += imgFile + " " + img[1] + " "
+        sign_image(imgFile, int(img[1], 16), 0xFFFFFFFF, "OEM")
 
     # create a pointer to keep track addresses of components (object_address in OTOC)
     mPointer = oemManagedAreaStartAddress
@@ -161,7 +172,9 @@ def createOemTocPackage(fwsections, outputFile):
             mPointer += CERT_CHAIN_SIZE - CONT_CERT_SIZE
             # print(f'mPointer KC un: {mPointer - oemManagedAreaStartAddress}')
         # copy the Content Certificate (for signed or unsigned images)
-        addContentCertificate(outf, sec["binary"] + "_" + str(sec["mramAddress"]))
+        addContentCertificate(
+            outf, os.path.basename(sec["binary"]) + "_" + str(sec["mramAddress"])
+        )
         # mapf.write(f"{hostAddress(mPointer)}\t{hex(CONT_CERT_SIZE)}\t{(CONT_CERT_SIZE)}\tSB" + sec['binary'] + ".crt\n")
         mapf.write(
             f"{hex(mPointer)}\t{hex(CONT_CERT_SIZE)}\t{(CONT_CERT_SIZE)}\tSB"
@@ -198,7 +211,9 @@ def createOemTocPackage(fwsections, outputFile):
             mPointer += CERT_CHAIN_SIZE - CONT_CERT_SIZE
             # print(f'mPointer - KCs: {mPointer - oemManagedAreaStartAddress}')
         # copy the Content Certificate (for signed or unsigned images)
-        addContentCertificate(outf, sec["binary"] + "_" + str(sec["mramAddress"]))
+        addContentCertificate(
+            outf, os.path.basename(sec["binary"]) + "_" + str(sec["mramAddress"])
+        )
         # mapf.write(f"{hostAddress(mPointer)}\t{hex(CONT_CERT_SIZE)}\t{(CONT_CERT_SIZE)}\tSB" + sec['binary'] + ".crt\n")
         mapf.write(
             f"{hex(mPointer)}\t{hex(CONT_CERT_SIZE)}\t{(CONT_CERT_SIZE)}\tSB"
@@ -216,7 +231,7 @@ def createOemTocPackage(fwsections, outputFile):
             binFile += ".lzf"
 
         # print("Copying: " + binFile)
-        outf.write(getBlob(imagePath / binFile))
+        outf.write(getBlob(binFile))
         # mapf.write(f"{hostAddress(mPointer)}\t{hex(sec['size'])}\t{sec['size']}\t" + binFile + "\n")
         mapf.write(
             f"{hex(mPointer)}\t{hex(sec['size'])}\t{sec['size']}\t" + binFile + "\n"
@@ -358,15 +373,15 @@ def createOemTocPackage(fwsections, outputFile):
 
     mapf.write("\n* * * END of APP Package * * * \n")
 
-    debugScript += "../" + outputFile + " " + hex(oemManagedAreaStartAddress)
+    debugScript += outputFile + " " + hex(oemManagedAreaStartAddress)
 
     # close the file
     outf.close()
 
     mapf.close()
 
     # generate debug script file
-    dsFile = "bin/application_package.ds"  # Was bin/oempackage.ds
+    dsFile = paths.OUTPUT_DIR / "application_package.ds"  # Was bin/oempackage.ds
     try:
         ds = open(dsFile, "w")
         # f.write('reset system\n')
@@ -410,7 +425,7 @@ def calcOemManagedArea(fwsections):
         numImages += 1
 
         # determine the size of file and if padding is needed
-        fsize, padlen = getImageSize("build/images/" + sec["binary"])
+        fsize, padlen = getImageSize(sec["binary"])
         # update the size and padding information
         sec["size"] = fsize
         sec["padlen"] = padlen
@@ -420,11 +435,11 @@ def calcOemManagedArea(fwsections):
         compressLabel = "uncompressed"
         if "COMPRESS" in sec["flags"]:
             compressLabel = "compressed"
-            compressImage("build/images/" + sec["binary"])
+            compressImage(sec["binary"])
             # we should have the (new) compressed file, so we will check if this is the case...
 
             # determine the size of (compressed) file and if padding is needed
-            fsize, padlen = getImageSize("build/images/" + sec["binary"] + ".lzf")
+            fsize, padlen = getImageSize(sec["binary"] + ".lzf")
             # add compressed file size and update padding information
             # (the compressed image will be included in the package so pad should be calculated for
             # compressed file size)
@@ -601,16 +616,25 @@ def validateVersAttr(version):
 
 
 def updateDeviceConfig(file):
+    file = paths.CONFIG_INPUT_DIR / file
     # print('*** updateDeviceConfig: ', file)
     # Update the firewall configuration in the OEM DEVICE config file
-    update_fw_cfg_oem(file)
+    # This doesn't do anything except format the json file.
+    # update_fw_cfg_oem(file)
 
-    cfg = read_global_config("build/config/" + file)
+    cfg = read_global_config(file)
     if "miscellaneous" in cfg:
+        unwanted_item = False
         for item in cfg["miscellaneous"]:
-            item.pop("sdesc", None)
-            item.pop("ldesc", None)
-            item.pop("options", None)
+            if "sdesc" in item or "ldesc" in item or "options" in item:
+                unwanted_item = True
+        if unwanted_item:
+            print(
+                "[ERROR] File '" + file + "' should not contain 'miscellaneous' entry"
+            )
+            sys.exit(EXIT_WITH_ERROR)
+    # Don't write out the json file, because it didn't change.
+    return
     with open("build/config/" + file, "w") as json_file:
         json.dump(cfg, json_file, indent=2)
 
@@ -658,9 +682,34 @@ def main():
         action="store_true",
     )
     parser.add_argument("-v", "--verbose", help="verbosity mode", action="store_true")
+    parser.add_argument(
+        "--config-dir",
+        type=str,
+        default="",
+        help="directory with configuration files",
+    )
+    parser.add_argument(
+        "--output-dir",
+        type=str,
+        default="",
+        help="directory to place output files",
+    )
+    parser.add_argument(
+        "--firmware-dir",
+        type=str,
+        default="",
+        help="directory contianing firmware files",
+    )
 
     args = parser.parse_args()
 
+    # Set paths given on command line.
+    paths.TOOLKIT_DIR = Path(os.path.dirname(__file__))
+    paths.CERT_INPUT_DIR = paths.TOOLKIT_DIR / "cert"
+    paths.CONFIG_INPUT_DIR = Path(args.config_dir)
+    paths.FIRMWARE_INPUT_DIR = Path(args.firmware_dir)
+    paths.OUTPUT_DIR = Path(args.output_dir)
+
     if args.version:
         print(TOOL_VERSION)
         sys.exit()
@@ -715,12 +764,15 @@ def main():
 
         # update the size and padding information
         if sec["identifier"].strip("\0") != "DEVICE":
+            sec["binary"] = (paths.FIRMWARE_INPUT_DIR / sec["binary"]).as_posix()
             continue
 
         print("Generating Device Configuration for: " + sec["binary"])
         updateDeviceConfig(sec["binary"])
         gen_device_config(sec["binary"], False)
-        sec["binary"] = sec["binary"][:-5] + ".bin"
+        sec["binary"] = (
+            (paths.OUTPUT_DIR / sec["binary"]).with_suffix(".bin").as_posix()
+        )
 
     #     also check unmanaged images (mramAddress != 0) are between boundaries (OEM_BASE_ADDRESS - only in Rev_A as in Rev_B will be 0)
     #     and images don't overlap... Also, advice is GAPs (big ones) exist - especially if tool can't create the layout...
@@ -746,7 +798,6 @@ def main():
 
     sign_image(args.output, oemManagedAreaStartAddress, 0xFFFFFFFF, "OEM")
 
-    print("Done!")
     return 0
 
 

toolkit/app-provision.py

@@ -14,7 +14,6 @@
 import signal
 import argparse
 
-sys.path.append("./isp")
 import subprocess
 from serialport import serialPort
 import utils.config

toolkit/app-secure-debug.py

@@ -14,7 +14,6 @@
 import signal
 import argparse
 
-sys.path.append("./isp")
 import subprocess
 from serialport import serialPort
 import utils.config

toolkit/app-write-mram.py

@@ -14,22 +14,29 @@
 
 import os
 import sys
-import signal
 import argparse
-from utils.discover import getValues, getJlinkSN
+from utils.discover import getJlinkSN
 import utils.config
-from utils.config import *
+from utils.config import load_global_config, getPartDescription
 from utils.user_validations import validateArgList
 
-sys.path.append("./isp")
-from serialport import serialPort
-from serialport import COM_BAUD_RATE_MAXIMUM
+from isp.serialport import serialPort
+from isp.serialport import COM_BAUD_RATE_MAXIMUM
+from utils.toc_common import globalToLocalAddress
 
 # import ispcommands
-from isp_core import *
-from isp_util import *
-import device_probe
-import pylink
+from isp.isp_core import (
+    CtrlCHandler,
+    isp_get_maintenance_status,
+    isp_mram_erase,
+    isp_reset,
+    isp_set_baud_rate,
+    isp_show_maintenance_mode,
+    isp_start,
+    isp_stop,
+)
+from isp.isp_util import put_target_in_maintenance_mode, burn_mram_isp
+from isp import device_probe
 import datetime
 # from array import array
 
@@ -132,13 +139,7 @@ def main():
     parser = argparse.ArgumentParser(
         description="NVM Burner for Application TOC Package"
     )
-    parser.add_argument(
-        "-d",
-        "--discover",
-        action="store_true",
-        default=False,
-        help="COM port discovery",
-    )
+    parser.add_argument("-d", "--device", type=str, help="serial port device")
     parser.add_argument("-b", "--baudrate", help="serial port baud rate", type=int)
     parser.add_argument(
         "-e",
@@ -267,11 +268,14 @@ def main():
                 print("[ERROR] erase arguments are empty")
                 sys.exit(EXIT_WITH_ERROR)
             argList += args.erase
-    elif args.images != "Application TOC Package":
-        argList = args.images
-    else:
-        dsFile = "bin/application_package.ds"
+    elif args.images == "Application TOC Package" or args.images.startswith("file:"):
+        if args.images.startswith("file:"):
+            dsFile = args.images.removeprefix("file:")
+        else:
+            dsFile = "bin/application_package.ds"
         argList = readImageList(dsFile)
+    else:
+        argList = args.images
 
     if args.skip:
         idx = argList.find("../build/AppTocPackage.bin 0x")
@@ -286,6 +290,8 @@ def main():
     print("[INFO]", action + argList)
 
     if method == "jtag" and not args.erase:  # erase via jtag not yet supported!
+        import pylink
+
         jlinkSN = getJlinkSN()
         if jlinkSN == -1:
             print("J-Link device not found!")
@@ -355,10 +361,12 @@ def main():
     handler = CtrlCHandler()
     isp = serialPort(baud_rate)  # Serial dabbling open up port.
 
+    """
     if args.discover:  # discover the COM ports if requested
         isp.discoverSerialPorts()
+    """
 
-    errorCode = isp.openSerial()
+    errorCode = isp.openSerial(args.device)
     if errorCode is False:
         print("[ERROR] isp openSerial failed for %s" % isp.getPort())
         sys.exit(EXIT_WITH_ERROR)

toolkit/isp/clock_decode.py

@@ -8,7 +8,7 @@
 # pylint: disable=unused-argument, invalid-name, consider-using-f-string
 import struct
 import ctypes
-from isp_print import isp_print_color
+from isp.isp_print import isp_print_color
 
 c_uint32 = ctypes.c_uint32
 

toolkit/isp/cpu_decode.py

@@ -7,9 +7,9 @@
 
 # pylint: disable=unused-argument, invalid-name, consider-using-f-string
 import struct
-from isp_print import isp_print_color
-from toc_decode import format_hex, format_cpu
-from toc_decode import TOC_IMAGE_CPU_LAST
+from isp.isp_print import isp_print_color
+from isp.toc_decode import format_hex, format_cpu
+from isp.toc_decode import TOC_IMAGE_CPU_LAST
 
 
 def display_cpu_info(message):