From 091bf8fbc0502a68d25f6d46107a327b0e2951fe Mon Sep 17 00:00:00 2001
From: Jakob Meier <meier-jakob@gmx.de>
Date: Thu, 17 Mar 2022 19:42:27 +0100
Subject: [PATCH] ploc mpsoc commands

---
 ...PLOC_Test_UDP_Local.xml => PLOC_MPSoC.xml} |   4 +-
 .../PLOC_Test_UDP_Flatsat.xml                 |  24 ----
 config/definitions.py                         |   4 +-
 config/hook_implementations.py                |   6 +-
 pus_tc/cmd_definitions.py                     |  12 +-
 pus_tc/devs/ploc_mpsoc.py                     | 103 ++++++++++++------
 pus_tc/devs/ploc_supervisor.py                |   2 +-
 pus_tc/devs/star_tracker.py                   |   1 +
 pus_tc/tc_packer_hook.py                      |  10 +-
 pus_tm/service_8_hook.py                      |   3 +-
 10 files changed, 97 insertions(+), 72 deletions(-)
 rename .idea/runConfigurations/{PLOC_Test_UDP_Local.xml => PLOC_MPSoC.xml} (81%)
 delete mode 100644 .idea/runConfigurations/PLOC_Test_UDP_Flatsat.xml

diff --git a/.idea/runConfigurations/PLOC_Test_UDP_Local.xml b/.idea/runConfigurations/PLOC_MPSoC.xml
similarity index 81%
rename from .idea/runConfigurations/PLOC_Test_UDP_Local.xml
rename to .idea/runConfigurations/PLOC_MPSoC.xml
index 65d59e9..9c534f8 100644
--- a/.idea/runConfigurations/PLOC_Test_UDP_Local.xml
+++ b/.idea/runConfigurations/PLOC_MPSoC.xml
@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="PLOC Test UDP Local" type="PythonConfigurationType" factoryName="Python" folderName="Devices">
+  <configuration default="false" name="PLOC MPSoC" type="PythonConfigurationType" factoryName="Python" folderName="Devices">
     <module name="tmtc" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtccli.py" />
-    <option name="PARAMETERS" value="-m 1 -c 2 -s PLOC -l" />
+    <option name="PARAMETERS" value="-s ploc_mpsoc -l -t 6" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="true" />
     <option name="MODULE_MODE" value="false" />
diff --git a/.idea/runConfigurations/PLOC_Test_UDP_Flatsat.xml b/.idea/runConfigurations/PLOC_Test_UDP_Flatsat.xml
deleted file mode 100644
index 688bd6b..0000000
--- a/.idea/runConfigurations/PLOC_Test_UDP_Flatsat.xml
+++ /dev/null
@@ -1,24 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="PLOC Test UDP Flatsat" type="PythonConfigurationType" factoryName="Python" folderName="Devices">
-    <module name="tmtc" />
-    <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="PARENT_ENVS" value="true" />
-    <envs>
-      <env name="PYTHONUNBUFFERED" value="1" />
-    </envs>
-    <option name="SDK_HOME" value="" />
-    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
-    <option name="IS_MODULE_SDK" value="true" />
-    <option name="ADD_CONTENT_ROOTS" value="true" />
-    <option name="ADD_SOURCE_ROOTS" value="true" />
-    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
-    <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtccli.py" />
-    <option name="PARAMETERS" value="-m 1 -c 2 -s PLOC -l" />
-    <option name="SHOW_COMMAND_LINE" value="false" />
-    <option name="EMULATE_TERMINAL" value="true" />
-    <option name="MODULE_MODE" value="false" />
-    <option name="REDIRECT_INPUT" value="false" />
-    <option name="INPUT_FILE" value="" />
-    <method v="2" />
-  </configuration>
-</component>
\ No newline at end of file
diff --git a/config/definitions.py b/config/definitions.py
index ded12d5..fe668db 100644
--- a/config/definitions.py
+++ b/config/definitions.py
@@ -22,7 +22,8 @@ class CustomServiceList(enum.Enum):
     TMP1075_2 = "tmp1075_2"
     HEATER = "heater"
     IMTQ = "imtq"
-    PLOC = "ploc"
+    PLOC_SUPV = "ploc_supv"
+    PLOC_MPSOC = "ploc_mpsoc"
     PCDU = "pcdu"
     PL_PCDU = "plpcdu"
     SA_DEPLYOMENT = "sa_depl"
@@ -31,7 +32,6 @@ class CustomServiceList(enum.Enum):
     REACTION_WHEEL_3 = "reaction_wheel_3"
     REACTION_WHEEL_4 = "reaction_wheel_4"
     RAD_SENSOR = "rad_sensor"
-    PLOC_SUPV = "ploc_supv"
     PLOC_UPDATER = "ploc_updater"
     GPS_0 = "gps0"
     GPS_1 = "gps1"
diff --git a/config/hook_implementations.py b/config/hook_implementations.py
index 3cc9be8..40dcf84 100644
--- a/config/hook_implementations.py
+++ b/config/hook_implementations.py
@@ -124,7 +124,8 @@ def get_eive_service_op_code_dict(service_op_code_dict: ServiceOpCodeDictT):
         add_imtq_cmds,
         add_rw_cmds,
         add_rad_sens_cmds,
-        add_ploc_cmds,
+        add_ploc_mpsoc_cmds,
+        add_ploc_supv_cmds,
         add_system_cmds,
     )
     from pus_tc.devs.gps import GpsOpCodes
@@ -136,7 +137,8 @@ def get_eive_service_op_code_dict(service_op_code_dict: ServiceOpCodeDictT):
     add_imtq_cmds(cmd_dict=service_op_code_dict)
     add_rad_sens_cmds(cmd_dict=service_op_code_dict)
     add_rw_cmds(cmd_dict=service_op_code_dict)
-    add_ploc_cmds(cmd_dict=service_op_code_dict)
+    add_ploc_mpsoc_cmds(cmd_dict=service_op_code_dict)
+    add_ploc_supv_cmds(cmd_dict=service_op_code_dict)
     add_system_cmds(cmd_dict=service_op_code_dict)
 
     op_code_dict = {
diff --git a/pus_tc/cmd_definitions.py b/pus_tc/cmd_definitions.py
index 5ea1a2d..878def9 100644
--- a/pus_tc/cmd_definitions.py
+++ b/pus_tc/cmd_definitions.py
@@ -392,7 +392,17 @@ def add_rad_sens_cmds(cmd_dict: ServiceOpCodeDictT):
     cmd_dict[CustomServiceList.RAD_SENSOR.value] = service_rad_sensor_tuple
 
 
-def add_ploc_cmds(cmd_dict: ServiceOpCodeDictT):
+def add_ploc_mpsoc_cmds(cmd_dict: ServiceOpCodeDictT):
+    op_code_dict_srv_ploc_mpsoc = {
+        "0": ("Ploc MPSoC: Memory write", {OpCodeDictKeys.TIMEOUT: 2.0}),
+        "1": ("Ploc MPSoC: Memory read", {OpCodeDictKeys.TIMEOUT: 2.0}),
+        "2": ("Ploc MPSoC: Flash write", {OpCodeDictKeys.TIMEOUT: 2.0}),
+    }
+    service_ploc_mpsoc_tuple = ("Ploc MPSoC", op_code_dict_srv_ploc_mpsoc)
+    cmd_dict[CustomServiceList.PLOC_MPSOC.value] = service_ploc_mpsoc_tuple
+
+
+def add_ploc_supv_cmds(cmd_dict: ServiceOpCodeDictT):
     op_code_dict_ploc_mem_dumper = {
         "0": ("PLOC Memory Dumper: MRAM dump", {OpCodeDictKeys.TIMEOUT: 2.0}),
     }
diff --git a/pus_tc/devs/ploc_mpsoc.py b/pus_tc/devs/ploc_mpsoc.py
index 5fc2224..ca2f188 100644
--- a/pus_tc/devs/ploc_mpsoc.py
+++ b/pus_tc/devs/ploc_mpsoc.py
@@ -9,61 +9,68 @@
 import struct
 
 from tmtccmd.config.definitions import QueueCommands
-
+from tmtccmd.utility.logger import get_console_logger
 from tmtccmd.tc.packer import TcQueueT
 from spacepackets.ecss.tc import PusTelecommand
 
+LOGGER = get_console_logger()
 
-class PlocTestProcedure:
-    """
-    @brief  Use this class to define the tests to perform for the PLOC.
-    @details    Setting all to True will run all tests.
-                Setting all to False will only run the tests set to True.
-    """
+MANUAL_INPUT = "3"
 
-    all = False
-    test_tc_mem_write = False
-    test_tc_mem_read = True
+flash_write_dict = {
+    "1": ["q7s test file", "/mnt/sd0/ploc-mpsoc/flashwrite.bin"],
+    "2": ["te0720-1cfa test file", "/mnt/sd0/ploc-mpsoc/flashwrite.bin"],
+    MANUAL_INPUT: ["manual input", ""],
+}
 
 
-class PlocActionIds:
-    tc_mem_write = bytearray([0x0, 0x0, 0x0, 0x1])
-    tc_mem_read = bytearray([0x0, 0x0, 0x0, 0x2])
+class CommandIds:
+    tc_mem_write = 1
+    tc_mem_read = 2
+    flash_write = 3
 
 
 class PlocReplyIds:
     tm_mem_read_report = 6
 
 
-def pack_ploc_mpsoc_test_into(object_id: bytearray, tc_queue: TcQueueT) -> TcQueueT:
+def pack_ploc_mpsoc_commands(
+        object_id: bytearray, tc_queue: TcQueueT, op_code: str
+) -> TcQueueT:
     tc_queue.appendleft(
-        (QueueCommands.PRINT, "Testing PLOC MPSoC with object id: 0x" + object_id.hex())
+        (
+            QueueCommands.PRINT,
+            "Generate command for PLOC MPSoC with object id: 0x" + object_id.hex(),
+        )
     )
 
-    if PlocTestProcedure.all or PlocTestProcedure.test_tc_mem_write:
-        tc_queue.appendleft((QueueCommands.PRINT, "PLOC: TC Mem Write Test"))
-        memory_address = int(input("PLOC Tc Mem Write: Type memory address: 0x"), 16)
-        memory_data = int(input("PLOC Tc Mem Write: Type memory data: 0x"), 16)
+    if op_code == "0":
+        tc_queue.appendleft((QueueCommands.PRINT, "PLOC MPSoC: TC mem write test"))
+        memory_address = int(input("PLOC MPSoC: Tc Mem Write: Type memory address: 0x"), 16)
+        memory_data = int(input("PLOC MPSoC: Tc Mem Write: Type memory data: 0x"), 16)
+        # TODO: implement variable length mem write command
+        mem_len = 1  # 1 32-bit word
         command = generate_write_mem_command(
-            object_id, struct.pack("!I", memory_address), memory_data
+            object_id, memory_address, memory_data, mem_len
         )
-        command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
+        command = PusTelecommand(service=8, subservice=128, ssc=20, app_data=command)
         tc_queue.appendleft(command.pack_command_tuple())
-
-    if PlocTestProcedure.all or PlocTestProcedure.test_tc_mem_read:
-        tc_queue.appendleft((QueueCommands.PRINT, "PLOC: TC Mem Read Test"))
-        memory_address = int(input("PLOC Tc Mem Read: Type memory address: 0x"), 16)
-        command = (
-            object_id + PlocActionIds.tc_mem_read + struct.pack("!I", memory_address)
-        )
-        command = PusTelecommand(service=8, subservice=128, ssc=24, app_data=command)
+    elif op_code == "1":
+        tc_queue.appendleft((QueueCommands.PRINT, "PLOC MPSoC: TC mem read test"))
+        command = prepare_mem_read_command(object_id)
+        command = PusTelecommand(service=8, subservice=128, ssc=21, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+    elif op_code == "2":
+        tc_queue.appendleft((QueueCommands.PRINT, "PLOC MPSoC: Flash write"))
+        command = prepare_flash_write_cmd(object_id)
+        command = PusTelecommand(service=8, subservice=128, ssc=22, app_data=command)
         tc_queue.appendleft(command.pack_command_tuple())
 
     return tc_queue
 
 
 def generate_write_mem_command(
-    object_id: bytearray, memory_address: bytes, memory_data: int
+        object_id: bytearray, memory_address: int, memory_data: int, mem_len: int
 ) -> bytearray:
     """This function generates the command to write to a memory address within the PLOC
     @param object_id    The object id of the PlocHandler
@@ -71,9 +78,37 @@ def generate_write_mem_command(
     @param memory_data    The data to write to the memory address specified by the bytearray memory_address.
     """
     command = (
-        object_id
-        + PlocActionIds.tc_mem_write
-        + memory_address
-        + struct.pack("!I", memory_data)
+            object_id
+            + struct.pack('!I', CommandIds.tc_mem_write)
+            + struct.pack('!I', memory_address)
+            + struct.pack('!H', mem_len)
+            + struct.pack("!I", memory_data)
     )
     return command
+
+
+def prepare_mem_read_command(object_id: bytearray) -> bytearray:
+    memory_address = int(input("PLOC MPSoC Tc Mem Read: Type memory address: 0x"), 16)
+    num_words = int(input("PLOC MPSoC specify number of words (32-bit) to read: "))
+    command = (
+            object_id + struct.pack('!I', CommandIds.tc_mem_read) + struct.pack("!I", memory_address) + struct.pack(
+        '!H', num_words)
+    )
+    return command
+
+
+def prepare_flash_write_cmd(object_id: bytearray) -> bytearray:
+    file = get_flash_write_file()
+    command = object_id + struct.pack('I', CommandIds.flash_write) + bytearray(file, 'utf-8')
+    return command
+
+
+def get_flash_write_file() -> str:
+    LOGGER.info("Specify json file")
+    input_helper = InputHelper(json_dict)
+    key = input_helper.get_key()
+    if key == MANUAL_INPUT:
+        file = input("Ploc MPSoC: Specify absolute name of flash write file: ")
+    else:
+        file = json_dict[key][1]
+    return file
diff --git a/pus_tc/devs/ploc_supervisor.py b/pus_tc/devs/ploc_supervisor.py
index 0513a22..b68d7bf 100644
--- a/pus_tc/devs/ploc_supervisor.py
+++ b/pus_tc/devs/ploc_supervisor.py
@@ -75,7 +75,7 @@ class SupvHkIds:
     BOOT_STATUS_REPORT = 53
 
 
-def pack_ploc_supv_test_into(
+def pack_ploc_supv_commands(
     object_id: bytearray, tc_queue: TcQueueT, op_code: str
 ) -> TcQueueT:
     tc_queue.appendleft(
diff --git a/pus_tc/devs/star_tracker.py b/pus_tc/devs/star_tracker.py
index b8da74b..6afccbe 100644
--- a/pus_tc/devs/star_tracker.py
+++ b/pus_tc/devs/star_tracker.py
@@ -15,6 +15,7 @@ from tmtccmd.tc.service_200_mode import pack_mode_data, Modes
 from tmtccmd.utility.logger import get_console_logger
 from utility.input_helper import InputHelper
 
+
 LOGGER = get_console_logger()
 
 
diff --git a/pus_tc/tc_packer_hook.py b/pus_tc/tc_packer_hook.py
index 340a8ac..b8c1751 100644
--- a/pus_tc/tc_packer_hook.py
+++ b/pus_tc/tc_packer_hook.py
@@ -18,8 +18,8 @@ from pus_tc.devs.bpx_batt import pack_bpx_commands
 from pus_tc.devs.acu import pack_acu_test_into
 from pus_tc.devs.imtq import pack_imtq_test_into
 from pus_tc.devs.tmp1075 import pack_tmp1075_test_into
-from pus_tc.devs.ploc_mpsoc import pack_ploc_mpsoc_test_into
-from pus_tc.devs.ploc_supervisor import pack_ploc_supv_test_into
+from pus_tc.devs.ploc_mpsoc import pack_ploc_mpsoc_commands
+from pus_tc.devs.ploc_supervisor import pack_ploc_supv_commands
 from pus_tc.devs.heater import pack_heater_test_into
 from pus_tc.devs.reaction_wheels import pack_single_rw_test_into
 from pus_tc.devs.rad_sensor import pack_rad_sensor_test_into
@@ -116,9 +116,9 @@ def pack_service_queue_user(
         return pack_imtq_test_into(
             object_id=object_id, tc_queue=service_queue, op_code=op_code
         )
-    if service == CustomServiceList.PLOC.value:
+    if service == CustomServiceList.PLOC_MPSOC.value:
         object_id = PLOC_MPSOC_ID
-        return pack_ploc_mpsoc_test_into(object_id=object_id, tc_queue=service_queue)
+        return pack_ploc_mpsoc_commands(object_id=object_id, tc_queue=service_queue, op_code=op_code)
     if service == CustomServiceList.REACTION_WHEEL_1.value:
         object_id = RW1_ID
         return pack_single_rw_test_into(
@@ -146,7 +146,7 @@ def pack_service_queue_user(
         )
     if service == CustomServiceList.PLOC_SUPV.value:
         object_id = PLOC_SUPV_ID
-        return pack_ploc_supv_test_into(
+        return pack_ploc_supv_commands(
             object_id=object_id, tc_queue=service_queue, op_code=op_code
         )
     if service == CustomServiceList.PLOC_UPDATER.value:
diff --git a/pus_tm/service_8_hook.py b/pus_tm/service_8_hook.py
index f5ddde0..a1ef8cf 100644
--- a/pus_tm/service_8_hook.py
+++ b/pus_tm/service_8_hook.py
@@ -69,7 +69,8 @@ def handle_ploc_replies(action_id: int, custom_data: bytearray) -> DataReplyUnpa
             "PLOC Mem Len",
             "PLOC Read Memory Data",
         ]
-        reply.content_list = [custom_data[:4], custom_data[4:6], custom_data[6:10]]
+        reply.content_list = ["0x" + custom_data[:4].hex(), struct.unpack('!H', custom_data[4:6])[0],
+                              "0x" + custom_data[6:10].hex()]
     return reply