Resolved number of issues and made update process more resilient

#5 #3 #2
khcnz · Jul 11, 2017 · df7b5e2 · df7b5e2
1 parent f883ce0
commit df7b5e2
Show file tree

Hide file tree

Showing 2 changed files with 184 additions and 117 deletions.
diff --git a/Espressif2Arduino/Espressif2Arduino.ino b/Espressif2Arduino/Espressif2Arduino.ino
@@ -1,20 +1,21 @@
-#include <ESP8266WiFi.h>                    // MQTT, Ota, WifiManager
-#include <ESP8266HTTPClient.h>              // MQTT, Ota
+#include <ESP8266WiFi.h>
+#include <ESP8266HTTPClient.h>
 
 extern "C" uint8_t system_upgrade_userbin_check();
 extern "C" void system_upgrade_flag_set(uint8 flag);
 extern "C" void system_upgrade_reboot (void);
 
-byte buffer[1024] = {0};
-uint16_t buffer_max_size = sizeof(buffer);
-byte _blink = 0;
+#define MAGIC_V1 0xE9
+#define MAGIC_V2 0xEA
+#define UPGRADE_FLAG_START 0x01
+#define UPGRADE_FLAG_FINISH 0x02
+#define SECTOR_SIZE 4096
+#define BUFFER_SIZE 1024
+#define TIMEOUT 5000
 
-void connectToWiFiBlocking();
-uint8_t determineFlashMode();
-void blink();
-void flashRom1();
-void flashRom2();
-void downloadRomToFlash(byte rom, byte magic, uint32_t to_address, uint32_t end_address, uint16_t erase_sectior_from, uint16_t erase_sector_to, char * url, uint8_t retry_limit);
+byte buffer[BUFFER_SIZE] = {0};
+byte bootrom[SECTOR_SIZE] = {0};
+byte _blink = 0;
 
 enum FlashMode
 {
@@ -23,19 +24,17 @@ enum FlashMode
   MODE_FLASH_ROM2
 };
 
-#define MAGIC_V1 0xE9
-#define MAGIC_V2 0xEA
-#define UPGRADE_FLAG_START 0x01
-#define UPGRADE_FLAG_FINISH 0x02
-
 
 //USER EDITABLE VARABLES HERE
-#define DELAY 100
-#define STATUS_GPIO 13
-#define RETRY 3
+#define DELAY 100        //ms to blink/delay for
+#define STATUS_GPIO 13  //gpio to toggle as status indicator
+#define RETRY 3         //number of times to retry
+
+#define URL_QIO_ROM_2 "http://sunlocker.khc.net.nz/static/8266/e2a-1024-2.bin"
+#define URL_QIO_ROM_3 "http://sunlocker.khc.net.nz/static/8266/sonoff-1024.bin"
 
-#define URL_ROM_2 "http://192.168.1.1/Espressif2Arduino.ino-0x81000.bin"
-#define URL_ROM_3 "http://192.168.1.1/sonoff.bin" //or use http://sonoff.maddox.co.uk/tasmota/sonoff.ino.bin
+#define URL_DIO_ROM_2 "http://sunlocker.khc.net.nz/static/8285/e2a-1024-2.bin"
+#define URL_DIO_ROM_3 "http://sunlocker.khc.net.nz/static/8285/sonoff-1024.bin"
 
 //Uncomment to provide fixed credentials - otherwise will try to use credentials saved by sonoff device
 //#define WIFI_SSID "TEST"
@@ -53,51 +52,54 @@ void setup()
   }
 
   //blink our status LED while we wait for serial to come up
-  for(int i=0;i<50;i++)
+  for(int i=0;i<100;i++)
   {
     blink(); 
     delay(DELAY);
   }
   digitalWrite(STATUS_GPIO, HIGH);
   Serial.println("Done");
 
-  uint8_t mode = determineFlashMode();
-  if(mode == MODE_FLASH_ROM1 || MODE_FLASH_ROM2)
+  uint8_t upgrade = determineUpgradeMode();
+  if(upgrade == MODE_FLASH_ROM1 || MODE_FLASH_ROM2)
   {
       connectToWiFiBlocking();
       digitalWrite(STATUS_GPIO, LOW);
   }
 
-  if (mode == MODE_FLASH_ROM1)
-    flashRom1();
-  else if(mode == MODE_FLASH_ROM2)
-    flashRom2();
+  Serial.printf("Flash Mode: ");
+  FlashMode_t mode = ESP.getFlashChipMode();
+  Serial.printf("%d\n", mode);
+
+  if (upgrade == MODE_FLASH_ROM1)
+    flashRom1(mode);
+  else if(upgrade == MODE_FLASH_ROM2)
+    flashRom2(mode);
   else
     Serial.println("Flash Mode not recognized");
 }
 
 
 
-uint8_t determineFlashMode()
+uint8_t determineUpgradeMode()
 {
-  Serial.printf("Current Rom: ");
+  Serial.printf("Current rom: ");
   uint8_t rom = system_upgrade_userbin_check() + 1;
   Serial.printf("%d\n", rom);
 
-  Serial.printf("Rom 1 Magic Byte: ");
+  Serial.printf("Rom 1 magic byte: ");
   uint32_t rom_1_start_address = 0x001000;
   byte magic = 0;
   ESP.flashRead(rom_1_start_address, (uint32_t*)&magic, 1);
   Serial.printf("0x%02X\n", magic);
 
-  Serial.printf("Flash Mode: ");
   uint8_t mode = MODE_UNKNOWN;
   if (rom == 1 && magic == MAGIC_V2)
     mode = MODE_FLASH_ROM2;
   else if (rom == 2 && magic == MAGIC_V2)
     mode = MODE_FLASH_ROM1;
 
-  Serial.printf("%d\n", mode);
+  Serial.printf("Reflashing rom: %d\n", mode);
   return mode;
 }
 
@@ -106,7 +108,7 @@ void connectToWiFiBlocking()
   char ssid[32] = {0};
   char pass[64] = {0};
 
-  Serial.print("Attemping to read itead Wifi credentials... ");
+  Serial.print("Attemping to read Sonoff Wifi credentials... ");
   ESP.flashRead(0x79000, (uint32_t *) &ssid[0], sizeof(ssid));
   ESP.flashRead(0x79020, (uint32_t *) &pass[0], sizeof(pass));
   Serial.print("Done\n");
@@ -138,102 +140,166 @@ void connectToWiFiBlocking()
 
 
 
-void flashRom1()
+void flashRom1(FlashMode_t mode)
 {
-  downloadRomToFlash(
+  bool result = downloadRomToFlash(
     1,                //Rom 1
+    true,             //Bootloader is being updated
     0xE9,             //Standard Arduino Magic
-    0x0,              //Write to 0x0 since we are replacing the bootloader
+    0x00000,          //Write to 0x0 since we are replacing the bootloader
     0x80000,          //Stop before 0x80000
     0,                //Erase Sector from 0 to
     128,              //Sector 128 (not inclusive)
-    URL_ROM_3,  //URL
+    (mode == FM_DIO) ? URL_DIO_ROM_3 : URL_QIO_ROM_3,
     RETRY             //Retry Count
   );
 
-  ESP.restart();
+  ESP.restart(); //restart regardless of success
 }
 
-//Simply copy over all data in flash from rom 1 to rom 2 and reboot.
-void flashRom2()
+//Download special rom.
+void flashRom2(FlashMode_t mode)
 {
-
   system_upgrade_flag_set(UPGRADE_FLAG_START);
-  downloadRomToFlash(
-    2,                //Rom 1
+  bool result = downloadRomToFlash(
+    2,                //Rom 2
+    false,            //Bootloader is not being updated
     0xEA,             //V2 Espressif Magic
-    0x81000,          //Write to 0x0 since we are replacing the bootloader
+    0x081000,         //Not replacing bootloader
     0x100000,         //Stop before end of ram
-    128,              //Erase Sector from 128
-    256,              //Sector 256 (not inclusive)
-    URL_ROM_2,        //URL
+    128,              //From middle of flash
+    256,              //End of flash
+    (mode == FM_DIO) ? URL_DIO_ROM_2 : URL_QIO_ROM_2,
     RETRY             //Retry Count
   );
-  system_upgrade_flag_set(UPGRADE_FLAG_FINISH);
-  system_upgrade_reboot();
+
+  if(result)
+  {
+    system_upgrade_flag_set(UPGRADE_FLAG_FINISH);
+    system_upgrade_reboot();
+  }
+  else
+  {
+    ESP.restart();
+  }
 }
 
-void downloadRomToFlash(byte rom, byte magic, uint32_t to_address, uint32_t end_address, uint16_t erase_sectior_from, uint16_t erase_sector_to, char * url, uint8_t retry_limit)
+//Assumes bootloader must be in first SECTOR_SIZE bytes.
+bool downloadRomToFlash(byte rom, byte bootloader, byte magic, uint32_t start_address, uint32_t end_address, uint16_t erase_sectior_start, uint16_t erase_sector_end, const char * url, uint8_t retry_limit)
 {
-  Serial.printf("Flash Rom %d: %s\n", rom, url);
-
   uint8_t retry_counter = 0;
   while(retry_counter < retry_limit)
   {
+    uint16_t erase_start = erase_sectior_start;
+    uint32_t write_address = start_address;
+    uint8_t header[4] = { 0 };
+    bootrom[SECTOR_SIZE] = { 0 };
+    buffer[BUFFER_SIZE] = { 0 };
+
+    Serial.printf("Flashing rom %d (retry:%d): %s\n", rom, retry_counter, url);
     HTTPClient http;
     http.begin(url);
     http.useHTTP10(true);
-    http.setTimeout(8000);
-
+    http.setTimeout(TIMEOUT);
+
+    //Response Code Check
     uint16_t httpCode = http.GET();
-    Serial.printf("HTTP Response Code: %d\n", httpCode);
-    if(httpCode == HTTP_CODE_OK)
+    Serial.printf("HTTP response Code: %d\n", httpCode);
+    if(httpCode != HTTP_CODE_OK)
+    {
+      Serial.println("Invalid response Code - retry");
+      retry_counter++;
+      continue;
+    }
+
+    //Length Check (at least one sector)
+    uint32_t len = http.getSize();
+    Serial.printf("HTTP response length: %d\n", len);
+    if(len < SECTOR_SIZE)
     {
-      uint32_t len = http.getSize();
-      Serial.printf("HTTP Response Length: %d\n", len);
+      Serial.println("Length too short - retry");
+      retry_counter++;
+      continue;
+    }
+
+    if(len > (end_address-start_address))
+    {
+      Serial.println("Length exceeds flash size - retry");
+      retry_counter++;
+      continue;
+    }
 
-      byte buffer[1024] = { 0 };
-      uint8_t header[4] = { 0 };
+    //Confirm magic byte
+    WiFiClient* stream = http.getStreamPtr();
+    stream->peekBytes(&header[0],4);
+    Serial.printf("Magic byte from stream: 0x%02X\n", header[0]);
+    if(header[0] != magic)
+    {
+      Serial.println("Invalid magic byte - retry");
+      retry_counter++;
+      continue;
+    }
 
-      WiFiClient* stream = http.getStreamPtr();
-      stream->peekBytes(&header[0],4);
-      Serial.printf("Magic Byte from stream: 0x%02X\n", header[0]);
-      if(header[0] == magic)
+    if(bootloader)
+    { 
+      Serial.printf("Downloading %d byte bootloader", sizeof(bootrom));
+      size_t size = stream->available();
+      while(size < sizeof(bootrom))
       {
-        Serial.printf("**CRITICAL SECTION START - DO NOT TURN OFF POWER OR INTERFERE WITH WIFI**\n");
-        Serial.printf("Erasing Flash Sectors %d-%d", erase_sectior_from, erase_sector_to);
-        for (uint16_t i = erase_sectior_from; i < erase_sector_to; i++)
-        {
-          ESP.flashEraseSector(i);
-          blink();
-        }  
-        Serial.printf("Done\n");
-
-        Serial.printf("Downloading Image in %d byte size blocks", sizeof(buffer));
-        while(len > 0)
-        {
-          size_t size = stream->available();
-          if(size) 
-          {
-            int c = stream->readBytes(buffer, ((size > sizeof(buffer)) ? sizeof(buffer) : size));
-            ESP.flashWrite(to_address, (uint32_t*)&buffer[0], c);
-            to_address +=c; //increment next write address
-            len -= c; //decremeant remaining bytes
-          }
-          blink();
-        }
-        http.end();
-        Serial.println("Done");
-        Serial.println("**CRITICAL SECTION END**");
-        return;
+        blink();
+        size = stream->available();
       }
+      int c = stream->readBytes(bootrom, sizeof(bootrom));
+
+      //Skip the bootloader section for the moment..
+      erase_start++;
+      write_address += SECTOR_SIZE;
+      len -= SECTOR_SIZE;
+      Serial.printf(".Done\n");
     }
+
+    Serial.printf("Erasing flash sectors %d-%d", erase_start, erase_sector_end);
+    for (uint16_t i = erase_start; i < erase_sector_end; i++)
+    {
+      ESP.flashEraseSector(i);
+      blink();
+    }  
+    Serial.printf("Done\n");
 
-    Serial.println("Error encountered.. sleeping and will try again");
-    delay(5000); //try again in 5 seconds...
-    retry_counter++;
+    Serial.printf("Downloading rom to 0x%06X-0x%06X in %d byte blocks", write_address, write_address+len, sizeof(buffer));
+    //Serial.println();
+    while(len > 0)
+    {
+      size_t size = stream->available();
+      if(size >= sizeof(buffer) || size == len) 
+      {
+        int c = stream->readBytes(buffer, ((size > sizeof(buffer)) ? sizeof(buffer) : size));
+        //Serial.printf("address=0x%06X, bytes=%d, len=%d\n", write_address, c, len);
+        ESP.flashWrite(write_address, (uint32_t*)&buffer[0], c);
+        write_address +=c; //increment next write address
+        len -= c; //decremeant remaining bytes
+      }
+      blink();
+      //delay(100);
+    }
+    http.end();
+    Serial.println("Done");
+
+    if(bootloader)
+    {
+      Serial.printf("Erasing bootloader sector 0");
+      ESP.flashEraseSector(0);
+      Serial.printf("..Done\n");
+
+      Serial.printf("Writing bootloader to 0x%06X-0x%06X", 0, SECTOR_SIZE);
+      ESP.flashWrite(0, (uint32_t*)&bootrom[0], SECTOR_SIZE);
+      Serial.printf("..Done\n");
+    }
+
+    return true;
   }
   Serial.println("Retry counter exceeded - giving up");
+  return false;
 }
 
 
@@ -254,7 +320,7 @@ void blink()
 
 void loop()
 {
-  delay(100);
+  //delay(100);
 }