Merge branch 'master' into ota_commands_in_flash

Author: davisonja

README.md

@@ -16,7 +16,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-basic-instructions)
+  - [Using git version](#using-git-version)
   - [Using PlatformIO](#using-platformio)
   - [Building with make](#building-with-make)
 - [Documentation](#documentation)
@@ -38,35 +38,13 @@ Boards manager link: `https://arduino.esp8266.com/stable/package_esp8266com_inde
 
 Documentation: [https://arduino-esp8266.readthedocs.io/en/2.5.2/](https://arduino-esp8266.readthedocs.io/en/2.5.2/)
 
-### Using git version (basic instructions)
+### Using git version
 [![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino)
 
+Also known as latest git or master branch.
+
 - Install the current upstream Arduino IDE at the 1.8 level or later. The current version is on the [Arduino website](https://www.arduino.cc/en/main/software).
-- 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
-mkdir esp8266com
-cd esp8266com
-git clone https://github.com/esp8266/Arduino.git esp8266
-cd esp8266
-git submodule update --init
-```
-- Download binary tools (you need Python 2.7)
-```bash
-cd esp8266/tools
-python get.py
-```
-- Restart Arduino
+- Follow the [instructions in the documentation](https://arduino-esp8266.readthedocs.io/en/latest/installing.html#using-git-version).
 
 ### Using PlatformIO
 

cores/esp8266/Arduino.h

@@ -285,10 +285,6 @@ void configTime(const char* tz, const char* server1,
 
 #include "pins_arduino.h"
 
-#ifndef PUYA_SUPPORT
-#define PUYA_SUPPORT 1
-#endif
-
 #endif
 
 #ifdef DEBUG_ESP_OOM

cores/esp8266/Esp.cpp

@@ -18,7 +18,7 @@
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#include "Arduino.h"
+#include "Esp.h"
 #include "flash_utils.h"
 #include "eboot_command.h"
 #include <memory>
@@ -36,6 +36,14 @@ extern struct rst_info resetInfo;
 
 //#define DEBUG_SERIAL Serial
 
+#ifndef PUYA_SUPPORT
+  #define PUYA_SUPPORT 1
+#endif
+#ifndef PUYA_BUFFER_SIZE
+  // Good alternative for buffer size is: SPI_FLASH_SEC_SIZE (= 4k)
+  // Always use a multiple of flash page size (256 bytes)
+  #define PUYA_BUFFER_SIZE 256
+#endif
 
 /**
  * User-defined Literals
@@ -494,7 +502,7 @@ uint32_t EspClass::getSketchSize() {
 
     image_header_t image_header;
     uint32_t pos = APP_START_OFFSET;
-    if (spi_flash_read(pos, (uint32_t*) &image_header, sizeof(image_header))) {
+    if (spi_flash_read(pos, (uint32_t*) &image_header, sizeof(image_header)) != SPI_FLASH_RESULT_OK) {
         return 0;
     }
     pos += sizeof(image_header);
@@ -506,7 +514,7 @@ uint32_t EspClass::getSketchSize() {
         ++section_index)
     {
         section_header_t section_header = {0, 0};
-        if (spi_flash_read(pos, (uint32_t*) &section_header, sizeof(section_header))) {
+        if (spi_flash_read(pos, (uint32_t*) &section_header, sizeof(section_header)) != SPI_FLASH_RESULT_OK) {
             return 0;
         }
         pos += sizeof(section_header);
@@ -578,26 +586,27 @@ bool EspClass::flashEraseSector(uint32_t sector) {
 }
 
 #if PUYA_SUPPORT
-static int spi_flash_write_puya(uint32_t offset, uint32_t *data, size_t size) {
+static SpiFlashOpResult spi_flash_write_puya(uint32_t offset, uint32_t *data, size_t size) {
     if (data == nullptr) {
-      return 1; // SPI_FLASH_RESULT_ERR
+      return SPI_FLASH_RESULT_ERR;
     }
     // PUYA flash chips need to read existing data, update in memory and write modified data again.
     static uint32_t *flash_write_puya_buf = nullptr;
-    int rc = 0;
-    uint32_t* ptr = data;
 
     if (flash_write_puya_buf == nullptr) {
         flash_write_puya_buf = (uint32_t*) malloc(PUYA_BUFFER_SIZE);
         // No need to ever free this, since the flash chip will never change at runtime.
         if (flash_write_puya_buf == nullptr) {
             // Memory could not be allocated.
-            return 1; // SPI_FLASH_RESULT_ERR
+            return SPI_FLASH_RESULT_ERR;
         }
     }
+
+    SpiFlashOpResult rc = SPI_FLASH_RESULT_OK;
+    uint32_t* ptr = data;
     size_t bytesLeft = size;
     uint32_t pos = offset;
-    while (bytesLeft > 0 && rc == 0) {
+    while (bytesLeft > 0 && rc == SPI_FLASH_RESULT_OK) {
         size_t bytesNow = bytesLeft;
         if (bytesNow > PUYA_BUFFER_SIZE) {
             bytesNow = PUYA_BUFFER_SIZE;
@@ -606,7 +615,7 @@ static int spi_flash_write_puya(uint32_t offset, uint32_t *data, size_t size) {
             bytesLeft = 0;
         }
         rc = spi_flash_read(pos, flash_write_puya_buf, bytesNow);
-        if (rc != 0) {
+        if (rc != SPI_FLASH_RESULT_OK) {
             return rc;
         }
         for (size_t i = 0; i < bytesNow / 4; ++i) {
@@ -621,7 +630,7 @@ static int spi_flash_write_puya(uint32_t offset, uint32_t *data, size_t size) {
 #endif
 
 bool EspClass::flashWrite(uint32_t offset, uint32_t *data, size_t size) {
-    int rc = 0;
+    SpiFlashOpResult rc = SPI_FLASH_RESULT_OK;
 #if PUYA_SUPPORT
     if (getFlashChipVendorId() == SPI_FLASH_VENDOR_PUYA) {
         rc = spi_flash_write_puya(offset, data, size);
@@ -631,12 +640,12 @@ bool EspClass::flashWrite(uint32_t offset, uint32_t *data, size_t size) {
     {
         rc = spi_flash_write(offset, data, size);
     }
-    return rc == 0;
+    return rc == SPI_FLASH_RESULT_OK;
 }
 
 bool EspClass::flashRead(uint32_t offset, uint32_t *data, size_t size) {
-    int rc = spi_flash_read(offset, (uint32_t*) data, size);
-    return rc == 0;
+    auto rc = spi_flash_read(offset, (uint32_t*) data, size);
+    return rc == SPI_FLASH_RESULT_OK;
 }
 
 String EspClass::getSketchMD5()

cores/esp8266/Esp.h

@@ -23,15 +23,6 @@
 
 #include <Arduino.h>
 
-#ifndef PUYA_SUPPORT
-  #define PUYA_SUPPORT 0
-#endif
-#ifndef PUYA_BUFFER_SIZE
-  // Good alternative for buffer size is: SPI_FLASH_SEC_SIZE (= 4k)
-  // Always use a multiple of flash page size (256 bytes)
-  #define PUYA_BUFFER_SIZE 256
-#endif
-
 // Vendor IDs taken from Flashrom project
 // https://review.coreboot.org/cgit/flashrom.git/tree/flashchips.h?h=1.0.x
 typedef enum {

cores/esp8266/HardwareSerial.cpp

@@ -108,14 +108,16 @@ int HardwareSerial::available(void)
 
 void HardwareSerial::flush()
 {
+    uint8_t bit_length = 0;
     if(!_uart || !uart_tx_enabled(_uart)) {
         return;
     }
 
+    bit_length = uart_get_bit_length(_uart_nr); // data width, parity and stop
     uart_wait_tx_empty(_uart);
     //Workaround for a bug in serial not actually being finished yet
     //Wait for 8 data bits, 1 parity and 2 stop bits, just in case
-    delayMicroseconds(11000000 / uart_get_baudrate(_uart) + 1);
+    delayMicroseconds(bit_length * 1000000 / uart_get_baudrate(_uart) + 1);
 }
 
 void HardwareSerial::startDetectBaudrate()

cores/esp8266/base64.cpp

@@ -31,11 +31,11 @@ extern "C" {
 
 /**
  * convert input data to base64
- * @param data uint8_t *
+ * @param data const uint8_t *
  * @param length size_t
  * @return String
  */
-String base64::encode(uint8_t * data, size_t length, bool doNewLines) {
+String base64::encode(const uint8_t * data, size_t length, bool doNewLines) {
     // base64 needs more size then the source data, use cencode.h macros
     size_t size = ((doNewLines ? base64_encode_expected_len(length)
                                : base64_encode_expected_len_nonewlines(length)) + 1);
@@ -62,10 +62,10 @@ String base64::encode(uint8_t * data, size_t length, bool doNewLines) {
 
 /**
  * convert input data to base64
- * @param text String
+ * @param text const String&
  * @return String
  */
-String base64::encode(String text, bool doNewLines) {
-    return base64::encode((uint8_t *) text.c_str(), text.length(), doNewLines);
+String base64::encode(const String& text, bool doNewLines) {
+    return base64::encode((const uint8_t *) text.c_str(), text.length(), doNewLines);
 }
 

cores/esp8266/base64.h

@@ -30,8 +30,8 @@ class base64 {
         // NOTE: The default behaviour of backend (lib64)
         // is to add a newline every 72 (encoded) characters output.
         // This may 'break' longer uris and json variables
-        static String encode(uint8_t * data, size_t length, bool doNewLines = true);
-        static String encode(String text, bool doNewLines = true);
+        static String encode(const uint8_t * data, size_t length, bool doNewLines = true);
+        static String encode(const String& text, bool doNewLines = true);
     private:
 };
 

cores/esp8266/cont.S

@@ -18,7 +18,7 @@
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
-    .text
+    .section .irom0.text
     .align    4
     .literal_position
     .global   cont_yield
@@ -84,7 +84,7 @@ cont_wrapper:
 
 ////////////////////////////////////////////////////
 
-    .text
+    .section .irom0.text
     .align   4
     .literal_position
     .global  cont_run

cores/esp8266/coredecls.h

@@ -17,14 +17,21 @@ extern bool timeshift64_is_set;
 void esp_yield();
 void esp_schedule();
 void tune_timeshift64 (uint64_t now_us);
-void settimeofday_cb (void (*cb)(void));
 void disable_extra4k_at_link_time (void) __attribute__((noinline));
 
 uint32_t sqrt32 (uint32_t n);
 uint32_t crc32 (const void* data, size_t length, uint32_t crc = 0xffffffff);
 
 #ifdef __cplusplus
 }
+
+#include <functional>
+
+using TrivialCB = std::function<void()>;
+
+void settimeofday_cb (TrivialCB&& cb);
+void settimeofday_cb (const TrivialCB& cb);
+
 #endif
 
 #endif // __COREDECLS_H

cores/esp8266/sntp-lwip2.cpp

@@ -42,16 +42,22 @@
 #include <osapi.h>
 #include <os_type.h>
 #include "coredecls.h"
+#include "Schedule.h"
 
-extern "C" {
+static TrivialCB _settimeofday_cb;
 
-static void (*_settimeofday_cb)(void) = NULL;
+void settimeofday_cb (TrivialCB&& cb)
+{
+    _settimeofday_cb = std::move(cb);
+}
 
-void settimeofday_cb (void (*cb)(void))
+void settimeofday_cb (const TrivialCB& cb)
 {
     _settimeofday_cb = cb;
 }
 
+extern "C" {
+
 #if LWIP_VERSION_MAJOR == 1
 
 #include <pgmspace.h>
@@ -478,7 +484,7 @@ int settimeofday(const struct timeval* tv, const struct timezone* tz)
         sntp_set_system_time(tv->tv_sec);
 
         if (_settimeofday_cb)
-            _settimeofday_cb();
+            schedule_function(_settimeofday_cb);
     }
     return 0;
 }

cores/esp8266/uart.cpp

@@ -48,6 +48,10 @@
 #include "user_interface.h"
 #include "uart_register.h"
 
+#define MODE2WIDTH(mode) (((mode%16)>>2)+5)
+#define MODE2STOP(mode) (((mode)>>5)+1)
+#define MODE2PARITY(mode) (mode%4)
+
 /*
   Some general architecture for GDB integration with the UART to enable
   serial debugging.
@@ -204,7 +208,14 @@ uart_read_char_unsafe(uart_t* uart)
     return -1;
 }
 
-size_t
+uint8_t
+uart_get_bit_length(const int uart_nr)
+{
+    // return bit length from uart mode, +1 for the start bit which is always there. 
+    return MODE2WIDTH(USC0(uart_nr)) + MODE2PARITY(USC0(uart_nr)) + MODE2STOP(USC0(uart_nr)) + 1;
+}
+
+size_t 
 uart_rx_available(uart_t* uart)
 {
     if(uart == NULL || !uart->rx_enabled)

cores/esp8266/uart.h

@@ -147,6 +147,7 @@ int uart_get_debug();
 void uart_start_detect_baudrate(int uart_nr);
 int uart_detect_baudrate(int uart_nr);
 
+uint8_t uart_get_bit_length(const int uart_nr);
 
 #if defined (__cplusplus)
 } // extern "C"