mcux: scripts: pinctrl: update comment syntax

Update code from writing descriptions given in pin control groups to
handle multiline descriptions as block comments. Also, update comment
code to write name of generation script correctly- since pin control
scripts are all called from gen_board_pinctrl.py

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

Author: danieldegrasse

mcux/scripts/pinctrl/imx/imx_cfg_utils.py

@@ -11,6 +11,7 @@
 import os
 import pathlib
 import logging
+import __main__
 
 # MEX file has a default namespace, map it here
 NAMESPACES = {'mex' : 'http://mcuxpresso.nxp.com/XSD/mex_configuration_14'}
@@ -586,7 +587,8 @@ def __init__(self, function, signal_map, rt):
         description = function.find('mex:description', NAMESPACES)
         pins = function.find('mex:pins', NAMESPACES)
         if description is not None and description.text is not None:
-            self._description = description.text
+            # Replace <br> html tag with newline
+            self._description = description.text.replace("&lt;br/&gt;", "\n")
         else:
             self._description = ""
         # Build dictionary mapping pin properties to pins. This allows us to
@@ -752,8 +754,12 @@ def _props_to_dts(self, props, defaults):
         zephyr_props = []
         prop_mapping = {
             'MHZ_50': '50-mhz',
+            'MHZ_100_01': '100-mhz',
+            # On some iMX RT10xx SOCs, 150 MHz is mapped to this value. However,
+            # this is not consistent for all iMX RT10xx supported by
+            # config tools. Therefore, we just force both MHZ_100_01 and
+            # MHZ_100 to 100-mhz.
             'MHZ_100': '100-mhz',
-            'MHZ_150': '150-mhz',
             'MHZ_200': '200-mhz',
             'R0': 'r0',
             'R0_2': 'r0-2',
@@ -922,7 +928,7 @@ def write_gpio_mux(self, outputfile):
         with open(outputfile, "w", encoding='utf8') as gpio_dsti:
             # Write header
             gpio_dsti.write(f"/*\n"
-                f" * File created by {os.path.basename(__file__)}\n"
+                f" * File created by {os.path.basename(__main__.__file__)}\n"
                 " * not intended for direct usage. Hand edit these DTS\n"
                 " * nodes as needed to integrate them into Zephyr.\n"
                 " */\n\n")
@@ -996,7 +1002,7 @@ def write_pinctrl_defs(self, outputfile):
             header = (f"/*\n"
             f" * {self._copyright}\n"
             f" *\n"
-            f" * Note: File generated by {os.path.basename(__file__)}\n"
+            f" * Note: File generated by {os.path.basename(__main__.__file__)}\n"
             f" * from configuration data for {self._soc_sku}\n"
             " */\n\n")
             soc_dtsi.write(header)
@@ -1058,7 +1064,7 @@ def write_pinctrl_groups(self, mexfile, outputfile):
         header = (f"/*\n"
         f" * {self._copyright}\n"
         f" *\n"
-        f" * Note: File generated by {os.path.basename(__file__)}\n"
+        f" * Note: File generated by {os.path.basename(__main__.__file__)}\n"
         f" * from {os.path.basename(mexfile)}\n"
         " */\n\n")
         with open(outputfile, "w", encoding="utf8") as dts_file:
@@ -1070,12 +1076,19 @@ def write_pinctrl_groups(self, mexfile, outputfile):
                 dts_file.write("#include <nxp/nxp_imx/"
                     f"{self.get_part_num().lower()}-pinctrl.dtsi>\n\n")
             dts_file.write("&pinctrl {\n")
-            for pin_group in sorted(pin_groups.values()):
+            for pin_group in pin_groups.values():
                 pin_props = pin_group.get_pin_props()
                 description = pin_group.get_description()
                 # if a description is present, write it
                 if description != "":
-                    dts_file.write(f"\t/* {description} */\n")
+                    description_lines = description.split("\n")
+                    if len(description_lines) == 1:
+                        dts_file.write(f"\t/* {description} */\n")
+                    else:
+                        dts_file.write("\t/*\n")
+                        for line in description_lines:
+                            dts_file.write(f"\t * {line}\n")
+                        dts_file.write("\t */\n")
                 # Write pin group name
                 name = pin_group.get_name().lower()
                 dts_file.write(f"\t{name}: {name} {{\n")

mcux/scripts/pinctrl/kinetis/kinetis_cfg_utils.py

@@ -14,6 +14,7 @@
 import collections
 import logging
 import pathlib
+import __main__
 
 # layout/index of pins tuple
 PIN = collections.namedtuple('PIN', ['PERIPH', 'NAME_PART', 'SIGNAL', 'PORT',
@@ -290,7 +291,8 @@ def __init__(self, function, signal_map):
         pins = function.find('mex:pins', NAMESPACES)
         description = function.find('mex:description', NAMESPACES)
         if description is not None and description.text is not None:
-            self._description = description.text
+            # Replace <br> html tag with newline
+            self._description = description.text.replace("&lt;br/&gt;", "\n")
         else:
             self._description = ""
         # Build dictionary mapping pin properties to pins. This allows us to
@@ -511,7 +513,7 @@ def write_pinctrl_defs(self, outputfile):
             pinmux_opts.extend(pin.get_mux_options())
         pcr_pins = list(filter(lambda p: (p.get_periph() not in ["FB", "EZPORT"]), pinmux_opts))
         file_header = ("/*\n"
-            f" * NOTE: Autogenerated file by {os.path.basename(__file__)}\n"
+            f" * NOTE: Autogenerated file by {os.path.basename(__main__.__file__)}\n"
             f" * for {self._part_num}/signal_configuration.xml\n"
             " *\n"
             f" * {self._copyright}\n"
@@ -571,7 +573,7 @@ def write_pinctrl_groups(self, mexfile, outputfile):
         @param outputfile: DTS pinctrl file to write pin groups to
         """
         file_header = ("/*\n"
-            f" * NOTE: Autogenerated file by {os.path.basename(__file__)}\n"
+            f" * NOTE: Autogenerated file by {os.path.basename(__main__.__file__)}\n"
             f" * for {self._part_num}/signal_configuration.xml\n"
             " *\n"
             f" * {self._copyright}\n"
@@ -583,15 +585,23 @@ def write_pinctrl_groups(self, mexfile, outputfile):
             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 sorted(pin_groups.values()):
+            for group in pin_groups.values():
                 pin_props = group.get_pin_props()
                 if len(pin_props) == 0:
                     # Do not write to disk
                     continue
                 logging.info("Writing pin group %s to disk", group.get_name())
                 # Write description as comment if group has one
-                if group.get_description() != "":
-                    file.write(f"\t/* {group.get_description()} */\n")
+                description = group.get_description()
+                if description != "":
+                    description_lines = description.split("\n")
+                    if len(description_lines) == 1:
+                        file.write(f"\t/* {description} */\n")
+                    else:
+                        file.write("\t/*\n")
+                        for line in description_lines:
+                            file.write(f"\t * {line}\n")
+                        file.write("\t */\n")
                 file.write(f"\t{group.get_name().lower()}: {group.get_name().lower()} {{\n")
                 idx = 0
                 for pin_prop in sorted(pin_props):

mcux/scripts/pinctrl/lpc/lpc_cfg_utils.py

@@ -15,6 +15,7 @@
 import logging
 import os
 import pathlib
+import __main__
 
 NAMESPACES = {'mex': 'http://mcuxpresso.nxp.com/XSD/mex_configuration_14'}
 
@@ -362,7 +363,8 @@ def __init__(self, function, signal_map, imx_rt = False):
         pins = function.find('mex:pins', NAMESPACES)
         description = function.find('mex:description', NAMESPACES)
         if description is not None and description.text is not None:
-            self._description = description.text
+            # Replace <br> html tag with newline
+            self._description = description.text.replace("&lt;br/&gt;", "\n")
         else:
             self._description = ""
         # Build dictionary mapping pin properties to pins. This allows us to
@@ -633,7 +635,7 @@ def write_pinctrl_defs(self, outputfile):
         @param outputfile: file to write output pinctrl defs to
         """
         file_header = ("/*\n"
-            f" * NOTE: File generated by {os.path.basename(__file__)}\n"
+            f" * NOTE: File generated by {os.path.basename(__main__.__file__)}\n"
             f" * from {self._part_num}/signal_configuration.xml\n"
             " *\n"
             f" * {self._copyright}\n"
@@ -732,7 +734,7 @@ def write_pinctrl_groups(self, mexfile, outputfile):
         """
 
         file_header = ("/*\n"
-            f" * NOTE: File generated by {os.path.basename(__file__)}\n"
+            f" * NOTE: File generated by {os.path.basename(__main__.__file__)}\n"
             f" * from {os.path.basename(mexfile)}\n"
             " *\n"
             f" * {self._copyright}\n"
@@ -747,12 +749,19 @@ def write_pinctrl_groups(self, mexfile, outputfile):
                 file.write(f"\n#include <nxp/lpc/{get_package_name(mexfile)}-pinctrl.h>\n\n")
             file.write("&pinctrl {\n")
             # Write pin groups back out to disk
-            for group in sorted(pin_groups.values()):
+            for group in pin_groups.values():
                 pin_props = group.get_pin_props()
                 description = group.get_description()
                 # if a description is present, write it
                 if description != "":
-                    file.write(f"\t/* {description} */\n")
+                    description_lines = description.split("\n")
+                    if len(description_lines) == 1:
+                        file.write(f"\t/* {description} */\n")
+                    else:
+                        file.write("\t/*\n")
+                        for line in description_lines:
+                            file.write(f"\t * {line}\n")
+                        file.write("\t */\n")
                 logging.info("Writing pin group %s to disk", group.get_name())
                 file.write(f"\t{group.get_name().lower()}: {group.get_name().lower()} {{\n")
                 idx = 0