Synchronize PlatformIO build script according to changes in v2.0

Author: valeros

tools/platformio/boards_remap.json

@@ -0,0 +1,31 @@
+{
+    "adafruit_feather_f405": "FEATHER_F405",
+    "blackpill_f103c8_128": "BLACKPILL_F103C8",
+    "blackpill_f401ce": "BLACKPILL_F401CC",
+    "coreboard_f401rc": "CoreBoard_F401RC",
+    "disco_g031j6": "DISCO_G0316",
+    "disco_l072cz_lrwan1": "B_L072Z_LRWAN1",
+    "disco_l475vg_iot01a": "B_L475E_IOT01A",
+    "disco_l4s5i_iot01a": "B_L4S5I_IOT01A",
+    "electrosmith_daisy": "DAISY_SEED",
+    "maple_mini_origin": "MAPLEMINI_F103CB",
+    "microduino32_flash": "GENERIC_F103C8TX",
+    "netduino2plus": "GENERIC_F405RGTX",
+    "nucleo_wb55rg_p": "P_NUCLEO_WB55RG",
+    "olimex_e407": "GENERIC_F407ZGTX",
+    "olimex_f103": "GENERIC_F103R8TX",
+    "olimex_h407": "GENERIC_F407ZGTX",
+    "olimex_p405": "GENERIC_F405RGTX",
+    "olimexino": "GENERIC_F103RBTX",
+    "piconomix_px_her0": "PX_HER0",
+    "rak811_tracker_32": "RAK811_TRACKERA",
+    "robotdyn_blackpill_f303cc": "BLACKPILL_F303CC",
+    "rumba32_f446ve": "RUMBA32",
+    "sparky_v1": "SPARKY_F303CC",
+    "steval_mksboxv1": "STEVAL_MKSBOX1V1",
+    "stm32f4stamp": "GENERIC_F405RGTX",
+    "thunder_pack": "THUNDERPACK_L072",
+    "thunder_pack_f411": "THUNDERPACK_F411",
+    "vccgnd_f103zet6": "VCCGND_F103ZET6_MINI",
+    "waveshare_open103z": "GENERIC_F103ZEHX"
+}

tools/platformio-build.py renamed to tools/platformio/platformio-build.py

@@ -22,29 +22,29 @@
 https://github.com/stm32duino/Arduino_Core_STM32
 """
 
-
+import json
 from os.path import isfile, isdir, join
 
 from SCons.Script import DefaultEnvironment
 
 env = DefaultEnvironment()
 platform = env.PioPlatform()
-board = env.BoardConfig()
+board_config = env.BoardConfig()
 
 FRAMEWORK_DIR = platform.get_package_dir("framework-arduinoststm32")
 CMSIS_DIR = join(platform.get_package_dir("framework-cmsis"), "CMSIS")
 assert isdir(FRAMEWORK_DIR)
 assert isdir(CMSIS_DIR)
 
 
-mcu = env.BoardConfig().get("build.mcu", "")
-board_name = env.subst("$BOARD")
+mcu = board_config.get("build.mcu", "")
 mcu_type = mcu[:-2]
-variant = board.get("build.variant")
+variant = board_config.get(
+    "build.variant", board_config.get("build.arduino.variant", "generic"))
 series = mcu_type[:7].upper() + "xx"
 variants_dir = (
-    join("$PROJECT_DIR", board.get("build.variants_dir"))
-    if board.get("build.variants_dir", "")
+    join("$PROJECT_DIR", board_config.get("build.variants_dir"))
+    if board_config.get("build.variants_dir", "")
     else join(FRAMEWORK_DIR, "variants")
 )
 variant_dir = join(variants_dir, variant)
@@ -97,8 +97,8 @@ def process_usb_configuration(cpp_defines):
         env.Append(
             CPPDEFINES=[
                 "USBCON",
-                ("USB_VID", board.get("build.hwids", [[0, 0]])[0][0]),
-                ("USB_PID", board.get("build.hwids", [[0, 0]])[0][1]),
+                ("USB_VID", board_config.get("build.hwids", [[0, 0]])[0][0]),
+                ("USB_PID", board_config.get("build.hwids", [[0, 0]])[0][1]),
             ]
         )
 
@@ -107,13 +107,15 @@ def process_usb_configuration(cpp_defines):
 
 
 def get_arm_math_lib(cpu):
-    core = board.get("build.cpu")[7:9]
-    if core == "m4":
+    core = board_config.get("build.cpu")
+    if "m33" in core:
+        return "arm_ARMv8MMLlfsp_math"
+    elif "m4" in core:
         return "arm_cortexM4lf_math"
-    elif core == "m7":
+    elif "m7" in core:
         return "arm_cortexM7lfsp_math"
 
-    return "arm_cortex%sl_math" % core.upper()
+    return "arm_cortex%sl_math" % core[7:9].upper()
 
 
 def configure_application_offset(mcu, upload_protocol):
@@ -131,7 +133,7 @@ def configure_application_offset(mcu, upload_protocol):
         # STM32F103 series doesn't have embedded DFU over USB
         # stm32duino bootloader (v1, v2) is used instead
         if mcu.startswith("stm32f103"):
-            if board.get("upload.boot_version", 2) == 1:
+            if board_config.get("upload.boot_version", 2) == 1:
                 offset = 0x5000
             else:
                 offset = 0x2000
@@ -144,12 +146,61 @@ def configure_application_offset(mcu, upload_protocol):
     env.Append(LINKFLAGS=["-Wl,--defsym=LD_FLASH_OFFSET=%s" % hex(offset)])
 
 
-if any(mcu in board.get("build.cpu") for mcu in ("cortex-m4", "cortex-m7")):
+if any(mcu in board_config.get("build.cpu") for mcu in ("cortex-m4", "cortex-m7")):
     env.Append(
         CCFLAGS=["-mfpu=fpv4-sp-d16", "-mfloat-abi=hard"],
         LINKFLAGS=["-mfpu=fpv4-sp-d16", "-mfloat-abi=hard"],
     )
 
+
+def load_boards_remap():
+    remap_file = join(FRAMEWORK_DIR, "tools", "platformio", "boards_remap.json")
+    if not isfile(remap_file):
+        print("Warning! Couldn't find board remap file!")
+        return {}
+
+    with open(remap_file, "r") as fp:
+        try:
+            return json.load(fp)
+        except:
+            print("Warning! Failed to parse board remap file!")
+            return {}
+
+
+def get_arduino_board_id(board_config, mcu):
+    # User-specified value
+    if board_config.get("build.arduino.board", ""):
+        return board_config.get("build.arduino.board")
+
+    # Default boards
+    boards_remap = load_boards_remap()
+    board_id = env.subst("$BOARD")
+    if board_id in boards_remap:
+        return boards_remap[board_id]
+
+    # Fall back to default cases according to MCU value for generic boards
+    if board_id.lower().startswith("generic"):
+        board_id = "GENERIC_"
+        mcu = mcu.upper()
+        if len(mcu) > 12:
+            board_id += mcu[5:12] + "X"
+        else:
+            if len(mcu) > 10:
+                board_id += mcu[5:11] + "TX"
+            else:
+                board_id += mcu
+            print(
+                "Warning! Couldn't generate proper internal board id from the `%s` MCU "
+                "field! At least 12 symbols are required!" % mcu
+            )
+
+            print("Falling back to `%s`." % board_id)
+
+    return board_id.upper()
+
+
+board_id = get_arduino_board_id(board_config, mcu)
+
 env.Append(
     ASFLAGS=["-x", "assembler-with-cpp"],
     CFLAGS=["-std=gnu11"],
@@ -162,11 +213,10 @@ def configure_application_offset(mcu, upload_protocol):
     ],
     CCFLAGS=[
         "-Os",  # optimize for size
-        "-mcpu=%s" % env.BoardConfig().get("build.cpu"),
+        "-mcpu=%s" % board_config.get("build.cpu"),
         "-mthumb",
         "-ffunction-sections",  # place each function in its own section
         "-fdata-sections",
-        "-Wall",
         "-nostdlib",
         "--param",
         "max-inline-insns-single=500",
@@ -175,9 +225,23 @@ def configure_application_offset(mcu, upload_protocol):
         series,
         ("ARDUINO", 10808),
         "ARDUINO_ARCH_STM32",
-        "ARDUINO_%s" % board_name.upper(),
-        ("BOARD_NAME", '\\"%s\\"' % board_name.upper()),
+        "ARDUINO_%s" % board_id,
+        ("BOARD_NAME", '\\"%s\\"' % board_id),
         "HAL_UART_MODULE_ENABLED",
+        "USE_FULL_LL_DRIVER",
+        (
+            "VARIANT_H",
+            '\\"%s\\"'
+            % board_config.get(
+                "build.arduino.variant_h",
+                "variant_%s.h"
+                % (
+                    "generic"
+                    if board_id.lower().startswith("generic")
+                    else board_id
+                ),
+            ),
+        ),
     ],
     CPPPATH=[
         join(FRAMEWORK_DIR, "cores", "arduino", "avr"),
@@ -263,45 +327,55 @@ def configure_application_offset(mcu, upload_protocol):
             "gcc",
         ),
         join(CMSIS_DIR, "DSP", "Include"),
+        join(CMSIS_DIR, "DSP", "PrivateInclude"),
         join(FRAMEWORK_DIR, "cores", "arduino"),
-        variant_dir,
     ],
     LINKFLAGS=[
         "-Os",
         "-mthumb",
-        "-mcpu=%s" % env.BoardConfig().get("build.cpu"),
+        "-mcpu=%s" % board_config.get("build.cpu"),
         "--specs=nano.specs",
         "-Wl,--gc-sections,--relax",
         "-Wl,--check-sections",
         "-Wl,--entry=Reset_Handler",
         "-Wl,--unresolved-symbols=report-all",
         "-Wl,--warn-common",
-        "-Wl,--defsym=LD_MAX_SIZE=%d" % board.get("upload.maximum_size"),
-        "-Wl,--defsym=LD_MAX_DATA_SIZE=%d" % board.get("upload.maximum_ram_size"),
+        "-Wl,--defsym=LD_MAX_SIZE=%d" % board_config.get("upload.maximum_size"),
+        "-Wl,--defsym=LD_MAX_DATA_SIZE=%d" % board_config.get("upload.maximum_ram_size"),
     ],
     LIBS=[
-        get_arm_math_lib(env.BoardConfig().get("build.cpu")),
+        get_arm_math_lib(board_config.get("build.cpu")),
         "c",
         "m",
         "gcc",
         "stdc++",
     ],
-    LIBPATH=[variant_dir, join(CMSIS_DIR, "DSP", "Lib", "GCC")],
+    LIBPATH=[join(CMSIS_DIR, "DSP", "Lib", "GCC")],
 )
 
-env.ProcessFlags(board.get("build.framework_extra_flags.arduino", ""))
+env.ProcessFlags(board_config.get("build.framework_extra_flags.arduino", ""))
 
 configure_application_offset(mcu, upload_protocol)
 
 #
 # Linker requires preprocessing with correct RAM|ROM sizes
 #
 
-if not board.get("build.ldscript", ""):
+if not board_config.get("build.ldscript", ""):
     env.Replace(LDSCRIPT_PATH=join(FRAMEWORK_DIR, "system", "ldscript.ld"))
     if not isfile(join(env.subst(variant_dir), "ldscript.ld")):
         print("Warning! Cannot find linker script for the current target!\n")
-    env.Append(LINKFLAGS=[("-Wl,--default-script", join(variant_dir, "ldscript.ld"))])
+    env.Append(
+        LINKFLAGS=[
+            (
+                "-Wl,--default-script",
+                '\"%s\"' % join(
+                    variant_dir,
+                    board_config.get("build.arduino.ldscript", "ldscript.ld"),
+                ),
+            )
+        ]
+    )
 
 #
 # Process configuration flags
@@ -330,13 +404,16 @@ def configure_application_offset(mcu, upload_protocol):
 
 libs = []
 
-if "build.variant" in env.BoardConfig():
-    env.Append(CPPPATH=[variant_dir])
+if "build.variant" in board_config:
+    env.Append(
+        CCFLAGS='"-I%s"' % variant_dir,
+        LINKFLAGS=['"-L%s"' % variant_dir]
+    )
     env.BuildSources(join("$BUILD_DIR", "FrameworkArduinoVariant"), variant_dir)
 
-env.BuildSources(
+libs.append(env.BuildLibrary(
     join("$BUILD_DIR", "FrameworkArduino"), join(FRAMEWORK_DIR, "cores", "arduino")
-)
+))
 
 env.BuildSources(
     join("$BUILD_DIR", "SrcWrapper"), join(FRAMEWORK_DIR, "libraries", "SrcWrapper")