PoC for handling Erase WiFi Setting after OTA

cores/esp8266/Arduino.h

@@ -40,6 +40,7 @@ extern "C" {
 
 #include "core_esp8266_features.h"
 #include "core_esp8266_version.h"
+#include "erase_config.h"
 
 #define HIGH 0x1
 #define LOW 0x0

cores/esp8266/Esp.cpp

@@ -325,6 +325,36 @@ FlashMode_t EspClass::getFlashChipMode(void)
  return mode;
 }
 
+#ifdef ERASE_CONFIG_H
+// This change is only needed for method 3
+extern "C" uint32_t esp_c_magic_flash_chip_size(uint8_t byte)
+{
+ switch(byte & 0x0F) {
+ case 0x0: // 4 Mbit (512KB)
+ return (512_kB);
+ case 0x1: // 2 MBit (256KB)
+ return (256_kB);
+ case 0x2: // 8 MBit (1MB)
+ return (1_MB);
+ case 0x3: // 16 MBit (2MB)
+ return (2_MB);
+ case 0x4: // 32 MBit (4MB)
+ return (4_MB);
+ case 0x8: // 64 MBit (8MB)
+ return (8_MB);
+ case 0x9: // 128 MBit (16MB)
+ return (16_MB);
+ default: // fail?
+ return 0;
+ }
+}
+
+uint32_t EspClass::magicFlashChipSize(uint8_t byte)
+{
+ return esp_c_magic_flash_chip_size(byte);
+}
+
+#else
 uint32_t EspClass::magicFlashChipSize(uint8_t byte) {
  switch(byte & 0x0F) {
  case 0x0: // 4 Mbit (512KB)
@@ -345,6 +375,7 @@ uint32_t EspClass::magicFlashChipSize(uint8_t byte) {
  return 0;
  }
 }
+#endif
 
 uint32_t EspClass::magicFlashChipSpeed(uint8_t byte) {
  switch(byte & 0x0F) {

cores/esp8266/Updater.cpp

@@ -62,6 +62,11 @@ void UpdaterClass::_reset() {
 }
 
 bool UpdaterClass::begin(size_t size, int command, int ledPin, uint8_t ledOn) {
+#if defined(ERASE_CONFIG_H) && !defined(HOST_MOCK)
+ // Empty call so erase_config.cpp module to ensure it is built and linked in.
+ enable_erase_config_at_link_time();
+#endif
+
  if(_size > 0){
 #ifdef DEBUG_UPDATER
  DEBUG_UPDATER.println(F("[begin] already running"));
@@ -82,7 +87,7 @@ bool UpdaterClass::begin(size_t size, int command, int ledPin, uint8_t ledOn) {
  _setError(UPDATE_ERROR_BOOTSTRAP);
  return false;
  }
- 
+
 #ifdef DEBUG_UPDATER
  if (command == U_FS) {
  DEBUG_UPDATER.println(F("[begin] Update Filesystem."));
@@ -129,7 +134,7 @@ bool UpdaterClass::begin(size_t size, int command, int ledPin, uint8_t ledOn) {
 
  //make sure that the size of both sketches is less than the total space (updateEndAddress)
  if(updateStartAddress < currentSketchSize) {
- _setError(UPDATE_ERROR_SPACE); 
+ _setError(UPDATE_ERROR_SPACE);
  return false;
  }
  }
@@ -298,10 +303,17 @@ bool UpdaterClass::end(bool evenIfRemaining){
 
  if (_command == U_FLASH) {
  eboot_command ebcmd;
+ memset(&ebcmd, 0, sizeof(ebcmd));
  ebcmd.action = ACTION_COPY_RAW;
  ebcmd.args[0] = _startAddress;
  ebcmd.args[1] = 0x00000;
  ebcmd.args[2] = _size;
+#ifdef ERASE_CONFIG_H
+ ebcmd.args[4] = _eraseConfigOption;
+ ebcmd.args[5] = ~_eraseConfigOption;
+ ebcmd.args[6] = _eraseConfigOption;
+ ebcmd.args[7] = ~_eraseConfigOption;
+#endif
  eboot_command_write(&ebcmd);
 
 #ifdef DEBUG_UPDATER
@@ -311,6 +323,7 @@ bool UpdaterClass::end(bool evenIfRemaining){
  else if (_command == U_FS) {
 #ifdef ATOMIC_FS_UPDATE
  eboot_command ebcmd;
+ memset(&ebcmd, 0, sizeof(ebcmd));
  ebcmd.action = ACTION_COPY_RAW;
  ebcmd.args[0] = _startAddress;
  ebcmd.args[1] = (uintptr_t)&_FS_start - 0x40200000;
@@ -359,7 +372,7 @@ bool UpdaterClass::_writeBuffer(){
  modifyFlashMode = true;
  }
  }
- 
+
  if (eraseResult) {
  if(!_async) yield();
  writeResult = ESP.flashWrite(_currentAddress, _buffer, _bufferLen);
@@ -443,7 +456,7 @@ bool UpdaterClass::_verifyEnd() {
  uint8_t buf[4] __attribute__((aligned(4)));
  if(!ESP.flashRead(_startAddress, (uint32_t *) &buf[0], 4)) {
  _currentAddress = (_startAddress);
- _setError(UPDATE_ERROR_READ); 
+ _setError(UPDATE_ERROR_READ);
  return false;
  }
 
@@ -455,7 +468,7 @@ bool UpdaterClass::_verifyEnd() {
  return true;
  } else if (buf[0] != 0xE9) {
  _currentAddress = (_startAddress);
- _setError(UPDATE_ERROR_MAGIC_BYTE); 
+ _setError(UPDATE_ERROR_MAGIC_BYTE);
  return false;
  }
 
@@ -464,7 +477,7 @@ bool UpdaterClass::_verifyEnd() {
  // check if new bin fits to SPI flash
  if(bin_flash_size > ESP.getFlashChipRealSize()) {
  _currentAddress = (_startAddress);
- _setError(UPDATE_ERROR_NEW_FLASH_CONFIG); 
+ _setError(UPDATE_ERROR_NEW_FLASH_CONFIG);
  return false;
  }
 

cores/esp8266/Updater.h

@@ -5,6 +5,7 @@
 #include <flash_utils.h>
 #include <MD5Builder.h>
 #include <functional>
+#include <erase_config.h>
 
 #define UPDATE_ERROR_OK (0)
 #define UPDATE_ERROR_WRITE (1)
@@ -52,7 +53,7 @@ class UpdaterVerifyClass {
 class UpdaterClass {
  public:
  typedef std::function<void(size_t, size_t)> THandlerFunction_Progress;
- 
+
  UpdaterClass();
  ~UpdaterClass();
 
@@ -65,6 +66,13 @@ class UpdaterClass {
  */
  bool begin(size_t size, int command = U_FLASH, int ledPin = -1, uint8_t ledOn = LOW);
 
+#ifdef ERASE_CONFIG_H
+ /*
+ */
+ inline void setEraseConfigOption(ERASE_CONFIG_MASK_t eraseOption) {
+ _eraseConfigOption = eraseOption;
+ }
+#endif
  /*
  Run Updater from asynchronous callbacs
  */
@@ -181,7 +189,7 @@ class UpdaterClass {
  bool _verifyHeader(uint8_t data);
  bool _verifyEnd();
 
- void _setError(int error); 
+ void _setError(int error);
 
  bool _async = false;
  uint8_t _error = 0;
@@ -199,6 +207,9 @@ class UpdaterClass {
  int _ledPin = -1;
  uint8_t _ledOn;
 
+#ifdef ERASE_CONFIG_H
+ uint32_t _eraseConfigOption = ERASE_CONFIG_BLANK_BIN;
+#endif
  // Optional signed binary verification
  UpdaterHashClass *_hash = nullptr;
  UpdaterVerifyClass *_verify = nullptr;

cores/esp8266/core_esp8266_main.cpp

@@ -309,6 +309,17 @@ void init_done() {
  https:/esp8266/Arduino/pull/4889
 
 */
+#if defined(DEBUG_ERASE_CONFIG)
+extern "C" void erase_config__fix_divider(void);
+#define ERASE_CFG__FIX_DIVIDER erase_config__fix_divider
+#define ERASE_CFG__ETS_PRINTF(...) ets_uart_printf(__VA_ARGS__)
+#define ERASE_CFG__ETS_DELAY_US(a) ets_delay_us(a)
+#else
+#define ERASE_CFG__FIX_DIVIDER() do {} while(0)
+#define ERASE_CFG__ETS_PRINTF(...) do {} while(0)
+#define ERASE_CFG__ETS_DELAY_US(a) do {} while(0)
+#endif
+
 
 extern "C" void app_entry_redefinable(void) __attribute__((weak));
 extern "C" void app_entry_redefinable(void)
@@ -318,6 +329,9 @@ extern "C" void app_entry_redefinable(void)
  cont_t s_cont __attribute__((aligned(16)));
  g_pcont = &s_cont;
 
+ ERASE_CFG__FIX_DIVIDER();
+ ERASE_CFG__ETS_PRINTF("\n\ncall_user_start()\n");
+
  /* Call the entry point of the SDK code. */
  call_user_start();
 }
@@ -339,7 +353,13 @@ extern "C" void user_init(void) {
  struct rst_info *rtc_info_ptr = system_get_rst_info();
  memcpy((void *) &resetInfo, (void *) rtc_info_ptr, sizeof(resetInfo));
 
+#if defined(DEBUG_ERASE_CONFIG)
+ uart_div_modify(0, UART_CLK_FREQ / (74880));
+ ERASE_CFG__ETS_DELAY_US(150);
+ ERASE_CFG__ETS_PRINTF("\nuser_init()\n");
+#else
  uart_div_modify(0, UART_CLK_FREQ / (115200));
+#endif
 
  init(); // in core_esp8266_wiring.c, inits hw regs and sdk timer