programmer-core 1.0.29__py3-none-any.whl

programmer_core/query_device.py

@@ -0,0 +1,274 @@
+import logging
+import pathlib
+
+from communicator_core import (
+    BinaryDownloader,
+    DeviceLifeCycleNum,
+    DSSMStatus,
+    CC35XXE,
+    CC37XXR,
+)
+from flash_images_builder_core import ActionReqBuilder
+
+try:
+    from report import QueryReportGeneratorCC35XXE, QueryReportGeneratorCC35XX
+    from utility import ProgrammerUtility, get_lifecycle_state_reg_class
+except ImportError:
+    from .report import QueryReportGeneratorCC35XXE, QueryReportGeneratorCC35XX
+    from .utility import ProgrammerUtility, get_lifecycle_state_reg_class
+
+# uncomment for debug communicator code without build pakage communicator-core for every change
+# if 'communicator' in sys.modules.keys():
+#     from communicator.communicator_core.core.cc35xx_config_ap import DeviceLifeCycleNum, DSSMStatus, LifeCycleStateReg
+#     from communicator.communicator_core.core.binary_downloader import BinaryDownloader
+
+PROGRAMMER_QUERY_LOGGER = logging.getLogger("query")
+
+
+class QueryDevice:
+    SIMULATION = "DEMO"
+    XDS110 = "XDS110"
+
+    def __init__(
+        self,
+        interface_type,
+        serial_number,
+        query_action_req_path,
+        programmer_artifacts_path,
+        fib_artifacts_path,
+        device_type,
+        report_file_path=None,
+        reset_on_timeout=True,
+        path_to_tpr=None,
+        wait_timeout=1,
+        write_timeout=0,
+        wait_for_resp=True,
+        verbose=False,
+        tclk_delay=4,
+        chunk_size=1085,
+    ):
+        self.query_action_req_path = query_action_req_path
+        self.device_type = device_type
+
+        # Initialize the appropriate LifeCycleStateReg class based on device type
+        self._lifecycle_reg_class = get_lifecycle_state_reg_class(self.device_type)
+
+        self.prog_utility = ProgrammerUtility(
+            programmer_artifacts_path, fib_artifacts_path
+        )
+
+        self.path_to_tpr = path_to_tpr
+        if self.path_to_tpr is None:
+            self.path_to_tpr = self.prog_utility.get_default_prog(self.device_type)
+
+        self.report_file_path = (
+            report_file_path
+            if report_file_path
+            else (pathlib.Path(self.query_action_req_path).parent / "query_report.txt")
+        )
+        self.reset_on_timeout = reset_on_timeout
+
+        self.interface_type = interface_type
+        self.serial_number = serial_number
+        self.wait_timeout = wait_timeout
+        self.write_timeout = write_timeout
+        self.wait_for_resp = wait_for_resp
+        self.tclk_delay = tclk_delay
+        self.chunk_size = chunk_size
+        self.verbose = verbose
+        self.log_level = logging.INFO if verbose else logging.DEBUG
+        self.error_message = ""
+
+        # TODO: temporary - CC37XXR uses CC35XXE report generator until CC37XXR specific generators are available
+        if self.device_type in [CC35XXE, CC37XXR]:
+            self.report_generator = QueryReportGeneratorCC35XXE(
+                programmer_artifacts_path=programmer_artifacts_path,
+                fib_artifacts_path=fib_artifacts_path,
+                report_file_path=self.report_file_path,
+                verbose=self.verbose,
+            )
+        else:
+            self.report_generator = QueryReportGeneratorCC35XX(
+                programmer_artifacts_path=programmer_artifacts_path,
+                fib_artifacts_path=fib_artifacts_path,
+                report_file_path=self.report_file_path,
+                verbose=self.verbose,
+            )
+
+    def _get_selected_images(self, query_action_req_path):
+        with open(query_action_req_path, "rb") as f:
+            action_req_content_row = f.read()
+
+        action_req_builder = ActionReqBuilder(
+            header_version=None,
+            type=ActionReqBuilder.QUERY,
+            device_type=self.device_type,
+            payload_param=None,
+        )
+
+        action_req_parsed = action_req_builder.parse(action_req_content_row)
+
+        # TODO: check if this field exist or catch an error if false
+        selected_images = action_req_parsed["payload"]["action_payload"][
+            "query_req_content"
+        ]
+
+        return selected_images
+
+    def query(self):
+
+        #################################################
+        ##                     Step 0                  ##
+        ##          check that all files exist         ##
+        #################################################
+        self.path_to_tpr = self.prog_utility.fix_path(self.path_to_tpr)
+        res = self.prog_utility.file_path_exist(self.path_to_tpr, "TI Programmer")
+        if res is not None:
+            self.error_message = res
+            PROGRAMMER_QUERY_LOGGER.error(self.error_message)
+            return False
+
+        res = self.prog_utility.file_path_exist(
+            self.query_action_req_path, "query_request"
+        )
+        if res is not None:
+            self.error_message = res
+            PROGRAMMER_QUERY_LOGGER.error(self.error_message)
+            return False
+
+        #################################################
+        ##                     Step 1                  ##
+        ##   Reset device and download TI Bootloader   ##
+        #################################################
+
+        tbl_download = BinaryDownloader(
+            bin_file=self.path_to_tpr,
+            interface_type=self.interface_type,
+            serial_number=self.serial_number,
+            wait_timeout=self.wait_timeout,
+            write_timeout=self.write_timeout,
+            verbose=self.verbose,
+            tclk_delay=self.tclk_delay,
+            chunk_size=self.chunk_size,
+        )
+
+        # reset device
+        tbl_download.device.reset_device()
+
+        # Download TI bootloader
+        tbl_download.daemon = True
+        tbl_download.start()
+
+        while tbl_download.is_alive():
+            tbl_download.join(0.1)
+
+        error_code, error_msg = tbl_download.download_status
+
+        if error_code > 0:
+            PROGRAMMER_QUERY_LOGGER.log(self.log_level, "Successfully loaded binary")
+        else:
+            self.error_message = f"Failed loading 'TI Programmer' image"
+            PROGRAMMER_QUERY_LOGGER.error(
+                f"Failed loading binary with error code: {error_code}\nError message: {error_msg}"
+            )
+            return False
+
+        #################################################
+        ##                     Step 2                  ##
+        ## Read CFGAP and check life-cycle/dssm status ##
+        #################################################
+
+        if self.interface_type != self.SIMULATION:
+            # Read cfgap - use device-specific register class
+            life_cycle_state_reg = self._lifecycle_reg_class(
+                interface=self.interface_type,
+                serial_number=self.serial_number,
+                verbose=self.verbose,
+            )
+            life_cycle_state_reg.read_reg()
+            life_cycle = life_cycle_state_reg.life_cycle_sw_coded
+            dssm_status = life_cycle_state_reg.dssm_status
+            life_cycle_state_reg.disconnect()
+
+            # Check if life cycle is one of allowed_life_cycle
+            allowed_life_cycle = [
+                DeviceLifeCycleNum.DEPLOYED,
+                DeviceLifeCycleNum.RMA_HW_ANALYSIS,
+                DeviceLifeCycleNum.RMA_FAILIURE_ANALYSIS,
+            ]
+            if life_cycle not in allowed_life_cycle:
+                self.error_message = f"Life cycle is not valid"
+                PROGRAMMER_QUERY_LOGGER.error(
+                    f"Process is stopped. Life cycle {DeviceLifeCycleNum(life_cycle).name} is not valid."
+                )
+                return False
+
+            # Check if dssm status is DSSM_READY
+            if not dssm_status == DSSMStatus.DSSM_READY:
+                self.error_message = f"Device is not ready for query"
+                PROGRAMMER_QUERY_LOGGER.error(self.error_message)
+                return False
+
+        #################################################
+        ##                     Step 3                  ##
+        ##          Download query action req          ##
+        #################################################
+
+        # check selected images
+        selected_images = self._get_selected_images(
+            query_action_req_path=self.query_action_req_path
+        )
+
+        query_req_downloader = BinaryDownloader(
+            bin_file=self.query_action_req_path,
+            interface_type=self.interface_type,
+            serial_number=self.serial_number,
+            wait_timeout=self.wait_timeout,
+            write_timeout=self.write_timeout,
+            wait_for_resp=self.wait_for_resp,
+            verbose=self.verbose,
+            expected_resp_size=self.report_generator._get_expected_report_size(
+                selected_images
+            ),
+            tclk_delay=self.tclk_delay,
+            chunk_size=self.chunk_size,
+        )
+        query_req_downloader.daemon = True
+        query_req_downloader.start()
+
+        while query_req_downloader.is_alive():
+            query_req_downloader.join(0.1)
+
+        error_code, error_msg = query_req_downloader.download_status
+
+        if error_code > 0:
+            PROGRAMMER_QUERY_LOGGER.log(self.log_level, "Successfully loaded binary")
+        else:
+            self.error_message = f"Failed loading 'Query Action Request'"
+            PROGRAMMER_QUERY_LOGGER.error(
+                f"Failed loading binary with error code: {error_code}\nError message: {error_msg}"
+            )
+            return False
+
+        #################################################
+        ##                     Step 4                  ##
+        ##    get response and print to the user       ##
+        #################################################
+
+        if self.wait_for_resp:
+            # parse report from device
+            report_content_raw = query_req_downloader.resp
+
+            # check selected images
+            selected_images = self._get_selected_images(
+                query_action_req_path=self.query_action_req_path
+            )
+
+            # parse report from device
+            if not self.report_generator.generate_report(
+                report_content_raw, selected_images
+            ):
+                self.error_message = self.report_generator.error_message
+                return False
+
+        return True