[genpinmap] Manage atlernative pins (_ALTx)

Signed-off-by: Frederic Pillon <frederic.pillon@st.com>

Author: fpistm

src/genpinmap/genpinmap_arduino.py

@@ -12,6 +12,7 @@
 mcu_file = ""
 mcu_list = []  # 'name'
 io_list = []  # 'PIN','name'
+alt_list = []  # 'PIN','name'
 adclist = []  # 'PIN','name','ADCSignal'
 daclist = []  # 'PIN','name','DACSignal'
 i2cscl_list = []  # 'PIN','name','I2CSCLSignal'
@@ -167,13 +168,13 @@ def isPinAndSignalInList(pin, signal, lst):
     return len([item for item in lst if item[0] == pin and item[2] == signal])
 
 
-def store_pin(pin, name):
-    if pin in [p[0] for p in io_list]:
+def store_pin(pin, name, dest_list):
+    if pin in [p[0] for p in dest_list]:
         return
     # store pin I/O
     p = [pin, name]
-    if p not in io_list:
-        io_list.append(p)
+    if p not in dest_list:
+        dest_list.append(p)
 
 
 # function to store ADC list
@@ -349,8 +350,14 @@ def print_header():
 #include "%s.h"
 
 /* =====
- * Note: Commented lines are alternative possibilities which are not used per default.
- *       If you change them, you will have to know what you do
+ * Notes:
+ * - The pins mentioned Px_y_ALTz are alternative possibilities which use other
+ *   HW peripheral instances. You can use them the same way as any other "normal"
+ *   pin (i.e. analogWrite(PA7_ALT0, 128);). These pins are not available thanks
+ *   pin number (Dx or x).
+ *
+ * - Commented lines are alternative possibilities which are not used per default.
+ *   If you change them, you will have to know what you do
  * =====
  */
 """ % (
@@ -444,6 +451,7 @@ def print_all_lists():
     if print_list_header("SD", "SD", "SD", sd_list):
         print_sd()
     # Print specific PinNames in header file
+    print_alt_h()
     print_syswkup_h()
     print_usb_h()
 
@@ -500,9 +508,19 @@ def print_adc():
         s_pin_data += "_ADC_CONTROL"
     s_pin_data += ", GPIO_NOPULL, 0, "
 
+    prev_p = ""
+    alt_index = 0
+
     for p in adclist:
         if "IN" in p[2]:
-            s1 = "%-10s" % ("  {" + p[0] + ",")
+            if p[0] == prev_p:
+                p[0] += "_ALT%d" % alt_index
+                alt_index += 1
+                store_pin(p[0], p[1], alt_list)
+            else:
+                prev_p = p[0]
+                alt_index = 0
+            s1 = "%-15s" % ("  {" + p[0] + ",")
             a = p[2].split("_")
             inst = a[0].replace("ADC", "")
             if len(inst) == 0:
@@ -553,9 +571,18 @@ def print_dac():
 
 
 def print_i2c(lst):
+    prev_p = ""
+    alt_index = 0
     for p in lst:
         result = get_gpio_af_num(p[1], p[2])
-        s1 = "%-10s" % ("  {" + p[0] + ",")
+        if p[0] == prev_p:
+            p[0] += "_ALT%d" % alt_index
+            store_pin(p[0], p[1], alt_list)
+            alt_index += 1
+        else:
+            prev_p = p[0]
+            alt_index = 0
+        s1 = "%-15s" % ("  {" + p[0] + ",")
         # 2nd element is the I2C XXX signal
         b = p[2].split("_")[0]
         s1 += (
@@ -576,9 +603,18 @@ def print_i2c(lst):
 
 
 def print_pwm():
+    prev_p = ""
+    alt_index = 0
     for p in pwm_list:
         result = get_gpio_af_num(p[1], p[2])
-        s1 = "%-10s" % ("  {" + p[0] + ",")
+        if p[0] == prev_p:
+            p[0] += "_ALT%d" % alt_index
+            store_pin(p[0], p[1], alt_list)
+            alt_index += 1
+        else:
+            prev_p = p[0]
+            alt_index = 0
+        s1 = "%-15s" % ("  {" + p[0] + ",")
         # 2nd element is the PWM signal
         a = p[2].split("_")
         inst = a[0]
@@ -605,9 +641,18 @@ def print_pwm():
 
 
 def print_uart(lst):
+    prev_p = ""
+    alt_index = 0
     for p in lst:
         result = get_gpio_af_num(p[1], p[2])
-        s1 = "%-10s" % ("  {" + p[0] + ",")
+        if p[0] == prev_p:
+            p[0] += "_ALT%d" % alt_index
+            store_pin(p[0], p[1], alt_list)
+            alt_index += 1
+        else:
+            prev_p = p[0]
+            alt_index = 0
+        s1 = "%-15s" % ("  {" + p[0] + ",")
         # 2nd element is the UART_XX signal
         b = p[2].split("_")[0]
         s1 += "%-9s" % (b[: len(b) - 1] + b[len(b) - 1 :] + ",")
@@ -628,9 +673,18 @@ def print_uart(lst):
 
 
 def print_spi(lst):
+    prev_p = ""
+    alt_index = 0
     for p in lst:
         result = get_gpio_af_num(p[1], p[2])
-        s1 = "%-10s" % ("  {" + p[0] + ",")
+        if p[0] == prev_p:
+            p[0] += "_ALT%d" % alt_index
+            store_pin(p[0], p[1], alt_list)
+            alt_index += 1
+        else:
+            prev_p = p[0]
+            alt_index = 0
+        s1 = "%-15s" % ("  {" + p[0] + ",")
         # 2nd element is the SPI_XXXX signal
         instance = p[2].split("_")[0].replace("SPI", "")
         s1 += "SPI" + instance + ", STM_PIN_DATA(STM_MODE_AF_PP, GPIO_PULLUP, "
@@ -804,6 +858,23 @@ def print_usb(lst):
         )
 
 
+def print_alt_h():
+    if len(alt_list) == 0:
+        out_h_file.write("/* No alternate */\n")
+    else:
+        out_h_file.write("/* Alternate pin name */\n")
+        # print pin name under switch
+        for p in alt_list:
+            if "_ALT" in p[0]:
+                s1 = "  %-10s = %-5s | %s,\n" % (
+                    p[0],
+                    p[0].split("_A")[0],
+                    p[0].split("_")[2],
+                )
+                out_h_file.write(s1)
+    out_h_file.write("\n")
+
+
 def print_syswkup_h():
     if len(syswkup_list) == 0:
         out_h_file.write("/* NO SYS_WKUP */\n")
@@ -863,6 +934,8 @@ def natural_sortkey2(list_2_elem):
 
 
 def sort_my_lists():
+    io_list.sort(key=natural_sortkey)
+    alt_list.sort(key=natural_sortkey)
     adclist.sort(key=natural_sortkey)
     daclist.sort(key=natural_sortkey)
     i2cscl_list.sort(key=natural_sortkey)
@@ -895,6 +968,7 @@ def sort_my_lists():
 
 def clean_all_lists():
     del io_list[:]
+    del alt_list[:]
     del adclist[:]
     del daclist[:]
     del i2cscl_list[:]
@@ -939,7 +1013,7 @@ def parse_pins():
                 pin = m.group(0)[:3] + "_" + m.group(0)[3:]
             name = s.attributes["Name"].value.strip()  # full name: "PF0 / OSC_IN"
             if s.attributes["Type"].value in ["I/O", "MonoIO"]:
-                store_pin(pin, name)
+                store_pin(pin, name, io_list)
             else:
                 continue
             siglist = s.getElementsByTagName("Signal")
@@ -1110,12 +1184,15 @@ def parse_pins():
     print_header()
     print_all_lists()
 
-    nb_pin = len(io_list)
-    print(" * I/O pins found: %i" % nb_pin)
+    print(
+        " * Total I/O pins found: {} ({} + {} ALT I/O pins)\n".format(
+            (len(io_list) + len(alt_list)), len(io_list), len(alt_list)
+        )
+    )
     # io_list.sort(key=natural_sortkey)
     # for io in io_list:
     #     print(io[0] + ", " + io[1])
-    print("done\n")
+
     clean_all_lists()
 
     out_c_file.close()