make eboot erase/read/write sector by sector

that makes possible having sketches with size up to the free size

Author: John Doe

hardware/esp8266com/esp8266/bootloaders/eboot/Makefile

@@ -1,4 +1,5 @@
-XTENSA_TOOLCHAIN ?=
+XTENSA_TOOLCHAIN ?= ../../tools/xtensa-lx106-elf/bin/
+ESPTOOL ?= ../../tools/esptool
 
 BIN_DIR := ./
 TARGET_DIR := ./

hardware/esp8266com/esp8266/bootloaders/eboot/eboot.c

@@ -76,38 +76,31 @@ int copy_raw(const uint32_t src_addr,
              const uint32_t dst_addr, 
              const uint32_t size)
 {
-    ets_putc('\n');
-    ets_putc('c');
-    ets_putc('p');
-    ets_putc('\n');
     // require regions to be aligned
     if (src_addr & 0xfff != 0 ||
         dst_addr & 0xfff != 0) {
         return 1;
     }
 
-    if (SPIEraseAreaEx(dst_addr, size)) {
-        return 2;
-    }
-
-    const uint32_t buffer_size = 4096;
+    const uint32_t buffer_size = FLASH_SECTOR_SIZE;
     uint8_t buffer[buffer_size];
-
-    const uint32_t end = src_addr + size;
+    uint32_t left = ((size+buffer_size-1) & ~(buffer_size-1));
     uint32_t saddr = src_addr;
     uint32_t daddr = dst_addr;
-    uint32_t left = size;
-    while (saddr < end) {
-        uint32_t will_copy = (left < buffer_size) ? left : buffer_size;
-        if (SPIRead(saddr, buffer, will_copy)) {
-            return 3;
-        }
-        if (SPIWrite(daddr, buffer, will_copy)) {
-            return 4;
-        }
-        saddr += will_copy;
-        daddr += will_copy;
-        left  -= will_copy;
+    
+    while (left) {
+      if (SPIEraseSector(daddr/buffer_size)) {
+          return 2;
+      }
+      if (SPIRead(saddr, buffer, buffer_size)) {
+        return 3;
+      }
+      if (SPIWrite(daddr, buffer, buffer_size)) {
+        return 4;
+      }
+      saddr += buffer_size;
+      daddr += buffer_size;
+      left  -= buffer_size;
     }
 
     return 0;
@@ -123,30 +116,31 @@ void main()
     if (eboot_command_read(&cmd)) {
         cmd.action = ACTION_LOAD_APP;
         cmd.args[0] = 0;
-        ets_putc('e');
+        ets_putc('~');
     } else {
         ets_putc('@');
     }
     eboot_command_clear();
-
+    
     if (cmd.action == ACTION_COPY_RAW) {
+        ets_putc('c'); ets_putc('p'); ets_putc(':');
         res = copy_raw(cmd.args[0], cmd.args[1], cmd.args[2]);
+        ets_putc((char)0x30+res); ets_putc('\n');
         if (res == 0) {
             cmd.action = ACTION_LOAD_APP;
             cmd.args[0] = cmd.args[1];
         }
     }
 
     if (cmd.action == ACTION_LOAD_APP) {
-        res = load_app_from_flash_raw(cmd.args[0]);
+      ets_putc('l'); ets_putc('d'); ets_putc('\n');
+      res = load_app_from_flash_raw(cmd.args[0]);
+      //we will get to this only on load fail
+      ets_putc('e'); ets_putc(':'); ets_putc((char)0x30+res); ets_putc('\n');
     }
 
     if (res) {
-        ets_putc('\n');
-        ets_putc('#');
-        ets_putc('0' + res);
-        ets_putc('\n');
-        SWRST;
+      SWRST;
     }
 
     while(true){}

hardware/esp8266com/esp8266/bootloaders/eboot/eboot.elf

@@ -4,7 +4,7 @@
  * Redistribution and use is permitted according to the conditions of the
  * 3-clause BSD license to be found in the LICENSE file.
  */
- 
+/*
 #include <stddef.h>
 #include <stdint.h>
 #include <stdbool.h>
@@ -46,4 +46,4 @@ int SPIEraseAreaEx(const uint32_t start, const uint32_t size)
 
     return 0;
 }
-
+*/

hardware/esp8266com/esp8266/bootloaders/eboot/flash.c

@@ -12,7 +12,7 @@ int SPIEraseBlock(uint32_t block);
 int SPIEraseSector(uint32_t sector);
 int SPIRead(uint32_t addr, void *dest, size_t size);
 int SPIWrite(uint32_t addr, void *src, size_t size);
-int SPIEraseAreaEx(const uint32_t start, const uint32_t size);
+//int SPIEraseAreaEx(const uint32_t start, const uint32_t size);
 
 #define FLASH_SECTOR_SIZE 0x1000
 #define FLASH_BLOCK_SIZE 0x10000

hardware/esp8266com/esp8266/bootloaders/eboot/flash.h

@@ -27,30 +27,33 @@ bool UpdaterClass::begin(size_t size){
   }
 
   if(_buffer) os_free(_buffer);
-  
   _bufferLen = 0;
   _startAddress = 0;
   _currentAddress = 0;
   _size = 0;
   _error = 0;
 
-  uint32_t usedSize = ESP.getSketchSize();
-  uint32_t freeSpaceEnd = (uint32_t)&_SPIFFS_start - 0x40200000 - (5 * FLASH_SECTOR_SIZE);
+  //size of current sketch rounded to a sector
+  uint32_t currentSketchSize = (ESP.getSketchSize() + FLASH_SECTOR_SIZE - 1) & (~(FLASH_SECTOR_SIZE - 1));
+  //address of the end of the space available for sketch and update (5 sectors are for EEPROM and init data)
+  uint32_t updateEndAddress = (uint32_t)&_SPIFFS_start - 0x40200000 - (5 * FLASH_SECTOR_SIZE);
+  //size of the update rounded to a sector
   uint32_t roundedSize = (size + FLASH_SECTOR_SIZE - 1) & (~(FLASH_SECTOR_SIZE - 1));
-  uint32_t freeSpaceStart = freeSpaceEnd - roundedSize;
+  //address where we will start writing the update
+  uint32_t updateStartAddress = updateEndAddress - roundedSize;
 
-  //new sketch can not be more then half the size or more than the free space
-  //this means that max sketch size is (1MB - 20KB) / 2 for flash 2MB and above
-  //and the current sketch should not be more than that either
-  if(freeSpaceStart < usedSize || roundedSize > (freeSpaceEnd/2)){
+  //make sure that the size of both sketches is less than the total space (updateEndAddress)
+  if(updateStartAddress < currentSketchSize){
     _error = UPDATE_ERROR_SPACE;
 #ifdef DEBUG_UPDATER
     printError(DEBUG_UPDATER);
 #endif
     return false;
   }
+  
+  //erase the neede space
   noInterrupts();
-  int rc = SPIEraseAreaEx(freeSpaceStart, roundedSize);
+  int rc = SPIEraseAreaEx(updateStartAddress, roundedSize);
   interrupts();
   if (rc){
     _error = UPDATE_ERROR_ERASE;
@@ -59,7 +62,9 @@ bool UpdaterClass::begin(size_t size){
 #endif
     return false;
   }
-  _startAddress = freeSpaceStart;
+  
+  //initialize
+  _startAddress = updateStartAddress;
   _currentAddress = _startAddress;
   _size = size;
   _buffer = (uint8_t*)os_malloc(FLASH_SECTOR_SIZE);

hardware/esp8266com/esp8266/cores/esp8266/Updater.cpp

@@ -1,11 +1,7 @@
 #!/usr/bin/env python
 #
 # this script will push an OTA update to the ESP
-#
-# use it like: python ota_server.py <ESP_IP_address> <sketch.bin>
-#
-# on the ESP side you need code like this: https://gist.github.com/igrr/43d5c52328e955bb6b09 to handle the update
-#
+# use it like: python espota.py <ESP_IP_address> <sketch.bin>
 
 from __future__ import print_function
 import socket
@@ -22,7 +18,7 @@ def serve(remoteAddr, remotePort, filename):
     sock.bind(server_address)
     sock.listen(1)
   except:
-    print('Socket Failed', file=sys.stderr)
+    print('Listen Failed', file=sys.stderr)
     return 1
 
   content_size = os.path.getsize(filename)
@@ -80,10 +76,11 @@ def serve(remoteAddr, remotePort, filename):
       f.close()
       sock.close()
       return 1
-    
+
   finally:
     connection.close()
     f.close()
+
   sock.close()
   return 1