Correct typo in PlatformIO docs (#342)

By default RTTI (Run-Time Type Information) is disabled because most apps
don't need run time type info enabled.  However, certain libraries expect
to be able to query types of objects at runtime, so add a menu to enable it.

README.md

@@ -18,9 +18,12 @@ See https://arduino-pico.readthedocs.io/en/latest/ along with the examples for m
 * Adafruit STEMMA Friend RP2040
 * Adafruit Trinkey RP2040 QT
 * Arduino Nano RP2040 Connect (preliminary)
+* Cytron Maker Pi RP2040
 * Invector Labs Challenger RP2040 WiFi
 * Invector Labs Challenger RP2040 LTE
+* Melopero Shake RP2040
 * SparkFun ProMicro RP2040
+* uPesy RP2040 DevKit
 * Generic (configurable flash, I/O pins)
 
 # Installing via Arduino Boards Manager

cores/rp2040/wiring_analog.cpp

@@ -121,7 +121,10 @@ auto_init_mutex(_adcMutex);
 extern "C" int analogRead(pin_size_t pin) {
     CoreMutex m(&_adcMutex);
 
-    if ((pin < A0) || (pin > A3) || !m) {
+    pin_size_t maxPin = max(A0, A3);
+    pin_size_t minPin = min(A0, A3);
+
+    if ((pin < minPin) || (pin > maxPin) || !m) {
         DEBUGCORE("ERROR: Illegal analogRead pin (%d)\n", pin);
         return 0;
     }
@@ -129,7 +132,7 @@ extern "C" int analogRead(pin_size_t pin) {
         adc_init();
     }
     adc_gpio_init(pin);
-    adc_select_input(pin - A0);
+    adc_select_input(pin - minPin);
     return adc_read();
 }
 

cores/rp2040/wiring_digital.cpp

@@ -28,6 +28,7 @@ extern "C" void pinMode(pin_size_t ulPin, PinMode ulMode) {
     case INPUT:
         gpio_init(ulPin);
         gpio_set_dir(ulPin, false);
+        gpio_disable_pulls(ulPin);
         break;
     case INPUT_PULLUP:
         gpio_init(ulPin);

cores/rp2040/wiring_pulse.cpp

@@ -38,7 +38,7 @@ extern "C" unsigned long pulseIn(uint8_t pin, uint8_t state, unsigned long timeo
     }
 
     // Wait for assert
-    while ((!!gpio_get(pin) != !state) && (time_us_64() < abort));
+    while ((!!gpio_get(pin) != !!state) && (time_us_64() < abort));
     uint64_t begin = time_us_64();
     if (begin >= abort) {
         return 0;

docs/index.rst

@@ -20,6 +20,8 @@ For the latest version, always check https://github.com/earlephilhower/arduino-p
    Installation <install>
    IDE Menus <ide>
 
+   Platform.IO Integration <platformio>
+
    Pin (Re)Assignment <pins>
 
    Analog I/O <analog>

docs/platformio.rst

@@ -0,0 +1,219 @@
+Using this core with PlatformIO
+===============================
+
+What is PlatformIO? 
+-------------------
+
+`PlatformIO <https://platformio.org/>`__  is a free, open-source build-tool written in Python, which also integrates into VSCode code as an extension.
+
+PlatformIO significantly simplifies writing embedded software by offering a unified build system, yet being able to create project files for many different IDEs, including VSCode, Eclipse, CLion, etc. 
+Through this, PlatformIO can offer extensive features such as IntelliSense (autocomplete), debugging, unit testing etc., which not available in the standard Arduino IDE.
+
+The Arduino IDE experience:
+
+.. image:: images/the_arduinoide_experience.png
+
+The PlatformIO experience:
+
+.. image:: images/the_platformio_experience.png
+
+Refer to the general documentation at https://docs.platformio.org/.
+
+Especially useful is the `Getting started with VSCode + PlatformIO <https://docs.platformio.org/en/latest/integration/ide/vscode.html#installation), [CLI reference](https://docs.platformio.org/en/latest/core/index.html) and [platformio.ini options](https://docs.platformio.org/en/latest/projectconf/index.html)>`__ page.
+
+Hereafter it is assumed that you have a basic understanding of PlatformIO in regards to project creation, project file structure and building and uploading PlatformIO projects, through reading the above pages.
+
+Current state of development
+----------------------------
+
+At the time of writing, PlatformIO integration for this core is a work-in-progress and not yet merged into mainline PlatformIO. This is subject to change soon.
+
+If you want to use the PlatformIO integration right now, make sure you first create a standard Raspberry Pi Pico + Arduino project within PlatformIO. 
+This will give you a project with the ``platformio.ini`` 
+
+.. code:: ini
+
+    [env:pico]
+    platform = raspberrypi
+    board = pico
+    framework = arduino
+
+Here, you need to change the `platform` to take advantage of the features described hereunder. 
+You *also* need to inject two PlatformIO packages, one for the compiler toolchain and one for the Arduino core package.
+
+.. code:: ini
+
+    [env:pico]
+    platform = https://github.com/maxgerhardt/platform-raspberrypi.git
+    board = pico
+    framework = arduino
+    ; note that download link for toolchain is specific for OS. see https://github.com/earlephilhower/pico-quick-toolchain/releases.
+    platform_packages = 
+        maxgerhardt/framework-arduinopico@https://github.com/earlephilhower/arduino-pico.git
+        maxgerhardt/toolchain-pico@https://github.com/earlephilhower/pico-quick-toolchain/releases/download/1.3.1-a/x86_64-w64-mingw32.arm-none-eabi-7855b0c.210706.zip
+    
+When the support for this core has been merged into mainline PlatformIO, this notice will be removed and a standard `platformio.ini` as shown above will work as a base.
+
+Selecting the new core
+----------------------
+
+Prerequisite for using this core is to tell PlatformIO to switch to it.
+There will be board definition files where the Earle-Philhower core will
+be the default since it's a board that only exists in this core (and not
+the other https://github.com/arduino/ArduinoCore-mbed). To switch boards
+for which this is not the default core (e.g. the standard
+``board = pico``), the directive
+
+.. code:: ini
+
+    board_build.core = earlephilhower
+
+must be added to the ``platformio.ini``. This controls the `core
+switching
+logic <https://github.com/maxgerhardt/platform-raspberrypi/blob/77e0d3a29d1dbf00fd3ec3271104e3bf4820869c/builder/frameworks/arduino/arduino.py#L27-L32>`__.
+
+Flash size
+----------
+
+Controlled via specifying the size allocated for the filesystem.
+Available sketch size is calculated accordingly by using (as in
+``makeboards.py``) that number and the (constant) EEPROM size (4096
+bytes) and the total flash size as known to PlatformIO via the board
+definition file. The expression on the right can involve "b","k","m"
+(bytes/kilobytes/megabytes) and floating point numbers. This makes it
+actually more flexible than in the Arduino IDE where there is a finite
+list of choices. Calculations happen in `the
+platform <https://github.com/maxgerhardt/platform-raspberrypi/blob/77e0d3a29d1dbf00fd3ec3271104e3bf4820869c/builder/main.py#L118-L184>`__.
+
+.. code:: ini
+
+    ; in reference to a board = pico config (2MB flash)
+    ; Flash Size: 2MB (Sketch: 1MB, FS:1MB)
+    board_build.filesystem_size = 1m
+    ; Flash Size: 2MB (No FS)
+    board_build.filesystem_size = 0m
+    ; Flash Size: 2MB (Sketch: 0.5MB, FS:1.5MB)
+    board_build.filesystem_size = 1.5m
+
+CPU Speed
+---------
+
+As for all other PlatformIO platforms, the ``f_cpu`` macro value (which
+is passed to the core) can be changed as
+`documented <https://docs.platformio.org/en/latest/boards/raspberrypi/pico.html#configuration>`__
+
+.. code:: ini
+
+    ; 133MHz
+    board_build.f_cpu = 133000000L
+
+Debug Port
+----------
+
+Via
+`build_flags <https://docs.platformio.org/en/latest/projectconf/section_env_build.html#build-flags>`__
+as done for many other cores
+(`example <https://docs.platformio.org/en/latest/platforms/ststm32.html#configuration>`__).
+
+.. code:: ini
+
+    ; Debug Port: Serial
+    build_flags = -DDEBUG_RP2040_PORT=Serial
+    ; Debug Port: Serial 1
+    build_flags = -DDEBUG_RP2040_PORT=Serial1
+    ; Debug Port: Serial 2
+    build_flags = -DDEBUG_RP2040_PORT=Serial2
+
+Debug Level
+-----------
+
+Done again by directly adding the needed `build
+flags <https://github.com/earlephilhower/arduino-pico/blob/05356da2c5552413a442f742e209c6fa92823666/boards.txt#L104-L114>`__.
+When wanting to define multiple build flags, they must be accumulated in
+either a sing line or a newline-separated expression.
+
+.. code:: ini
+
+    ; Debug level: Core
+    build_flags = -DDEBUG_RP2040_CORE
+    ; Debug level: SPI
+    build_flags = -DDEBUG_RP2040_SPI
+    ; Debug level: Wire
+    build_flags = -DDEBUG_RP2040_WIRE
+    ; Debug level: All
+    build_flags = -DDEBUG_RP2040_WIRE -DDEBUG_RP2040_SPI -DDEBUG_RP2040_CORE
+    ; Debug level: NDEBUG
+    build_flags = -DNDEBUG
+
+    ; example: Debug port on serial 2 and all debug output
+    build_flags = -DDEBUG_RP2040_WIRE -DDEBUG_RP2040_SPI -DDEBUG_RP2040_CORE -DDEBUG_RP2040_PORT=Serial2
+    ; equivalent to above
+    build_flags = 
+       -DDEBUG_RP2040_WIRE
+       -DDEBUG_RP2040_SPI
+       -DDEBUG_RP2040_CORE
+       -DDEBUG_RP2040_PORT=Serial2
+
+USB Stack
+---------
+
+Not specifying any special build flags regarding this gives one the
+default Pico SDK USB stack. To change it, add
+
+.. code:: ini
+
+    ; Adafruit TinyUSB
+    build_flags = -DUSE_TINYUSB
+    ; No USB stack
+    build_flags = -DPIO_FRAMEWORK_ARDUINO_NO_USB
+
+Note that the special "No USB" setting is also supported, through the
+shortcut-define ``PIO_FRAMEWORK_ARDUINO_NO_USB``.
+
+
+Selecting a different core version
+----------------------------------
+
+If you wish to use a different version of the core, e.g., the latest git
+``master`` version, you can use a
+`platform_packages <https://docs.platformio.org/en/latest/projectconf/section_env_platform.html#platform-packages>`__
+directive to do so. Simply specify that the framework package
+(``framework-arduinopico``) comes from a different source.
+
+.. code:: ini
+
+    platform_packages =
+       framework-arduinopico@https://github.com/earlephilhower/arduino-pico.git#master
+
+Whereas the ``#master`` can also be replaced by a ``#branchname`` or a
+``#commithash``. If left out, it will pull the default branch, which is ``master``.
+
+The ``file://`` pseudo-protocol can also be used instead of ``https://`` to point to a
+local copy of the core (with e.g. some modifications) on disk.
+
+Note that this can only be done for versions that have the PlatformIO
+builder script it in, so versions before 1.9.2 are not supported.
+
+Examples 
+--------
+
+The following example ``platformio.ini`` can be used for a Raspberry Pi Pico
+and 0.5MByte filesystem. 
+
+.. code:: ini
+
+    [env:pico]
+    platform = https://github.com/maxgerhardt/platform-raspberrypi.git
+    board = pico
+    framework = arduino
+    board_build.core = earlephilhower
+    board_build.filesystem_size = 0.5m
+    ; note that download link for toolchain is specific for OS. see https://github.com/earlephilhower/pico-quick-toolchain/releases.
+    platform_packages = 
+        maxgerhardt/framework-arduinopico@https://github.com/earlephilhower/arduino-pico.git
+        maxgerhardt/toolchain-pico@https://github.com/earlephilhower/pico-quick-toolchain/releases/download/1.3.1-a/x86_64-w64-mingw32.arm-none-eabi-7855b0c.210706.zip
+
+
+The initial project structure should be generated just creating a new
+project for the Pico and the Arduino framework, after which the
+auto-generated ``platformio.ini`` can be adapted per above.

libraries/Wire/src/Wire.cpp

@@ -181,6 +181,8 @@ void TwoWire::end() {
         return;
     }
     i2c_deinit(_i2c);
+    pinMode(_sda, INPUT);
+    pinMode(_scl, INPUT);
     _running = false;
     _txBegun = false;
 }

package.json

@@ -1,6 +1,17 @@
 {
-    "name": "framework-arduinopico",
-    "description": "Arduino Wiring-based Framework (RPi Pico RP2040)",
-    "url": "https://github.com/earlephilhower/arduino-pico",
-    "version": "0.9.2"
+  "name": "framework-arduinopico",
+  "version": "1.10905.0",
+  "description": "Arduino Wiring-based Framework (RPi Pico RP2040)",
+  "keywords": [
+    "framework",
+    "arduino",
+    "Cortex-M",
+    "Raspberry Pi",
+    "RP2040"
+  ],
+  "homepage": "https://arduino-pico.readthedocs.io/en/latest/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/earlephilhower/arduino-pico"
+  }
 }

package/package_pico_index.template.json

@@ -41,9 +41,18 @@
                   {
                      "name": "Arduino Nano RP2040 Connect"
                   },
+                  {
+                     "name": "Cytron Maker Pi RP2040"
+                  },
                   {
                      "name": "SparkFun ProMicro RP2040"
                   },
+                  {
+                     "name": "Melopero Shake RP2040"
+                  },
+                  {
+                     "name": "uPesy RP2040 DevKit"
+                  },
                   {
                      "name": "Generic RP2040 Module"
                   }

platform.txt

@@ -40,7 +40,7 @@ compiler.warning_flags.all=-Wall -Wextra -Werror=return-type -Wno-ignored-qualif
 
 compiler.defines={build.led} {build.usbstack_flags} -DCFG_TUSB_MCU=OPT_MCU_RP2040 -DUSB_VID={build.vid} -DUSB_PID={build.pid} '-DUSB_MANUFACTURER={build.usb_manufacturer}' '-DUSB_PRODUCT={build.usb_product}'
 compiler.includes="-iprefix{runtime.platform.path}/" "@{runtime.platform.path}/lib/platform_inc.txt"
-compiler.flags=-Os -march=armv6-m -mcpu=cortex-m0plus -mthumb -ffunction-sections -fdata-sections -fno-exceptions
+compiler.flags=-march=armv6-m -mcpu=cortex-m0plus -mthumb -ffunction-sections -fdata-sections -fno-exceptions
 compiler.wrap="@{runtime.platform.path}/lib/platform_wrap.txt"
 compiler.libpico="{runtime.platform.path}/lib/libpico.a"
 compiler.libstdcpp="-lstdc++"
@@ -48,11 +48,11 @@ compiler.libstdcpp="-lstdc++"
 compiler.c.cmd=arm-none-eabi-gcc
 compiler.c.flags=-c {compiler.warning_flags} {compiler.defines} {compiler.flags} {compiler.includes} -std=gnu17 -g
 compiler.c.elf.cmd=arm-none-eabi-g++
-compiler.c.elf.flags={compiler.warning_flags} {compiler.defines} {compiler.flags} -u _printf_float -u _scanf_float
+compiler.c.elf.flags={compiler.warning_flags} {compiler.defines} {compiler.flags} {build.flags.optimize} -u _printf_float -u _scanf_float
 compiler.S.cmd=arm-none-eabi-gcc
 compiler.S.flags=-c {compiler.warning_flags} -g -x assembler-with-cpp -MMD {compiler.includes} -g
 compiler.cpp.cmd=arm-none-eabi-g++
-compiler.cpp.flags=-c {compiler.warning_flags} {compiler.defines} {compiler.flags} {compiler.includes} -fno-rtti -std=gnu++17 -g
+compiler.cpp.flags=-c {compiler.warning_flags} {compiler.defines} {compiler.flags} {compiler.includes} {build.flags.rtti} -std=gnu++17 -g
 
 compiler.ar.cmd=arm-none-eabi-ar
 compiler.ar.flags=rcs
@@ -80,6 +80,8 @@ compiler.elf2hex.extra_flags=
 # Board configuration, set in boards.txt.  Present here to ensure substitution works
 build.flash_length=
 build.eeprom_start=
+build.flags.optimize=-Os
+build.flags.rtti=-fno-rtti
 build.fs_start=
 build.fs_end=
 build.usbstack_flags=
@@ -94,10 +96,10 @@ discovery.rp2040.pattern="{runtime.tools.pqt-python3.path}/python3" -I "{runtime
 # ----------------
 
 ## Compile c files
-recipe.c.o.pattern="{compiler.path}{compiler.c.cmd}" {compiler.c.flags} {build.usbpid} -DF_CPU={build.f_cpu} -DARDUINO={runtime.ide.version} -DARDUINO_{build.board} -DBOARD_NAME="{build.board}" -DARDUINO_ARCH_{build.arch} {compiler.c.extra_flags} {build.extra_flags} {build.debug_port} {build.debug_level} {includes} "{source_file}" -o "{object_file}"
+recipe.c.o.pattern="{compiler.path}{compiler.c.cmd}" {compiler.c.flags} {build.usbpid} -DF_CPU={build.f_cpu} -DARDUINO={runtime.ide.version} -DARDUINO_{build.board} -DBOARD_NAME="{build.board}" -DARDUINO_ARCH_{build.arch} {compiler.c.extra_flags} {build.extra_flags} {build.debug_port} {build.debug_level} {build.flags.optimize} {includes} "{source_file}" -o "{object_file}"
 
 ## Compile c++ files
-recipe.cpp.o.pattern="{compiler.path}{compiler.cpp.cmd}" {compiler.cpp.flags} {build.usbpid} -DF_CPU={build.f_cpu} -DARDUINO={runtime.ide.version} -DARDUINO_{build.board} -DBOARD_NAME="{build.board}" -DARDUINO_ARCH_{build.arch} {compiler.cpp.extra_flags} {build.extra_flags} {build.debug_port} {build.debug_level} {includes} "{source_file}" -o "{object_file}"
+recipe.cpp.o.pattern="{compiler.path}{compiler.cpp.cmd}" {compiler.cpp.flags} {build.usbpid} -DF_CPU={build.f_cpu} -DARDUINO={runtime.ide.version} -DARDUINO_{build.board} -DBOARD_NAME="{build.board}" -DARDUINO_ARCH_{build.arch} {compiler.cpp.extra_flags} {build.extra_flags} {build.debug_port} {build.debug_level} {build.flags.optimize} {includes} "{source_file}" -o "{object_file}"
 
 ## Compile S files
 recipe.S.o.pattern="{compiler.path}{compiler.S.cmd}" {compiler.S.flags} {build.usbpid} -DF_CPU={build.f_cpu} -DARDUINO={runtime.ide.version} -DARDUINO_{build.board} -DBOARD_NAME="{build.board}" -DARDUINO_ARCH_{build.arch} {compiler.S.extra_flags} {build.extra_flags} {build.debug_port} {build.debug_level} {includes} "{source_file}" -o "{object_file}"

tools/libpico/CMakeLists.txt

@@ -13,9 +13,11 @@ pico_sdk_init()
 
 add_library(pico STATIC)
 
+# Use a longer XOSC startup time, to accommodate Adafruit and other boards that may need it.
 target_compile_definitions(pico PUBLIC
 	PICO_PRINTF_ALWAYS_INCLUDED=1
 	PICO_FLASH_SIZE_BYTES=16777216
+	PICO_XOSC_STARTUP_DELAY_MULTIPLIER=64
 )
 
 target_compile_options(pico PUBLIC
@@ -25,7 +27,7 @@ target_compile_options(pico PUBLIC
 
 include_directories(BEFORE ${PICO_SDK_PATH}/../tools/libpico)
 
-target_link_libraries(pico 
+target_link_libraries(pico
 	boot_stage2
 	hardware_adc
 	hardware_base

tools/makeboards.py

@@ -36,6 +36,18 @@ def BuildFreq(name):
         print("%s.menu.freq.%s=%s MHz%s" % (name, f, f, warn))
         print("%s.menu.freq.%s.build.f_cpu=%dL" % (name, f, f * 1000000))
 
+def BuildOptimize(name):
+    for l in [ ("Small", "Small", "-Os", "(standard)"), ("Optimize", "Optimize", "-O", ""), ("Optimize2", "Optimize More", "-O2", ""),
+               ("Optimize3", "Optimize Even More", "-O3", ""), ("Fast", "Fast", "-Ofast", "(maybe slower)"), ("Debug", "Debug", "-Og", "") ]:
+        print("%s.menu.opt.%s=%s (%s) %s" % (name, l[0], l[1], l[2], l[3]))
+        print("%s.menu.opt.%s.build.flags.optimize=%s" % (name, l[0], l[2]))
+
+def BuildRTTI(name):
+    print("%s.menu.rtti.Disabled=Disabled" % (name))
+    print("%s.menu.rtti.Disabled.build.flags.rtti=-fno-rtti" % (name))
+    print("%s.menu.rtti.Enabled=Enabled" % (name))
+    print("%s.menu.rtti.Enabled.build.flags.rtti=" % (name))
+
 def BuildBoot(name):
     for l in [ ("Generic SPI /2", "boot2_generic_03h_2_padded_checksum"),  ("Generic SPI /4", "boot2_generic_03h_4_padded_checksum"),
             ("IS25LP080 QSPI /2", "boot2_is25lp080_2_padded_checksum"), ("IS25LP080 QSPI /4", "boot2_is25lp080_4_padded_checksum"),
@@ -90,6 +102,8 @@ def BuildGlobalMenuList():
     print("menu.BoardModel=Model")
     print("menu.flash=Flash Size")
     print("menu.freq=CPU Speed")
+    print("menu.opt=Optimize")
+    print("menu.rtti=RTTI")
     print("menu.dbgport=Debug Port")
     print("menu.dbglvl=Debug Level")
     print("menu.boot2=Boot Stage 2")
@@ -122,6 +136,8 @@ def MakeBoard(name, vendor_name, product_name, vid, pid, boarddefine, flashsizem
         else:
             BuildFlashMenu(n, flashsizemb * 1024 * 1024, fssizelist)
         BuildFreq(n)
+        BuildOptimize(n)
+        BuildRTTI(n)
         BuildDebugPort(n)
         BuildDebugLevel(n)
         if a == "picodebug":
@@ -136,12 +152,15 @@ BuildGlobalMenuList()
 MakeBoard("rpipico", "Raspberry Pi", "Pico", "0x2e8a", "0x000a", "RASPBERRY_PI_PICO", 2, "boot2_w25q080_2_padded_checksum")
 MakeBoard("adafruit_feather", "Adafruit", "Feather RP2040", "0x239a", "0x80f1", "ADAFRUIT_FEATHER_RP2040", 8, "boot2_w25x10cl_4_padded_checksum")
 MakeBoard("adafruit_itsybitsy", "Adafruit", "ItsyBitsy RP2040", "0x239a", "0x80fd", "ADAFRUIT_ITSYBITSY_RP2040", 8, "boot2_w25q080_2_padded_checksum")
-MakeBoard("adafruit_qtpy", "Adafruit", "QT Py RP2040", "0x239a", "0x80f7", "ADAFRUIT_QTPY_RP2040", 8, "boot2_generic_03h_4_padded_checksum")
+MakeBoard("adafruit_qtpy", "Adafruit", "QT Py RP2040", "0x239a", "0x80f7", "ADAFRUIT_QTPY_RP2040", 8, "boot2_w25q080_2_padded_checksum")
 MakeBoard("adafruit_stemmafriend", "Adafruit", "STEMMA Friend RP2040", "0x239a", "0x80e3", "ADAFRUIT_STEMMAFRIEND_RP2040", 8, "boot2_w25q080_2_padded_checksum")
 MakeBoard("adafruit_trinkeyrp2040qt", "Adafruit", "Trinkey RP2040 QT", "0x239a", "0x8109", "ADAFRUIT_TRINKEYQT_RP2040", 8, "boot2_w25q080_2_padded_checksum")
 MakeBoard("adafruit_macropad2040", "Adafruit", "MacroPad RP2040", "0x239a", "0x8107", "ADAFRUIT_MACROPAD_RP2040", 8, "boot2_w25q080_2_padded_checksum")
 MakeBoard("arduino_nano_connect", "Arduino", "Nano RP2040 Connect", "0x2341", "0x0058", "ARDUINO_NANO_RP2040_CONNECT", 16, "boot2_w25q080_2_padded_checksum")
+MakeBoard("cytron_maker_pi_rp2040", "Cytron", "Maker Pi RP2040", "0x2e8a", "0x1000", "CYTRON_MAKER_PI_RP2040", 2, "boot2_w25q080_2_padded_checksum")
 MakeBoard("sparkfun_promicrorp2040", "SparkFun", "ProMicro RP2040", "0x1b4f", "0x0026", "SPARKFUN_PROMICRO_RP2040", 16, "boot2_generic_03h_4_padded_checksum")
 MakeBoard("generic", "Generic", "RP2040", "0x2e8a", "0xf00a", "GENERIC_RP2040", 16, "boot2_generic_03h_4_padded_checksum")
 MakeBoard("challenger_2040_wifi", "iLabs", "Challenger 2040 WiFi", "0x2e8a", "0x1006", "CHALLENGER_2040_WIFI_RP2040", 8, "boot2_w25q080_2_padded_checksum")
 MakeBoard("challenger_2040_lte", "iLabs", "Challenger 2040 LTE", "0x2e8a", "0x100b", "CHALLENGER_2040_LTE_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("melopero_shake_rp2040", "Melopero", "Shake RP2040", "0x2e8a", "0x1005", "MELOPERO_SHAKE_RP2040", 16, "boot2_w25q080_2_padded_checksum")
+MakeBoard("upesy_rp2040_devkit", "uPesy", "RP2040 DevKit", "0x2e8a", "0x1007", "UPESY_RP2040_DEVKIT", 2, "boot2_w25q080_2_padded_checksum")

tools/platformio-build.py

@@ -0,0 +1,228 @@
+# Copyright 2021-present Maximilian Gerhardt <maximilian.gerhardt@rub.de>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os, re, sys
+from SCons.Script import DefaultEnvironment, Builder, AlwaysBuild
+
+env = DefaultEnvironment()
+platform = env.PioPlatform()
+board = env.BoardConfig()
+upload_protocol = env.subst("$UPLOAD_PROTOCOL") or "picotool"
+ram_size = board.get("upload.maximum_ram_size")
+
+FRAMEWORK_DIR = platform.get_package_dir("framework-arduinopico")
+assert os.path.isdir(FRAMEWORK_DIR)
+
+# update progsize expression to also check for bootloader.
+env.Replace(
+    SIZEPROGREGEXP=r"^(?:\.boot2|\.text|\.data|\.rodata|\.text.align|\.ARM.exidx)\s+(\d+).*"
+)
+
+env.Append(
+    ASFLAGS=env.get("CCFLAGS", [])[:],
+
+    CCFLAGS=[
+        "-Werror=return-type",
+        "-march=armv6-m",
+        "-mcpu=cortex-m0plus",
+        "-mthumb",
+        "-ffunction-sections",
+        "-fdata-sections",
+        "-iprefix" + os.path.join(FRAMEWORK_DIR),
+        "@%s" % os.path.join(FRAMEWORK_DIR, "lib", "platform_inc.txt")
+    ],
+
+    CFLAGS=[
+        "-std=gnu17"
+    ],
+
+    CXXFLAGS=[
+        "-std=gnu++17",
+        "-fno-exceptions",
+        "-fno-rtti",
+    ],
+
+    CPPDEFINES=[
+        ("ARDUINO", 10810),
+        "ARDUINO_ARCH_RP2040",
+        ("F_CPU", "$BOARD_F_CPU"),
+        ("BOARD_NAME", '\\"%s\\"' % env.subst("$BOARD")),
+    ],
+
+    CPPPATH=[
+        os.path.join(FRAMEWORK_DIR, "cores", "rp2040"),
+        os.path.join(FRAMEWORK_DIR, "cores", "rp2040", "api", "deprecated"),
+        os.path.join(FRAMEWORK_DIR, "cores", "rp2040",
+                     "api", "deprecated-avr-comp")
+    ],
+
+    LINKFLAGS=[
+        "-march=armv6-m",
+        "-mcpu=cortex-m0plus",
+        "-mthumb",
+        "@%s" % os.path.join(FRAMEWORK_DIR, "lib", "platform_wrap.txt"),
+        "-u_printf_float",
+        "-u_scanf_float",
+        # no cross-reference table, heavily spams the output
+        # "-Wl,--cref",
+        "-Wl,--check-sections",
+        "-Wl,--gc-sections",
+        "-Wl,--unresolved-symbols=report-all",
+        "-Wl,--warn-common"
+    ],
+
+    LIBSOURCE_DIRS=[os.path.join(FRAMEWORK_DIR, "libraries")],
+
+    LIBPATH=[
+        os.path.join(FRAMEWORK_DIR, "lib")
+    ],
+
+    # link lib/libpico.a
+    LIBS=["pico", "m", "c", "stdc++", "c"]
+)
+
+
+def configure_usb_flags(cpp_defines):
+    global ram_size
+    if "USE_TINYUSB" in cpp_defines:
+        env.Append(CPPPATH=[os.path.join(
+            FRAMEWORK_DIR, "libraries", "Adafruit_TinyUSB_Arduino", "src", "arduino")])
+    elif "PIO_FRAMEWORK_ARDUINO_NO_USB" in cpp_defines:
+        env.Append(
+            CPPPATH=[os.path.join(FRAMEWORK_DIR, "tools", "libpico")],
+            CPPDEFINES=[
+                "NO_USB",
+                "DISABLE_USB_SERIAL" 
+            ]
+        )
+        # do not further add more USB flags or update sizes. no USB used.
+        return
+    else:
+        # standard Pico SDK USB stack used.
+        env.Append(CPPPATH=[os.path.join(FRAMEWORK_DIR, "tools", "libpico")])
+    # in any case, add standard flags
+    # preferably use USB information from arduino.earlephilhower section,
+    # but fallback to sensible values derived from other parts otherwise.
+    usb_pid = board.get("build.arduino.earlephilhower.usb_pid",
+                        board.get("build.hwids", [[0, 0]])[0][1])
+    usb_vid = board.get("build.arduino.earlephilhower.usb_vid",
+                        board.get("build.hwids", [[0, 0]])[0][0])
+    usb_manufacturer = board.get(
+        "build.arduino.earlephilhower.usb_manufacturer", board.get("vendor", "Raspberry Pi"))
+    usb_product = board.get(
+        "build.arduino.earlephilhower.usb_product", board.get("name", "Pico"))
+
+    # Copy logic from makeboards.py. 
+    # Depending on whether a certain upload / debug method is used, change
+    # the PID/VID.
+    # https://github.com/earlephilhower/arduino-pico/blob/master/tools/makeboards.py
+    vidtouse = usb_vid
+    pidtouse = usb_pid
+    if upload_protocol == "picoprobe": 
+        pidtouse = '0x0004'
+    elif upload_protocol == "picodebug":
+        vidtouse = '0x1209'
+        pidtouse = '0x2488'
+        ram_size = 240 * 1024
+
+    env.Append(CPPDEFINES=[
+        ("CFG_TUSB_MCU", "OPT_MCU_RP2040"),
+        ("USB_VID", usb_vid),
+        ("USB_PID", usb_pid),
+        ("USB_MANUFACTURER", '\\"%s\\"' % usb_manufacturer),
+        ("USB_PRODUCT", '\\"%s\\"' % usb_product),
+        ("SERIALUSB_PID", usb_pid)
+    ])
+
+    # use vidtouse and pidtouse 
+    # for USB PID/VID autodetection
+    hw_ids = board.get("build.hwids", [["0x2E8A", "0x00C0"]])
+    hw_ids[0][0] = vidtouse
+    hw_ids[0][1] = pidtouse
+    board.update("build.hwids", hw_ids)
+    board.update("upload.maximum_ram_size", ram_size)
+
+#
+# Process configuration flags
+#
+cpp_defines = env.Flatten(env.get("CPPDEFINES", []))
+
+configure_usb_flags(cpp_defines)
+
+# info about the filesystem is already parsed by the platform's main.py 
+# script. We can just use the info here
+ 
+linkerscript_cmd = env.Command(
+    os.path.join("$BUILD_DIR", "memmap_default.ld"),  # $TARGET
+    os.path.join(FRAMEWORK_DIR, "lib", "memmap_default.ld"),  # $SOURCE
+    env.VerboseAction(" ".join([
+        '"$PYTHONEXE" "%s"' % os.path.join(
+            FRAMEWORK_DIR, "tools", "simplesub.py"),
+        "--input", "$SOURCE",
+        "--out", "$TARGET",
+        "--sub", "__FLASH_LENGTH__", "$PICO_FLASH_LENGTH",
+        "--sub", "__EEPROM_START__", "$PICO_EEPROM_START",
+        "--sub", "__FS_START__", "$FS_START",
+        "--sub", "__FS_END__", "$FS_END",
+        "--sub", "__RAM_LENGTH__", "%dk" % (ram_size // 1024),
+    ]), "Generating linkerscript $BUILD_DIR/memmap_default.ld")
+)
+
+# if no custom linker script is provided, we use the command that we prepared to generate one.
+if not board.get("build.ldscript", ""):
+    # execute fetch filesystem info stored in env to alawys have that info ready
+    env["fetch_fs_size"](env)
+    env.Depends("$BUILD_DIR/${PROGNAME}.elf", linkerscript_cmd)
+    env.Replace(LDSCRIPT_PATH=os.path.join("$BUILD_DIR", "memmap_default.ld"))
+
+libs = []
+
+variant = board.get("build.arduino.earlephilhower.variant", board.get("build.variant", None))
+
+if variant is not None:
+    env.Append(CPPPATH=[
+        os.path.join(FRAMEWORK_DIR, "variants", variant)
+    ])
+
+    libs.append(
+        env.BuildLibrary(
+            os.path.join("$BUILD_DIR", "FrameworkArduinoVariant"),
+            os.path.join(FRAMEWORK_DIR, "variants", variant)))
+
+libs.append(
+    env.BuildLibrary(
+        os.path.join("$BUILD_DIR", "FrameworkArduino"),
+        os.path.join(FRAMEWORK_DIR, "cores", "rp2040")))
+
+bootloader_src_file = board.get(
+    "build.arduino.earlephilhower.boot2_source", "boot2_generic_03h_2_padded_checksum.S")
+
+# Add bootloader file (boot2.o)
+# Only build the needed .S file, exclude all others via src_filter.
+env.BuildSources(
+    os.path.join("$BUILD_DIR", "FrameworkArduinoBootloader"),
+    os.path.join(FRAMEWORK_DIR, "boot2"),
+    "-<*> +<%s>" % bootloader_src_file,
+)
+# Add include flags for all .S assembly file builds
+env.Append(
+    ASFLAGS=[
+        "-I", os.path.join(FRAMEWORK_DIR, "pico-sdk", "src",
+                           "rp2040", "hardware_regs", "include"),
+        "-I", os.path.join(FRAMEWORK_DIR, "pico-sdk", "src",
+                           "common", "pico_binary_info", "include")
+    ]
+)
+
+env.Prepend(LIBS=libs)

variants/adafruit_feather/pins_arduino.h

@@ -27,12 +27,10 @@
 #define PIN_SPI1_SS    (31u)
 
 // Wire
-#define PIN_WIRE0_SDA  (2u)
-#define PIN_WIRE0_SCL  (3u)
-
-// Not pinned out
-#define PIN_WIRE1_SDA  (31u)
-#define PIN_WIRE1_SCL  (31u)
+#define PIN_WIRE0_SDA  (24u)
+#define PIN_WIRE0_SCL  (25u)
+#define PIN_WIRE1_SDA  (2u)
+#define PIN_WIRE1_SCL  (3u)
 
 #define SERIAL_HOWMANY (2u)
 #define SPI_HOWMANY    (1u)

variants/adafruit_itsybitsy/pins_arduino.h

@@ -27,15 +27,13 @@
 #define PIN_SPI1_SS    (31u)
 
 // Wire
-#define PIN_WIRE0_SDA  (2u)
-#define PIN_WIRE0_SCL  (3u)
-
-// Not pinned out
-#define PIN_WIRE1_SDA  (31u)
-#define PIN_WIRE1_SCL  (31u)
+#define PIN_WIRE0_SDA  (24u)
+#define PIN_WIRE0_SCL  (25u)
+#define PIN_WIRE1_SDA  (2u)
+#define PIN_WIRE1_SCL  (3u)
 
 #define SERIAL_HOWMANY (2u)
 #define SPI_HOWMANY    (1u)
-#define WIRE_HOWMANY   (1u)
+#define WIRE_HOWMANY   (2u)
 
 #include "../generic/common.h"

variants/challenger_2040_lte/pins_arduino.h

@@ -67,9 +67,9 @@ static const uint8_t D15 =  (14u);
 static const uint8_t D16 =  (15u);
 static const uint8_t D17 =  (19u);
 
-static const uint8_t A0 =   (26u);
-static const uint8_t A1 =   (27u);
-static const uint8_t A2 =   (28u);
-static const uint8_t A3 =   (29u);
+static const uint8_t A0 =   (29u);
+static const uint8_t A1 =   (28u);
+static const uint8_t A2 =   (27u);
+static const uint8_t A3 =   (26u);
 static const uint8_t A4 =   (25u);
 static const uint8_t A5 =   (21u);

variants/challenger_2040_wifi/ChallengerWiFi.cpp

@@ -0,0 +1,107 @@
+/*
+    ESP8285 helper class for the Challenger RP2040 WiFi boards
+
+    Copyright (c) 2021 P. Oldberg <pontus@ilabs.se>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#include <Arduino.h>
+#include <ChallengerWiFi.h>
+
+Challenger2040WiFiClass::Challenger2040WiFiClass() {
+  pinMode(PIN_ESP8285_RST, OUTPUT);
+  digitalWrite(PIN_ESP8285_RST, LOW);       // Hold ESP8285 in reset
+  pinMode(PIN_ESP8285_MODE, OUTPUT);
+  digitalWrite(PIN_ESP8285_MODE, HIGH);     // Prepare for normal start
+}
+
+// Do a HW reset by applying a low pulse to the reset line for 1mSec
+void Challenger2040WiFiClass::doHWReset() {
+  digitalWrite(PIN_ESP8285_RST, LOW);       // Hold ESP8285 in reset
+  delay(1);
+  digitalWrite(PIN_ESP8285_RST, HIGH);      // Release ESP8285 reset
+}
+
+// Set the mode flag high to indicate normal run operation and do a HW
+// reset.
+void Challenger2040WiFiClass::runReset() {  // Prepare ESP8285 for normal op
+  digitalWrite(PIN_ESP8285_MODE, HIGH);     // Prepare for normal start
+  doHWReset();
+}
+
+// Set the mode flag low to indicate flash operation and do a HW
+// reset.
+void Challenger2040WiFiClass::flashReset() { // Prepare ESP8285 for flashing
+  digitalWrite(PIN_ESP8285_MODE, LOW);       // Prepare for normal start
+  doHWReset();
+}
+
+// Wait for the modem to reply with a "ready" prompt. This can be done
+// after a sw or hw reset have been performed to ensure that the AT
+// interpreter is up and running.
+bool Challenger2040WiFiClass::waitForReady() {
+  int timeout = 20;                         // Aprox max 2 sec
+
+  Serial2.begin(DEFAULT_ESP8285_BAUDRATE);
+  Serial2.setTimeout(100);
+  String rdy = Serial2.readStringUntil('\n');
+  while(!rdy.startsWith("ready") && timeout--) {
+    rdy = Serial2.readStringUntil('\n');
+  }
+  Serial2.setTimeout(1000);  // Reset default timeout to 1000
+  if (timeout)
+    return true;
+  return false;
+}
+
+// Reset the ESP8285 and wait for the "ready" prompt to be returned.
+bool Challenger2040WiFiClass::reset() {
+  runReset();
+  return waitForReady();
+}
+
+// Checks to see if the modem responds to the "AT" poll command.
+bool Challenger2040WiFiClass::isAlive() {
+  int timeout = 5;
+
+  Serial2.setTimeout(250);
+  Serial2.println(F("AT"));
+  String rdy = Serial2.readStringUntil('\n');
+  while(!rdy.startsWith(F("OK")) && timeout--) {
+    rdy = Serial2.readStringUntil('\n');
+  }
+  Serial2.setTimeout(1000);
+
+  if (timeout)
+    return true;
+  return false;
+}
+
+// Change the baud rate of the ESP8285 as well as the local UART.
+// No checking is done on the input baud rate so the user must know what
+// baud rates are valid. The function ends by checking if the ESP8285 is
+// reachable by doing an "AT" poll.
+bool Challenger2040WiFiClass::changeBaudRate(int baud) {
+  Serial2.print(F("AT+UART_CUR="));
+  Serial2.print(baud);
+  Serial2.println(F(",8,1,0,0"));
+  delay(100);
+  Serial2.end();
+  Serial2.begin(baud);
+  return isAlive();
+}
+
+Challenger2040WiFiClass Challenger2040WiFi;

variants/challenger_2040_wifi/ChallengerWiFi.h

@@ -0,0 +1,36 @@
+/*
+    ESP8285 helper class for the Challenger RP2040 WiFi boards
+
+    Copyright (c) 2021 P. Oldberg <pontus@ilabs.se>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+#pragma once
+
+#define DEFAULT_ESP8285_BAUDRATE      115200
+
+class Challenger2040WiFiClass {
+  public:
+    Challenger2040WiFiClass();
+    void doHWReset();
+    void runReset();
+    void flashReset();
+    bool waitForReady();
+    bool reset();
+    bool isAlive();
+    bool changeBaudRate(int baud);
+};
+
+extern Challenger2040WiFiClass Challenger2040WiFi;

variants/cytron_maker_pi_rp2040/pins_arduino.h

@@ -0,0 +1,57 @@
+#pragma once
+
+// LEDs
+#define PIN_LED             (3u)
+
+// Neopixel
+#define PIN_NEOPIXEL        (18u)
+#define NUM_NEOPIXEL        (2u)
+#define PIN_RGB             PIN_NEOPIXEL
+
+// Buzzer
+#define PIN_BUZZER          (22u)
+
+// Motor Driver
+#define PIN_M1A	            (8u)
+#define PIN_M1B	            (9u)
+#define PIN_M2A	            (10u)
+#define PIN_M2B	            (11u)
+
+// Voltage Monitor
+#define PIN_VBATT           (29u)
+#define PIN_VOLTAGE_MONITOR PIN_VBATT
+
+
+
+// Serial
+#define PIN_SERIAL1_TX      (0u)
+#define PIN_SERIAL1_RX      (1u)
+
+#define PIN_SERIAL2_TX      (4u)
+#define PIN_SERIAL2_RX      (5u)
+
+// SPI (Not pinned out)
+#define PIN_SPI0_MISO       (31u)
+#define PIN_SPI0_MOSI       (31u)
+#define PIN_SPI0_SCK        (31u)
+#define PIN_SPI0_SS         (31u)
+
+#define PIN_SPI1_MISO       (31u)
+#define PIN_SPI1_MOSI       (31u)
+#define PIN_SPI1_SCK        (31u)
+#define PIN_SPI1_SS         (31u)
+
+// Wire
+#define PIN_WIRE0_SDA       (16u)
+#define PIN_WIRE0_SCL       (17u)
+
+#define PIN_WIRE1_SDA       (2u)
+#define PIN_WIRE1_SCL       (3u)
+
+
+
+#define SERIAL_HOWMANY      (2u)
+#define SPI_HOWMANY         (0u)
+#define WIRE_HOWMANY        (2u)
+
+#include "../generic/common.h"

variants/melopero_shake_rp2040/pins_arduino.h

@@ -0,0 +1,39 @@
+#pragma once
+
+// Pin definitions taken from:
+//    https://datasheets.raspberrypi.org/pico/pico-datasheet.pdf
+
+
+// LEDs
+#define PIN_LED        (25u)
+
+// Serial
+#define PIN_SERIAL1_TX (0u)
+#define PIN_SERIAL1_RX (1u)
+
+#define PIN_SERIAL2_TX (8u)
+#define PIN_SERIAL2_RX (9u)
+
+// SPI
+#define PIN_SPI0_MISO  (20u)
+#define PIN_SPI0_MOSI  (19u)
+#define PIN_SPI0_SCK   (18u)
+#define PIN_SPI0_SS    (1u)
+
+#define PIN_SPI1_MISO  (12u)
+#define PIN_SPI1_MOSI  (11u)
+#define PIN_SPI1_SCK   (10u)
+#define PIN_SPI1_SS    (13u)
+
+// Wire
+#define PIN_WIRE0_SDA  (8u) 
+#define PIN_WIRE0_SCL  (9u)
+
+#define PIN_WIRE1_SDA  (2u) 
+#define PIN_WIRE1_SCL  (3u)
+
+#define SERIAL_HOWMANY (3u)
+#define SPI_HOWMANY    (2u)
+#define WIRE_HOWMANY   (2u)
+
+#include "../generic/common.h"

variants/upesy_rp2040_devkit/pins_arduino.h

@@ -0,0 +1,39 @@
+#pragma once
+
+// Pin definitions taken from:
+//    https://datasheets.raspberrypi.org/pico/pico-datasheet.pdf
+
+
+// LEDs
+#define PIN_LED        (25u)
+
+// Serial
+#define PIN_SERIAL1_TX (0u)
+#define PIN_SERIAL1_RX (1u)
+
+#define PIN_SERIAL2_TX (8u)
+#define PIN_SERIAL2_RX (9u)
+
+// SPI
+#define PIN_SPI0_MISO  (16u)
+#define PIN_SPI0_MOSI  (19u)
+#define PIN_SPI0_SCK   (18u)
+#define PIN_SPI0_SS    (17u)
+
+#define PIN_SPI1_MISO  (12u)
+#define PIN_SPI1_MOSI  (15u)
+#define PIN_SPI1_SCK   (14u)
+#define PIN_SPI1_SS    (13u)
+
+// Wire
+#define PIN_WIRE0_SDA  (4u)
+#define PIN_WIRE0_SCL  (5u)
+
+#define PIN_WIRE1_SDA  (22u)
+#define PIN_WIRE1_SCL  (23u)
+
+#define SERIAL_HOWMANY (3u)
+#define SPI_HOWMANY    (2u)
+#define WIRE_HOWMANY   (2u)
+
+#include "../generic/common.h"