Merge pull request #148 from embeddedteam103/workaround_stlink_plugin_enter_bug

ST-LINK Plugin bugfix: Create temp file containing an Enter tab and pass it to ST-LINK CLI

Author: bridadan

src/mbed_os_tools/test/host_tests_conn_proxy/conn_primitive_serial.py

@@ -31,6 +31,7 @@ def __init__(self, name, port, baudrate, config):
         self.write_timeout = 5
         self.config = config
         self.target_id = self.config.get('target_id', None)
+        self.mcu = self.config.get('mcu', None)
         self.polling_timeout = config.get('polling_timeout', 60)
         self.forced_reset_timeout = config.get('forced_reset_timeout', 1)
         self.skip_reset = config.get('skip_reset', False)
@@ -86,6 +87,7 @@ def reset_dev_via_serial(self, delay=1):
             reset_type,
             serial=self.serial,
             disk=disk,
+            mcu=self.mcu,
             target_id=self.target_id,
             polling_timeout=self.config.get('polling_timeout'))
         # Post-reset sleep

src/mbed_os_tools/test/host_tests_plugins/host_test_plugins.py

@@ -221,16 +221,17 @@ def check_parameters(self, capability, *args, **kwargs):
             return False
         return True
 
-    def run_command(self, cmd, shell=True):
+    def run_command(self, cmd, shell=True, stdin = None):
         """! Runs command from command line.
         @param cmd Command to execute
         @param shell True if shell command should be executed (eg. ls, ps)
+        @param stdin A custom stdin for the process running the command (defaults to None)
         @details Function prints 'cmd' return code if execution failed
         @return True if command successfully executed
         """
         result = True
         try:
-            ret = call(cmd, shell=shell)
+            ret = call(cmd, shell=shell, stdin=stdin)
             if ret:
                 self.print_plugin_error("[ret=%d] Command: %s"% (int(ret), cmd))
                 return False

src/mbed_os_tools/test/host_tests_plugins/module_reset_stlink.py

@@ -13,8 +13,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import os
+import sys
+import tempfile
 from .host_test_plugins import HostTestPluginBase
 
+FIX_FILE_NAME = "enter_file.txt"
+
 
 class HostTestPluginResetMethod_Stlink(HostTestPluginBase):
 
@@ -49,6 +54,20 @@ def setup(self, *args, **kwargs):
         self.ST_LINK_CLI = 'ST-LINK_CLI.exe'
         return True
 
+    def create_stlink_fix_file(self, file_path):
+        """! Creates a file with a line separator
+        This is to work around a bug in ST-LINK CLI that does not let the target run after burning it.
+        See https://github.com/ARMmbed/mbed-os-tools/issues/147 for the details.
+        @param file_path A path to write into this file
+        """
+        try:
+            with open(file_path, "w") as fix_file:
+                fix_file.write(os.linesep)
+        except (OSError, IOError):
+            self.print_plugin_error("Error opening STLINK-PRESS-ENTER-BUG file")
+            sys.exit(1)
+
+
     def execute(self, capability, *args, **kwargs):
         """! Executes capability by name
 
@@ -67,7 +86,20 @@ def execute(self, capability, *args, **kwargs):
                 # ST-LINK_CLI.exe -Rst -Run
                 cmd = [self.ST_LINK_CLI,
                        '-Rst', '-Run']
-                result = self.run_command(cmd)
+                
+                # Due to the ST-LINK bug, we must press enter after burning the target
+                # We do this here automatically by passing a file which contains an `ENTER` (line separator)
+                # to the ST-LINK CLI as `stdin` for the running process
+                enter_file_path = os.path.join(tempfile.gettempdir(), FIX_FILE_NAME)
+                self.create_stlink_fix_file(enter_file_path)
+                try:
+                    with open(enter_file_path, 'r') as fix_file:
+                        stdin_arg = kwargs.get('stdin', fix_file)
+                        result = self.run_command(cmd, stdin = stdin_arg)
+                except (OSError, IOError):
+                    self.print_plugin_error("Error opening STLINK-PRESS-ENTER-BUG file")
+                    sys.exit(1)
+
         return result
 
 

src/mbed_os_tools/test/host_tests_runner/host_test_default.py

@@ -164,6 +164,7 @@ def callback__notify_prn(key, value, timestamp):
             "digest" : "serial",
             "port" : self.mbed.port,
             "baudrate" : self.mbed.serial_baud,
+            "mcu" : self.mbed.mcu,
             "program_cycle_s" : self.options.program_cycle_s,
             "reset_type" : self.options.forced_reset_type,
             "target_id" : self.options.target_id,

src/mbed_os_tools/test/host_tests_runner/mbed_base.py

@@ -36,6 +36,7 @@ def __init__(self, options):
         self.logger = HtrunLogger('MBED')
         # Options related to copy / reset mbed device
         self.port = self.options.port
+        self.mcu = self.options.micro
         self.disk = self.options.disk
         self.target_id = self.options.target_id
         self.image_path = self.options.image_path.strip('"') if self.options.image_path is not None else ''
@@ -80,7 +81,7 @@ def __init__(self, options):
                 self.logger.prn_err("Test configuration JSON Unexpected error:", str(e))
                 raise
 
-    def copy_image(self, image_path=None, disk=None, copy_method=None, port=None, retry_copy=5):
+    def copy_image(self, image_path=None, disk=None, copy_method=None, port=None, mcu=None, retry_copy=5):
         """! Closure for copy_image_raw() method.
         @return Returns result from copy plugin
         """
@@ -172,6 +173,8 @@ def check_flash_error(target_id, disk, initial_remount_count):
             copy_method = self.copy_method
         if not port:
             port = self.port
+        if not mcu:
+            mcu = self.mcu
         if not retry_copy:
             retry_copy = self.retry_copy
         target_id = self.target_id
@@ -187,7 +190,7 @@ def check_flash_error(target_id, disk, initial_remount_count):
         for count in range(0, retry_copy):
             initial_remount_count = get_remount_count(disk)
             # Call proper copy method
-            result = self.copy_image_raw(image_path, disk, copy_method, port)
+            result = self.copy_image_raw(image_path, disk, copy_method, port, mcu)
             sleep(self.program_cycle_s)
             if not result:
                 continue
@@ -196,7 +199,7 @@ def check_flash_error(target_id, disk, initial_remount_count):
                 break
         return result
 
-    def copy_image_raw(self, image_path=None, disk=None, copy_method=None, port=None):
+    def copy_image_raw(self, image_path=None, disk=None, copy_method=None, port=None, mcu=None):
         """! Copy file depending on method you want to use. Handles exception
              and return code from shell copy commands.
         @return Returns result from copy plugin
@@ -214,6 +217,7 @@ def copy_image_raw(self, image_path=None, disk=None, copy_method=None, port=None
         result = ht_plugins.call_plugin('CopyMethod',
                                         copy_method,
                                         image_path=image_path,
+                                        mcu=mcu,
                                         serial=port,
                                         destination_disk=disk,
                                         target_id=self.target_id,