scripts: rt_cfg_utils: Generate SOC level pinctrl definition list

Generate soc level pinctrl DTSI with all pinmux options, and use those
phandles in pin groups

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

Author: danieldegrasse

tools/rt_cfg_utils.py

@@ -523,21 +523,22 @@ def write_pinctrl_nodes(self, outputfile):
         soc_dtsi.write("};\n\n")
         soc_dtsi.close()
 
-    def write_pinctrl_header(self, outfile):
+    def write_pinctrl_defs(self, outputfile):
         """
-        Write pinctrl header to disk in a format suitable for inclusion into
-        DTSI file
-        @param outfile: output file destination
+        Writes a pinctrl dtsi file that defines all pinmux options. The board
+        level pin groups will include the pinctrl definitions here, and define
+        the properties to be set on each pin.
+        @param outputfile file to write pinctrl dtsi file to
         """
         try:
-            soc_header = open(outfile, "w", encoding='utf8')
+            soc_dtsi = open(outputfile, "w", encoding='utf8')
         except IOError:
-            print(f"Could not write to file {outfile}")
+            print(f"Could not write to file {outputfile}")
             return
         # Start by writing header
-        soc_header.write(self._header)
+        soc_dtsi.write(self._header)
         # Write documentation block
-        soc_header.write("/*\n"
+        soc_dtsi.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"
@@ -547,25 +548,25 @@ def write_pinctrl_header(self, outfile):
                 " * each register, respectively. The config_register is used to configure\n"
                 " * the pin based on the devicetree properties set\n"
                 " */\n\n")
+        soc_dtsi.write("&iomuxc {\n")
         for pin in sorted(self._signal_map.values()):
             for iomux_opt in sorted(pin.get_mux_options()):
-                header_block = ""
                 # Get iomuxc constant values
                 iomuxc_name = iomux_opt.get_name()
                 register = iomux_opt.get_mux_reg()
-                header_block += f"#define {iomuxc_name}_MUX 0x{register:x}\n"
                 mode = iomux_opt.get_mux_val()
-                header_block += f"#define {iomuxc_name}_MODE {mode:d}\n"
                 input_reg = iomux_opt.get_daisy_reg()
-                header_block += f"#define {iomuxc_name}_INPUT 0x{input_reg:x}\n"
                 input_daisy = iomux_opt.get_daisy_val()
-                header_block += f"#define {iomuxc_name}_DAISY {input_daisy:d}\n"
                 config_reg = iomux_opt.get_cfg_reg()
-                header_block += f"#define {iomuxc_name}_CFG 0x{config_reg:x}\n"
-                soc_header.write(header_block)
-        soc_header.write("\n")
-        soc_header.close()
-
+                # build DTS node
+                dts_node = f"\t{iomuxc_name.lower()}: {iomuxc_name} {{\n"
+                dts_node += (f"\t\tpinmux = <0x{register:x} {mode:d} 0x{input_reg:x} "
+                        f"{input_daisy:d} 0x{config_reg:x}>;\n")
+                dts_node += "\t};\n"
+                # Write iomuxc dts node to file
+                soc_dtsi.write(dts_node)
+        soc_dtsi.write("};\n\n")
+        soc_dtsi.close()
 
     def write_pinctrl_overrides(self, mexfile, outputfile):
         """
@@ -634,7 +635,7 @@ def write_pinctrl_groups(self, mexfile, outputfile):
         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(f"#include <nxp/nxp_imx/rt/{self.get_soc().lower()}-iomuxc.dtsi>\n\n")
         dts_file.write("&pinctrl {\n")
         for pin_group in sorted(pin_groups.keys()):
             pins = pin_groups[pin_group]
@@ -650,31 +651,21 @@ def write_pinctrl_groups(self, mexfile, outputfile):
                 overrides = props['overrides']
                 defaults = props['defaults']
                 dts_strings = self._props_to_dts(overrides, defaults)
-                cfg_dict[dts_strings].append(iomux.get_name())
+                cfg_dict[dts_strings].append(iomux.get_name().lower())
             sorted_keys = sorted(cfg_dict.keys())
             # Second step- take each dictionary, and write out all pinmuxes
             # as well as their shared configuration into a group
             for idx in range(len(cfg_dict.keys())):
                 pinmuxes = cfg_dict[sorted_keys[idx]]
-                # MUX REG, MUX MODE, DAISY REG, DAISY, CFG_REG
-                mux_props = ["", "" ,"", "", ""]
-                # Generate each named pinmux property
+                pinmux_str = "<"
+                # Select each DTS node for mux properties
                 for mux in pinmuxes:
-                    mux_props[0] += f"<{mux + '_MUX'}>,\n\t\t\t\t"
-                    mux_props[1] += f"<{mux + '_MODE'}>,\n\t\t\t\t"
-                    mux_props[2] += f"<{mux + '_INPUT'}>,\n\t\t\t\t"
-                    mux_props[3] += f"<{mux + '_DAISY'}>,\n\t\t\t\t"
-                    mux_props[4] += f"<{mux + '_CFG'}>,\n\t\t\t\t"
-                for i in range(len(mux_props)):
-                    mux_props[i] = re.sub(r',\n\t\t\t\t$','', mux_props[i])
+                    pinmux_str += f"&{mux}\n\t\t\t\t"
+                pinmux_str = re.sub(r'\n\t\t\t\t$','>', pinmux_str)
                 # Name of group
                 dts_entry = f"\t\tgroup{idx} {{\n"
                 # Pinmuxes for group
-                dts_entry += f"\t\t\tmux = {mux_props[0]};\n"
-                dts_entry += f"\t\t\tmode = {mux_props[1]};\n"
-                dts_entry += f"\t\t\tinput = {mux_props[2]};\n"
-                dts_entry += f"\t\t\tdaisy = {mux_props[3]};\n"
-                dts_entry += f"\t\t\tcfg = {mux_props[4]};\n"
+                dts_entry += f"\t\t\tpins = {pinmux_str};\n"
                 # Properties of group
                 for prop in sorted_keys[idx]:
                     dts_entry += f"\t\t\t{prop};\n"
@@ -737,8 +728,27 @@ def _props_to_dts(self, props, defaults):
         @return array of strings suitable for writing to DTS
         """
         zephyr_props = []
+        prop_mapping = {
+            'MHZ_50': '50-mhz',
+            'MHZ_100': '100-mhz',
+            'MHZ_150': '150-mhz',
+            'MHZ_200': '200-mhz',
+            'R0': 'r0',
+            'R0_2': 'r0-2',
+            'R0_3': 'r0-3',
+            'R0_4': 'r0-4',
+            'R0_5': 'r0-5',
+            'R0_6': 'r0-6',
+            'R0_7': 'r0-7',
+            'Pull_Down_100K_Ohm': '100k',
+            'Pull_Up_47K_Ohm': '47k',
+            'Pull_Up_100K_Ohm': '100k',
+            'Pull_Up_22K_Ohm': '22k',
+            'Fast': 'fast',
+            'Slow': 'slow',
+        }
         # Lambda to convert property names to zephyr formatted strings
-        sanitize = lambda x : "\"" + re.sub(r'[\W_]', '-', x).lower() + "\""
+        sanitize = lambda x: "\"" + prop_mapping[x] + "\"" if (x in prop_mapping) else ""
         # Check pin defaults and overrides to see if the pin will have a pull or keeper
         if 'pull_keeper_enable' in props:
             pull_keeper = props['pull_keeper_enable'] == 'Enable'
@@ -751,8 +761,8 @@ def _props_to_dts(self, props, defaults):
                 keeper = props['pull_keeper_select'] == 'Keeper'
             else:
                 keeper = defaults['pull_keeper_select'] == 'Keeper'
-        if keeper:
-            zephyr_props.append('bias-bus-hold')
+        if not keeper:
+            zephyr_props.append('bias-disable')
         # For each property, append the provided override or the default
         if 'drive_strength' in props:
             zephyr_props.append(f"drive-strength = {sanitize(props['drive_strength'])}")

tools/rt_dts_gen.py

@@ -62,7 +62,7 @@
 
 if not args.soc_output:
     if args.pin_groups:
-        args.soc_output = f"{soc_name.lower()}-iomuxc.h"
+        args.soc_output = f"{soc_name.lower()}-iomuxc.dtsi"
     else:
         args.soc_output = f"{soc_name.lower()}-pinctrl.dtsi"
 
@@ -111,7 +111,7 @@
     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_defs(args.soc_output)
+    print(f"Wrote pinctrl header defs to {args.soc_output}")
     util.write_pinctrl_groups(args.mex_file, args.board_output)
     print(f"Wrote pinctrl dts file to {args.board_output}")