tools: Enabled rt_cfg_utils script to generate pin node or pin groups

Enabled rt_cfg_utils script to generate pin node DTS and DTSI files, or
pin group/iomuxc header formats, since the format for RT parts is not
yet standardized.

Signed-off-by: Daniel DeGrasse <[email protected]>

Author: danieldegrasse

tools/rt_cfg_utils.py

@@ -523,9 +523,50 @@ def write_pinctrl_nodes(self, outputfile):
         soc_dtsi.write("};\n\n")
         soc_dtsi.close()
 
+    def write_pinctrl_header(self, outfile):
+        """
+        Write pinctrl header to disk in a format suitable for inclusion into
+        DTSI file
+        @param outfile: output file destination
+        """
+        try:
+            soc_header = open(outfile, "w", encoding='utf8')
+        except IOError:
+            print(f"Could not write to file {outfile}")
+            return
+        # Start by writing header
+        soc_header.write(self._header)
+        # Write documentation block
+        soc_header.write("/*\n"
+                " * SOC level pinctrl defintions\n"
+                " * These definitions define SOC level defaults for each pin,\n"
+                " * and select the pinmux for the pin. Pinmux entries are a tuple of:\n"
+                " * <mux_register mux_mode input_register input_daisy config_register>\n"
+                " * the mux_register and input_daisy reside in the IOMUXC peripheral, and\n"
+                " * the pinctrl driver will write the mux_mode and input_daisy values into\n"
+                " * each register, respectively. The config_register is used to configure\n"
+                " * the pin based on the devicetree properties set\n"
+                " */\n\n")
+        for pin in sorted(self._signal_map.values()):
+            for iomux_opt in sorted(pin.get_mux_options()):
+                # Get iomuxc constant values
+                iomuxc_name = iomux_opt.get_name()
+                register = iomux_opt.get_mux_reg()
+                mode = iomux_opt.get_mux_val()
+                input_reg = iomux_opt.get_daisy_reg()
+                input_daisy = iomux_opt.get_daisy_val()
+                config_reg = iomux_opt.get_cfg_reg()
+                header_line = (f"#define {iomuxc_name} 0x{register:x} {mode:d}"
+                    f" 0x{input_reg:x} {input_daisy:d} 0x{config_reg:x}\n")
+                soc_header.write(header_line)
+        soc_header.write("\n")
+        soc_header.close()
+
+
     def write_pinctrl_overrides(self, mexfile, outputfile):
         """
-        Write pinctrl overrides to disk as a parsed DTS file
+        Write pinctrl overrides to disk as a parsed DTS file. Intended for use
+        with the output of @ref write_pinctrl_nodes
         @param mexfile: mex file to parse for pin configuration
         @param outputfile: file to write dts to
         """
@@ -564,6 +605,54 @@ def write_pinctrl_overrides(self, mexfile, outputfile):
             dts_file.write(dts_entry)
         # DTS file write is done, close it
         dts_file.close()
+    
+    def write_pinctrl_groups(self, mexfile, outputfile):
+        """
+        Write pinctrl groups to disk as a parsed DTS file. Intended for use
+        with the output of @ref write_pinctrl_header
+        """
+        if self._signal_map is None:
+            print("Cannot write pinctrl groups without a signal map")
+        try:
+            config_tree = ET.parse(mexfile)
+        except ET.ParseError:
+            print(f"Malformed XML tree {mexfile}")
+            return
+        except IOError:
+            print(f"File {mexfile} could not be opened")
+            return
+        try:
+            dts_file = open(outputfile, "w", encoding='utf8')
+        except IOError:
+            print(f"Could not write to file {outputfile}")
+            return
+        # Parse the mex file
+        pin_groups = self._parse_mex_cfg(config_tree, self._signal_map)
+        # Start by writing header
+        dts_file.write(self._header)
+        dts_file.write(f"#include <nxp/nxp_imx/rt/{self.get_soc().lower()}-iomuxc.h>\n\n")
+        dts_file.write("&pinctrl {\n")
+        for pin_group in sorted(pin_groups.keys()):
+            pins = pin_groups[pin_group]
+            # Write pin group name
+            dts_file.write(f"\t{pin_group}: {pin_group} {{\n")
+            for pin in sorted(pins.keys()):
+                props = pins[pin]
+                iomux = props['mux']
+                overrides = props['overrides']
+                defaults = props['defaults']
+                dts_entry = f"\t\t{pin}: {pin} {{\n"
+                dts_entry += f"\t\t\tpinmux = <{iomux.get_name()}>;\n"
+                dts_strings = self._props_to_dts(overrides, defaults)
+                for entry in sorted(dts_strings):
+                    dts_entry += f"\t\t\t{entry};\n"
+                dts_entry += "\t\t};\n\n"
+                dts_file.write(dts_entry)
+            # Write closing brace of pin group
+            dts_file.write("\t};\n\n")
+        # Write closing brace of pinctrl node
+        dts_file.write("};\n\n")
+            
 
     """
     Private class methods

tools/rt_dts_gen.py

@@ -46,6 +46,8 @@
                     help='Output path for board level DTS file')
 parser.add_argument('--soc-output', metavar = 'SOC_OUT', type=str,
                     help='Output path for soc level DTSI file')
+parser.add_argument('--pin-groups', action='store_true',
+                    help='Use pin groups instead of pin nodes')
 
 args = parser.parse_args()
 
@@ -54,12 +56,15 @@
 package_name = rt_cfg_utils.get_package_name(args.mex_file)
 soc_name = re.match(r'MIMXRT[0-9]+', processor_name).group(0)
 
+# Set defaults for optional arguments
 if not args.board_output:
     args.board_output = f"{board_name.lower()}-pinctrl.dtsi"
 
-# Set defaults for optional arguments
 if not args.soc_output:
-    args.soc_output = f"{soc_name.lower()}-pinctrl.dtsi"
+    if args.pin_groups:
+        args.soc_output = f"{soc_name.lower()}-iomuxc.h"
+    else:
+        args.soc_output = f"{soc_name.lower()}-pinctrl.dtsi"
 
 if args.cfg_tool_root:
     # Attempt to locate all the required config files automatically, using
@@ -98,9 +103,15 @@
 else:
     util = rt_cfg_utils.NXPSdkUtil(args.register_file, args.iomuxc_file, args.snvs_file,
         args.signal_file)
-
-print(f"Generating configuration for {board_name}")
-util.write_pinctrl_nodes(args.soc_output)
-print(f"Wrote pinctrl dtsi file to {args.soc_output}")
-util.write_pinctrl_overrides(args.mex_file, args.board_output)
-print(f"Wrote pinctrl dts file to {args.board_output}")
+if not args.pin_groups:
+    print(f"Generating configuration for {board_name}")
+    util.write_pinctrl_nodes(args.soc_output)
+    print(f"Wrote pinctrl dtsi file to {args.soc_output}")
+    util.write_pinctrl_overrides(args.mex_file, args.board_output)
+    print(f"Wrote pinctrl dts file to {args.board_output}")
+else:
+    print(f"Generating configuration for {board_name}")
+    util.write_pinctrl_header(args.soc_output)
+    print(f"Wrote pinctrl header file to {args.soc_output}")
+    util.write_pinctrl_groups(args.mex_file, args.board_output)
+    print(f"Wrote pinctrl dts file to {args.board_output}")