Update package.json

When the Serial software FIFOs overeflowed, the IRQ handler would not
read any more data from the hardware FIFOs.  This would cause the
IRQ handler to be continually called as soon as it exited since the
HW FIFOS were not empty.

Now always read every available HW FIFO entry and throw out any that
don't fit in the SW FIFO.

Also fix a too long by half stop bit timing in the PIOSerial receiver.

README.md

@@ -13,14 +13,18 @@ See https://arduino-pico.readthedocs.io/en/latest/ along with the examples for m
 * Raspberry Pi Pico
 * Adafruit Feather RP2040
 * Adafruit ItsyBitsy RP2040
+* Adafruit KB2040
 * Adafruit Macropad RP2040
 * Adafruit QTPy RP2040
 * Adafruit STEMMA Friend RP2040
 * Adafruit Trinkey RP2040 QT
 * Arduino Nano RP2040 Connect (preliminary)
 * Cytron Maker Pi RP2040
+* Cytron Maker Nano RP2040
 * Invector Labs Challenger RP2040 WiFi
+* Invector Labs Challenger NB RP2040 WiFi
 * Invector Labs Challenger RP2040 LTE
+* Invector Labs RPICO32
 * Melopero Shake RP2040
 * SparkFun ProMicro RP2040
 * uPesy RP2040 DevKit
@@ -142,6 +146,7 @@ The RP2040 PIO state machines (SMs) are used to generate jitter-free:
 * Servos
 * Tones
 * I2S Output
+* Software UARTs (Serial ports)
 
 # Tutorials from Across the Web
 Here are some links to coverage and additional tutorials for using `arduino-pico`

cores/rp2040/Arduino.h

@@ -30,6 +30,7 @@
 #include <pins_arduino.h>
 #include "hardware/gpio.h" // Required for the port*Register macros
 #include "debug_internal.h"
+#include <RP2040.h> // CMSIS
 
 // Try and make the best of the old Arduino abs() macro.  When in C++, use
 // the sane std::abs() call, but for C code use their macro since stdlib abs()
@@ -95,7 +96,8 @@ void analogWriteResolution(int res);
 #endif
 
 #include "SerialUART.h"
-#include "RP2040.h"
+#include "RP2040Support.h"
+#include "SerialPIO.h"
 #include "Bootsel.h"
 
 // Template which will evaluate at *compile time* to a single 32b number

cores/rp2040/RP2040USB.cpp

@@ -52,7 +52,6 @@ mutex_t __usb_mutex;
 #endif
 
 #define USBD_DESC_LEN (TUD_CONFIG_DESC_LEN + TUD_CDC_DESC_LEN)
-#define USBD_MAX_POWER_MA (250)
 
 #define USBD_ITF_CDC (0) // needs 2 interfaces
 #define USBD_ITF_MAX (2)

cores/rp2040/SerialPIO.cpp

@@ -0,0 +1,338 @@
+/*
+    Serial-over-PIO for the Raspberry Pi Pico RP2040
+
+    Copyright (c) 2021 Earle F. Philhower, III <earlephilhower@yahoo.com>
+
+    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 "SerialPIO.h"
+#include "CoreMutex.h"
+#include <hardware/gpio.h>
+#include <map>
+#include "pio_uart.pio.h"
+
+
+// ------------------------------------------------------------------------
+// -- Generates a unique program for differing bit lengths
+static std::map<int, PIOProgram*> _txMap;
+static std::map<int, PIOProgram*> _rxMap;
+
+// Duplicate a program and replace the first insn with a "set x, repl"
+static pio_program_t *pio_make_uart_prog(int repl, const pio_program_t *pg) {
+    pio_program_t *p = new pio_program_t;
+    p->length = pg->length;
+    p->origin = pg->origin;
+    uint16_t *insn = (uint16_t *)malloc(p->length * 2);
+    memcpy(insn, pg->instructions, p->length * 2);
+    insn[0] = pio_encode_set(pio_x, repl);
+    p->instructions = insn;
+    return p;
+}
+
+static PIOProgram *_getTxProgram(int bits) {
+    auto f = _txMap.find(bits);
+    if (f == _txMap.end()) {
+        pio_program_t * p = pio_make_uart_prog(bits, &pio_tx_program);
+        _txMap.insert({bits, new PIOProgram(p)});
+        f = _txMap.find(bits);
+    }
+    return f->second;
+}
+
+static PIOProgram *_getRxProgram(int bits) {
+    auto f = _rxMap.find(bits);
+    if (f == _rxMap.end()) {
+        pio_program_t * p = pio_make_uart_prog(bits, &pio_rx_program);
+        _rxMap.insert({bits, new PIOProgram(p)});
+        f = _rxMap.find(bits);
+    }
+    return f->second;
+}
+// ------------------------------------------------------------------------
+
+// TODO - this works, but there must be a faster/better way...
+static int _parity(int bits, int data) {
+    int p = 0;
+    for (int b = 0; b < bits; b++) {
+        p ^= (data & (1 << b)) ? 1 : 0;
+    }
+    return p;
+}
+
+// We need to cache generated SerialPIOs so we can add data to them from
+// the shared handler
+static SerialPIO *_pioSP[2][4];
+static void __not_in_flash_func(_fifoIRQ)() {
+    for (int p = 0; p < 2; p++) {
+        for (int sm = 0; sm < 4; sm++) {
+            SerialPIO *s = _pioSP[p][sm];
+            if (s) {
+                s->_handleIRQ();
+                pio_interrupt_clear((p == 0) ? pio0 : pio1, sm);
+            }
+        }
+    }
+}
+
+void __not_in_flash_func(SerialPIO::_handleIRQ)() {
+    if (_rx == NOPIN) {
+        return;
+    }
+    while (!pio_sm_is_rx_fifo_empty(_rxPIO, _rxSM)) {
+        uint32_t decode = _rxPIO->rxf[_rxSM];
+        decode >>= 32 - _rxBits;
+        uint32_t val = 0;
+        for (int b = 0; b < _bits + 1; b++) {
+            val |= (decode & (1 << (b * 2))) ? 1 << b : 0;
+        }
+        if (_parity == UART_PARITY_EVEN) {
+            int p = ::_parity(_bits, val);
+            int r = (val & (1 << _bits)) ? 1 : 0;
+            if (p != r) {
+                // TODO - parity error
+                continue;
+            }
+        } else if (_parity == UART_PARITY_ODD) {
+            int p = ::_parity(_bits, val);
+            int r = (val & (1 << _bits)) ? 1 : 0;
+            if (p == r) {
+                // TODO - parity error
+                continue;
+            }
+        }
+
+        if ((_writer + 1) % sizeof(_queue) != _reader) {
+            _queue[_writer] = val & ((1 << _bits) -  1);
+            asm volatile("" ::: "memory"); // Ensure the queue is written before the written count advances
+            _writer = (_writer + 1) % sizeof(_queue);
+        } else {
+            // TODO: Overflow
+        }
+    }
+}
+
+SerialPIO::SerialPIO(pin_size_t tx, pin_size_t rx) {
+    _tx = tx;
+    _rx = rx;
+    mutex_init(&_mutex);
+}
+
+void SerialPIO::begin(unsigned long baud, uint16_t config) {
+    _baud = baud;
+    switch (config & SERIAL_PARITY_MASK) {
+    case SERIAL_PARITY_EVEN:
+        _parity = UART_PARITY_EVEN;
+        break;
+    case SERIAL_PARITY_ODD:
+        _parity = UART_PARITY_ODD;
+        break;
+    default:
+        _parity = UART_PARITY_NONE;
+        break;
+    }
+    switch (config & SERIAL_STOP_BIT_MASK) {
+    case SERIAL_STOP_BIT_1:
+        _stop = 1;
+        break;
+    default:
+        _stop = 2;
+        break;
+    }
+    switch (config & SERIAL_DATA_MASK) {
+    case SERIAL_DATA_5:
+        _bits = 5;
+        break;
+    case SERIAL_DATA_6:
+        _bits = 6;
+        break;
+    case SERIAL_DATA_7:
+        _bits = 7;
+        break;
+    default:
+        _bits = 8;
+        break;
+    }
+
+    if ((_tx == NOPIN) && (_rx == NOPIN)) {
+        DEBUGCORE("ERROR: No pins specified for SerialPIO\n");
+        return;
+    }
+
+    if (_tx != NOPIN) {
+        _txBits = _bits + _stop + (_parity != UART_PARITY_NONE ? 1 : 0) + 1/*start bit*/;
+        _txPgm = _getTxProgram(_txBits);
+        int off;
+        if (!_txPgm->prepare(&_txPIO, &_txSM, &off)) {
+            DEBUGCORE("ERROR: Unable to allocate PIO TX UART, out of PIO resources\n");
+            // ERROR, no free slots
+            return;
+        }
+
+        digitalWrite(_tx, HIGH);
+        pinMode(_tx, OUTPUT);
+
+        pio_tx_program_init(_txPIO, _txSM, off, _tx);
+        pio_sm_clear_fifos(_txPIO, _txSM); // Remove any existing data
+
+        // Put the divider into ISR w/o using up program space
+        pio_sm_put_blocking(_txPIO, _txSM, clock_get_hz(clk_sys) / _baud - 2);
+        pio_sm_exec(_txPIO, _txSM, pio_encode_pull(false, false));
+        pio_sm_exec(_txPIO, _txSM, pio_encode_mov(pio_isr, pio_osr));
+
+        // Start running!
+        pio_sm_set_enabled(_txPIO, _txSM, true);
+    }
+    if (_rx != NOPIN) {
+        _writer = 0;
+        _reader = 0;
+
+        _rxBits = 2 * (_bits + _stop + (_parity != UART_PARITY_NONE ? 1 : 0) + 1) - 1;
+        _rxPgm = _getRxProgram(_rxBits);
+        int off;
+        if (!_rxPgm->prepare(&_rxPIO, &_rxSM, &off)) {
+            DEBUGCORE("ERROR: Unable to allocate PIO RX UART, out of PIO resources\n");
+            return;
+        }
+        // Stash away the created RX port for the IRQ handler
+        _pioSP[pio_get_index(_rxPIO)][_rxSM] = this;
+
+        pinMode(_rx, INPUT);
+        pio_rx_program_init(_rxPIO, _rxSM, off, _rx);
+        pio_sm_clear_fifos(_rxPIO, _rxSM); // Remove any existing data
+
+        // Put phase divider into OSR w/o using add'l program memory
+        pio_sm_put_blocking(_rxPIO, _rxSM, clock_get_hz(clk_sys) / (_baud * 2) - 2);
+        pio_sm_exec(_rxPIO, _rxSM, pio_encode_pull(false, false));
+
+        // Join the TX FIFO to the RX one now that we don't need it
+        _rxPIO->sm[_rxSM].shiftctrl |= 0x80000000;
+
+        // Enable interrupts on rxfifo
+        switch (_rxSM) {
+        case 0: pio_set_irq0_source_enabled(_rxPIO, pis_sm0_rx_fifo_not_empty, true); break;
+        case 1: pio_set_irq0_source_enabled(_rxPIO, pis_sm1_rx_fifo_not_empty, true); break;
+        case 2: pio_set_irq0_source_enabled(_rxPIO, pis_sm2_rx_fifo_not_empty, true); break;
+        case 3: pio_set_irq0_source_enabled(_rxPIO, pis_sm3_rx_fifo_not_empty, true); break;
+        }
+        irq_set_exclusive_handler(PIO0_IRQ_0, _fifoIRQ);
+        irq_set_enabled(PIO0_IRQ_0, true);
+
+        pio_sm_set_enabled(_rxPIO, _rxSM, true);
+    }
+
+    _running = true;
+}
+
+void SerialPIO::end() {
+    if (!_running) {
+        return;
+    }
+    // TODO: Deallocate PIO resources, stop them
+    _pioSP[pio_get_index(_rxPIO)][_rxSM] = nullptr;
+    _running = false;
+}
+
+int SerialPIO::peek() {
+    CoreMutex m(&_mutex);
+    if (!_running || !m || (_rx == NOPIN)) {
+        return -1;
+    }
+    // If there's something in the FIFO now, just peek at it
+    uint32_t start = millis();
+    uint32_t now = millis();
+    while ((now - start) < _timeout) {
+        if (_writer != _reader) {
+            return _queue[_reader];
+        }
+        delay(1);
+        now = millis();
+    }
+    return -1; // Nothing available before timeout
+}
+
+int SerialPIO::read() {
+    CoreMutex m(&_mutex);
+    if (!_running || !m || (_rx == NOPIN)) {
+        return -1;
+    }
+    uint32_t start = millis();
+    uint32_t now = millis();
+    while ((now - start) < _timeout) {
+        if (_writer != _reader) {
+            auto ret = _queue[_reader];
+            _reader = (_reader + 1) % sizeof(_queue);
+            return ret;
+        }
+        delay(1);
+        now = millis();
+    }
+    return -1; // Timeout
+}
+
+int SerialPIO::available() {
+    CoreMutex m(&_mutex);
+    if (!_running || !m || (_rx == NOPIN)) {
+        return 0;
+    }
+    return (_writer - _reader) % sizeof(_queue);
+}
+
+int SerialPIO::availableForWrite() {
+    CoreMutex m(&_mutex);
+    if (!_running || !m || (_tx == NOPIN)) {
+        return 0;
+    }
+    return 8 - pio_sm_get_tx_fifo_level(_txPIO, _txSM);
+}
+
+void SerialPIO::flush() {
+    CoreMutex m(&_mutex);
+    if (!_running || !m || (_tx == NOPIN)) {
+        return;
+    }
+    while (!pio_sm_is_tx_fifo_empty(_txPIO, _txSM)) {
+        delay(1); // Wait for all FIFO to be read
+    }
+    // Could have 1 byte being transmitted, so wait for bit times
+    delay((1000 * (_txBits + 1)) / _baud);
+}
+
+size_t SerialPIO::write(uint8_t c) {
+    CoreMutex m(&_mutex);
+    if (!_running || !m || (_tx == NOPIN)) {
+        return 0;
+    }
+
+    uint32_t val = c;
+    if (_parity == UART_PARITY_NONE) {
+        val |= 7 << _bits; // Set 2 stop bits, the HW will only transmit the required number
+    } else if (_parity == UART_PARITY_EVEN) {
+        val |= ::_parity(_bits, c) << _bits;
+        val |= 7 << (_bits + 1);
+    } else {
+        val |= (1 ^ ::_parity(_bits, c)) << _bits;
+        val |= 7 << (_bits + 1);
+    }
+    val <<= 1;  // Start bit = low
+
+    pio_sm_put_blocking(_txPIO, _txSM, val);
+
+    return 1;
+}
+
+SerialPIO::operator bool() {
+    return _running;
+}

cores/rp2040/SerialPIO.h

@@ -0,0 +1,78 @@
+/*
+    Serial-over-PIO for the Raspberry Pi Pico RP2040
+
+    Copyright (c) 2021 Earle F. Philhower, III <earlephilhower@yahoo.com>
+
+    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
+
+#include <Arduino.h>
+#include "api/HardwareSerial.h"
+#include <stdarg.h>
+#include <queue>
+#include <hardware/uart.h>
+#include "CoreMutex.h"
+
+extern "C" typedef struct uart_inst uart_inst_t;
+
+class SerialPIO : public HardwareSerial {
+public:
+    static const pin_size_t NOPIN = 0xff; // Use in constructor to disable RX or TX unit
+    SerialPIO(pin_size_t tx, pin_size_t rx);
+
+    void begin(unsigned long baud = 115200) override {
+        begin(baud, SERIAL_8N1);
+    };
+    void begin(unsigned long baud, uint16_t config) override;
+    void end() override;
+
+    virtual int peek() override;
+    virtual int read() override;
+    virtual int available() override;
+    virtual int availableForWrite() override;
+    virtual void flush() override;
+    virtual size_t write(uint8_t c) override;
+    using Print::write;
+    operator bool() override;
+
+    // Not to be called by users, only from the IRQ handler.  In public so that the C-language IQR callback can access it
+    void _handleIRQ();
+
+private:
+    bool _running = false;
+    pin_size_t _tx, _rx;
+    int _baud;
+    int _bits;
+    uart_parity_t _parity;
+    int _stop;
+    mutex_t _mutex;
+
+    PIOProgram *_txPgm;
+    PIO _txPIO;
+    int _txSM;
+    int _txBits;
+
+    PIOProgram *_rxPgm;
+    PIO _rxPIO;
+    int _rxSM;
+    int _rxBits;
+
+    // Lockless, IRQ-handled circular queue
+    uint32_t _writer;
+    uint32_t _reader;
+    uint8_t  _queue[32];
+};

cores/rp2040/SerialUART.cpp

@@ -72,37 +72,73 @@ SerialUART::SerialUART(uart_inst_t *uart, pin_size_t tx, pin_size_t rx) {
     mutex_init(&_mutex);
 }
 
+static void _uart0IRQ();
+static void _uart1IRQ();
+
 void SerialUART::begin(unsigned long baud, uint16_t config) {
     _baud = baud;
     uart_init(_uart, baud);
     int bits, stop;
     uart_parity_t parity;
     switch (config & SERIAL_PARITY_MASK) {
-    case SERIAL_PARITY_EVEN: parity = UART_PARITY_EVEN; break;
-    case SERIAL_PARITY_ODD: parity = UART_PARITY_ODD; break;
-    default: parity = UART_PARITY_NONE; break;
+    case SERIAL_PARITY_EVEN:
+        parity = UART_PARITY_EVEN;
+        break;
+    case SERIAL_PARITY_ODD:
+        parity = UART_PARITY_ODD;
+        break;
+    default:
+        parity = UART_PARITY_NONE;
+        break;
     }
     switch (config & SERIAL_STOP_BIT_MASK) {
-    case SERIAL_STOP_BIT_1: stop = 1; break;
-    default: stop = 2; break;
+    case SERIAL_STOP_BIT_1:
+        stop = 1;
+        break;
+    default:
+        stop = 2;
+        break;
     }
     switch (config & SERIAL_DATA_MASK) {
-    case SERIAL_DATA_5: bits = 5; break;
-    case SERIAL_DATA_6: bits = 6; break;
-    case SERIAL_DATA_7: bits = 7; break;
-    default: bits = 8; break;
+    case SERIAL_DATA_5:
+        bits = 5;
+        break;
+    case SERIAL_DATA_6:
+        bits = 6;
+        break;
+    case SERIAL_DATA_7:
+        bits = 7;
+        break;
+    default:
+        bits = 8;
+        break;
     }
     uart_set_format(_uart, bits, stop, parity);
     gpio_set_function(_tx, GPIO_FUNC_UART);
     gpio_set_function(_rx, GPIO_FUNC_UART);
+    _writer = 0;
+    _reader = 0;
+
+    if (_uart == uart0) {
+        irq_set_exclusive_handler(UART0_IRQ, _uart0IRQ);
+        irq_set_enabled(UART0_IRQ, true);
+    } else {
+        irq_set_exclusive_handler(UART1_IRQ, _uart1IRQ);
+        irq_set_enabled(UART1_IRQ, true);
+    }
+    uart_get_hw(_uart)->imsc |= UART_UARTIMSC_RXIM_BITS | UART_UARTIMSC_RTIM_BITS;
     _running = true;
-    _peek = -1;
 }
 
 void SerialUART::end() {
     if (!_running) {
         return;
     }
+    if (_uart == uart0) {
+        irq_set_enabled(UART0_IRQ, false);
+    } else {
+        irq_set_enabled(UART1_IRQ, false);
+    }
     uart_deinit(_uart);
     _running = false;
 }
@@ -112,15 +148,16 @@ int SerialUART::peek() {
     if (!_running || !m) {
         return -1;
     }
-    if (_peek >= 0) {
-        return _peek;
+    uint32_t start = millis();
+    uint32_t now = millis();
+    while ((now - start) < _timeout) {
+        if (_writer != _reader) {
+            return _queue[_reader];
+        }
+        delay(1);
+        now = millis();
     }
-    if (uart_is_readable_within_us(_uart, _timeout * 1000)) {
-        _peek = uart_getc(_uart);
-    } else {
-        _peek = -1; // Timeout
-    }
-    return _peek;
+    return -1; // Nothing available before timeout
 }
 
 int SerialUART::read() {
@@ -128,16 +165,18 @@ int SerialUART::read() {
     if (!_running || !m) {
         return -1;
     }
-    if (_peek >= 0) {
-        int ret = _peek;
-        _peek = -1;
-        return ret;
-    }
-    if (uart_is_readable_within_us(_uart, _timeout * 1000)) {
-        return uart_getc(_uart);
-    } else {
-        return -1; // Timeout
+    uint32_t start = millis();
+    uint32_t now = millis();
+    while ((now - start) < _timeout) {
+        if (_writer != _reader) {
+            auto ret = _queue[_reader];
+            _reader = (_reader + 1) % sizeof(_queue);
+            return ret;
+        }
+        delay(1);
+        now = millis();
     }
+    return -1; // Timeout
 }
 
 int SerialUART::available() {
@@ -145,7 +184,7 @@ int SerialUART::available() {
     if (!_running || !m) {
         return 0;
     }
-    return (uart_is_readable(_uart)) ? 1 : 0;
+    return (_writer - _reader) % sizeof(_queue);
 }
 
 int SerialUART::availableForWrite() {
@@ -205,3 +244,26 @@ void arduino::serialEvent2Run(void) {
         serialEvent2();
     }
 }
+
+// IRQ handler, called when FIFO > 1/4 full or when it had held unread data for >32 bit times
+void __not_in_flash_func(SerialUART::_handleIRQ)() {
+    uart_get_hw(_uart)->icr |= UART_UARTICR_RTIC_BITS | UART_UARTICR_RXIC_BITS;
+    while (uart_is_readable(_uart)) {
+        auto val = uart_getc(_uart);
+        if ((_writer + 1) % sizeof(_queue) != _reader) {
+            _queue[_writer] = val;
+            asm volatile("" ::: "memory"); // Ensure the queue is written before the written count advances
+            _writer = (_writer + 1) % sizeof(_queue);
+        } else {
+            // TODO: Overflow
+        }
+    }
+}
+
+static void __not_in_flash_func(_uart0IRQ)() {
+    Serial1._handleIRQ();
+}
+
+static void __not_in_flash_func(_uart1IRQ)() {
+    Serial2._handleIRQ();
+}

cores/rp2040/SerialUART.h

@@ -23,6 +23,7 @@
 #include <Arduino.h>
 #include "api/HardwareSerial.h"
 #include <stdarg.h>
+#include <queue>
 #include "CoreMutex.h"
 
 extern "C" typedef struct uart_inst uart_inst_t;
@@ -56,13 +57,20 @@ public:
     using Print::write;
     operator bool() override;
 
+    // Not to be called by users, only from the IRQ handler.  In public so that the C-language IQR callback can access it
+    void _handleIRQ();
+
 private:
     bool _running = false;
     uart_inst_t *_uart;
     pin_size_t _tx, _rx;
     int _baud;
-    int _peek;
     mutex_t _mutex;
+
+    // Lockless, IRQ-handled circular queue
+    uint32_t _writer;
+    uint32_t _reader;
+    uint8_t  _queue[32];
 };
 
 extern SerialUART Serial1; // HW UART 0

cores/rp2040/pio_uart.pio

@@ -0,0 +1,109 @@
+; pio_uart for the Raspberry Pi Pico RP2040
+;
+; Based loosely off of the uart_rx/_tx examples in the pico-examples repo,
+; but heavily modified and optimized to not require changing the PIO
+; clocks so that Tone and Servo won't be affected, and multiple different
+; PIO ports can be run at different baud at the same time.
+;
+; Copyright (c) 2021 Earle F. Philhower, III <earlephilhower@yahoo.com>
+;
+; 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
+
+
+
+.program pio_tx
+.side_set 1 opt
+
+; We shift out the start and stop bit as part of the FIFO
+    set x, 9
+
+    pull               side 1 ; Force stop bit
+
+; Send the bits
+bitloop:
+    out pins, 1
+    mov y, isr                ; ISR is loaded by the setup routine with the period-1 count
+wait_bit:
+    jmp y-- wait_bit
+    jmp x-- bitloop
+
+    
+
+% c-sdk {
+
+static inline void pio_tx_program_init(PIO pio, uint sm, uint offset, uint pin_tx) {
+    // Tell PIO to initially drive output-high on the selected pin, then map PIO
+    // onto that pin with the IO muxes.
+    pio_sm_set_pins_with_mask(pio, sm, 1u << pin_tx, 1u << pin_tx);
+    pio_sm_set_pindirs_with_mask(pio, sm, 1u << pin_tx, 1u << pin_tx);
+    pio_gpio_init(pio, pin_tx);
+
+    pio_sm_config c = pio_tx_program_get_default_config(offset);
+
+    // OUT shifts to right, no autopull
+    sm_config_set_out_shift(&c, true, false, 32);
+
+    // We are mapping both OUT and side-set to the same pin, because sometimes
+    // we need to assert user data onto the pin (with OUT) and sometimes
+    // assert constant values (start/stop bit)
+    sm_config_set_out_pins(&c, pin_tx, 1);
+    sm_config_set_sideset_pins(&c, pin_tx);
+
+    // We only need TX, so get an 8-deep FIFO!
+    sm_config_set_fifo_join(&c, PIO_FIFO_JOIN_TX);
+
+    pio_sm_init(pio, sm, offset, &c);
+}
+
+%}
+
+
+.program pio_rx
+
+; IN pin 0 and JMP pin are both mapped to the GPIO used as UART RX.
+
+start:
+    set x, 18           ; Preload bit counter...we'll shift in the start bit and stop bit, and each bit will be double-recorded (to be fixed by RP2040 code)
+    wait 0 pin 0        ; Stall until start bit is asserted
+
+bitloop:
+   ; Delay until 1/2 way into the bit time
+    mov y, osr
+wait_half:
+    jmp y-- wait_half
+
+    ; Read in the bit
+    in pins, 1          ; Shift data bit into ISR
+    jmp x-- bitloop     ; Loop all bits
+    
+    push                ; Stuff it and wait for next start
+
+
+% c-sdk {
+static inline void pio_rx_program_init(PIO pio, uint sm, uint offset, uint pin) {
+    pio_sm_set_consecutive_pindirs(pio, sm, pin, 1, false);
+    pio_gpio_init(pio, pin);
+    gpio_pull_up(pin);
+
+    pio_sm_config c = pio_rx_program_get_default_config(offset);
+    sm_config_set_in_pins(&c, pin); // for WAIT, IN
+    sm_config_set_jmp_pin(&c, pin); // for JMP
+    // Shift to right, autopull disabled
+    sm_config_set_in_shift(&c, true, false, 32);
+
+    pio_sm_init(pio, sm, offset, &c);
+}
+
+%}

cores/rp2040/pio_uart.pio.h

@@ -0,0 +1,107 @@
+// -------------------------------------------------- //
+// This file is autogenerated by pioasm; do not edit! //
+// -------------------------------------------------- //
+
+#if !PICO_NO_HARDWARE
+#include "hardware/pio.h"
+#endif
+
+// ------ //
+// pio_tx //
+// ------ //
+
+#define pio_tx_wrap_target 0
+#define pio_tx_wrap 5
+
+static const uint16_t pio_tx_program_instructions[] = {
+    //     .wrap_target
+    0xe029, //  0: set    x, 9
+    0x98a0, //  1: pull   block           side 1
+    0x6001, //  2: out    pins, 1
+    0xa046, //  3: mov    y, isr
+    0x0084, //  4: jmp    y--, 4
+    0x0042, //  5: jmp    x--, 2
+    //     .wrap
+};
+
+#if !PICO_NO_HARDWARE
+static const struct pio_program pio_tx_program = {
+    .instructions = pio_tx_program_instructions,
+    .length = 6,
+    .origin = -1,
+};
+
+static inline pio_sm_config pio_tx_program_get_default_config(uint offset) {
+    pio_sm_config c = pio_get_default_sm_config();
+    sm_config_set_wrap(&c, offset + pio_tx_wrap_target, offset + pio_tx_wrap);
+    sm_config_set_sideset(&c, 2, true, false);
+    return c;
+}
+
+static inline void pio_tx_program_init(PIO pio, uint sm, uint offset, uint pin_tx) {
+    // Tell PIO to initially drive output-high on the selected pin, then map PIO
+    // onto that pin with the IO muxes.
+    pio_sm_set_pins_with_mask(pio, sm, 1u << pin_tx, 1u << pin_tx);
+    pio_sm_set_pindirs_with_mask(pio, sm, 1u << pin_tx, 1u << pin_tx);
+    pio_gpio_init(pio, pin_tx);
+    pio_sm_config c = pio_tx_program_get_default_config(offset);
+    // OUT shifts to right, no autopull
+    sm_config_set_out_shift(&c, true, false, 32);
+    // We are mapping both OUT and side-set to the same pin, because sometimes
+    // we need to assert user data onto the pin (with OUT) and sometimes
+    // assert constant values (start/stop bit)
+    sm_config_set_out_pins(&c, pin_tx, 1);
+    sm_config_set_sideset_pins(&c, pin_tx);
+    // We only need TX, so get an 8-deep FIFO!
+    sm_config_set_fifo_join(&c, PIO_FIFO_JOIN_TX);
+    pio_sm_init(pio, sm, offset, &c);
+}
+
+#endif
+
+// ------ //
+// pio_rx //
+// ------ //
+
+#define pio_rx_wrap_target 0
+#define pio_rx_wrap 6
+
+static const uint16_t pio_rx_program_instructions[] = {
+    //     .wrap_target
+    0xe032, //  0: set    x, 18
+    0x2020, //  1: wait   0 pin, 0
+    0xa047, //  2: mov    y, osr
+    0x0083, //  3: jmp    y--, 3
+    0x4001, //  4: in     pins, 1
+    0x0042, //  5: jmp    x--, 2
+    0x8020, //  6: push   block
+    //     .wrap
+};
+
+#if !PICO_NO_HARDWARE
+static const struct pio_program pio_rx_program = {
+    .instructions = pio_rx_program_instructions,
+    .length = 7,
+    .origin = -1,
+};
+
+static inline pio_sm_config pio_rx_program_get_default_config(uint offset) {
+    pio_sm_config c = pio_get_default_sm_config();
+    sm_config_set_wrap(&c, offset + pio_rx_wrap_target, offset + pio_rx_wrap);
+    return c;
+}
+
+static inline void pio_rx_program_init(PIO pio, uint sm, uint offset, uint pin) {
+    pio_sm_set_consecutive_pindirs(pio, sm, pin, 1, false);
+    pio_gpio_init(pio, pin);
+    gpio_pull_up(pin);
+    pio_sm_config c = pio_rx_program_get_default_config(offset);
+    sm_config_set_in_pins(&c, pin); // for WAIT, IN
+    sm_config_set_jmp_pin(&c, pin); // for JMP
+    // Shift to right, autopull disabled
+    sm_config_set_in_shift(&c, true, false, 32);
+    pio_sm_init(pio, sm, offset, &c);
+}
+
+#endif
+

docs/index.rst

@@ -29,6 +29,7 @@ For the latest version, always check https://github.com/earlephilhower/arduino-p
    EEPROM <eeprom>
    I2S Audio <i2s>
    Serial USB and UARTs <serial>
+   "Software Serial" PIO UART <piouart>
    Servo <servo>
    SPI <spi>
    Wire(I2C) <wire>

docs/piouart.rst

@@ -0,0 +1,22 @@
+"SoftwareSerial" PIO-based UART
+================================
+
+Equivalent to the Arduino SoftwareSerial library, an emulated UART using
+one or two PIO state machines is included in the Arduino-Pico core.  This
+allows for up to 8 additional serial ports to be run from the RP2040 without
+requiring additional CPU resources.
+
+Instantiate a ``SerialPIO(txpin, rxpin)`` object in your sketch and then
+use it the same as any other serial port.  Even, odd, and no parity modes
+are supported, as well as data sizes from 5- to 8-bits.
+
+To instantiate only a serial transmit or receive unit, pass in
+``SerialPIO::NOPIN`` as the ``txpin`` or ``rxpin``.
+
+For example, to make a transmit-only port on GP16
+.. code:: cpp
+
+        SerialPIO transmitter( 16, SerialPIO::NOPIN );
+
+For detailed information about the Serial ports, see the
+Arduino `Serial Reference <https://www.arduino.cc/reference/en/language/functions/communication/serial/>`_ .

keywords.txt

@@ -33,3 +33,4 @@ resumeOtherCore	KEYWORD2
 
 PIOProgram	KEYWORD2
 prepare	KEYWORD2
+SerialPIO	KEYWORD2

lib/pico_base/pico/version.h

@@ -12,8 +12,8 @@
 #define _PICO_VERSION_H
 
 #define PICO_SDK_VERSION_MAJOR    1
-#define PICO_SDK_VERSION_MINOR    2
+#define PICO_SDK_VERSION_MINOR    3
 #define PICO_SDK_VERSION_REVISION 0
-#define PICO_SDK_VERSION_STRING   "1.2.0"
+#define PICO_SDK_VERSION_STRING   "1.3.0"
 
 #endif

lib/platform_inc.txt

@@ -15,6 +15,9 @@
 -iwithprefixbefore/pico-sdk/src/common/pico_util/include
 -iwithprefixbefore/pico-sdk/src/rp2040/hardware_regs/include
 -iwithprefixbefore/pico-sdk/src/rp2040/hardware_structs/include
+-iwithprefixbefore/pico-sdk/src/rp2_common/cmsis/include
+-iwithprefixbefore/pico-sdk/src/rp2_common/cmsis/stub/CMSIS/Core/Include
+-iwithprefixbefore/pico-sdk/src/rp2_common/cmsis/stub/CMSIS/Device/RaspberryPi/RP2040/Include
 -iwithprefixbefore/pico-sdk/src/rp2_common/hardware_adc/include
 -iwithprefixbefore/pico-sdk/src/rp2_common/hardware_base/include
 -iwithprefixbefore/pico-sdk/src/rp2_common/hardware_claim/include

libraries/SPI/SPI.cpp

@@ -179,23 +179,22 @@ void SPIClassRP2040::transfer(void *txbuf, void *rxbuf, size_t count) {
 
 void SPIClassRP2040::beginTransaction(SPISettings settings) {
     DEBUGSPI("SPI::beginTransaction(clk=%d, bo=%s\n", _spis.getClockFreq(), (_spis.getBitOrder() == MSBFIRST) ? "MSB" : "LSB");
-    _spis = settings;
-    if (_initted) {
-        DEBUGSPI("SPI: deinitting currently active SPI\n");
-        spi_deinit(_spi);
+    if (_initted && settings == _spis) {
+        DEBUGSPI("SPI: Reusing existing initted SPI\n");
+    } else {
+        _spis = settings;
+        if (_initted) {
+            DEBUGSPI("SPI: deinitting currently active SPI\n");
+            spi_deinit(_spi);
+        }
+        DEBUGSPI("SPI: initting SPI\n");
+        spi_init(_spi, _spis.getClockFreq());
+        _initted = true;
     }
-    DEBUGSPI("SPI: initting SPI\n");
-    spi_init(_spi, _spis.getClockFreq());
-    _initted = true;
 }
 
 void SPIClassRP2040::endTransaction(void) {
     DEBUGSPI("SPI::endTransaction()\n");
-    if (_initted) {
-        DEBUGSPI("SPI: deinitting currently active SPI\n");
-        spi_deinit(_spi);
-    }
-    _initted = false;
 }
 
 bool SPIClassRP2040::setRX(pin_size_t pin) {
@@ -281,6 +280,11 @@ void SPIClassRP2040::begin(bool hwCS) {
 
 void SPIClassRP2040::end() {
     DEBUGSPI("SPI::end()\n");
+    if (_initted) {
+        DEBUGSPI("SPI: deinitting currently active SPI\n");
+        _initted = false;
+        spi_deinit(_spi);
+    }
     gpio_set_function(_RX, GPIO_FUNC_SIO);
     if (_hwCS) {
         gpio_set_function(_CS, GPIO_FUNC_SIO);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "framework-arduinopico",
-  "version": "1.10905.0",
+  "version": "1.10912.0",
   "description": "Arduino Wiring-based Framework (RPi Pico RP2040)",
   "keywords": [
     "framework",

package/package_pico_index.template.json

@@ -41,6 +41,9 @@
                   {
                      "name": "Arduino Nano RP2040 Connect"
                   },
+                  {
+                     "name": "Cytron Maker Nano RP2040"
+                  },
                   {
                      "name": "Cytron Maker Pi RP2040"
                   },

platform.txt

@@ -29,6 +29,8 @@ runtime.tools.pqt-elf2uf2.path={runtime.platform.path}/system/elf2uf2
 
 compiler.path={runtime.tools.pqt-gcc.path}/bin/
 
+compiler.libraries.ldflags=
+
 # Compile variables
 # -----------------
 
@@ -96,13 +98,13 @@ 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} {build.flags.optimize} {includes} "{source_file}" -o "{object_file}"
+recipe.c.o.pattern="{compiler.path}{compiler.c.cmd}" {compiler.c.flags} {build.usbpid} {build.usbpwr} -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} {build.flags.optimize} {includes} "{source_file}" -o "{object_file}"
+recipe.cpp.o.pattern="{compiler.path}{compiler.cpp.cmd}" {compiler.cpp.flags} {build.usbpid} {build.usbpwr} -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}"
+recipe.S.o.pattern="{compiler.path}{compiler.S.cmd}" {compiler.S.flags} {build.usbpid} {build.usbpwr} -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}"
 
 ## Create archives
 # archive_file_path is needed for backwards compatibility with IDE 1.6.5 or older, IDE 1.6.6 or newer overrides this value
@@ -116,7 +118,7 @@ recipe.hooks.linking.prelink.1.pattern="{runtime.tools.pqt-python3.path}/python3
 recipe.hooks.linking.prelink.2.pattern="{compiler.path}{compiler.S.cmd}" {compiler.c.elf.flags} {compiler.c.elf.extra_flags} -c "{runtime.platform.path}/boot2/{build.boot2}.S" "-I{runtime.platform.path}/pico-sdk/src/rp2040/hardware_regs/include/" "-I{runtime.platform.path}/pico-sdk/src/common/pico_binary_info/include" -o "{build.path}/boot2.o"
 
 ## Combine gc-sections, archives, and objects
-recipe.c.combine.pattern="{compiler.path}{compiler.c.elf.cmd}" "-L{build.path}" {compiler.c.elf.flags} {compiler.c.elf.extra_flags} {compiler.ldflags} "-Wl,--script={build.path}/memmap_default.ld" "-Wl,-Map,{build.path}/{build.project_name}.map" -o "{build.path}/{build.project_name}.elf" -Wl,--start-group {object_files} "{build.path}/{archive_file}" "{build.path}/boot2.o" {compiler.libpico} -lm -lc {compiler.libstdcpp} -lc -Wl,--end-group
+recipe.c.combine.pattern="{compiler.path}{compiler.c.elf.cmd}" "-L{build.path}" {compiler.c.elf.flags} {compiler.c.elf.extra_flags} {compiler.ldflags} "-Wl,--script={build.path}/memmap_default.ld" "-Wl,-Map,{build.path}/{build.project_name}.map" -o "{build.path}/{build.project_name}.elf" -Wl,--start-group {object_files} "{build.path}/{archive_file}" "{build.path}/boot2.o" {compiler.libraries.ldflags} {compiler.libpico} -lm -lc {compiler.libstdcpp} -lc -Wl,--end-group
 
 ## Create output (UF2 file)
 recipe.objcopy.uf2.pattern="{runtime.tools.pqt-elf2uf2.path}/elf2uf2" "{build.path}/{build.project_name}.elf" "{build.path}/{build.project_name}.uf2"

tools/libpico/CMakeLists.txt

@@ -53,6 +53,7 @@ target_link_libraries(pico
 	hardware_vreg
 	hardware_watchdog
 	hardware_xosc
+	cmsis
 	pico_bit_ops
 	pico_bootrom
 	pico_bootsel_via_double_reset

tools/libpico/make-libpico.sh

@@ -23,6 +23,7 @@ for type in boot2_generic_03h boot2_is25lp080 boot2_w25q080 boot2_w25x10cl; do
         arm-none-eabi-gcc -march=armv6-m -mcpu=cortex-m0plus -mthumb -O3 \
                          -DNDEBUG -DPICO_FLASH_SPI_CLKDIV=$div \
                          -c "$PICO_SDK_PATH/src/rp2_common/boot_stage2/$type.S" \
+                         -I "$PICO_SDK_PATH/src/boards/include/boards/" \
                          -I "$PICO_SDK_PATH/src/rp2040/hardware_regs/include/" \
                          -I "$PICO_SDK_PATH/src/rp2_common/pico_platform/include/" \
                          -I "$PICO_SDK_PATH/src/rp2_common/boot_stage2/asminclude/" \

tools/libpico/pico_extras_import.cmake

@@ -26,14 +26,14 @@ if (NOT PICO_EXTRAS_PATH)
             get_filename_component(FETCHCONTENT_BASE_DIR "${PICO_EXTRAS_FETCH_FROM_GIT_PATH}" REALPATH BASE_DIR "${CMAKE_SOURCE_DIR}")
         endif ()
         FetchContent_Declare(
-                PICO_EXTRAS
+                pico_extras
                 GIT_REPOSITORY https://github.com/raspberrypi/pico-extras
                 GIT_TAG master
         )
-        if (NOT PICO_EXTRAS)
-            message("Downloading PICO EXTRAS")
-            FetchContent_Populate(PICO_EXTRAS)
-            set(PICO_EXTRAS_PATH ${PICO_EXTRAS_SOURCE_DIR})
+        if (NOT pico_extras)
+            message("Downloading Raspberry Pi Pico Extras")
+            FetchContent_Populate(pico_extras)
+            set(PICO_EXTRAS_PATH ${pico_extras_SOURCE_DIR})
         endif ()
         set(FETCHCONTENT_BASE_DIR ${FETCHCONTENT_BASE_DIR_SAVE})
     else ()
@@ -59,4 +59,4 @@ endif ()
 
 set(PICO_EXTRAS_PATH ${PICO_EXTRAS_PATH} CACHE PATH "Path to the PICO EXTRAS" FORCE)
 
-add_subdirectory(${PICO_EXTRAS_PATH} pico_extras)
+add_subdirectory(${PICO_EXTRAS_PATH} pico_extras)

tools/libpico/pico_sdk_import.cmake

@@ -3,8 +3,6 @@
 # This can be dropped into an external project to help locate this SDK
 # It should be include()ed prior to project()
 
-# todo document
-
 if (DEFINED ENV{PICO_SDK_PATH} AND (NOT PICO_SDK_PATH))
     set(PICO_SDK_PATH $ENV{PICO_SDK_PATH})
     message("Using PICO_SDK_PATH from environment ('${PICO_SDK_PATH}')")
@@ -20,8 +18,8 @@ if (DEFINED ENV{PICO_SDK_FETCH_FROM_GIT_PATH} AND (NOT PICO_SDK_FETCH_FROM_GIT_P
     message("Using PICO_SDK_FETCH_FROM_GIT_PATH from environment ('${PICO_SDK_FETCH_FROM_GIT_PATH}')")
 endif ()
 
-set(PICO_SDK_PATH "${PICO_SDK_PATH}" CACHE PATH "Path to the PICO SDK")
-set(PICO_SDK_FETCH_FROM_GIT "${PICO_SDK_FETCH_FROM_GIT}" CACHE BOOL "Set to ON to fetch copy of PICO SDK from git if not otherwise locatable")
+set(PICO_SDK_PATH "${PICO_SDK_PATH}" CACHE PATH "Path to the Raspberry Pi Pico SDK")
+set(PICO_SDK_FETCH_FROM_GIT "${PICO_SDK_FETCH_FROM_GIT}" CACHE BOOL "Set to ON to fetch copy of SDK from git if not otherwise locatable")
 set(PICO_SDK_FETCH_FROM_GIT_PATH "${PICO_SDK_FETCH_FROM_GIT_PATH}" CACHE FILEPATH "location to download SDK")
 
 if (NOT PICO_SDK_PATH)
@@ -37,14 +35,14 @@ if (NOT PICO_SDK_PATH)
                 GIT_TAG master
         )
         if (NOT pico_sdk)
-            message("Downloading PICO SDK")
+            message("Downloading Raspberry Pi Pico SDK")
             FetchContent_Populate(pico_sdk)
             set(PICO_SDK_PATH ${pico_sdk_SOURCE_DIR})
         endif ()
         set(FETCHCONTENT_BASE_DIR ${FETCHCONTENT_BASE_DIR_SAVE})
     else ()
         message(FATAL_ERROR
-                "PICO SDK location was not specified. Please set PICO_SDK_PATH or set PICO_SDK_FETCH_FROM_GIT to on to fetch from git."
+                "SDK location was not specified. Please set PICO_SDK_PATH or set PICO_SDK_FETCH_FROM_GIT to on to fetch from git."
                 )
     endif ()
 endif ()
@@ -56,9 +54,9 @@ endif ()
 
 set(PICO_SDK_INIT_CMAKE_FILE ${PICO_SDK_PATH}/pico_sdk_init.cmake)
 if (NOT EXISTS ${PICO_SDK_INIT_CMAKE_FILE})
-    message(FATAL_ERROR "Directory '${PICO_SDK_PATH}' does not appear to contain the PICO SDK")
+    message(FATAL_ERROR "Directory '${PICO_SDK_PATH}' does not appear to contain the Raspberry Pi Pico SDK")
 endif ()
 
-set(PICO_SDK_PATH ${PICO_SDK_PATH} CACHE PATH "Path to the PICO SDK" FORCE)
+set(PICO_SDK_PATH ${PICO_SDK_PATH} CACHE PATH "Path to the Raspberry Pi Pico SDK" FORCE)
 
 include(${PICO_SDK_INIT_CMAKE_FILE})

tools/makeboards.py

@@ -66,7 +66,7 @@ def BuildWithoutUSBStack(name):
     print("%s.menu.usbstack.nousb=No USB" % (name))
     print('%s.menu.usbstack.nousb.build.usbstack_flags="-DNO_USB -DDISABLE_USB_SERIAL -I{runtime.platform.path}/tools/libpico"' % (name))
 
-def BuildHeader(name, vendor_name, product_name, vidtouse, pidtouse, vid, pid, boarddefine, variant, uploadtool, flashsize, ramsize, boot2):
+def BuildHeader(name, vendor_name, product_name, vidtouse, pidtouse, vid, pid, pwr, boarddefine, variant, uploadtool, flashsize, ramsize, boot2):
     prettyname = vendor_name + " " + product_name
     print()
     print("# -----------------------------------")
@@ -76,6 +76,7 @@ def BuildHeader(name, vendor_name, product_name, vidtouse, pidtouse, vid, pid, b
     print("%s.vid.0=%s" % (name, vidtouse))
     print("%s.pid.0=%s" % (name, pidtouse))
     print("%s.build.usbpid=-DSERIALUSB_PID=%s" % (name, pid))
+    print("%s.build.usbpwr=-DUSBD_MAX_POWER_MA=%s" % (name, pwr))
     print("%s.build.board=%s" % (name, boarddefine))
     print("%s.build.mcu=cortex-m0plus" % (name))
     print("%s.build.variant=%s" % (name, variant))
@@ -89,7 +90,6 @@ def BuildHeader(name, vendor_name, product_name, vidtouse, pidtouse, vid, pid, b
     print("%s.build.f_cpu=125000000" % (name))
     print("%s.build.led=" % (name))
     print("%s.build.core=rp2040" % (name))
-    print("%s.build.mcu=rp2040" % (name))
     print("%s.build.ldscript=memmap_default.ld" % (name))
     print("%s.build.ram_length=%dk" % (name, ramsize / 1024))
     print("%s.build.boot2=%s" % (name, boot2))
@@ -98,6 +98,12 @@ def BuildHeader(name, vendor_name, product_name, vidtouse, pidtouse, vid, pid, b
     print('%s.build.usb_manufacturer="%s"' % (name, vendor_name))
     print('%s.build.usb_product="%s"' % (name, product_name))
 
+def WriteWarning():
+    print("# WARNING - DO NOT EDIT THIS FILE, IT IS MACHINE GENERATED")
+    print("#           To change something here, edit tools/makeboards.py and")
+    print("#           run 'python3 makeboards.py > ../boards.txt' to regenerate")
+    print()
+
 def BuildGlobalMenuList():
     print("menu.BoardModel=Model")
     print("menu.flash=Flash Size")
@@ -110,7 +116,7 @@ def BuildGlobalMenuList():
     print("menu.usbstack=USB Stack")
 
 
-def MakeBoard(name, vendor_name, product_name, vid, pid, boarddefine, flashsizemb, boot2):
+def MakeBoard(name, vendor_name, product_name, vid, pid, pwr, boarddefine, flashsizemb, boot2):
     for a, b, c in [ ["", "", "uf2conv"], ["picoprobe", " (Picoprobe)", "picoprobe"], ["picodebug", " (pico-debug)", "picodebug"]]:
         n = name + a
         p = product_name + b
@@ -127,7 +133,7 @@ def MakeBoard(name, vendor_name, product_name, vid, pid, boarddefine, flashsizem
             ramsizekb = 240;
         else:
             pidtouse = pid
-        BuildHeader(n, vendor_name, p, vidtouse, pidtouse, vid, pid, boarddefine, name, c, flashsizemb * 1024 * 1024, ramsizekb * 1024, boot2)
+        BuildHeader(n, vendor_name, p, vidtouse, pidtouse, vid, pid, pwr, boarddefine, name, c, flashsizemb * 1024 * 1024, ramsizekb * 1024, boot2)
         if name == "generic":
             BuildFlashMenu(n, 2*1024*1024, [0, 1*1024*1024])
             BuildFlashMenu(n, 4*1024*1024, [0, 2*1024*1024])
@@ -147,21 +153,25 @@ def MakeBoard(name, vendor_name, product_name, vid, pid, boarddefine, flashsizem
         if name == "generic":
             BuildBoot(n)
 
-
+WriteWarning()
 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_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")
-MakeBoard("wiznet_5100s_evb_pico", "WIZnet", "W5100S-EVB-Pico", "0x2e8a", "0x1008", "WIZNET_5100S_EVB_PICO", 2, "boot2_w25q080_2_padded_checksum")
+MakeBoard("rpipico", "Raspberry Pi", "Pico", "0x2e8a", "0x000a", 250, "RASPBERRY_PI_PICO", 2, "boot2_w25q080_2_padded_checksum")
+MakeBoard("adafruit_feather", "Adafruit", "Feather RP2040", "0x239a", "0x80f1", 250, "ADAFRUIT_FEATHER_RP2040", 8, "boot2_w25x10cl_4_padded_checksum")
+MakeBoard("adafruit_itsybitsy", "Adafruit", "ItsyBitsy RP2040", "0x239a", "0x80fd", 250, "ADAFRUIT_ITSYBITSY_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("adafruit_qtpy", "Adafruit", "QT Py RP2040", "0x239a", "0x80f7", 250, "ADAFRUIT_QTPY_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("adafruit_stemmafriend", "Adafruit", "STEMMA Friend RP2040", "0x239a", "0x80e3", 250, "ADAFRUIT_STEMMAFRIEND_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("adafruit_trinkeyrp2040qt", "Adafruit", "Trinkey RP2040 QT", "0x239a", "0x8109", 250, "ADAFRUIT_TRINKEYQT_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("adafruit_macropad2040", "Adafruit", "MacroPad RP2040", "0x239a", "0x8107", 250, "ADAFRUIT_MACROPAD_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("adafruit_kb2040", "Adafruit", "KB2040", "0x239a", "0x8105", 250, "ADAFRUIT_KB2040_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("arduino_nano_connect", "Arduino", "Nano RP2040 Connect", "0x2341", "0x0058", 250, "ARDUINO_NANO_RP2040_CONNECT", 16, "boot2_w25q080_2_padded_checksum")
+MakeBoard("cytron_maker_nano_rp2040", "Cytron", "Maker Nano RP2040", "0x2e8a", "0x100f", 250, "CYTRON_MAKER_NANO_RP2040", 2, "boot2_w25q080_2_padded_checksum")
+MakeBoard("cytron_maker_pi_rp2040", "Cytron", "Maker Pi RP2040", "0x2e8a", "0x1000", 250, "CYTRON_MAKER_PI_RP2040", 2, "boot2_w25q080_2_padded_checksum")
+MakeBoard("sparkfun_promicrorp2040", "SparkFun", "ProMicro RP2040", "0x1b4f", "0x0026", 250, "SPARKFUN_PROMICRO_RP2040", 16, "boot2_generic_03h_4_padded_checksum")
+MakeBoard("generic", "Generic", "RP2040", "0x2e8a", "0xf00a", 250, "GENERIC_RP2040", 16, "boot2_generic_03h_4_padded_checksum")
+MakeBoard("challenger_2040_wifi", "iLabs", "Challenger 2040 WiFi", "0x2e8a", "0x1006", 250, "CHALLENGER_2040_WIFI_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("challenger_2040_lte", "iLabs", "Challenger 2040 LTE", "0x2e8a", "0x100b", 500, "CHALLENGER_2040_LTE_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("challenger_nb_2040_wifi", "iLabs", "Challenger NB 2040 WiFi", "0x2e8a", "0x100b", 500, "CHALLENGER_NB_2040_WIFI_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("ilabs_rpico32", "iLabs", "RPICO32", "0x2e8a", "0x1010", 250, "ILABS_2040_RPICO32_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("melopero_shake_rp2040", "Melopero", "Shake RP2040", "0x2e8a", "0x1005", 250, "MELOPERO_SHAKE_RP2040", 16, "boot2_w25q080_2_padded_checksum")
+MakeBoard("upesy_rp2040_devkit", "uPesy", "RP2040 DevKit", "0x2e8a", "0x1007", 250, "UPESY_RP2040_DEVKIT", 2, "boot2_w25q080_2_padded_checksum")
+MakeBoard("wiznet_5100s_evb_pico", "WIZnet", "W5100S-EVB-Pico", "0x2e8a", "0x1008", 250, "WIZNET_5100S_EVB_PICO", 2, "boot2_w25q080_2_padded_checksum")

tools/platformio-build.py

@@ -142,7 +142,8 @@ def configure_usb_flags(cpp_defines):
         ("USB_PID", usb_pid),
         ("USB_MANUFACTURER", '\\"%s\\"' % usb_manufacturer),
         ("USB_PRODUCT", '\\"%s\\"' % usb_product),
-        ("SERIALUSB_PID", usb_pid)
+        ("SERIALUSB_PID", usb_pid),
+        ("USBD_MAX_POWER_MA", 250)
     ])
 
     # use vidtouse and pidtouse 

variants/adafruit_kb2040/pins_arduino.h

@@ -0,0 +1,42 @@
+#pragma once
+
+// Pin definitions taken from:
+//    https://learn.adafruit.com/assets/100337
+
+// LEDs not pinned out
+#define PIN_LED        (31u)
+
+// Serial
+#define PIN_SERIAL1_TX (0u)
+#define PIN_SERIAL1_RX (1u)
+
+// Not pinned out
+#define PIN_SERIAL2_TX (31u)
+#define PIN_SERIAL2_RX (31u)
+
+// SPI
+#define PIN_SPI0_MISO  (20u)
+#define PIN_SPI0_MOSI  (19u)
+#define PIN_SPI0_SCK   (18u)
+#define PIN_SPI0_SS    (31u) // not pinned out
+
+// Not pinned out
+#define PIN_SPI1_MISO  (31u)
+#define PIN_SPI1_MOSI  (31u)
+#define PIN_SPI1_SCK   (31u)
+#define PIN_SPI1_SS    (31u)
+
+// Wire is on the STEMMA QT port
+#define PIN_WIRE0_SDA  (12u)
+#define PIN_WIRE0_SCL  (13u)
+
+// Wire1 is on the breakout pins
+#define PIN_WIRE1_SDA  (2u)
+#define PIN_WIRE1_SCL  (3u)
+
+#define SERIAL_HOWMANY (1u)
+#define SPI_HOWMANY    (1u)
+#define WIRE_HOWMANY   (2u)
+
+#define PIN_NEOPIXEL   (17u)
+#include "../generic/common.h"

variants/adafruit_qtpy/pins_arduino.h

@@ -38,4 +38,10 @@
 #define SPI_HOWMANY    (1u)
 #define WIRE_HOWMANY   (2u)
 
+// Pin overrides specific to the QT Py RP2040
+#define __PIN_A0 (29u)
+#define __PIN_A1 (28u)
+#define __PIN_A2 (27u)
+#define __PIN_A3 (26u)
+
 #include "../generic/common.h"

variants/arduino_nano_connect/pins_arduino.h

@@ -56,19 +56,19 @@ static const uint8_t A5 = (13u);
 #define PIN_SPI0_MISO  (D12)
 #define PIN_SPI0_MOSI  (D11)
 #define PIN_SPI0_SCK   (D13)
-#define PIN_SPI0_SS    (13u)//(D10)
+#define PIN_SPI0_SS    (D10)
 
 #define PIN_SPI1_MISO  (D25)
 #define PIN_SPI1_MOSI  (D28)
 #define PIN_SPI1_SCK   (D29)
-#define PIN_SPI1_SS    (13u)
+#define PIN_SPI1_SS    (D10)
 
 // Wire
 #define PIN_WIRE0_SDA  (D18)
 #define PIN_WIRE0_SCL  (D19)
 
-#define PIN_WIRE1_SDA  (26u) //Non c'è
-#define PIN_WIRE1_SCL  (27u) //Non c'è
+#define PIN_WIRE1_SDA  (D14)
+#define PIN_WIRE1_SCL  (D15)
 
 #define SERIAL_HOWMANY (3u)
 #define SPI_HOWMANY    (2u)
@@ -95,7 +95,7 @@ static const uint8_t SCK = PIN_SPI0_SCK;
 #define SerialHCI		Serial2
 
 //#define NINA_GPIOIRQ	(21u) // LEDG pin (GPIO26 on NINA)
-#define NINA_GPIO0		(20u) // real GPIO0 on NINA
+#define NINA_GPIO0		(D20)   // (2u), real GPIO0 on NINA
 
 #define SPIWIFI_SS		(D26)
 #define SPIWIFI_ACK		(D27)

variants/challenger_2040_lte/ChallengerLTE.cpp

@@ -0,0 +1,133 @@
+/*
+    UBlox SARA helper class for the Challenger RP2040 LTE 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 <ChallengerLTE.h>
+
+Challenger2040LTEClass::Challenger2040LTEClass() {
+  pinMode(PIN_SARA_ON, OUTPUT);
+  digitalWrite(PIN_SARA_ON, LOW);           // Output register must always be low
+  pinMode(PIN_SARA_ON, INPUT_PULLUP);
+
+  pinMode(PIN_SARA_RST, INPUT_PULLUP);      // Keep as input for now
+
+  pinMode(PIN_SARA_PWR, OUTPUT);
+  digitalWrite(PIN_SARA_PWR, LOW);          // No power to SARA yet
+  serialPortConfigured = false;
+}
+
+// Do a HW reset by applying a low pulse to the reset line for 1mSec
+bool Challenger2040LTEClass::doPowerOn() {
+  bool ret;
+  digitalWrite(PIN_SARA_PWR, HIGH);         // Make sure LDO is on
+  delay(100);                               // let the power stabilize
+  pinMode(PIN_SARA_ON, OUTPUT);             // Pull power on control low
+  delay(150);                               // For 150mS
+  pinMode(PIN_SARA_ON, INPUT_PULLUP);       // before releasing it again.
+  delay(1000);                              // Now wait for 1 second
+  SARA_SERIAL_PORT.begin(DEFAULT_SARA_BAUDRATE);
+  serialPortConfigured = true;
+  ret = isAlive();                          // Makie sure the modem is
+                                            // up and running
+
+  delay(250);                               // Allow for any extra characters
+  // before flushing the input buffer
+  while(SARA_SERIAL_PORT.available()) SARA_SERIAL_PORT.read();
+
+  return ret;
+}
+
+// Checks to see if the modem responds to the "AT" poll command.
+bool Challenger2040LTEClass::isAlive(uint32_t timeout) {
+  SARA_SERIAL_PORT.setTimeout(100);
+  SARA_SERIAL_PORT.println(F("AT"));
+  String rdy = SARA_SERIAL_PORT.readStringUntil('\n');
+  while(!rdy.startsWith(F("OK")) && --timeout) {
+    SARA_SERIAL_PORT.println(F("AT"));
+    rdy = SARA_SERIAL_PORT.readStringUntil('\n');
+    //Serial.println(rdy);
+  }
+  SARA_SERIAL_PORT.setTimeout(1000);      // Restore serial timeout
+  if (timeout)
+    return true;
+  return false;
+}
+
+// Return the current MNO profile
+// Returns -1 if the serial port is not yet setup or the number of the current
+// MNO profile setting from the modem.
+int Challenger2040LTEClass::getMNOProfile() {
+  if (!serialPortConfigured)
+    return -1;
+  SARA_SERIAL_PORT.println(F("AT+UMNOPROF?"));
+  String resp = getResponse();
+  return resp.substring(resp.indexOf("+UMNOPROF: ") + 11).toInt();
+}
+
+// Set a new MNO profile
+// Returns false if the serial port is not yet setup
+bool Challenger2040LTEClass::setMNOProfile(int profile) {
+  if (!serialPortConfigured)
+    return false;
+  String cmd = "AT+UMNOPROF=" + String(profile) + ",1";
+  SARA_SERIAL_PORT.println(cmd);
+
+  if (!getResponse().endsWith("OK")) {
+    return false;
+  }
+  return true;
+}
+
+// Disable power save features
+bool Challenger2040LTEClass::enablePS(bool enable) {
+  if (!serialPortConfigured)
+    return false;
+  if (enable)
+    SARA_SERIAL_PORT.println(F("AT+CPSMS=1"));
+  else
+    SARA_SERIAL_PORT.println(F("AT+CPSMS=0"));
+
+  if (!getResponse().endsWith("OK")) {
+    return false;
+  }
+  return true;
+}
+
+// Get a response from SARA
+// A default serial timeout of 2 seconds allow for reading really slow
+// responses which should accommodate most replies. Replies are then trimmed
+// from control characters and appended with a tab character as a separator.
+//
+String Challenger2040LTEClass::getResponse(int timeout) {
+  SARA_SERIAL_PORT.setTimeout(2000);            // allow for really slow responses
+
+  String resp = SARA_SERIAL_PORT.readStringUntil('\n');
+  resp.trim();
+  String acc = resp;
+  while(resp.indexOf("OK") == -1 && resp.indexOf("ERROR") == -1 && --timeout) {
+    resp = SARA_SERIAL_PORT.readStringUntil('\n');
+    resp.trim();
+    if (resp.length())
+      acc += "\t" + resp;
+  }
+  return acc;
+}
+
+Challenger2040LTEClass Challenger2040LTE;

variants/challenger_2040_lte/ChallengerLTE.h

@@ -0,0 +1,38 @@
+/*
+    UBlox SARA helper class for the Challenger RP2040 LTE 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_SARA_BAUDRATE      115200
+
+class Challenger2040LTEClass {
+  public:
+    Challenger2040LTEClass();
+    bool doPowerOn();
+    bool isAlive(uint32_t timeout = 50);
+    int getMNOProfile();
+    bool setMNOProfile(int profile);
+    bool enablePS(bool enable = true);
+    String getResponse(int timeout = 5);
+
+  private:
+    bool serialPortConfigured;
+};
+
+extern Challenger2040LTEClass Challenger2040LTE;

variants/challenger_2040_lte/pins_arduino.h

@@ -21,6 +21,7 @@
 #define PIN_SARA_ON         (13u)
 #define PIN_SARA_RST        (14u)
 #define PIN_SARA_PWR        (15u)
+#define SARA_SERIAL_PORT    Serial2
 
 // SPI
 #define PIN_SPI0_MISO       (24u)

variants/challenger_nb_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_nb_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/challenger_nb_2040_wifi/pins_arduino.h

@@ -0,0 +1,75 @@
+#pragma once
+
+#include <ChallengerWiFi.h>
+
+#define PINS_COUNT          (24u)
+#define NUM_DIGITAL_PINS    (24u)
+#define NUM_ANALOG_INPUTS   (4u)
+#define NUM_ANALOG_OUTPUTS  (0u)
+#define ADC_RESOLUTION      (12u)
+
+// LEDs
+#define PIN_LED             (12u)
+
+// Serial
+#define PIN_SERIAL1_TX      (16u)
+#define PIN_SERIAL1_RX      (17u)
+
+// Connected to ESP8285
+#define PIN_SERIAL2_TX      (4u)
+#define PIN_SERIAL2_RX      (5u)
+#define PIN_ESP8285_RST     (19u)
+#define PIN_ESP8285_MODE    (13u)
+
+// SPI
+#define PIN_SPI0_MISO       (24u)
+#define PIN_SPI0_MOSI       (23u)
+#define PIN_SPI0_SCK        (22u)
+#define PIN_SPI0_SS         (21u)
+
+// Not pinned out
+#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       (0u)
+#define PIN_WIRE0_SCL       (1u)
+
+// Not pinned out
+#define PIN_WIRE1_SDA       (31u)
+#define PIN_WIRE1_SCL       (31u)
+
+#define SERIAL_HOWMANY      (2u)
+#define SPI_HOWMANY         (1u)
+#define WIRE_HOWMANY        (1u)
+
+#define LED_BUILTIN         PIN_LED
+#define NEOPIXEL            (11u)
+
+static const uint8_t D0 =   (16u);
+static const uint8_t D1 =   (17u);
+static const uint8_t D2 =   (24u);
+static const uint8_t D3 =   (23u);
+static const uint8_t D4 =   (22u);
+static const uint8_t D5 =   (2u);
+static const uint8_t D6 =   (3u);
+static const uint8_t D7 =   (0u);
+static const uint8_t D8 =   (1u);
+static const uint8_t D9 =   (6u);
+static const uint8_t D10 =  (7u);
+static const uint8_t D11 =  (8u);
+static const uint8_t D12 =  (9u);
+static const uint8_t D13 = (10u);
+static const uint8_t D14 = (14u);
+static const uint8_t D15 = (15u);
+static const uint8_t D16 = (18u);
+static const uint8_t D17 = (20u);
+
+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 A4 = (25u);
+static const uint8_t A5 = (21u);

variants/cytron_maker_nano_rp2040/pins_arduino.h

@@ -0,0 +1,52 @@
+#pragma once
+
+// LEDs
+#define PIN_LED             (2u)
+
+// Neopixel
+#define PIN_NEOPIXEL        (11u)
+#define NUM_NEOPIXEL        (2u)
+#define PIN_RGB             PIN_NEOPIXEL
+
+// Buzzer
+#define PIN_BUZZER          (22u)
+
+// Button
+#define PIN_BUTTON			(20u)
+
+
+
+// Serial 1
+#define PIN_SERIAL1_TX      (0u)
+#define PIN_SERIAL1_RX      (1u)
+
+// Serial 2 (Not pinned out)
+#define PIN_SERIAL2_TX      (31u)
+#define PIN_SERIAL2_RX      (31u)
+
+// SPI 0
+#define PIN_SPI0_MISO       (16u)
+#define PIN_SPI0_MOSI       (19u)
+#define PIN_SPI0_SCK        (18u)
+#define PIN_SPI0_SS         (17u)
+
+// SPI 1 (Not pinned out)
+#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       (0u)
+#define PIN_WIRE0_SCL       (1u)
+
+#define PIN_WIRE1_SDA       (26u)
+#define PIN_WIRE1_SCL       (27u)
+
+
+
+#define SERIAL_HOWMANY      (1u)
+#define SPI_HOWMANY         (1u)
+#define WIRE_HOWMANY        (2u)
+
+#include "../generic/common.h"

variants/generic/common.h

@@ -39,12 +39,34 @@ static const uint8_t D27 = (27u);
 static const uint8_t D28 = (28u);
 static const uint8_t D29 = (29u);
 
-static const uint8_t A0 = (26u);
-static const uint8_t A1 = (27u);
-static const uint8_t A2 = (28u);
-static const uint8_t A3 = (29u);
+#ifdef __PIN_A0
+	static const uint8_t A0 = __PIN_A0;
+#else
+	static const uint8_t A0 = (26u);
+#endif
+
+#ifdef __PIN_A1
+	static const uint8_t A1 = __PIN_A1;
+#else
+	static const uint8_t A1 = (27u);
+#endif
+
+#ifdef __PIN_A2
+	static const uint8_t A2 = __PIN_A2;
+#else
+	static const uint8_t A2 = (28u);
+#endif
+
+#ifdef __PIN_A3
+	static const uint8_t A3 = __PIN_A3;
+#else
+	static const uint8_t A3 = (29u);
+#endif
 
 static const uint8_t SS = PIN_SPI0_SS;
 static const uint8_t MOSI = PIN_SPI0_MOSI;
 static const uint8_t MISO = PIN_SPI0_MISO;
 static const uint8_t SCK = PIN_SPI0_SCK;
+
+static const uint8_t SDA = PIN_WIRE0_SDA;
+static const uint8_t SCL = PIN_WIRE0_SCL;

variants/ilabs_rpico32/Ilabs2040WiFiClass.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 <Ilabs2040WiFiClass.h>
+
+Ilabs2040WiFiClass::Ilabs2040WiFiClass() {
+  pinMode(PIN_ESP_RESET, OUTPUT);
+  digitalWrite(PIN_ESP_RESET, LOW);     // Hold ESP8285 in reset
+  pinMode(PIN_ESP_MODE, OUTPUT);
+  digitalWrite(PIN_ESP_MODE, HIGH);     // Prepare for normal start
+}
+
+// Do a HW reset by applying a low pulse to the reset line for 1mSec
+void Ilabs2040WiFiClass::doHWReset() {
+  digitalWrite(PIN_ESP_RESET, LOW);     // Hold ESP8285 in reset
+  delay(1);
+  digitalWrite(PIN_ESP_RESET, HIGH);    // Release ESP8285 reset
+}
+
+// Set the mode flag high to indicate normal run operation and do a HW
+// reset.
+void Ilabs2040WiFiClass::runReset() {   // Prepare ESP8285 for normal op
+  digitalWrite(PIN_ESP_MODE, HIGH);     // Prepare for normal start
+  doHWReset();
+}
+
+// Set the mode flag low to indicate flash operation and do a HW
+// reset.
+void Ilabs2040WiFiClass::flashReset() { // Prepare ESP8285 for flashing
+  digitalWrite(PIN_ESP_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 Ilabs2040WiFiClass::waitForReady() {
+  int timeout = 20;                     // Aprox max 2 sec
+
+  ESP_SERIAL_PORT.begin(DEFAULT_ESP8285_BAUDRATE);
+  ESP_SERIAL_PORT.setTimeout(100);
+  String rdy = ESP_SERIAL_PORT.readStringUntil('\n');
+  while(!rdy.startsWith("ready") && timeout--) {
+    rdy = ESP_SERIAL_PORT.readStringUntil('\n');
+  }
+  ESP_SERIAL_PORT.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 Ilabs2040WiFiClass::reset() {
+  runReset();
+  return waitForReady();
+}
+
+// Checks to see if the modem responds to the "AT" poll command.
+bool Ilabs2040WiFiClass::isAlive() {
+  int timeout = 5;
+
+  ESP_SERIAL_PORT.setTimeout(250);
+  ESP_SERIAL_PORT.println(F("AT"));
+  String rdy = ESP_SERIAL_PORT.readStringUntil('\n');
+  while(!rdy.startsWith(F("OK")) && timeout--) {
+    rdy = ESP_SERIAL_PORT.readStringUntil('\n');
+  }
+  ESP_SERIAL_PORT.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 Ilabs2040WiFiClass::changeBaudRate(int baud) {
+  ESP_SERIAL_PORT.print(F("AT+UART_CUR="));
+  ESP_SERIAL_PORT.print(baud);
+  ESP_SERIAL_PORT.println(F(",8,1,0,0"));
+  delay(100);
+  ESP_SERIAL_PORT.end();
+  ESP_SERIAL_PORT.begin(baud);
+  return isAlive();
+}
+
+Ilabs2040WiFiClass Ilabs2040WiFi;

variants/ilabs_rpico32/Ilabs2040WiFiClass.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 Ilabs2040WiFiClass {
+  public:
+    Ilabs2040WiFiClass();
+    void doHWReset();
+    void runReset();
+    void flashReset();
+    bool waitForReady();
+    bool reset();
+    bool isAlive();
+    bool changeBaudRate(int baud);
+};
+
+extern Ilabs2040WiFiClass Ilabs2040WiFi;

variants/ilabs_rpico32/pins_arduino.h

@@ -0,0 +1,82 @@
+#pragma once
+
+#include <Ilabs2040WiFiClass.h>
+
+#define PINS_COUNT          (26u)
+#define NUM_DIGITAL_PINS    (26u)
+#define NUM_ANALOG_INPUTS   (4u)
+#define NUM_ANALOG_OUTPUTS  (0u)
+#define ADC_RESOLUTION      (12u)
+
+// Connected to ESP8285
+#define PIN_SERIAL1_TX      (0u)
+#define PIN_SERIAL1_RX      (1u)
+#define PIN_ESP_RESET       (2u)
+#define PIN_ESP_MODE        (3u)
+#define PIN_ESP_TXD         PIN_SERIAL1_TX
+#define PIN_ESP_RXD         PIN_SERIAL1_RX
+#define ESP_SERIAL_PORT     Serial1
+
+// Serial
+#define PIN_SERIAL2_TX      (8u)
+#define PIN_SERIAL2_RX      (9u)
+
+// SPI
+#define PIN_SPI0_MISO       (24u)
+#define PIN_SPI0_MOSI       (23u)
+#define PIN_SPI0_SCK        (22u)
+#define PIN_SPI0_SS         (21u)
+
+// Not pinned out
+#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       (4u)
+#define PIN_WIRE0_SCL       (5u)
+
+// Not pinned out
+#define PIN_WIRE1_SDA       (31u)
+#define PIN_WIRE1_SCL       (31u)
+
+#define SERIAL_HOWMANY      (2u)
+#define SPI_HOWMANY         (1u)
+#define WIRE_HOWMANY        (1u)
+
+static const uint8_t D0 = (0u);     // Internal to the board
+static const uint8_t D1 = (1u);     // Internal to the board
+static const uint8_t D2 = (2u);     // Internal to the board
+static const uint8_t D3 = (3u);     // Internal to the board
+static const uint8_t D4 = (4u);
+static const uint8_t D5 = (5u);
+static const uint8_t D6 = (6u);
+static const uint8_t D7 = (7u);
+static const uint8_t D8 = (8u);
+static const uint8_t D9 = (9u);
+static const uint8_t D10 = (10u);
+static const uint8_t D11 = (11u);
+static const uint8_t D12 = (12u);
+static const uint8_t D13 = (13u);
+static const uint8_t D14 = (14u);
+static const uint8_t D15 = (15u);
+static const uint8_t D16 = (16u);
+static const uint8_t D17 = (17u);
+static const uint8_t D18 = (18u);
+static const uint8_t D19 = (19u);
+static const uint8_t D20 = (20u);
+static const uint8_t D21 = (21u);
+static const uint8_t D22 = (22u);
+static const uint8_t D23 = (23u);
+static const uint8_t D24 = (24u);
+static const uint8_t D25 = (25u);
+static const uint8_t D26 = (26u);
+static const uint8_t D27 = (27u);
+static const uint8_t D28 = (28u);
+static const uint8_t D29 = (29u);
+
+static const uint8_t A0 = (26u);
+static const uint8_t A1 = (27u);
+static const uint8_t A2 = (28u);
+static const uint8_t A3 = (29u);