Merge branch 'master' into littlefs

Author: earlephilhower

.travis.yml

@@ -20,58 +20,70 @@ stages:
 jobs:
   include:
     # Build stage. To save time, run all kinds of builds and tests in parallel.
-    - name: "Host tests"
+
+    - name: "Platformio (1)"
       stage: build
-      script: $TRAVIS_BUILD_DIR/tests/ci/host_test.sh
-      install: sudo apt-get install valgrind lcov
+      script: $TRAVIS_BUILD_DIR/tests/platformio.sh
+      env:
+        - BUILD_PARITY=even
+    - name: "Platformio (2)"
+      stage: build
+      script: $TRAVIS_BUILD_DIR/tests/platformio.sh
+      env:
+        - BUILD_PARITY=odd
 
-    # TODO: since we can now call different script for each job,
-    # split the do-it-all common.sh into separate scripts responsible
-    # for different types of jobs below:
     - name: "Build (1)"
-      script: $TRAVIS_BUILD_DIR/tests/common.sh
+      stage: build
+      script: $TRAVIS_BUILD_DIR/tests/build.sh
       env:
-        - BUILD_TYPE=build_even
+        - BUILD_PARITY=even
     - name: "Build (2)"
-      script: $TRAVIS_BUILD_DIR/tests/common.sh
+      stage: build
+      script: $TRAVIS_BUILD_DIR/tests/build.sh
       env:
-        - BUILD_TYPE=build_odd
+        - BUILD_PARITY=odd
+
     - name: "Debug (1)"
-      script: $TRAVIS_BUILD_DIR/tests/common.sh
+      stage: build
+      script: $TRAVIS_BUILD_DIR/tests/debug.sh
       env:
-        - BUILD_TYPE=debug_even
+        - BUILD_PARITY=even
     - name: "Debug (2)"
-      script: $TRAVIS_BUILD_DIR/tests/common.sh
+      stage: build
+      script: $TRAVIS_BUILD_DIR/tests/debug.sh
       env:
-        - BUILD_TYPE=debug_odd
+        - BUILD_PARITY=odd
+
     - name: "Build IPv6 (1)"
-      script: $TRAVIS_BUILD_DIR/tests/common.sh
+      stage: build
+      script: $TRAVIS_BUILD_DIR/tests/build6.sh
       env:
-        - BUILD_TYPE=build6_even
+        - BUILD_PARITY=even
     - name: "Build IPv6 (2)"
-      script: $TRAVIS_BUILD_DIR/tests/common.sh
-      env:
-        - BUILD_TYPE=build6_odd
-    - name: "Platformio (1)"
-      script: $TRAVIS_BUILD_DIR/tests/common.sh
-      env:
-        - BUILD_TYPE=platformio_even
-    - name: "Platformio (2)"
-      script: $TRAVIS_BUILD_DIR/tests/common.sh
+      stage: build
+      script: $TRAVIS_BUILD_DIR/tests/build6.sh
       env:
-        - BUILD_TYPE=platformio_odd
+        - BUILD_PARITY=odd
+
+    - name: "Host tests"
+      stage: build
+      script: $TRAVIS_BUILD_DIR/tests/ci/host_test.sh
+      install: sudo apt-get install valgrind lcov
 
     - name: "Docs"
+      stage: build
       script: $TRAVIS_BUILD_DIR/tests/ci/build_docs.sh
       install:
           - sudo apt-get install python3-pip
           - pip3 install --user -r doc/requirements.txt;
 
     - name: "Style check"
+      stage: build
       script: $TRAVIS_BUILD_DIR/tests/ci/style_check.sh
       install: tests/ci/install_astyle.sh
 
     - name: "Boards"
+      stage: build
       script: $TRAVIS_BUILD_DIR/tests/ci/build_boards.sh
 
     # Deploy stage.

cores/esp8266/HardwareSerial.cpp

@@ -27,6 +27,7 @@
 #include <stdio.h>
 #include <string.h>
 #include <inttypes.h>
+#include <PolledTimeout.h>
 #include "Arduino.h"
 #include "HardwareSerial.h"
 #include "Esp.h"
@@ -132,6 +133,22 @@ unsigned long HardwareSerial::detectBaudrate(time_t timeoutMillis)
     return detectedBaudrate;
 }
 
+size_t HardwareSerial::readBytes(char* buffer, size_t size)
+{
+    size_t got = 0;
+
+    while (got < size)
+    {
+        esp8266::polledTimeout::oneShot timeOut(_timeout);
+        size_t avail;
+        while ((avail = available()) == 0 && !timeOut);
+        if (avail == 0)
+            break;
+        got += read(buffer + got, std::min(size - got, avail));
+    }
+    return got;
+}
+
 #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SERIAL)
 HardwareSerial Serial(UART0);
 #endif

cores/esp8266/HardwareSerial.h

@@ -132,13 +132,15 @@ class HardwareSerial: public Stream
         // return -1 when data is unvailable (arduino api)
         return uart_read_char(_uart);
     }
-    size_t readBytes(char* buffer, size_t size) override
+    // ::read(buffer, size): same as readBytes without timeout
+    size_t read(char* buffer, size_t size)
     {
         return uart_read(_uart, buffer, size);
     }
+    size_t readBytes(char* buffer, size_t size) override;
     size_t readBytes(uint8_t* buffer, size_t size) override
     {
-        return uart_read(_uart, (char*)buffer, size);
+        return readBytes((char*)buffer, size);
     }
     int availableForWrite(void)
     {

libraries/esp8266/examples/SerialStress/SerialStress.ino

@@ -16,12 +16,15 @@
 #define BUFFER_SIZE     4096    // may be useless to use more than 2*SERIAL_SIZE_RX
 #define SERIAL_SIZE_RX  1024    // Serial.setRxBufferSize()
 
+#define FAKE_INCREASED_AVAILABLE 100 // test readBytes's timeout
+
 #define TIMEOUT 5000
 #define DEBUG(x...) //x
 
 uint8_t buf [BUFFER_SIZE];
 uint8_t temp [BUFFER_SIZE];
 bool reading = true;
+size_t testReadBytesTimeout = 0;
 
 static size_t out_idx = 0, in_idx = 0;
 static size_t local_receive_size = 0;
@@ -83,6 +86,7 @@ void setup() {
   size_for_1sec = baud / 10; // 8n1=10baudFor8bits
   logger->printf("led changes state every %zd bytes (= 1 second)\n", size_for_1sec);
   logger->printf("press 's' to stop reading, not writing (induces overrun)\n");
+  logger->printf("press 't' to toggle timeout testing on readBytes\n");
 
   // prepare send/compare buffer
   for (size_t i = 0; i < sizeof buf; i++) {
@@ -136,7 +140,7 @@ void loop() {
 
   if (reading) {
     // receive data
-    maxlen = Serial.available();
+    maxlen = Serial.available() + testReadBytesTimeout;
     if (maxlen > maxavail) {
       maxavail = maxlen;
     }
@@ -180,8 +184,16 @@ void loop() {
     timeout = (last_ms = now_ms) + TIMEOUT;
   }
 
-  if (logger->read() == 's') {
-    logger->println("now stopping reading, keeping writing");
-    reading = false;
-  }
+  if (logger->available())
+    switch (logger->read()) {
+      case 's':
+        logger->println("now stopping reading, keeping writing");
+        reading = false;
+        break;
+      case 't':
+        testReadBytesTimeout ^= FAKE_INCREASED_AVAILABLE;
+        logger->printf("testing readBytes timeout: %d\n", !!testReadBytesTimeout);
+        break;
+      default:;
+    }
 }

tests/build.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+cache_dir=$(mktemp -d)
+
+source "$TRAVIS_BUILD_DIR"/tests/common.sh
+
+if [ -z "$BUILD_PARITY" ]; then
+    mod=1
+    rem=0
+elif [ "$BUILD_PARITY" = "even" ]; then
+    mod=2
+    rem=0
+elif [ "$BUILD_PARITY" = "odd" ]; then
+    mod=2
+    rem=1
+fi
+
+install_arduino nodebug
+build_sketches_with_arduino "$mod" "$rem" lm2f
+
+rm -rf "$cache_dir"
+

tests/build6.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+cache_dir=$(mktemp -d)
+
+source "$TRAVIS_BUILD_DIR"/tests/common.sh
+
+if [ -z "$BUILD_PARITY" ]; then
+    mod=1
+    rem=0
+elif [ "$BUILD_PARITY" = "even" ]; then
+    mod=2
+    rem=0
+elif [ "$BUILD_PARITY" = "odd" ]; then
+    mod=2
+    rem=1
+fi
+
+install_arduino nodebug
+build_sketches_with_arduino "$mod" "$rem" lm6f
+
+rm -rf "$cache_dir"
+

tests/common.sh

@@ -141,59 +141,6 @@ function install_ide()
     export PATH="$ide_path:$core_path/tools/xtensa-lx106-elf/bin:$PATH"
 }
 
-function install_platformio()
-{
-    pip install --user -U https://github.com/platformio/platformio/archive/develop.zip
-    platformio platform install "https://github.com/platformio/platform-espressif8266.git#feature/stage"
-    sed -i 's/https:\/\/github\.com\/esp8266\/Arduino\.git/*/' ~/.platformio/platforms/espressif8266/platform.json
-    ln -s $TRAVIS_BUILD_DIR ~/.platformio/packages/framework-arduinoespressif8266
-    # Install dependencies:
-    # - esp8266/examples/ConfigFile
-    pio lib install ArduinoJson
-}
-
-function build_sketches_with_platformio()
-{
-    set +e
-    local srcpath=$1
-    local build_arg=$2
-    local build_mod=$3
-    local build_rem=$4
-    local sketches=$(find $srcpath -name *.ino | sort)
-    local testcnt=0
-    for sketch in $sketches; do
-        testcnt=$(( ($testcnt + 1) % $build_mod ))
-        if [ $testcnt -ne $build_rem ]; then
-            continue  # Not ours to do
-        fi
-        local sketchdir=$(dirname $sketch)
-        local sketchdirname=$(basename $sketchdir)
-        local sketchname=$(basename $sketch)
-        if [[ "${sketchdirname}.ino" != "$sketchname" ]]; then
-            echo "Skipping $sketch, beacause it is not the main sketch file";
-            continue
-        fi;
-        if [[ -f "$sketchdir/.test.skip" ]]; then
-            echo -e "\n ------------ Skipping $sketch ------------ \n";
-            continue
-        fi
-        local build_cmd="pio ci $sketchdir $build_arg"
-        echo -e "\n ------------ Building $sketch ------------ \n";
-        echo "$build_cmd"
-        time ($build_cmd >build.log)
-        local result=$?
-        if [ $result -ne 0 ]; then
-            echo "Build failed ($1)"
-            echo "Build log:"
-            cat build.log
-            set -e
-            return $result
-        fi
-        rm build.log
-    done
-    set -e
-}
-
 function install_arduino()
 {
     local debug=$1
@@ -235,48 +182,3 @@ if [ -z "$TRAVIS_BUILD_DIR" ]; then
     echo "TRAVIS_BUILD_DIR=$TRAVIS_BUILD_DIR"
 fi
 
-cache_dir=$(mktemp -d)
-
-if [ "$BUILD_TYPE" = "build" ]; then
-    install_arduino nodebug
-    build_sketches_with_arduino 1 0 lm2f
-elif [ "$BUILD_TYPE" = "build6" ]; then
-    install_arduino nodebug
-    build_sketches_with_arduino 1 0 lm6f
-elif [ "$BUILD_TYPE" = "build_even" ]; then
-    install_arduino nodebug
-    build_sketches_with_arduino 2 0 lm2f
-elif [ "$BUILD_TYPE" = "build_odd" ]; then
-    install_arduino nodebug
-    build_sketches_with_arduino 2 1 lm2f
-elif [ "$BUILD_TYPE" = "debug_even" ]; then
-    install_arduino debug
-    build_sketches_with_arduino 2 0 lm2f
-elif [ "$BUILD_TYPE" = "debug_odd" ]; then
-    install_arduino debug
-    build_sketches_with_arduino 2 1 lm2f
-elif [ "$BUILD_TYPE" = "build6_even" ]; then
-    install_arduino nodebug
-    build_sketches_with_arduino 2 0 lm6f
-elif [ "$BUILD_TYPE" = "build6_odd" ]; then
-    install_arduino nodebug
-    build_sketches_with_arduino 2 1 lm6f
-elif [ "$BUILD_TYPE" = "platformio" ]; then
-    # PlatformIO
-    install_platformio
-    build_sketches_with_platformio $TRAVIS_BUILD_DIR/libraries "--board nodemcuv2 --verbose" 1 0
-elif [ "$BUILD_TYPE" = "platformio_even" ]; then
-    # PlatformIO
-    install_platformio
-    build_sketches_with_platformio $TRAVIS_BUILD_DIR/libraries "--board nodemcuv2 --verbose" 2 0
-elif [ "$BUILD_TYPE" = "platformio_odd" ]; then
-    # PlatformIO
-    install_platformio
-    build_sketches_with_platformio $TRAVIS_BUILD_DIR/libraries "--board nodemcuv2 --verbose" 2 1
-else
-    echo "BUILD_TYPE not set or invalid"
-    rm -rf $cache_dir
-    exit 1
-fi
-
-rm -rf $cache_dir

tests/debug.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+cache_dir=$(mktemp -d)
+
+source "$TRAVIS_BUILD_DIR"/tests/common.sh
+
+if [ "$BUILD_PARITY" = "even" ]; then
+    mod=2
+    rem=0
+elif [ "$BUILD_PARITY" = "odd" ]; then
+    mod=2
+    rem=1
+fi
+
+install_arduino debug
+build_sketches_with_arduino "$mod" "$rem" lm2f
+
+rm -rf "$cache_dir"
+