scripts: implemented pinctrl header definition

Generate pinctrl header definitions, as opposed to pinctrl DTS nodes

Author: danieldegrasse

mcux/scripts/kinetis_cfg_utils.py

@@ -10,6 +10,7 @@
 pinctrl definitions for Zephyr
 """
 
+from bdb import set_trace
 import xml.etree.ElementTree as ET
 import re
 import collections
@@ -453,33 +454,27 @@ def _write_pins(self, which_port, pins, file):
 
         seen_nodes = []
 
-        file.write(f"&port{which_port} {{\n")
-        for pin_data in port_pins:
-            port_name = f"PT{pin_data.get_port().upper()}{pin_data.get_pin()}"
-            # Special case handle GPIO so that it will be of the form:
-            # PT[A-E][0-31]: GPIO[A-E]_PT[A-E][0-31]: ...
-            #
-            # eg:
-            # PTA3: GPIOA_PTA3: gpioa_pta3 { .... };
-            if pin_data.get_periph().startswith("GPIO"):
-                node = f"{pin_data.get_periph().lower()}_{port_name.lower()}"
-                label = f"{port_name}: {node.upper()}"
-            else:
-                label = pin_data.get_name()
-                node = label.lower()
-            k_port_pins_prop = f"< {pin_data.get_pin()} {pin_data.get_mux()} >"
 
-            if node in seen_nodes:
+        for pin_data in port_pins:
+            label = pin_data.get_name()
+            port = pin_data.get_port()
+            pin = pin_data.get_pin()
+
+            # Port values range from 'A'-'E'. Store with 4 bits
+            # Shift port value so it will not conflict with pin configuration
+            pin_val = (((ord(port) - ord('A')) & 0xF) << 28)
+            # Shift pin value to where it will be stored in the pin setting reg
+            # Pin values range from 0-31, give 6 bits for future expansion
+            # Shift pin value so it will not conflict with pin configuration
+            pin_val |= ((int(pin) & 0x3F) << 22)
+            # Put pin mux value in at the correct offset for the pin config register
+            pin_val |= ((pin_data.get_mux() & 0x7) << 8)
+
+            if label in seen_nodes:
                 continue
-            seen_nodes.append(node)
-
-            file.write(f"\t{label}: {node} {{\n")
-            file.write("\t\t/* < PIN PCR[MUX] > */\n")
-            file.write(f"\t\tnxp,kinetis-port-pins = {k_port_pins_prop};\n")
-            file.write("\t};\n")
+            seen_nodes.append(label)
 
-        file.write("};\n")
-        file.write("\n")
+            file.write(f"#define {label} 0x{pin_val:x} /* PT{port}{pin} */\n")
 
     def write_pinctrl_defs(self, outputfile):
         """
@@ -501,11 +496,19 @@ def write_pinctrl_defs(self, outputfile):
             "\n")
         with open(outputfile, "w", encoding="utf8") as file:
             file.write(file_header)
+            # ifdef guard
+            file.write(f"#ifndef _ZEPHYR_DTS_BINDING_{self._part_num.upper()}_\n")
+            file.write(f"#define _ZEPHYR_DTS_BINDING_{self._part_num.upper()}_\n\n")
+            # Write macro to make port name
+            file.write("#define MUX(port, pin) (((((port) - 'A') & 0xF) << 28) | (((pin) & 0x3F)) << 22)\n\n")
+            file.write("#define PIN(mux) (((mux) & 0xFC00000) >> 22\n\n")
+            file.write("#define PORT(mux) (((mux) & 0xF0000000) >> 28)\n\n")
             self._write_pins('a', pcr_pins, file)
             self._write_pins('b', pcr_pins, file)
             self._write_pins('c', pcr_pins, file)
             self._write_pins('d', pcr_pins, file)
             self._write_pins('e', pcr_pins, file)
+            file.write("#endif\n")
 
     def _parse_mex_cfg(self, mexfile):
         """
@@ -542,7 +545,7 @@ def write_pinctrl_groups(self, mexfile, outputfile):
         pin_groups = self._parse_mex_cfg(mexfile)
         with open(outputfile, "w", encoding="utf8") as file:
             file.write(file_header)
-            file.write(f"\n#include <nxp/kinetis/{get_package_name(mexfile)}-pinctrl.dtsi>\n\n")
+            file.write(f"\n#include <nxp/kinetis/{get_package_name(mexfile)}-pinctrl.h>\n\n")
             file.write("&pinctrl {\n")
             # Write pin groups back out to disk
             for group in pin_groups.values():
@@ -558,7 +561,7 @@ def write_pinctrl_groups(self, mexfile, outputfile):
                     # Write all pin names
                     group_str += "\t\t\tpinmux = <"
                     for pin in group.get_pins(pin_prop):
-                        group_str += f"&{pin.get_name()}\n\t\t\t\t"
+                        group_str += f"{pin.get_name()}\n\t\t\t\t"
                     # Strip out last 3 tabs and close pin name list
                     group_str = re.sub(r'\n\t\t\t\t$', '>;\n', group_str)
                     idx += 1

mcux/scripts/kinetis_gen_dts.py

@@ -56,7 +56,7 @@
     args.board_output = f"{board_name.lower().replace('-', '_')}-pinctrl.dtsi"
 
 if not args.soc_output:
-    args.soc_output = f"{package_name}-pinctrl.dtsi"
+    args.soc_output = f"{package_name}-pinctrl.h"
 
 if args.cfg_tool_root:
     # Attempt to locate all the required config files automatically, using