programmer-core 1.0.29__py3-none-any.whl

programmer_core/full_flash_erase.py

@@ -0,0 +1,268 @@
+from os.path import join, isfile
+import logging
+import json
+import pathlib
+
+from flash_images_builder_core import (
+    PsramOption,
+    FIBUtility,
+)
+
+try:
+    from utility import (
+        ProgrammerUtility,
+        AUTHENTICATION_BYPASS_FILES_FOLDER_NAME,
+        ACTION_PARAMS,
+    )
+    from program_device import ProgramDevice
+except ImportError:
+    from .utility import (
+        ProgrammerUtility,
+        AUTHENTICATION_BYPASS_FILES_FOLDER_NAME,
+        ACTION_PARAMS,
+    )
+    from .program_device import ProgramDevice
+
+FULL_FLASH_ERASE_LOGGER = logging.getLogger("full-flash-erase")
+
+
+class FullFlashErase:
+    def __init__(
+        self,
+        interface_type,
+        serial_number,
+        flash_type,
+        activation_type,
+        signing_module,
+        device_type,
+        verbose,
+        programmer_artifacts_path,
+        fib_artifacts_path,
+        psram_type=PsramOption.NO_PSRAM.name,
+        enable_ota=False,
+        nvs_size=None,
+        key_storage_size=None,
+        vendor_specific_size=None,
+        bl2_size=None,
+        wsoc_size=None,
+        tclk_delay=4,
+        chunk_size=1085,
+    ):
+        self.device_type = device_type
+        self.interface_type = interface_type
+        self.serial_number = serial_number
+        self.flash_type = flash_type
+        self.verbose = verbose
+        self.enable_ota = enable_ota
+        self.psram_type = psram_type
+        self.activation_type = activation_type
+        self.signing_module = signing_module
+
+        self.tclk_delay = tclk_delay
+        self.chunk_size = chunk_size
+
+        self.nvs_size = nvs_size
+        self.key_storage_size = key_storage_size
+        self.vendor_specific_size = vendor_specific_size
+        self.bl2_size = bl2_size
+        self.wsoc_size = wsoc_size
+
+        self.prog_dir = programmer_artifacts_path
+        self.fib_dir = fib_artifacts_path
+        self.prog_utility = ProgrammerUtility(self.prog_dir, self.fib_dir)
+        self.fib_utility = FIBUtility(self.fib_dir)
+        self.tmp_folder = self.prog_utility.get_programming_tmp_folder()
+        self.jsons_dir_path = self.prog_utility.get_config_folder()
+        self.tool_settings_json_template = (
+            self.prog_utility.get_tool_settings_template()
+        )
+
+        self.updated_tool_settings_json = join(self.tmp_folder, "tool_settings.json")
+
+        self.action_request_json_template = (
+            self.prog_utility.get_action_params_template()
+        )
+
+        self.updated_action_request_json = join(self.tmp_folder, ACTION_PARAMS)
+
+        # Get limits for default values
+        limits = self.fib_utility.get_limits_by_flash_device_name(
+            self.flash_type, self.enable_ota
+        )
+
+        if self.nvs_size is None:
+            self.nvs_size = limits["protected_storage"]["nvsSize"]["default"]
+        if self.key_storage_size is None:
+            self.key_storage_size = limits["protected_storage"]["keyStorageSize"][
+                "default"
+            ]
+        if self.vendor_specific_size is None:
+            self.vendor_specific_size = limits["protected_storage"]["vendorSize"]["default"]
+        if self.bl2_size is None:
+            self.bl2_size = limits["ti_components"]["bl2_size"]["default"]
+        if self.wsoc_size is None:
+            self.wsoc_size = limits["ti_components"]["wsoc_size"]["default"]
+
+        ext_flash_dir_path = self.fib_utility.get_ext_flash_dir_path()
+        # move flash jsons files to tmp folder
+        self.xspi_json, self.otfde_json, self.ext_mem_json = (
+            self.prog_utility.move_flash_json_files(
+                flash_type_files_folder=ext_flash_dir_path,
+                flash_device=self.flash_type,
+                enable_ota=self.enable_ota,
+            )
+        )
+
+        if (
+            not isfile(self.xspi_json)
+            or not isfile(self.otfde_json)
+            or not isfile(self.ext_mem_json)
+        ):
+            raise Exception(f"Some JSONs are missing for Flash Device {flash_type}")
+
+        # modify jsons by user parameters
+        self.ext_mem_json, self.otfde_json, self.xspi_json = (
+            self.fib_utility.update_flash_configuration_files(
+                ext_mem_json_path=self.ext_mem_json,
+                otfde_json_path=self.otfde_json,
+                xspi_json_path=self.xspi_json,
+                nvs_size_kb=self.nvs_size,
+                ks_size_kb=self.key_storage_size,
+                vs_size_kb=self.vendor_specific_size,
+                bl2_size_kb=self.bl2_size,
+                wsoc_size_kb=self.wsoc_size,
+                device_type=self.device_type,
+                psram_type=self.psram_type,
+                ota_enabled=self.enable_ota,
+            )
+        )
+        if (
+            not isfile(self.xspi_json)
+            or not isfile(self.otfde_json)
+            or not isfile(self.ext_mem_json)
+        ):
+            raise Exception(f"Some Modify JSONs are missing")
+
+        fuse_json_name = self.prog_utility.get_fuse_json_name(self.device_type)
+        self.fuse_conf_json = join(
+            self.jsons_dir_path,
+            AUTHENTICATION_BYPASS_FILES_FOLDER_NAME,
+            fuse_json_name,
+        )
+
+    def _build_action_request_image(self):
+        with open(self.action_request_json_template, "r") as f:
+            action_params = json.load(f)
+
+        action_params_prog_req_content = action_params["programming"]["payload_param"][
+            "payload"
+        ]["prog_req_content"]
+
+        action_params_prog_req_content["flash_factory_reset"] = True
+        action_params_prog_req_content["boot_sector"] = False
+        action_params_prog_req_content["primary_tbl"] = False
+        action_params_prog_req_content["secondary_tbl"] = False
+        action_params_prog_req_content["primary_vendor_image"] = False
+        action_params_prog_req_content["secondary_vendor_image"] = False
+        action_params_prog_req_content["secondary_ti_wsoc"] = False
+        action_params_prog_req_content["primary_ti_wsoc"] = False
+        action_params_prog_req_content["protected_storage"] = False
+
+        with open(self.updated_action_request_json, "w") as f:
+            json.dump(action_params, f, indent=4)
+
+        # Build action params
+        action_req_out_path, action_req_to_sign_out_path = (
+            self.prog_utility.build_action_request_image(
+                params_json=self.updated_action_request_json,
+                type="programming",
+                dir_out_path=self.tmp_folder,
+                device=self.device_type,
+            )
+        )
+
+        signed_action_req_out_path = self.prog_utility.sign_action_request_image(
+            unsign_request=action_req_out_path,
+            forsign_request=action_req_to_sign_out_path,
+            activation_type=self.activation_type,
+            signing_module=self.signing_module,
+            dir_out_path=self.tmp_folder,
+        )
+
+        return signed_action_req_out_path
+
+    def _build_programming_inst_image(self):
+        programming_unsign_image_path, programming_forsign_image_path = (
+            self.prog_utility.build_programming_image(
+                version="0.0.1.0",
+                pub_key_path=None,
+                activation_type=self.activation_type,
+                dir_out_path=self.tmp_folder,
+                fuses_programming_instructions=self.fuse_conf_json,
+                flash_discovery_config_xspi=self.xspi_json,
+                flash_discovery_config_otfde=self.otfde_json,
+                flash_discovery_config_ext_mem=self.ext_mem_json,
+                device=self.device_type,
+            )
+        )
+
+        signed_programming_image_path = self.prog_utility.sign_programming_image(
+            programming_unsign_image=programming_unsign_image_path,
+            programming_forsign_image=programming_forsign_image_path,
+            activation_type=self.activation_type,
+            signing_module=self.signing_module,
+            dir_out_path=self.tmp_folder,
+        )
+
+        return signed_programming_image_path
+
+    def _update_tool_settings(self, action_req_path, programming_instructions_path):
+        tool_settings = json.load(open(self.tool_settings_json_template, "r"))
+        programming_debug_and_ota_signed_components = tool_settings[
+            "programming_debug_and_ota_signed_components"
+        ]
+
+        # Update paths in tool_settings
+        programming_debug_and_ota_signed_components["actions_req_paths"][
+            "programming"
+        ] = str(action_req_path)
+        programming_debug_and_ota_signed_components["programming_instructions"] = str(
+            programming_instructions_path
+        )
+
+        with open(self.updated_tool_settings_json, "w") as f:
+            json.dump(tool_settings, f, indent=4)
+
+    def erase_flash(self):
+        # Build action request and programming instructions images
+        signed_action_req_out_path = self._build_action_request_image()
+        programming_instructions_path = self._build_programming_inst_image()
+
+        # Create tool_settings
+        self._update_tool_settings(
+            action_req_path=signed_action_req_out_path,
+            programming_instructions_path=programming_instructions_path,
+        )
+
+        # Program the device with the created tool_settings
+        programmer = ProgramDevice(
+            interface_type=self.interface_type,
+            serial_number=self.serial_number,
+            tool_settings=self.updated_tool_settings_json,
+            device_type=self.device_type,
+            report_file_path=(
+                pathlib.Path(self.tmp_folder) / "erase_programming_report.txt"
+            ),
+            programmer_artifacts_path=self.prog_dir,
+            fib_artifacts_path=self.fib_dir,
+            verbose=self.verbose,
+            tclk_delay=self.tclk_delay,
+            chunk_size=self.chunk_size,
+        )
+
+        if not programmer.program():
+            FULL_FLASH_ERASE_LOGGER.info("Full flash erase failed")
+            return False
+        else:
+            FULL_FLASH_ERASE_LOGGER.info("Full flash erase ended successfully")
+            return True

programmer_core/get_fuse_data.py

@@ -0,0 +1,277 @@
+from os.path import join, isfile
+import logging
+import json
+import pathlib
+
+from flash_images_builder_core import (
+    PsramOption,
+    FIBUtility,
+)
+
+try:
+    from utility import (
+        ProgrammerUtility,
+        FUSE_PROG_NAME_CC35XXE,
+        AUTHENTICATION_BYPASS_FILES_FOLDER_NAME,
+        ACTION_PARAMS,
+    )
+    from program_device import ProgramDevice
+except ImportError:
+    from .utility import (
+        ProgrammerUtility,
+        FUSE_PROG_NAME_CC35XXE,
+        AUTHENTICATION_BYPASS_FILES_FOLDER_NAME,
+        ACTION_PARAMS,
+    )
+    from .program_device import ProgramDevice
+
+GET_FUSE_DATA_LOGGER = logging.getLogger("get-fuse-data")
+
+
+class GetFuseData:
+    def __init__(
+        self,
+        interface_type,
+        serial_number,
+        flash_type,
+        activation_type,
+        signing_module,
+        device_type,
+        verbose,
+        programmer_artifacts_path,
+        fib_artifacts_path,
+        psram_type=PsramOption.NO_PSRAM.name,
+        enable_ota=False,
+        nvs_size=None,
+        key_storage_size=None,
+        vendor_specific_size=None,
+        bl2_size=None,
+        wsoc_size=None,
+        tclk_delay=4,
+        chunk_size=1085,
+    ):
+        self.device_type = device_type
+        self.interface_type = interface_type
+        self.serial_number = serial_number
+        self.flash_type = flash_type
+        self.verbose = verbose
+        self.enable_ota = enable_ota
+        self.psram_type = psram_type
+        self.activation_type = activation_type
+        self.signing_module = signing_module
+
+        self.tclk_delay = tclk_delay
+        self.chunk_size = chunk_size
+
+        self.nvs_size = nvs_size
+        self.key_storage_size = key_storage_size
+        self.vendor_specific_size = vendor_specific_size
+        self.bl2_size = bl2_size
+        self.wsoc_size = wsoc_size
+
+        self.prog_dir = programmer_artifacts_path
+        self.fib_dir = fib_artifacts_path
+        self.prog_utility = ProgrammerUtility(self.prog_dir, self.fib_dir)
+        self.fib_utility = FIBUtility(self.fib_dir)
+        self.tmp_folder = self.prog_utility.get_programming_tmp_folder()
+        self.jsons_dir_path = self.prog_utility.get_config_folder()
+        self.tool_settings_json_template = (
+            self.prog_utility.get_tool_settings_template()
+        )
+        self.report_path = (
+            pathlib.Path(self.tmp_folder) / "get_fuse_programming_report.txt"
+        )
+
+        self.updated_tool_settings_json = join(self.tmp_folder, "tool_settings.json")
+
+        self.action_request_json_template = (
+            self.prog_utility.get_action_params_template()
+        )
+
+        self.updated_action_request_json = join(self.tmp_folder, ACTION_PARAMS)
+
+        # Get limits for default values
+        limits = self.fib_utility.get_limits_by_flash_device_name(
+            self.flash_type, self.enable_ota
+        )
+
+        if self.nvs_size is None:
+            self.nvs_size = limits["protected_storage"]["nvsSize"]["default"]
+        if self.key_storage_size is None:
+            self.key_storage_size = limits["protected_storage"]["keyStorageSize"][
+                "default"
+            ]
+        if self.vendor_specific_size is None:
+            self.vendor_specific_size = limits["protected_storage"]["vendorSize"]["default"]
+        if self.bl2_size is None:
+            self.bl2_size = limits["ti_components"]["bl2_size"]["default"]
+        if self.wsoc_size is None:
+            self.wsoc_size = limits["ti_components"]["wsoc_size"]["default"]
+
+        ext_flash_dir_path = self.fib_utility.get_ext_flash_dir_path()
+        # move flash jsons files to tmp folder
+        self.xspi_json, self.otfde_json, self.ext_mem_json = (
+            self.prog_utility.move_flash_json_files(
+                flash_type_files_folder=ext_flash_dir_path,
+                flash_device=self.flash_type,
+                enable_ota=self.enable_ota,
+            )
+        )
+
+        if (
+            not isfile(self.xspi_json)
+            or not isfile(self.otfde_json)
+            or not isfile(self.ext_mem_json)
+        ):
+            raise Exception(f"Some JSONs are missing for Flash Device {flash_type}")
+
+        # modify jsons by user parameters
+        self.ext_mem_json, self.otfde_json, self.xspi_json = (
+            self.fib_utility.update_flash_configuration_files(
+                ext_mem_json_path=self.ext_mem_json,
+                otfde_json_path=self.otfde_json,
+                xspi_json_path=self.xspi_json,
+                nvs_size_kb=self.nvs_size,
+                ks_size_kb=self.key_storage_size,
+                vs_size_kb=self.vendor_specific_size,
+                bl2_size_kb=self.bl2_size,
+                wsoc_size_kb=self.wsoc_size,
+                device_type=self.device_type,
+                psram_type=self.psram_type,
+                ota_enabled=self.enable_ota,
+            )
+        )
+        if (
+            not isfile(self.xspi_json)
+            or not isfile(self.otfde_json)
+            or not isfile(self.ext_mem_json)
+        ):
+            raise Exception(f"Some Modify JSONs are missing")
+
+        self.fuse_conf_json = join(
+            self.jsons_dir_path,
+            AUTHENTICATION_BYPASS_FILES_FOLDER_NAME,
+            FUSE_PROG_NAME_CC35XXE,
+        )
+
+    def _build_action_request_image(self):
+        with open(self.action_request_json_template, "r") as f:
+            action_params = json.load(f)
+
+        action_params_prog_req_content = action_params["programming"]["payload_param"][
+            "payload"
+        ]["prog_req_content"]
+
+        action_params_prog_req_content["flash_factory_reset"] = False
+        action_params_prog_req_content["boot_sector"] = False
+        action_params_prog_req_content["primary_tbl"] = False
+        action_params_prog_req_content["secondary_tbl"] = False
+        action_params_prog_req_content["primary_vendor_image"] = False
+        action_params_prog_req_content["secondary_vendor_image"] = False
+        action_params_prog_req_content["secondary_ti_wsoc"] = False
+        action_params_prog_req_content["primary_ti_wsoc"] = False
+        action_params_prog_req_content["protected_storage"] = False
+
+        with open(self.updated_action_request_json, "w") as f:
+            json.dump(action_params, f, indent=4)
+
+        # Build action params
+        action_req_out_path, action_req_to_sign_out_path = (
+            self.prog_utility.build_action_request_image(
+                params_json=self.updated_action_request_json,
+                type="programming",
+                dir_out_path=self.tmp_folder,
+                device=self.device_type,
+            )
+        )
+
+        signed_action_req_out_path = self.prog_utility.sign_action_request_image(
+            unsign_request=action_req_out_path,
+            forsign_request=action_req_to_sign_out_path,
+            activation_type=self.activation_type,
+            signing_module=self.signing_module,
+            dir_out_path=self.tmp_folder,
+        )
+
+        return signed_action_req_out_path
+
+    def _build_programming_inst_image(self):
+        programming_unsign_image_path, programming_forsign_image_path = (
+            self.prog_utility.build_programming_image(
+                version="0.0.1.0",
+                pub_key_path=None,
+                activation_type=self.activation_type,
+                dir_out_path=self.tmp_folder,
+                fuses_programming_instructions=self.fuse_conf_json,
+                flash_discovery_config_xspi=self.xspi_json,
+                flash_discovery_config_otfde=self.otfde_json,
+                flash_discovery_config_ext_mem=self.ext_mem_json,
+                device=self.device_type,
+            )
+        )
+
+        signed_programming_image_path = self.prog_utility.sign_programming_image(
+            programming_unsign_image=programming_unsign_image_path,
+            programming_forsign_image=programming_forsign_image_path,
+            activation_type=self.activation_type,
+            signing_module=self.signing_module,
+            dir_out_path=self.tmp_folder,
+        )
+
+        return signed_programming_image_path
+
+    def _update_tool_settings(self, action_req_path, programming_instructions_path):
+        tool_settings = json.load(open(self.tool_settings_json_template, "r"))
+        programming_debug_and_ota_signed_components = tool_settings[
+            "programming_debug_and_ota_signed_components"
+        ]
+
+        # Update paths in tool_settings
+        programming_debug_and_ota_signed_components["actions_req_paths"][
+            "programming"
+        ] = str(action_req_path)
+        programming_debug_and_ota_signed_components["programming_instructions"] = str(
+            programming_instructions_path
+        )
+
+        with open(self.updated_tool_settings_json, "w") as f:
+            json.dump(tool_settings, f, indent=4)
+
+    def get_fuse_data(self):
+        # Build action request and programming instructions images
+        signed_action_req_out_path = self._build_action_request_image()
+        programming_instructions_path = self._build_programming_inst_image()
+
+        # Create tool_settings
+        self._update_tool_settings(
+            action_req_path=signed_action_req_out_path,
+            programming_instructions_path=programming_instructions_path,
+        )
+
+        # Program the device with the created tool_settings
+        programmer = ProgramDevice(
+            interface_type=self.interface_type,
+            serial_number=self.serial_number,
+            tool_settings=self.updated_tool_settings_json,
+            device_type=self.device_type,
+            report_file_path=self.report_path,
+            programmer_artifacts_path=self.prog_dir,
+            fib_artifacts_path=self.fib_dir,
+            verbose=self.verbose,
+            tclk_delay=self.tclk_delay,
+            chunk_size=self.chunk_size,
+        )
+
+        if not programmer.program():
+            GET_FUSE_DATA_LOGGER.info("Get fuse data failed")
+            return None
+        else:
+            GET_FUSE_DATA_LOGGER.info("Get fuse data ended successfully")
+
+            data = programmer.report_generator.report_container.vendor_fuse_report
+            fuse_data_table = self.prog_utility.create_table_from_json(data)
+
+            GET_FUSE_DATA_LOGGER.info("FUSES DATA:")
+            GET_FUSE_DATA_LOGGER.info(fuse_data_table)
+
+            return data