Merge branch 'master' into pr-eraseconfig-reset

Author: mhightower83

README.md

@@ -28,9 +28,9 @@ ESP8266 Arduino core comes with libraries to communicate over WiFi using TCP and
 
 Starting with 1.6.4, Arduino allows installation of third-party platform packages using Boards Manager. We have packages available for Windows, Mac OS, and Linux (32 and 64 bit).
 
-- Install the current upstream Arduino IDE at the 1.8.9 level or later. The current version is on the [Arduino website](https://www.arduino.cc/en/software).
-- Start Arduino and open the Preferences window.
-- Enter ```https://arduino.esp8266.com/stable/package_esp8266com_index.json``` into the *File>Preferences>Additional Boards Manager URLs* field of the Arduino IDE. You can add multiple URLs, separating them with commas.
+- [Download and install Arduino IDE 1.x or 2.x](https://www.arduino.cc/en/software)
+- Start Arduino and open the Preferences window
+- Enter `https://arduino.esp8266.com/stable/package_esp8266com_index.json` into the *File>Preferences>Additional Boards Manager URLs* field of the Arduino IDE. You can add multiple URLs, separating them with commas.
 - Open Boards Manager from Tools > Board menu and install *esp8266* platform (and don't forget to select your ESP8266 board from Tools > Board menu after installation).
 
 #### Latest release [![Latest release](https://img.shields.io/github/release/esp8266/Arduino.svg)](https://github.com/esp8266/Arduino/releases/latest/)

cores/esp8266/core_esp8266_main.cpp

@@ -166,6 +166,11 @@ extern "C" void __esp_delay(unsigned long ms) {
 extern "C" void esp_delay(unsigned long ms) __attribute__((weak, alias("__esp_delay")));
 
 bool esp_try_delay(const uint32_t start_ms, const uint32_t timeout_ms, const uint32_t intvl_ms) {
+    if (!timeout_ms) {
+        esp_yield();
+        return true;
+    }
+
     uint32_t expired = millis() - start_ms;
     if (expired >= timeout_ms) {
         return true; // expired

cores/esp8266/umm_malloc/umm_malloc.cpp

@@ -928,7 +928,7 @@ void *umm_realloc(void *ptr, size_t size) {
 
     uint16_t c;
 
-    size_t curSize;
+    [[maybe_unused]] size_t curSize;
 
     UMM_CHECK_INITIALIZED();
 
@@ -1089,7 +1089,8 @@ void *umm_realloc(void *ptr, size_t size) {
         STATS__FREE_BLOCKS_UPDATE(-prevBlockSize);
         STATS__FREE_BLOCKS_ISR_MIN();
         blockSize += prevBlockSize;
-        POISON_CHECK_SET_POISON((void *)&UMM_DATA(c), size);  // Fix allocation so ISR poison check is good
+        // Fix new allocation such that poison checks from an ISR pass.
+        POISON_CHECK_SET_POISON_BLOCKS((void *)&UMM_DATA(c), blockSize);
         UMM_CRITICAL_SUSPEND(id_realloc);
         UMM_POISON_MEMMOVE((void *)&UMM_DATA(c), ptr, curSize);
         ptr = (void *)&UMM_DATA(c);
@@ -1111,7 +1112,7 @@ void *umm_realloc(void *ptr, size_t size) {
         #else
         blockSize += (prevBlockSize + nextBlockSize);
         #endif
-        POISON_CHECK_SET_POISON((void *)&UMM_DATA(c), size);
+        POISON_CHECK_SET_POISON_BLOCKS((void *)&UMM_DATA(c), blockSize);
         UMM_CRITICAL_SUSPEND(id_realloc);
         UMM_POISON_MEMMOVE((void *)&UMM_DATA(c), ptr, curSize);
         ptr = (void *)&UMM_DATA(c);
@@ -1123,7 +1124,7 @@ void *umm_realloc(void *ptr, size_t size) {
         void *oldptr = ptr;
         if ((ptr = umm_malloc_core(_context, size))) {
             DBGLOG_DEBUG("realloc %i to a bigger block %i, copy, and free the old\n", blockSize, blocks);
-            POISON_CHECK_SET_POISON((void *)&UMM_DATA(c), size);
+            (void)POISON_CHECK_SET_POISON(ptr, size);
             UMM_CRITICAL_SUSPEND(id_realloc);
             UMM_POISON_MEMCPY(ptr, oldptr, curSize);
             UMM_CRITICAL_RESUME(id_realloc);
@@ -1186,7 +1187,8 @@ void *umm_realloc(void *ptr, size_t size) {
             blockSize = blocks;
             #endif
         }
-        POISON_CHECK_SET_POISON((void *)&UMM_DATA(c), size);
+        // Fix new allocation such that poison checks from an ISR pass.
+        POISON_CHECK_SET_POISON_BLOCKS((void *)&UMM_DATA(c), blockSize);
         UMM_CRITICAL_SUSPEND(id_realloc);
         UMM_POISON_MEMMOVE((void *)&UMM_DATA(c), ptr, curSize);
         ptr = (void *)&UMM_DATA(c);
@@ -1204,7 +1206,7 @@ void *umm_realloc(void *ptr, size_t size) {
         void *oldptr = ptr;
         if ((ptr = umm_malloc_core(_context, size))) {
             DBGLOG_DEBUG("realloc %d to a bigger block %d, copy, and free the old\n", blockSize, blocks);
-            POISON_CHECK_SET_POISON((void *)&UMM_DATA(c), size);
+            (void)POISON_CHECK_SET_POISON(ptr, size);
             UMM_CRITICAL_SUSPEND(id_realloc);
             UMM_POISON_MEMCPY(ptr, oldptr, curSize);
             UMM_CRITICAL_RESUME(id_realloc);
@@ -1230,7 +1232,7 @@ void *umm_realloc(void *ptr, size_t size) {
         void *oldptr = ptr;
         if ((ptr = umm_malloc_core(_context, size))) {
             DBGLOG_DEBUG("realloc %d to a bigger block %d, copy, and free the old\n", blockSize, blocks);
-            POISON_CHECK_SET_POISON((void *)&UMM_DATA(c), size);
+            (void)POISON_CHECK_SET_POISON(ptr, size);
             UMM_CRITICAL_SUSPEND(id_realloc);
             UMM_POISON_MEMCPY(ptr, oldptr, curSize);
             UMM_CRITICAL_RESUME(id_realloc);

cores/esp8266/umm_malloc/umm_malloc_cfg.h

@@ -619,8 +619,16 @@ extern bool  umm_poison_check(void);
 void *umm_poison_realloc_fl(void *ptr, size_t size, const char *file, int line);
 void  umm_poison_free_fl(void *ptr, const char *file, int line);
 #define POISON_CHECK_SET_POISON(p, s) get_poisoned(p, s)
-#define UMM_POISON_SKETCH_PTR(p) ((void*)((uintptr_t)p + sizeof(UMM_POISONED_BLOCK_LEN_TYPE) + UMM_POISON_SIZE_BEFORE))
-#define UMM_POISON_SKETCH_PTRSZ(s) (s - sizeof(UMM_POISONED_BLOCK_LEN_TYPE) - UMM_POISON_SIZE_BEFORE  - UMM_POISON_SIZE_AFTER)
+#define POISON_CHECK_SET_POISON_BLOCKS(p, s) \
+    do { \
+        size_t super_size = (s * sizeof(umm_block)) - (sizeof(((umm_block *)0)->header)); \
+        get_poisoned(p, super_size); \
+    } while (false)
+#define UMM_POISON_SKETCH_PTR(p) ((void *)((uintptr_t)p + sizeof(UMM_POISONED_BLOCK_LEN_TYPE) + UMM_POISON_SIZE_BEFORE))
+#define UMM_POISON_SKETCH_PTRSZ(p) (*(UMM_POISONED_BLOCK_LEN_TYPE *)p)
+#define UMM_POISON_MEMMOVE(t, p, s) memmove(UMM_POISON_SKETCH_PTR(t), UMM_POISON_SKETCH_PTR(p), UMM_POISON_SKETCH_PTRSZ(p))
+#define UMM_POISON_MEMCPY(t, p, s) memcpy(UMM_POISON_SKETCH_PTR(t), UMM_POISON_SKETCH_PTR(p), UMM_POISON_SKETCH_PTRSZ(p))
+
 #if defined(UMM_POISON_CHECK_LITE)
 /*
     * We can safely do individual poison checks at free and realloc and stay
@@ -641,13 +649,11 @@ void  umm_poison_free_fl(void *ptr, const char *file, int line);
 #define POISON_CHECK() 1
 #define POISON_CHECK_NEIGHBORS(c) do {} while (false)
 #define POISON_CHECK_SET_POISON(p, s) (p)
-#define UMM_POISON_SKETCH_PTR(p) (p)
-#define UMM_POISON_SKETCH_PTRSZ(s) (s)
+#define POISON_CHECK_SET_POISON_BLOCKS(p, s)
+#define UMM_POISON_MEMMOVE(t, p, s) memmove((t), (p), (s))
+#define UMM_POISON_MEMCPY(t, p, s) memcpy((t), (p), (s))
 #endif
 
-#define UMM_POISON_MEMMOVE(t, p, s) memmove(UMM_POISON_SKETCH_PTR(t), UMM_POISON_SKETCH_PTR(p), UMM_POISON_SKETCH_PTRSZ(s))
-#define UMM_POISON_MEMCPY(t, p, s) memcpy(UMM_POISON_SKETCH_PTR(t), UMM_POISON_SKETCH_PTR(p), UMM_POISON_SKETCH_PTRSZ(s))
-
 #if defined(UMM_POISON_CHECK) || defined(UMM_POISON_CHECK_LITE)
 /*
  * Overhead adjustments needed for free_blocks to express the number of bytes

doc/installing.rst

@@ -9,10 +9,9 @@ This is the suggested installation method for end users.
 Prerequisites
 ~~~~~~~~~~~~~
 
--  Arduino 1.6.8, get it from `Arduino
-   website <https://www.arduino.cc/en/Main/OldSoftwareReleases#previous>`__.
 -  Internet connection
--  Python 3 interpreter (Mac/Linux only, Windows installation supplies its own)
+-  Arduino IDE 1.x or 2.x (https://www.arduino.cc/en/software)
+-  (macOS/Linux only) Python ≥3.7 (https://python.org)
 
 Instructions
 ~~~~~~~~~~~~
@@ -33,6 +32,7 @@ For more information on the Arduino Board Manager, see:
 
 - https://www.arduino.cc/en/guide/cores
 
+
 Using git version
 -----------------
 
@@ -42,12 +42,12 @@ developers.
 Prerequisites
 ~~~~~~~~~~~~~
 
--  Arduino 1.6.8 (or newer, current working version is 1.8.5)
--  git
+-  Internet connection
+-  Arduino IDE 1.x or 2.x (https://www.arduino.cc/en/software)
+-  git (https://git-scm.com)
 -  Python ≥3.7 (https://python.org)
 -  terminal, console, or command prompt (depending on your OS)
--  Internet connection
--  Uninstalling any core version installed via Board Manager
+-  **Uninstalling any core version installed via Board Manager**
 
 Instructions - Windows 10
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -59,7 +59,7 @@ Instructions - Windows 10
 - Install git for Windows (if not already; see https://git-scm.com/download/win)
 
 -  Open a command prompt (cmd) and go to Arduino default directory. This is typically the
-   *sketchbook* directory (usually ``C:\users\{username}\Documents\Arduino`` where the environment variable ``%USERPROFILE%`` usually contains ``C:\users\{username}``)
+   *sketchbook* directory (usually ``C:\Users\{username}\Documents\Arduino`` where the environment variable ``%USERPROFILE%`` usually contains ``C:\Users\{username}``)
 
 -  Clone this repository into hardware/esp8266com/esp8266 directory.
 
@@ -101,14 +101,15 @@ Instructions - Windows 10
                    --- boards.txt
                    --- LICENSE
 
--  Initialize the submodules
+-  Initialize submodules to fetch external libraries
 
    .. code:: bash
 
        cd %USERPROFILE%\Documents\Arduino\hardware\esp8266com\esp8266
        git submodule update --init   
   
-  If error messages about missing files related to ``SoftwareSerial`` are encountered during the build process, it should be because this step was missed and is required.
+  Not doing this step would cause build failure when attempting to include ``SoftwareSerial.h``, ``Ethernet.h``, etc.
+  See our `.gitmodules file <https://github.com/esp8266/Arduino/blob/master/.gitmodules>`__ for the full list.
   
 -  Download binary tools
 
@@ -181,14 +182,16 @@ Instructions - Other OS
                    --- boards.txt
                    --- LICENSE
 
--  Initialize the submodules
+-  Initialize submodules to fetch external libraries
 
    .. code:: bash
 
        cd esp8266
        git submodule update --init   
-  
-  If error messages about missing files related to ``SoftwareSerial`` are encountered during the build process, it should be because this step was missed and is required.
+
+
+  Not doing this step would cause build failure when attempting to include ``SoftwareSerial.h``, ``Ethernet.h``, etc.
+  See our `.gitmodules file <https://github.com/esp8266/Arduino/blob/master/.gitmodules>`__ for the full list.
 
 -  Download binary tools
 
@@ -197,9 +200,10 @@ Instructions - Other OS
        cd tools
        python3 get.py
 
-   If you get an error message stating that python3 is not found, you will need to install it (most modern UNIX-like OSes provide Python 3 as
-   part of the default install).  To install you will need to use ``sudo yum install python3``, ``sudo apt install python3``, or ``brew install python3``
-   as appropriate.  On the Mac you may get an error message like:
+
+  If you get an error message stating that python3 is not found, you will need to install it (most modern UNIX-like OSes provide Python 3 as
+  part of the default install).  To install you will need to use ``sudo yum install python3``, ``sudo apt install python3``, or ``brew install python3``
+  as appropriate.  On the Mac you may get an error message like:
 
    .. code:: bash
 
@@ -214,7 +218,8 @@ Instructions - Other OS
            self._sslobj.do_handshake()
        ssl.SSLCertVerificationError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:1056)
 
-    This is because Homebrew on the Mac does not always install the required SSL certificates by default.  Install them manually (adjust the Python 3.7 as needed) with:
+
+  This is because Homebrew on the Mac does not always install the required SSL certificates by default.  Install them manually (adjust the Python 3.7 as needed) with:
 
     .. code:: bash
 
@@ -231,6 +236,44 @@ Instructions - Other OS
        git status
        git pull
 
+Maintaining
+~~~~~~~~~~~
+
+To keep up with the development branch
+
+.. code:: bash
+
+   git switch --recurse-submodules --discard-changes master
+   git pull --recurse-submodules
+   cd tools
+   python3 get.py
+
+Pull requests
+~~~~~~~~~~~~~
+
+To test not yet merged Pull Request, first you have to find its ID number. This is the sequence of digits right after the pull request title.
+
+Open terminal and cd into the directory where the repository was previously cloned. For example, 12345 is the Pull Request ID
+
+.. code:: bash
+
+   git fetch origin pull/12345/head
+   git switch --detach --recurse-submodules --discard-changes FETCH_HEAD
+
+When Pull Request updates packaged tools, make sure to also fetch their latest versions.
+
+.. code:: bash
+
+   cd tools
+   python3 get.py
+
+To go back to using the development branch
+
+.. code:: bash
+
+   git switch --recurse-submodules --discard-changes master
+   git pull --recurse-submodules
+
 Using PlatformIO
 ----------------
 
@@ -245,5 +288,6 @@ BeagleBone, CubieBoard).
 - `PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=arduino-esp8266>`__
 - `PlatformIO Core <https://docs.platformio.org/en/latest/core.html?utm_source=arduino-esp8266>`__ (command line tool)
 - `Advanced usage <https://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=arduino-esp8266>`__ - custom settings, uploading to LittleFS, Over-the-Air (OTA), staging version
+- `Using Arduino Framework Staging Version <https://docs.platformio.org/en/stable/platforms/espressif8266.html?utm_source=arduino-esp8266#using-arduino-framework-with-staging-version>`__ - install development version of the Core
 - `Integration with Cloud and Standalone IDEs <https://docs.platformio.org/en/latest/ide.html?utm_source=arduino-esp8266>`__ - Cloud9, Codeanywhere, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM, Visual Studio, and VSCode
 - `Project Examples <https://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=arduino-esp8266#examples>`__