Merge branch 'master' into pgmspace_to_libc

Author: earlephilhower

.travis.yml

@@ -13,6 +13,10 @@ matrix:
       - BUILD_TYPE=build_even
     - env:
       - BUILD_TYPE=build_odd
+    - env:
+      - BUILD_TYPE=debug_even
+    - env:
+      - BUILD_TYPE=debug_odd
     - env:
       - BUILD_TYPE=platformio
     - env:

README.md

@@ -8,7 +8,7 @@ ESP8266 Arduino core comes with libraries to communicate over WiFi using TCP and
 # Contents
 - Installing options:
   - [Using Boards Manager](#installing-with-boards-manager)
-  - [Using git version](#using-git-version)
+  - [Using git version](#using-git-version-basic-instructions)
   - [Using PlatformIO](#using-platformio)
   - [Building with make](#building-with-make)
 - [Documentation](#documentation)
@@ -30,16 +30,20 @@ Boards manager link: `http://arduino.esp8266.com/stable/package_esp8266com_index
 
 Documentation: [https://arduino-esp8266.readthedocs.io/en/2.4.2/](https://arduino-esp8266.readthedocs.io/en/2.4.2/)
 
-### Using git version
+### Using git version (basic instructions)
 [![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino)
 
 - Install the current upstream Arduino IDE at the 1.8 level or later. The current version is at the [Arduino website](http://www.arduino.cc/en/main/software).
-- Go to Arduino application directory
+- Go to Arduino directory
   - For Mac OS X, it is `Arduino.app` showing as the Arduino icon.  
     This location may be your `~/Downloads`, `~/Desktop` or even `/Applications`.
     ```bash
     cd <application-directory>/Arduino.app/Contents/Java
     ```
+  - For Linux, it is ~/arduino by default.
+    ```bash
+    cd ~arduino
+    ```
 - Clone this repository into hardware/esp8266com/esp8266 directory (or clone it elsewhere and create a symlink)
 ```bash
 cd hardware
@@ -124,3 +128,5 @@ ESP8266 core files are licensed under LGPL.
 [umm_malloc](https://github.com/rhempel/umm_malloc) memory management library written by Ralph Hempel is used in this project. It is distributed under MIT license.
 
 [axTLS](http://axtls.sourceforge.net/) library written by Cameron Rich, built from https://github.com/igrr/axtls-8266, is used in this project. It is distributed under [BSD license](https://github.com/igrr/axtls-8266/blob/master/LICENSE).
+
+[BearSSL](https://bearssl.org) library written by Thomas Pornin, built from https://github.com/earlephilhower/bearssl-esp8266, is used in this project.  It is distributed under the [MIT License](https://bearssl.org/#legal-details).

boards.txt

@@ -34,8 +34,8 @@ class Client: public Stream {
         virtual int read() = 0;
         virtual int read(uint8_t *buf, size_t size) = 0;
         virtual int peek() = 0;
-        virtual void flush() = 0;
-        virtual void stop() = 0;
+        virtual bool flush(unsigned int maxWaitMs = 0) = 0;
+        virtual bool stop(unsigned int maxWaitMs = 0) = 0;
         virtual uint8_t connected() = 0;
         virtual operator bool() = 0;
     protected:

cores/esp8266/Client.h

@@ -25,6 +25,7 @@
 #include "interrupts.h"
 #include "MD5Builder.h"
 #include "umm_malloc/umm_malloc.h"
+#include "cont.h"
 
 extern "C" {
 #include "user_interface.h"
@@ -177,6 +178,16 @@ uint16_t EspClass::getMaxFreeBlockSize(void)
     return umm_max_block_size();
 }
 
+uint32_t EspClass::getFreeContStack()
+{
+    return cont_get_free_stack(g_pcont);
+}
+
+void EspClass::resetFreeContStack()
+{
+    cont_repaint_stack(g_pcont);
+}
+
 uint32_t EspClass::getChipId(void)
 {
     return system_get_chip_id();

cores/esp8266/Esp.cpp

@@ -110,6 +110,9 @@ class EspClass {
         uint8_t getHeapFragmentation(); // in %
         void getHeapStats(uint32_t* free = nullptr, uint16_t* max = nullptr, uint8_t* frag = nullptr);
 
+        uint32_t getFreeContStack();
+        void resetFreeContStack();
+
         const char * getSdkVersion();
         String getCoreVersion();
         String getFullVersion();

cores/esp8266/Esp.h

@@ -35,16 +35,23 @@ void UpdaterClass::_reset() {
   _currentAddress = 0;
   _size = 0;
   _command = U_FLASH;
+
+  if(_ledPin != -1) {
+    digitalWrite(_ledPin, !_ledOn); // off
+  }
 }
 
-bool UpdaterClass::begin(size_t size, int command) {
+bool UpdaterClass::begin(size_t size, int command, int ledPin, uint8_t ledOn) {
   if(_size > 0){
 #ifdef DEBUG_UPDATER
     DEBUG_UPDATER.println(F("[begin] already running"));
 #endif
     return false;
   }
 
+  _ledPin = ledPin;
+  _ledOn = !!ledOn; // 0(LOW) or 1(HIGH)
+
   /* Check boot mode; if boot mode is 1 (UART download mode),
     we will not be able to reset into normal mode once update is done.
     Fail early to avoid frustration.
@@ -360,18 +367,32 @@ size_t UpdaterClass::writeStream(Stream &data) {
         return 0;
     }
 
+    if(_ledPin != -1) {
+        pinMode(_ledPin, OUTPUT);
+    }
+
     while(remaining()) {
-        toRead = data.readBytes(_buffer + _bufferLen,  (_bufferSize - _bufferLen));
+        if(_ledPin != -1) {
+            digitalWrite(_ledPin, _ledOn); // Switch LED on
+        }
+        size_t bytesToRead = _bufferSize - _bufferLen;
+        if(bytesToRead > remaining()) {
+            bytesToRead = remaining();
+        }
+        toRead = data.readBytes(_buffer + _bufferLen,  bytesToRead);
         if(toRead == 0) { //Timeout
             delay(100);
-            toRead = data.readBytes(_buffer + _bufferLen, (_bufferSize - _bufferLen));
+            toRead = data.readBytes(_buffer + _bufferLen, bytesToRead);
             if(toRead == 0) { //Timeout
                 _currentAddress = (_startAddress + _size);
                 _setError(UPDATE_ERROR_STREAM);
                 _reset();
                 return written;
             }
         }
+        if(_ledPin != -1) {
+            digitalWrite(_ledPin, !_ledOn); // Switch LED off
+        }
         _bufferLen += toRead;
         if((_bufferLen == remaining() || _bufferLen == _bufferSize) && !_writeBuffer())
             return written;

cores/esp8266/Updater.cpp

@@ -35,7 +35,7 @@ class UpdaterClass {
       Call this to check the space needed for the update
       Will return false if there is not enough space
     */
-    bool begin(size_t size, int command = U_FLASH);
+    bool begin(size_t size, int command = U_FLASH, int ledPin = -1, uint8_t ledOn = LOW);
 
     /*
       Run Updater from asynchronous callbacs
@@ -162,6 +162,9 @@ class UpdaterClass {
 
     String _target_md5;
     MD5Builder _md5;
+
+    int _ledPin;
+    uint8_t _ledOn;
 };
 
 extern UpdaterClass Update;

cores/esp8266/Updater.h

@@ -74,6 +74,12 @@ int cont_get_free_stack(cont_t* cont);
 // continuation stack
 bool cont_can_yield(cont_t* cont);
 
+// Repaint the stack from the current SP to the end, to allow individual
+// routines' stack usages to be calculated by re-painting, checking current
+// free, running the routine, then checking the max free
+void cont_repaint_stack(cont_t *cont);
+
+
 #ifdef __cplusplus
 }
 #endif

cores/esp8266/cont.h

@@ -64,3 +64,18 @@ bool ICACHE_RAM_ATTR cont_can_yield(cont_t* cont) {
     return !ETS_INTR_WITHINISR() &&
            cont->pc_ret != 0 && cont->pc_yield == 0;
 }
+
+// No need for this to be in IRAM, not expected to be IRQ called
+void cont_repaint_stack(cont_t *cont)
+{
+    register uint32_t *sp asm("a1");
+    // Ensure 64 bytes adjacent to the current SP don't get touched to endure
+    // we don't accidentally trounce over locals or IRQ temps.
+    uint32_t sp_safe = CONT_STACKSIZE/4 - ((sp - &cont->stack[0] - 64)/4);
+
+    // Fill stack with magic values
+    for(uint32_t pos = 0; pos < sp_safe; pos++)
+    {
+        cont->stack[pos] = CONT_STACKGUARD;
+    }
+}

cores/esp8266/cont_util.c

@@ -41,7 +41,7 @@
 #include "core_esp8266_waveform.h"
 
 // Need speed, not size, here
-#pragma GCC optimize ("O3")
+#pragma GCC optimize ("O2")
 
 // Maximum delay between IRQs
 #define MAXIRQUS (10000)
@@ -79,7 +79,13 @@ static Waveform waveform[] = {
   {0, 0, 1<<3, 0, 0, 0, 0, 0},
   {0, 0, 1<<4, 0, 0, 0, 0, 0},
   {0, 0, 1<<5, 0, 0, 0, 0, 0},
-  // GPIOS 6-11 not allowed, used for flash
+  // GPIOS 6-8 not allowed, used for flash
+  // GPIO 9 and 10 only allowed in 2-bit flash mode
+#if !isFlashInterfacePin(9)
+  {0, 0, 1<<9, 0, 0, 0, 0, 0},
+  {0, 0, 1<<10, 0, 0, 0, 0, 0},
+#endif
+  // GPIO 11 not allowed, used for flash
   {0, 0, 1<<12, 0, 0, 0, 0, 0},
   {0, 0, 1<<13, 0, 0, 0, 0, 0},
   {0, 0, 1<<14, 0, 0, 0, 0, 0},
@@ -131,7 +137,7 @@ static void initTimer() {
   timerRunning = true;
 }
 
-static void deinitTimer() {
+static void ICACHE_RAM_ATTR deinitTimer() {
   timer1_attachInterrupt(NULL);
   timer1_disable();
   timer1_isr_init();
@@ -196,7 +202,7 @@ int startWaveform(uint8_t pin, uint32_t timeHighUS, uint32_t timeLowUS, uint32_t
 }
 
 // Stops a waveform on a pin
-int stopWaveform(uint8_t pin) {
+int ICACHE_RAM_ATTR stopWaveform(uint8_t pin) {
   // Can't possibly need to stop anything if there is no timer active
   if (!timerRunning) {
     return false;

cores/esp8266/core_esp8266_waveform.c

@@ -74,7 +74,7 @@ Debug Level
 All defines for the different levels starts with ``DEBUG_ESP_``
 
 a full list can be found here in the
-`boards.txt <https://github.com/esp8266/Arduino/blob/master/boards.txt#L180>`__
+`boards.txt <https://github.com/esp8266/Arduino/blob/master/tools/boards.txt.py#L1045-L1047>`__
 
 Example for own debug messages
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

doc/Troubleshooting/debugging.rst

@@ -18,6 +18,17 @@ Methods documented for `Client <https://www.arduino.cc/en/Reference/WiFiClientCo
 
 Methods and properties described further down are specific to ESP8266. They are not covered in `Arduino WiFi library <https://www.arduino.cc/en/Reference/WiFi>`__ documentation. Before they are fully documented please refer to information below.
 
+flush and stop
+~~~~~~~~~~~~~~
+
+``flush(timeoutMs)`` and ``stop(timeoutMs)`` both have now an optional argument: ``timeout`` in millisecond, and both return a boolean.
+
+Default input value 0 means that effective value is left at the discretion of the implementer.
+
+``flush()`` returning ``true`` indicates that output data have effectively been sent, and ``false`` that a timeout has occurred.
+
+``stop()`` returns ``false`` in case of an issue when closing the client (for instance a timed-out ``flush``). Depending on implementation, its parameter can be passed to ``flush()``.
+
 setNoDelay
 ~~~~~~~~~~
 
@@ -35,6 +46,47 @@ This algorithm is intended to reduce TCP/IP traffic of small packets sent over t
 
     client.setNoDelay(true);
 
+getNoDelay
+~~~~~~~~~~
+
+Returns whether NoDelay is enabled or not for the current connection.
+
+setSync
+~~~~~~~
+
+This is an experimental API that will set the client in synchronized mode.
+In this mode, every ``write()`` is flushed.  It means that after a call to
+``write()``, data are ensured to be received where they went sent to (that is
+``flush`` semantic).
+
+When set to ``true`` in ``WiFiClient`` implementation,
+
+- It slows down transfers, and implicitely disable the Nagle algorithm.
+
+- It also allows to avoid a temporary copy of data that otherwise consumes
+  at most ``TCP_SND_BUF`` = (2 * ``MSS``) bytes per connection,
+
+getSync
+~~~~~~~
+
+Returns whether Sync is enabled or not for the current connection.
+
+setDefaultNoDelay and setDefaultSync
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+These set the default value for both ``setSync`` and ``setNoDelay`` for
+every future instance of ``WiFiClient`` (including those coming from
+``WiFiServer.available()`` by default).
+
+Default values are false for both ``NoDelay`` and ``Sync``.
+
+This means that Nagle is enabled by default *for all new connections*.
+
+getDefaultNoDelay and getDefaultSync
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Return the values to be used as default for NoDelay and Sync for all future connections.
+
 Other Function Calls
 ~~~~~~~~~~~~~~~~~~~~
 
@@ -54,7 +106,6 @@ Other Function Calls
     uint16_t  remotePort () 
     IPAddress  localIP () 
     uint16_t  localPort () 
-    bool  getNoDelay () 
 
 Documentation for the above functions is not yet prepared.
 

doc/esp8266wifi/client-class.rst

@@ -55,13 +55,46 @@ mode
 -  ``WiFi.getMode()``: return current Wi-Fi mode (one out of four modes
    above)
 
+WiFi power management, DTIM
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: cpp
+
+    bool setSleepMode (WiFiSleepType_t type, int listenInterval=0)
+
+Sleep mode type is ``WIFI_NONE_SLEEP``, ``WIFI_LIGHT_SLEEP`` or ``WIFI_MODEM_SLEEP``.
+
+(``listenInterval`` appeared in esp8266-arduino core v2.5.0 using the last
+V2 revision of nonos-sdk before V3)
+
+Quoting nonos-sdk datasheet:
+
+* ``NONE``: disable power saving
+
+* ``LIGHT`` or ``MODEM``: TCP timer rate raised from 250ms to 3s
+
+When ``listenInterval`` is set to 1..10, in ``LIGHT`` or ``MODEM`` mode,
+station wakes up every (DTIM-interval * ``listenInterval``).  This saves
+power but station interface may miss broadcast data.
+
+Otherwise (default value 0), station wakes up at every DTIM-interval
+(configured in the access-point).
+
+Quoting wikipedia:
+
+A Delivery Traffic Indication Map (DTIM) is a kind of Traffic Indication Map
+(TIM) which informs the clients about the presence of buffered
+multicast/broadcast data on the access point.  It is generated within the
+periodic beacon at a frequency specified by the DTIM Interval.  Beacons are
+packets sent by an access point to synchronize a wireless network.
+
+
 Other Function Calls
 ~~~~~~~~~~~~~~~~~~~~
 
 .. code:: cpp
 
     int32_t  channel (void)
-    bool  setSleepMode (WiFiSleepType_t type)
     WiFiSleepType_t  getSleepMode ()
     bool  setPhyMode (WiFiPhyMode_t mode)
     WiFiPhyMode_t  getPhyMode ()
@@ -73,6 +106,11 @@ Other Function Calls
     bool  forceSleepWake ()
     int  hostByName (const char *aHostname, IPAddress &aResult)
 
+    appeared with SDK pre-V3:
+    uint8_t getListenInterval ();
+    bool isSleepLevelMax ();
+
+
 Documentation for the above functions is not yet prepared.
 
 For code samples please refer to separate section with `examples <generic-examples.rst>`__ dedicated specifically to the Generic Class.