Merge branch 'master' into ld-script

Author: mcspr

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,8 +363,8 @@ 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.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
 generic.menu.ip.lm2f.build.lwip_lib=-llwip2-536-feat
@@ -708,8 +708,8 @@ 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.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
 esp8285.menu.ip.lm2f.build.lwip_lib=-llwip2-536-feat

cores/esp8266/FS.cpp

@@ -173,18 +173,15 @@ File File::openNextFile() {
     return _fakeDir->openFile("r");
 }
 
-String File::readString()
-{
+String File::readString() {
     String ret;
     ret.reserve(size() - position());
-    char temp[256+1];
-    int countRead = readBytes(temp, sizeof(temp)-1);
-    while (countRead > 0)
-    {
-        temp[countRead] = 0;
-        ret += temp;
-        countRead = readBytes(temp, sizeof(temp)-1);
-    }
+    uint8_t temp[256];
+    int countRead;
+    do {
+        countRead = read(temp, sizeof(temp));
+        ret.concat((const char*)temp, countRead);
+    } while (countRead > 0);
     return ret;
 }
 

cores/esp8266/core_esp8266_main.cpp

@@ -400,16 +400,238 @@ extern "C" void __disableWiFiAtBootTime (void)
 
 #if FLASH_MAP_SUPPORT
 #include "flash_hal.h"
-extern "C" void flashinit (void);
+extern "C" const char *flashinit (void);
 uint32_t __flashindex;
 #endif
 
+#if (NONOSDK >= (0x30000))
+#undef ETS_PRINTF
+#define ETS_PRINTF(...) ets_uart_printf(__VA_ARGS__)
+extern "C" uint8_t uart_rx_one_char_block();
+
+#if ! FLASH_MAP_SUPPORT
+#include "flash_hal.h"
+#endif
+
+extern "C" void ICACHE_FLASH_ATTR user_pre_init(void)
+{
+    const char *flash_map_str = NULL;
+    const char *chip_sz_str = NULL;
+    const char *table_regist_str = NULL;
+    [[maybe_unused]] uint32_t ld_config_chip_size = 0;
+    uint32_t flash_size = 0;
+    uint32_t phy_data = 0;
+    uint32_t rf_cal = 0;
+    uint32_t system_parameter = 0;
+    [[maybe_unused]] const partition_item_t *_at_partition_table = NULL;
+    size_t _at_partition_table_sz = 0;
+
+    do {
+        #if FLASH_MAP_SUPPORT
+        flash_map_str = flashinit();
+        if (flash_map_str) {
+            continue;
+        }
+        #endif
+
+        // For SDKs 3.0.0 and later, place phy_data readonly overlay on top of
+        // the EEPROM address. For older SDKs without a system partition, RF_CAL
+        // and PHY_DATA shared the same flash segment.
+        //
+        // For the Arduino ESP8266 core, the sectors for "EEPROM = size -
+        // 0x5000", "RF_CAL =  size - 0x4000", and "SYSTEM_PARAMETER = size -
+        // 0x3000" are positioned in the last five sectors of flash memory.
+        // PHY_INIT_DATA is special. It is a one time read of 128 bytes of data
+        // that is provided by a spoofed flash read.
+        #if FLASH_MAP_SUPPORT
+        flash_size = __flashdesc[__flashindex].flash_size_kb * 1024u;
+        #else
+        // flashchip->chip_size is updated by the SDK. The size is based on the
+        // value patched into the .bin header by esptool.
+        // system_get_flash_size_map() returns that patched value.
+        flash_size = flashchip->chip_size;
+        #endif
+
+        // For all configurations, place RF_CAL and system_parameter in the
+        // last 4 sectors of the flash chip.
+        rf_cal = flash_size - 0x4000u;
+        system_parameter = flash_size - 0x3000u;
+
+        // The system_partition_table_regist will not allow partitions to
+        // overlap. EEPROM_start is a good choice for phy_data overlay. The SDK
+        // does not need to know about EEPROM_start. So we can omit it from the
+        // table. The real EEPROM access is after user_init() begins long after
+        // the PHY_DATA read. So it should be safe from conflicts.
+        phy_data = EEPROM_start - 0x40200000u;
+
+        // For SDKs 3.0 builds, "sdk3_begin_phy_data_spoof and
+        // user_rf_cal_sector_set" starts and stops the spoofing logic in
+        // `core_esp8266_phy.cpp`.
+        extern void sdk3_begin_phy_data_spoof();
+        sdk3_begin_phy_data_spoof();
+
+        ld_config_chip_size = phy_data + 4096 * 5;
+
+        // -DALLOW_SMALL_FLASH_SIZE=1
+        // Allows for small flash-size builds targeted for multiple devices,
+        // commonly IoT, of varying flash sizes.
+        #if !defined(FLASH_MAP_SUPPORT) && !defined(ALLOW_SMALL_FLASH_SIZE)
+        // Note, system_partition_table_regist will only catch when the build
+        // flash size value set by the Arduino IDE Tools menu is larger than
+        // the firmware image value detected and updated on the fly by esptool.
+        if (flashchip->chip_size != ld_config_chip_size) {
+            // Stop to avoid possible stored flash data corruption. This
+            // mismatch will not occur with flash size selection "Mapping
+            // defined by Hardware and Sketch".
+            chip_sz_str = PSTR("Flash size mismatch, check that the build setting matches the device.\n");
+            continue;
+        }
+        #elif defined(ALLOW_SMALL_FLASH_SIZE) && !defined(FLASH_MAP_SUPPORT)
+        // Note, while EEPROM is confined to a smaller flash size, we are still
+        // placing RF_CAL and SYSTEM_PARAMETER at the end of flash. To prevent
+        // this, esptool or its equal needs to not update the flash size in the
+        // .bin image.
+        #endif
+
+        #if FLASH_MAP_SUPPORT && defined(DEBUG_ESP_PORT)
+        // I don't think this will ever fail. Everything traces back to the results of spi_flash_get_id()
+        if (flash_size != flashchip->chip_size) {
+            chip_sz_str = PSTR("Flash size mismatch, check that the build setting matches the device.\n");
+            continue;
+        }
+        #endif
+
+        // All the examples I find, show the partition table in the global address space.
+        static const partition_item_t at_partition_table[] =
+        {
+            { SYSTEM_PARTITION_PHY_DATA,         phy_data,         0x1000 }, // type 5
+            { SYSTEM_PARTITION_RF_CAL,           rf_cal,           0x1000 }, // type 4
+            { SYSTEM_PARTITION_SYSTEM_PARAMETER, system_parameter, 0x3000 }, // type 6
+        };
+        _at_partition_table = at_partition_table;
+        _at_partition_table_sz = std::size(at_partition_table);
+        // SDK 3.0's `system_partition_table_regist` is FOTA-centric. It will report
+        // on BOOT, OTA1, and OTA2 being missing. We are Non-FOTA. I don't see
+        // anything we can do about this. Other than maybe turning off os_print.
+        if (!system_partition_table_regist(at_partition_table, _at_partition_table_sz, system_get_flash_size_map())) {
+            table_regist_str = PSTR("System partition table registration failed!\n");
+            continue;
+        }
+    } while(false);
+
+    if (chip_sz_str || flash_map_str || table_regist_str) {
+        // user_pre_init() is called very early in the SDK startup. When called,
+        // the PLL CPU clock calibration hasn't not run. Since we are failing, the
+        // calibration will never complete. And the process will repeat over and
+        // over. The effective data rate will always be 74880 bps. If we had a
+        // successful boot, the effective data rate would be 115200 on a restart
+        // or HWDT. This hack relies on the CPU clock calibration never having
+        // completed. This assumes we are starting from a hard reset.
+
+        // A possible exception would be a soft reset after flashing. In which
+        // case the message will not be readable until after a hard reset or
+        // power cycle.
+
+        // After flashing, the Arduino Serial Monitor needs a moment to
+        // reconnect. This also allows time for the FIFO to clear and the host
+        // serial port to clear any framing errors.
+        ets_delay_us(200u * 1000u); // For an uncalibrated CPU Clock, this is close enough.
+
+        #if !defined(F_CRYSTAL)
+        #define F_CRYSTAL 26000000
+        #endif
+        // For print messages to be readable, the UART clock rate is based on the
+        // precalibration rate.
+        if (F_CRYSTAL != 40000000) {
+            uart_div_modify(0, F_CRYSTAL * 2 / 115200);
+            ets_delay_us(150);
+        }
+        do {
+            ETS_PRINTF("\n\n");
+            // Because SDK v3.0.x always has a non-32-bit wide exception handler
+            // installed, we can use PROGMEM strings with Boot ROM print functions.
+#if defined(DEBUG_ESP_CORE) || defined(DEBUG_ESP_PORT) // DEBUG_ESP_CORE => verbose
+            #if FLASH_MAP_SUPPORT
+            if (flash_map_str) {
+                ETS_PRINTF(flash_map_str);
+                #if defined(DEBUG_ESP_CORE)
+                size_t num = __flashindex; // On failure __flashindex is the size of __flashdesc[]; :/
+                ETS_PRINTF(PSTR("Table of __flashdesc[%u].flash_size_kb entries converted to bytes:\n"), num);
+                for (size_t i = 0; i < num; i++) {
+                    uint32_t size = __flashdesc[i].flash_size_kb << 10;
+                    ETS_PRINTF(PSTR("  [%02u] 0x%08X %8u\n"), i, size, size);
+                }
+                #endif
+                ETS_PRINTF(PSTR("Reference info:\n"));
+                uint32_t flash_chip_size = 1 << ((spi_flash_get_id() >> 16) & 0xff);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X %8u\n"), PSTR("fn(spi_flash_get_id())"), flash_chip_size, flash_chip_size);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X %8u\n"), PSTR("bin_chip_size"), flashchip->chip_size, flashchip->chip_size);
+            } else
+            #endif
+            if (chip_sz_str) {
+                ETS_PRINTF(chip_sz_str);
+            } else
+            if (table_regist_str) {
+                ETS_PRINTF(table_regist_str);
+                // (printing now works) repeat ...regist error messages
+                system_partition_table_regist(_at_partition_table, _at_partition_table_sz, system_get_flash_size_map());
+            }
+            if (chip_sz_str || table_regist_str) {
+                ETS_PRINTF(PSTR("Reference info:\n"));
+                #if FLASH_MAP_SUPPORT
+                ETS_PRINTF(PSTR("  %-24s 0x%08X %8u\n"), PSTR("fn(...ex].flash_size_kb)"), flash_size, flash_size);
+                uint32_t flash_chip_size = 1 << ((spi_flash_get_id() >> 16) & 0xff);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X %8u\n"), PSTR("fn(spi_flash_get_id())"), flash_chip_size, flash_chip_size);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X %8u\n"), PSTR("bin_chip_size"), flashchip->chip_size, flashchip->chip_size);
+                #else
+                ETS_PRINTF(PSTR("  %-24s 0x%08X %8u\n"), PSTR("config_flash_size"), ld_config_chip_size, ld_config_chip_size);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X %8u\n"), PSTR("bin_chip_size"), flashchip->chip_size, flashchip->chip_size);
+                #endif
+                #if defined(DEBUG_ESP_CORE)
+                ETS_PRINTF(PSTR("  %-24s 0x%08X\n"), PSTR("PHY_DATA"), phy_data);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X\n"), PSTR("RF_CAL"), rf_cal);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X\n"), PSTR("SYSTEM_PARAMETER"), system_parameter);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X\n"), PSTR("EEPROM_start"), EEPROM_start);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X\n"), PSTR("FS_start"), FS_start);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X\n"), PSTR("FS_end"), FS_end);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X\n"), PSTR("FS_page"), FS_page);
+                ETS_PRINTF(PSTR("  %-24s 0x%08X\n"), PSTR("FS_block"), FS_block);
+                #endif
+            }
+#else
+            if (flash_map_str) {
+                ETS_PRINTF(flash_map_str);
+            } else
+            if (chip_sz_str) {
+                ETS_PRINTF(chip_sz_str);
+            } else
+            if (table_regist_str) {
+                ETS_PRINTF(table_regist_str);
+            }
+#endif
+            uart_rx_one_char_block(); // Someone said hello - repeat message
+        } while(true);
+    }
+}
+#endif // #if (NONOSDK >= (0x30000))
+
 extern "C" void user_init(void) {
+
+#if (NONOSDK >= (0x30000))
+    extern void user_rf_pre_init();
+    user_rf_pre_init(); // Stop spoofing logic
+#endif
+
     struct rst_info *rtc_info_ptr = system_get_rst_info();
     memcpy((void *) &resetInfo, (void *) rtc_info_ptr, sizeof(resetInfo));
 
     uart_div_modify(0, UART_CLK_FREQ / (115200));
 
+#if FLASH_MAP_SUPPORT && (NONOSDK < (0x30000))
+    const char *err_msg = flashinit();
+    if (err_msg) __panic_func(err_msg, 0, NULL);
+#endif
+
     init(); // in core_esp8266_wiring.c, inits hw regs and sdk timer
 
     initVariant();
@@ -426,15 +648,12 @@ extern "C" void user_init(void) {
     install_vm_exception_handler();
 #endif
 
-#if defined(NON32XFER_HANDLER) || defined(MMU_IRAM_HEAP)
+#if defined(NON32XFER_HANDLER) || (defined(MMU_IRAM_HEAP) && (NONOSDK < (0x30000)))
     install_non32xfer_exception_handler();
 #endif
 
 #if defined(MMU_IRAM_HEAP)
     umm_init_iram();
-#endif
-#if FLASH_MAP_SUPPORT
-    flashinit();
 #endif
     preinit(); // Prior to C++ Dynamic Init (not related to above init() ). Meant to be user redefinable.
     __disableWiFiAtBootTime(); // default weak function disables WiFi

cores/esp8266/core_esp8266_non32xfer.cpp

@@ -26,10 +26,14 @@
  * Code taken directly from @pvvx's public domain code in
  * https://github.com/pvvx/esp8266web/blob/master/app/sdklib/system/app_main.c
  *
+ * In Espressif versions NONOSDK v3.0.0+ a similar feature was added
+ * load_non_32_wide_handler. Theirs is always loaded. Add weak attribute to
+ * theirs so we can choose by adding an alias to ours.
  *
  */
 
 #include <Arduino.h>
+#include <user_interface.h>
 #define VERIFY_C_ASM_EXCEPTION_FRAME_STRUCTURE
 #include <esp8266_undocumented.h>
 #include <core_esp8266_non32xfer.h>
@@ -58,10 +62,13 @@ extern "C" {
 
 #define EXCCAUSE_LOAD_STORE_ERROR 3 /* Non 32-bit read/write error */
 
+#if (defined(NON32XFER_HANDLER) || defined(MMU_IRAM_HEAP)) && (NONOSDK < (0x30000))
 static fn_c_exception_handler_t old_c_handler = NULL;
+#endif
 
+#if defined(NON32XFER_HANDLER) || (defined(MMU_IRAM_HEAP) && (NONOSDK < (0x30000)))
 static
-IRAM_ATTR void non32xfer_exception_handler(struct __exception_frame *ef, int cause)
+IRAM_ATTR void non32xfer_exception_handler(struct __exception_frame *ef, [[maybe_unused]] int cause)
 {
   do {
     uint32_t insn, excvaddr;
@@ -138,6 +145,7 @@ IRAM_ATTR void non32xfer_exception_handler(struct __exception_frame *ef, int cau
   } while(false);
 
 /* Fail request, die */
+#if (NONOSDK < (0x30000))
   /*
     The old handler points to the SDK. Be alert for HWDT when Calling with
     INTLEVEL != 0. I cannot create it any more. I thought I saw this as a
@@ -148,16 +156,23 @@ IRAM_ATTR void non32xfer_exception_handler(struct __exception_frame *ef, int cau
     old_c_handler(ef, cause);
     return;
   }
-
+#endif
   /*
     Calling _xtos_unhandled_exception(ef, cause) in the Boot ROM, gets us a
     hardware wdt.
 
     Use panic instead as a fall back. It will produce a stack trace.
    */
+#if defined(DEBUG_ESP_PORT) || defined(DEBUG_ESP_MMU)
   panic();
+#else
+  // For non-debug builds, save on resources
+  abort();
+#endif
 }
+#endif // #if defined(NON32XFER_HANDLER) || (defined(MMU_IRAM_HEAP) && (NONOSDK < (0x30000)))
 
+#if (defined(NON32XFER_HANDLER) || defined(MMU_IRAM_HEAP)) && (NONOSDK < (0x30000))
 /*
   To operate reliably, this module requires the new
   `_xtos_set_exception_handler` from `exc-sethandler.cpp` and
@@ -174,5 +189,17 @@ void install_non32xfer_exception_handler(void) {
       non32xfer_exception_handler);
   }
 }
+#else
+// For v3.0.x SDKs, no need for install - call_user_start will do the job.
+// Need this for build dependencies
+void install_non32xfer_exception_handler(void) __attribute__((weak));
+void install_non32xfer_exception_handler(void) {}
+#endif
+
+#if defined(NON32XFER_HANDLER)
+// For SDKs 3.0.x, we made load_non_32_wide_handler in
+// libmain.c:user_exceptions.o a weak symbol allowing this override to work.
+extern void load_non_32_wide_handler(struct __exception_frame *ef, int cause) __attribute__((alias("non32xfer_exception_handler")));
+#endif
 
 };