Commonize and improve clock frequency conversion.

- Moved convert_frequency() to pyocd.utility.cmdline.
- Added support for float values and 'Hz' suffix.
- Using convert_frequency() for 'set clock' in commander.

Author: flit

pyocd/__main__.py

@@ -41,6 +41,7 @@
     convert_vector_catch,
     convert_session_options,
     convert_reset_type,
+    convert_frequency,
     )
 from .probe.pydapaccess import DAPAccess
 from .tools.lists import ListGenerator
@@ -82,20 +83,6 @@
     'sector',
     ]
 
-def convert_frequency(value):
-    """! @brief Applies scale suffix to frequency value string."""
-    value = value.strip()
-    suffix = value[-1].lower()
-    if suffix in ('k', 'm'):
-        value = int(value[:-1])
-        if suffix == 'k':
-            value *= 1000
-        elif suffix == 'm':
-            value *= 1000000
-        return value
-    else:
-        return int(value)
-
 def flatten_args(args):
     """! @brief Converts a list of lists to a single list."""
     return [item for sublist in args for item in sublist]
@@ -164,7 +151,8 @@ def build_parser(self):
         connectOptions.add_argument("-t", "--target", dest="target_override", metavar="TARGET",
             help="Set the target type.")
         connectOptions.add_argument("-f", "--frequency", dest="frequency", default=None, type=convert_frequency,
-            help="SWD/JTAG clock frequency in Hz, with optional k/K or m/M suffix for kHz or MHz.")
+            help="SWD/JTAG clock frequency in Hz. Accepts a float or int with optional case-"
+                "insensitive K/M suffix and optional Hz. Examples: \"1000\", \"2.5khz\", \"10m\".")
         connectOptions.add_argument("-W", "--no-wait", action="store_true",
             help="Do not wait for a probe to be connected if none are available.")
         connectOptions.add_argument("-M", "--connect", dest="connect_mode", metavar="MODE",

pyocd/tools/pyocd.py

@@ -48,7 +48,7 @@
 from ..flash.file_programmer import FileProgrammer
 from ..gdbserver.gdbserver import GDBServer
 from ..utility import (mask, conversion)
-from ..utility.cmdline import convert_session_options
+from ..utility.cmdline import (convert_session_options, convert_frequency)
 from ..utility.hex import (format_hex_width, dump_hex_data)
 from ..utility.progress import print_progress
 from ..utility.compatibility import get_terminal_size
@@ -453,7 +453,10 @@
             },
         'clock' : {
             'aliases' : [],
-            'help' : "Set SWD or JTAG clock frequency in kilohertz."
+            'help' : "Set SWD or JTAG clock frequency in Hertz. A case-insensitive metric scale "
+                "suffix of either 'k' or 'm' is allowed, as well as a trailing \"Hz\". There must "
+                "be no space between the frequency and the suffix. For example, \"2.5MHz\" sets "
+                "the clock to 2.5 MHz."
             },
         'option' : {
             'aliases' : [],
@@ -1492,7 +1495,7 @@ def handle_set_clock(self, args):
             print("Error: no clock frequency provided")
             return 1
         try:
-            freq_Hz = self.convert_value(args[0]) * 1000
+            freq_Hz = convert_frequency(args[0])
         except:
             print("Error: invalid frequency")
             return 1

pyocd/utility/cmdline.py

@@ -161,3 +161,24 @@ def convert_reset_type(value):
         raise ValueError("unexpected value for reset_type option ('%s')" % value)
     return RESET_TYPE_MAP[value]
 
+def convert_frequency(value):
+    """! @brief Applies scale suffix to frequency value string.
+    @param value String with a float and possible 'k' or 'm' suffix (case-insensitive). "Hz" may
+        also follow. No space is allowed between the float and suffix. Leading and trailing
+        whitespace is allowed.
+    @return Integer scaled according to optional metric suffix.
+    """
+    value = value.strip().lower()
+    if value.endswith("hz"):
+        value = value[:-2]
+    suffix = value[-1]
+    if suffix in ('k', 'm'):
+        value = float(value[:-1])
+        if suffix == 'k':
+            value *= 1000
+        elif suffix == 'm':
+            value *= 1000000
+        return int(value)
+    else:
+        return int(float(value))
+