Merge branch 'vodak-configure-gls-gen' into 'devel'

Configure generator using gls tool

See merge request ndk/ndk-fpga!269

Author: VoDees

python/ofm/ofm/comp/mfb_tools/debug/gen_loop_switch/gen_loop_switch.py

@@ -255,17 +255,19 @@ def sm_measure(sm: SpeedMeter, to: float = 0.1, freq: Optional[int] = 2*10**8) -
         return sm.measure(to, freq)
 
 
-def main():
+def _main():
     help_dict = {
         "device"   : "set the target device",
         "index"    : "select index (instance) of the GLS in the Device Tree",
         "right"    : "select the RIGHT side of the GLS to use the MFB Generator or set loopback",
         "left"     : "select the LEFT side of the GLS to use the MFB Generator or set loopback",
         "loopback" : "enable (1) or disable (0) loopback (on the '-R' or '-L' side)",
-        "generate" : "start (1) or stop (0) generating (to the '-R' or '-L' side), 'c' to print its config",
+        "generate" : "start (1) or stop (0) generating (to the '-R' or '-L' side)",
         "size"     : "set frame size for the ('-R' or '-L') MFB Generator",
         "measure"  : "measure the throughput using selected Speed Meter (SM), 'a' for all, '0,1' by default",
         "config"   : "print full configuration and exit",
+        "gen-config" : "generator config - either print full configuration (no args) or set a value"
+                     " with two extra args"
     }
 
     gls_desc = """
@@ -307,10 +309,11 @@ def main():
     arg_parser.add_argument("-R", "--right", action="store_true", help=help_dict["right"])
     arg_parser.add_argument("-L", "--left", action="store_true", help=help_dict["left"])
     arg_parser.add_argument("-l", "--loopback", type=int, choices=[0, 1], help=help_dict["loopback"])
-    arg_parser.add_argument("-g", "--generate", nargs="?", choices=["0", "1", "c"], help=help_dict["generate"])
+    arg_parser.add_argument("-g", "--generate", nargs="?", choices=["0", "1"], help=help_dict["generate"])
     arg_parser.add_argument("-s", "--size", type=int, help=help_dict["size"])
     arg_parser.add_argument("-m", "--measure", nargs='?', const="default", choices=["default", "0", "1", "2", "3", "a"], help=help_dict["measure"])
     arg_parser.add_argument("-c", "--config", action="store_true", help=help_dict["config"])
+    arg_parser.add_argument("-C", "--gen-config", nargs="*", help=help_dict["gen-config"])
     args = arg_parser.parse_args()
 
     try:
@@ -377,9 +380,35 @@ def main():
             elif "0" in args.generate:
                 s.gen_stop()
 
-            if "c" in args.generate:
+        if args.gen_config is not None:
+            if len(args.gen_config) == 0:
                 print("MFB Generator configuration:")
                 print(tabulate(s.gen.get_fconfiguration()))
+            elif len(args.gen_config) == 2:
+                attr, value = args.gen_config
+                s.gen.configure_attr(attr, value)
+            else:
+                raise ValueError("Invalid number of arguments")
+
+
+def main():
+    EXIT_ERROR = 1
+
+    try:
+        _main()
+    except IndexError as exc:
+        print("Index error:", exc)
+        exit(EXIT_ERROR)
+    except NotImplementedError as exc:
+        print("Error, feature not yet implemented:", exc)
+        exit(EXIT_ERROR)
+    except ValueError as exc:
+        print("Invalid input:", exc)
+        print("Maybe a wrong combination of arguments or unknown configuration attribute?")
+        exit(EXIT_ERROR)
+    except Exception as exc:
+        print("Unexpected error: ", exc)
+        exit(EXIT_ERROR)
 
 
 if __name__ == "__main__":

python/ofm/ofm/comp/mfb_tools/debug/generator/mfb_generator.py

@@ -48,6 +48,10 @@ class MfbGenerator(nfb.BaseComp):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self._logger = logging.getLogger("MfbGenerator")
+        self._cfg_type_d = {
+            f.name : f.type for f in fields(GeneratorConfig)
+            if "Optional" not in str(f.type) # filter out read only values
+        }
 
     # ################
     # Command register
@@ -222,7 +226,7 @@ def src_mac_address(self, smac: bytes) -> None:
 
     @staticmethod
     def convert_bytes2mac(mac: bytes, sep: str = "") -> Any:
-        """Conver a 6-byte little-endian MAC address into big-endian with an optional formatting.
+        """Convert a 6-byte little-endian MAC address into big-endian with an optional formatting.
 
         Args:
             mac: The MAC Address as six little-endian bytes.
@@ -347,6 +351,57 @@ def configure(self, conf: GeneratorConfig) -> None:
         self.src_ip_address_mask = conf.src_ip_address_mask
         self.enabled = conf.enabled
 
+    def _convert_attr(self, attr_name: str, attr_value: str) -> Any:
+        if "mac" in attr_name:
+            return MfbGenerator.convert_mac2bytes(attr_value)
+
+        if "mask" in attr_name:
+            return int(attr_value, 16)
+
+        prop_type = self._cfg_type_d[attr_name]
+        return prop_type(attr_value)
+
+    def configure_attr(self, attr_name: str, str_value: str):
+        """Configure a config attribute.
+
+        This method aims to enable dynamic configuration using string names of data class
+        arguments and string values, that are going to be converted to int/bytes/bool.
+        For other usages, property setters are recommended.
+
+        Args:
+            attr_name: Attribute name of GeneratorConfig data class.
+                       NOTE that read-only attributes are not allowed.
+            str_value: Value to be set for given attribute.
+
+        Raises:
+            ValueError: If an invalid attribute name is passed.
+            AttributeError: If there is an inconsistency between this class's properties and
+                            GeneratorConfig attributes.
+            IOError: If the given attribute cannot be configured.
+        """
+
+        if attr_name not in self._cfg_type_d.keys():
+            attrs_str = ",\n\t".join(self._cfg_type_d.keys())
+            raise ValueError(
+                f"Cannot configure {attr_name},"
+                f" not in supported list of attributes:\n\t{attrs_str}"
+            )
+
+        if attr_name not in dir(self):
+            raise AttributeError("Internal error!")
+
+        if attr_name == "src_ip_address_mask":
+            version = self._node.get_property("version").value
+            if version < 2:
+                raise IOError(
+                    f"Cannot set src_ip_address_mask, version of MFB generator is {version},"
+                    f" but minimal version 2 is required"
+                )
+
+        prop_obj = getattr(type(self), attr_name)
+        value = self._convert_attr(attr_name, str_value)
+        prop_obj.fset(self, value)
+
     def get_fconfiguration(self) -> List:
         """Returns formatted configuration of the generator as a list of [item, value] lists."""
         conf = self.get_configuration()