Merge branch 'pr-heap-refactor3' of github.com:mhightower83/Arduino into pr-heap-refactor3

Author: mhightower83

.github/workflows/build-ide.yml

@@ -11,6 +11,22 @@ permissions:
 jobs:
 
   # Examples are built in parallel to avoid CI total job time limitation
+  sanity-check:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: false
+    - uses: actions/cache@v3
+      with:
+        path: ./tools/dist
+        key: ${{ runner.os }}-${{ hashFiles('package/package_esp8266com_index.template.json', 'tests/common.sh', 'tests/build.sh') }}
+    - name: Toolchain sanity checks
+      run: |
+        bash ./tests/sanity_check.sh
 
   build-linux:
     name: Linux - LwIP ${{ matrix.lwip }} (${{ matrix.chunk }})

README.md

@@ -3,7 +3,7 @@ Arduino core for ESP8266 WiFi chip
 
 # Quick links
 
-- [Latest release documentation](https://arduino-esp8266.readthedocs.io/en/3.0.2/)
+- [Latest release documentation](https://arduino-esp8266.readthedocs.io/en/3.1.1/)
 - [Current "git version" documentation](https://arduino-esp8266.readthedocs.io/en/latest/)
 - [Install git version](https://arduino-esp8266.readthedocs.io/en/latest/installing.html#using-git-version) ([sources](doc/installing.rst#using-git-version))
 
@@ -36,7 +36,7 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package
 #### Latest release [![Latest release](https://img.shields.io/github/release/esp8266/Arduino.svg)](https://github.com/esp8266/Arduino/releases/latest/)
 Boards manager link: `https://arduino.esp8266.com/stable/package_esp8266com_index.json`
 
-Documentation: [https://arduino-esp8266.readthedocs.io/en/3.0.2/](https://arduino-esp8266.readthedocs.io/en/3.0.2/)
+Documentation: [https://arduino-esp8266.readthedocs.io/en/3.1.1/](https://arduino-esp8266.readthedocs.io/en/3.1.1/)
 
 ### Using git version
 

boards.txt

@@ -22,7 +22,7 @@ menu.vt=VTables
 menu.exception=C++ Exceptions
 menu.stacksmash=Stack Protection
 menu.wipe=Erase Flash
-menu.sdk=Espressif FW
+menu.sdk=NONOS SDK Version
 menu.ssl=SSL Support
 menu.mmu=MMU
 menu.non32xfer=Non-32-Bit Access
@@ -363,19 +363,7 @@ generic.menu.sdk.nonosdk_190313=nonos-sdk 2.2.1+61 (190313)
 generic.menu.sdk.nonosdk_190313.build.sdk=NONOSDK22x_190313
 generic.menu.sdk.nonosdk221=nonos-sdk 2.2.1 (legacy)
 generic.menu.sdk.nonosdk221.build.sdk=NONOSDK221
-generic.menu.sdk.nonosdk3v0=nonos-sdk pre-3 (180626 known issues)
-generic.menu.sdk.nonosdk3v0.build.sdk=NONOSDK3V0
-generic.menu.sdk.nonosdk300=nonos-sdk 3.0.0
-generic.menu.sdk.nonosdk300.build.sdk=NONOSDK300
-generic.menu.sdk.nonosdk301=nonos-sdk 3.0.1
-generic.menu.sdk.nonosdk301.build.sdk=NONOSDK301
-generic.menu.sdk.nonosdk302=nonos-sdk 3.0.2
-generic.menu.sdk.nonosdk302.build.sdk=NONOSDK302
-generic.menu.sdk.nonosdk303=nonos-sdk 3.0.3
-generic.menu.sdk.nonosdk303.build.sdk=NONOSDK303
-generic.menu.sdk.nonosdk304=nonos-sdk 3.0.4
-generic.menu.sdk.nonosdk304.build.sdk=NONOSDK304
-generic.menu.sdk.nonosdk305=nonos-sdk 3.0.5
+generic.menu.sdk.nonosdk305=nonos-sdk 3.0.5 (experimental)
 generic.menu.sdk.nonosdk305.build.sdk=NONOSDK305
 generic.menu.ip.lm2f=v2 Lower Memory
 generic.menu.ip.lm2f.build.lwip_include=lwip2/include
@@ -720,19 +708,7 @@ esp8285.menu.sdk.nonosdk_190313=nonos-sdk 2.2.1+61 (190313)
 esp8285.menu.sdk.nonosdk_190313.build.sdk=NONOSDK22x_190313
 esp8285.menu.sdk.nonosdk221=nonos-sdk 2.2.1 (legacy)
 esp8285.menu.sdk.nonosdk221.build.sdk=NONOSDK221
-esp8285.menu.sdk.nonosdk3v0=nonos-sdk pre-3 (180626 known issues)
-esp8285.menu.sdk.nonosdk3v0.build.sdk=NONOSDK3V0
-esp8285.menu.sdk.nonosdk300=nonos-sdk 3.0.0
-esp8285.menu.sdk.nonosdk300.build.sdk=NONOSDK300
-esp8285.menu.sdk.nonosdk301=nonos-sdk 3.0.1
-esp8285.menu.sdk.nonosdk301.build.sdk=NONOSDK301
-esp8285.menu.sdk.nonosdk302=nonos-sdk 3.0.2
-esp8285.menu.sdk.nonosdk302.build.sdk=NONOSDK302
-esp8285.menu.sdk.nonosdk303=nonos-sdk 3.0.3
-esp8285.menu.sdk.nonosdk303.build.sdk=NONOSDK303
-esp8285.menu.sdk.nonosdk304=nonos-sdk 3.0.4
-esp8285.menu.sdk.nonosdk304.build.sdk=NONOSDK304
-esp8285.menu.sdk.nonosdk305=nonos-sdk 3.0.5
+esp8285.menu.sdk.nonosdk305=nonos-sdk 3.0.5 (experimental)
 esp8285.menu.sdk.nonosdk305.build.sdk=NONOSDK305
 esp8285.menu.ip.lm2f=v2 Lower Memory
 esp8285.menu.ip.lm2f.build.lwip_include=lwip2/include

cores/esp8266/Esp.cpp

@@ -471,7 +471,7 @@ bool EspClass::checkFlashCRC() {
     uint32_t firstPart = (uintptr_t)&__crc_len - 0x40200000; // How many bytes to check before the 1st CRC val
 
     // Start the checksum
-    uint32_t crc = crc32((const void*)0x40200000, firstPart, 0xffffffff);
+    uint32_t crc = crc32((const void*)0x40200000, firstPart);
     // Pretend the 2 words of crc/len are zero to be idempotent
     crc = crc32(z, 8, crc);
     // Finish the CRC calculation over the rest of flash

cores/esp8266/IPAddress.cpp

@@ -27,6 +27,11 @@ IPAddress::IPAddress(const IPAddress& from)
     ip_addr_copy(_ip, from._ip);
 }
 
+IPAddress::IPAddress(IPAddress&& from)
+{
+    ip_addr_copy(_ip, from._ip);
+}
+
 IPAddress::IPAddress() {
     _ip = *IP_ANY_TYPE; // lwIP's v4-or-v6 generic address
 }
@@ -36,24 +41,14 @@ bool IPAddress::isSet () const {
 }
 
 IPAddress::IPAddress(uint8_t first_octet, uint8_t second_octet, uint8_t third_octet, uint8_t fourth_octet) {
-    setV4();
-    (*this)[0] = first_octet;
-    (*this)[1] = second_octet;
-    (*this)[2] = third_octet;
-    (*this)[3] = fourth_octet;
-}
+    uint8_t addr[] {
+        first_octet,
+        second_octet,
+        third_octet,
+        fourth_octet,
+    };
 
-void IPAddress::ctor32(uint32_t address) {
-    setV4();
-    v4() = address;
-}
-
-IPAddress::IPAddress(const uint8_t *address) {
-    setV4();
-    (*this)[0] = address[0];
-    (*this)[1] = address[1];
-    (*this)[2] = address[2];
-    (*this)[3] = address[3];
+    *this = &addr[0];
 }
 
 bool IPAddress::fromString(const char *address) {
@@ -111,8 +106,10 @@ bool IPAddress::fromString4(const char *address) {
 }
 
 IPAddress& IPAddress::operator=(const uint8_t *address) {
-    setV4();
-    v4() = *reinterpret_cast<const uint32_t*>(address);
+    uint32_t value;
+    memcpy_P(&value, address, sizeof(value));
+
+    *this = value;
     return *this;
 }
 
@@ -123,7 +120,14 @@ IPAddress& IPAddress::operator=(uint32_t address) {
 }
 
 bool IPAddress::operator==(const uint8_t* addr) const {
-    return isV4() && v4() == *reinterpret_cast<const uint32_t*>(addr);
+    if (!isV4()) {
+        return false;
+    }
+
+    uint32_t value;
+    memcpy_P(&value, addr, sizeof(value));
+
+    return v4() == value;
 }
 
 size_t IPAddress::printTo(Print& p) const {

cores/esp8266/IPAddress.h

@@ -61,17 +61,16 @@ class IPAddress: public Printable {
             return reinterpret_cast<const uint8_t*>(&v4());
         }
 
-        void ctor32 (uint32_t);
-
     public:
-        // Constructors
         IPAddress();
-        IPAddress(const IPAddress& from);
+        IPAddress(const IPAddress&);
+        IPAddress(IPAddress&&);
+
         IPAddress(uint8_t first_octet, uint8_t second_octet, uint8_t third_octet, uint8_t fourth_octet);
-        IPAddress(uint32_t address) { ctor32(address); }
-        IPAddress(unsigned long address) { ctor32(address); }
-        IPAddress(int address) { ctor32(address); }
-        IPAddress(const uint8_t *address);
+        IPAddress(uint32_t address) { *this = address; }
+        IPAddress(unsigned long address) { *this = address; }
+        IPAddress(int address) { *this = address; }
+        IPAddress(const uint8_t *address) { *this = address; }
 
         bool fromString(const char *address);
         bool fromString(const String &address) { return fromString(address.c_str()); }
@@ -86,7 +85,7 @@ class IPAddress: public Printable {
         operator bool ()       { return isSet(); } // <- both are needed
 
         // generic IPv4 wrapper to uint32-view like arduino loves to see it
-        const uint32_t& v4() const { return ip_2_ip4(&_ip)->addr; } // for raw_address(const)
+        const uint32_t& v4() const { return ip_2_ip4(&_ip)->addr; }
               uint32_t& v4()       { return ip_2_ip4(&_ip)->addr; }
 
         bool operator==(const IPAddress& addr) const {
@@ -115,11 +114,18 @@ class IPAddress: public Printable {
 
         // Overloaded index operator to allow getting and setting individual octets of the address
         uint8_t operator[](int index) const {
-            return isV4()? *(raw_address() + index): 0;
+            if (!isV4()) {
+                return 0;
+            }
+
+            return ip4_addr_get_byte_val(*ip_2_ip4(&_ip), index);
         }
+
         uint8_t& operator[](int index) {
             setV4();
-            return *(raw_address() + index);
+
+            uint8_t* ptr = reinterpret_cast<uint8_t*>(&v4());
+            return *(ptr + index);
         }
 
         // Overloaded copy operators to allow initialisation of IPAddress objects from other types

cores/esp8266/LwipIntfDev.h

@@ -46,6 +46,13 @@
 #define DEFAULT_MTU 1500
 #endif
 
+enum EthernetLinkStatus
+{
+    Unknown,
+    LinkON,
+    LinkOFF
+};
+
 template<class RawDev>
 class LwipIntfDev: public LwipIntf, public RawDev
 {
@@ -93,9 +100,11 @@ class LwipIntfDev: public LwipIntf, public RawDev
     void setDefault(bool deflt = true);
 
     // true if interface has a valid IPv4 address
+    // (and ethernet link status is not detectable or is up)
     bool connected()
     {
-        return !!ip4_addr_get_u32(ip_2_ip4(&_netif.ip_addr));
+        return !!ip4_addr_get_u32(ip_2_ip4(&_netif.ip_addr))
+               && (!RawDev::isLinkDetectable() || RawDev::isLinked());
     }
 
     bool routable()
@@ -106,6 +115,9 @@ class LwipIntfDev: public LwipIntf, public RawDev
     // ESP8266WiFi API compatibility
     wl_status_t status();
 
+    // Arduino Ethernet compatibility
+    EthernetLinkStatus linkStatus();
+
 protected:
     err_t netif_init();
     void  check_route();
@@ -282,6 +294,12 @@ wl_status_t LwipIntfDev<RawDev>::status()
     return _started ? (connected() ? WL_CONNECTED : WL_DISCONNECTED) : WL_NO_SHIELD;
 }
 
+template<class RawDev>
+EthernetLinkStatus LwipIntfDev<RawDev>::linkStatus()
+{
+    return RawDev::isLinkDetectable() ? _started && RawDev::isLinked() ? LinkON : LinkOFF : Unknown;
+}
+
 template<class RawDev>
 err_t LwipIntfDev<RawDev>::linkoutput_s(netif* netif, struct pbuf* pbuf)
 {

cores/esp8266/Schedule.cpp

@@ -17,6 +17,7 @@
 */
 
 #include <assert.h>
+#include <numeric>
 
 #include "Schedule.h"
 #include "PolledTimeout.h"
@@ -34,6 +35,7 @@ static scheduled_fn_t* sFirst = nullptr;
 static scheduled_fn_t* sLast = nullptr;
 static scheduled_fn_t* sUnused = nullptr;
 static int sCount = 0;
+static uint32_t recurrent_max_grain_mS = 0;
 
 typedef std::function<bool(void)> mRecFuncT;
 struct recurrent_fn_t
@@ -130,9 +132,39 @@ bool schedule_recurrent_function_us(const std::function<bool(void)>& fn,
     }
     rLast = item;
 
+    // grain needs to be recomputed
+    recurrent_max_grain_mS = 0;
+
     return true;
 }
 
+uint32_t compute_scheduled_recurrent_grain ()
+{
+    if (recurrent_max_grain_mS == 0)
+    {
+        if (rFirst)
+        {
+            uint32_t recurrent_max_grain_uS = rFirst->callNow.getTimeout();
+            for (auto it = rFirst->mNext; it; it = it->mNext)
+                recurrent_max_grain_uS = std::gcd(recurrent_max_grain_uS, it->callNow.getTimeout());
+            if (recurrent_max_grain_uS)
+                // round to the upper millis
+                recurrent_max_grain_mS = recurrent_max_grain_uS <= 1000? 1: (recurrent_max_grain_uS + 999) / 1000;
+        }
+
+#ifdef DEBUG_ESP_CORE
+        static uint32_t last_grain = 0;
+        if (recurrent_max_grain_mS != last_grain)
+        {
+            ::printf(":rsf %u->%u\n", last_grain, recurrent_max_grain_mS);
+            last_grain = recurrent_max_grain_mS;
+        }
+#endif
+    }
+
+    return recurrent_max_grain_mS;
+}
+
 void run_scheduled_functions()
 {
     // prevent scheduling of new functions during this run
@@ -226,6 +258,9 @@ void run_scheduled_recurrent_functions()
             }
 
             delete(to_ditch);
+
+            // grain needs to be recomputed
+            recurrent_max_grain_mS = 0;
         }
         else
         {

cores/esp8266/Schedule.h

@@ -39,6 +39,11 @@
 // scheduled function happen more often: every yield() (vs every loop()),
 // and time resolution is microsecond (vs millisecond). Details are below.
 
+// compute_scheduled_recurrent_grain() is used by delay() to give a chance to
+// all recurrent functions to run per their timing requirement.
+
+uint32_t compute_scheduled_recurrent_grain ();
+
 // scheduled functions called once:
 //
 // * internal queue is FIFO.

cores/esp8266/Stream.cpp

@@ -58,16 +58,16 @@ int Stream::timedPeek() {
 
 // returns peek of the next digit in the stream or -1 if timeout
 // discards non-numeric characters
-int Stream::peekNextDigit() {
+int Stream::peekNextDigit(bool detectDecimal) {
     int c;
     while(1) {
         c = timedPeek();
-        if(c < 0)
-            return c;  // timeout
-        if(c == '-')
-            return c;
-        if(c >= '0' && c <= '9')
+        if( c < 0 || // timeout
+            c == '-' ||
+            ( c >= '0' && c <= '9' ) ||
+            ( detectDecimal && c == '.' ) ) {
             return c;
+        }
         read();  // discard non-numeric
     }
 }
@@ -141,7 +141,7 @@ long Stream::parseInt(char skipChar) {
     long value = 0;
     int c;
 
-    c = peekNextDigit();
+    c = peekNextDigit(false);
     // ignore non numeric leading characters
     if(c < 0)
         return 0; // zero returned if timeout
@@ -176,7 +176,7 @@ float Stream::parseFloat(char skipChar) {
     int c;
     float fraction = 1.0f;
 
-    c = peekNextDigit();
+    c = peekNextDigit(true);
     // ignore non numeric leading characters
     if(c < 0)
         return 0; // zero returned if timeout