Better memory layout info, multi-sector memory layouts

code/esp8266.flash.1m0.ld → code/eagle.flash.1m0m1s.ld

@@ -1,4 +1,4 @@
-/* Flash Split for 1M chips, no SPIFFS */
+/* Flash Split for 1M chips */
 /* sketch 999KB */
 /* eeprom 20KB */
 
@@ -12,7 +12,7 @@ MEMORY
 
 PROVIDE ( _SPIFFS_start = 0x402FB000 );
 PROVIDE ( _SPIFFS_end = 0x402FB000 );
-PROVIDE ( _SPIFFS_page = 0 );
-PROVIDE ( _SPIFFS_block = 0 );
+PROVIDE ( _SPIFFS_page = 0x0 );
+PROVIDE ( _SPIFFS_block = 0x0 );
 
-INCLUDE "esp8266.flash.common.ld"
+INCLUDE "../ld/eagle.app.v6.common.ld"

code/eagle.flash.1m0m2s.ld

@@ -0,0 +1,19 @@
+/* Flash Split for 1M chips, no SPIFFS */
+/* sketch 995KB */
+/* eeprom 8KB */
+/* reserved 16KB */
+
+MEMORY
+{
+  dport0_0_seg :                        org = 0x3FF00000, len = 0x10
+  dram0_0_seg :                         org = 0x3FFE8000, len = 0x14000
+  iram1_0_seg :                         org = 0x40100000, len = 0x8000
+  irom0_0_seg :                         org = 0x40201010, len = 0xf8ff0
+}
+
+PROVIDE ( _SPIFFS_start = 0x402FA000 );
+PROVIDE ( _SPIFFS_end = 0x402FA000 );
+PROVIDE ( _SPIFFS_page = 0 );
+PROVIDE ( _SPIFFS_block = 0 );
+
+INCLUDE "../ld/eagle.app.v6.common.ld"

code/eagle.flash.4m1m4s.ld

@@ -0,0 +1,21 @@
+/* Flash Split for 4M chips */
+/* sketch 1019KB */
+/* empty/ota? 2048KB */
+/* spiffs 992KB */
+/* eeprom 16KB */
+/* reserved 16KB */
+
+MEMORY
+{
+  dport0_0_seg :                        org = 0x3FF00000, len = 0x10
+  dram0_0_seg :                         org = 0x3FFE8000, len = 0x14000
+  iram1_0_seg :                         org = 0x40100000, len = 0x8000
+  irom0_0_seg :                         org = 0x40201010, len = 0xfeff0
+}
+
+PROVIDE ( _SPIFFS_start = 0x40500000 );
+PROVIDE ( _SPIFFS_end = 0x405F8000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
+
+INCLUDE "../ld/eagle.app.v6.common.ld"

code/eagle.flash.4m3m4e.ld

@@ -0,0 +1,20 @@
+/* Flash Split for 4M chips */
+/* sketch 1019KB */
+/* spiffs 3040KB */
+/* eeprom 16KB */
+/* reserved 16KB */
+
+MEMORY
+{
+  dport0_0_seg :                        org = 0x3FF00000, len = 0x10
+  dram0_0_seg :                         org = 0x3FFE8000, len = 0x14000
+  iram1_0_seg :                         org = 0x40100000, len = 0x8000
+  irom0_0_seg :                         org = 0x40201010, len = 0xfeff0
+}
+
+PROVIDE ( _SPIFFS_start = 0x40300000 );
+PROVIDE ( _SPIFFS_end = 0x405F8000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
+
+INCLUDE "../ld/eagle.app.v6.common.ld"

code/eagle.flash.512k0m1s.ld

@@ -0,0 +1,18 @@
+/* Flash Split for 512K chips */
+/* sketch 487KB */
+/* eeprom 20KB */
+
+MEMORY
+{
+  dport0_0_seg :                        org = 0x3FF00000, len = 0x10
+  dram0_0_seg :                         org = 0x3FFE8000, len = 0x14000
+  iram1_0_seg :                         org = 0x40100000, len = 0x8000
+  irom0_0_seg :                         org = 0x40201010, len = 0x79ff0
+}
+
+PROVIDE ( _SPIFFS_start = 0x4027B000 );
+PROVIDE ( _SPIFFS_end = 0x4027B000 );
+PROVIDE ( _SPIFFS_page = 0x0 );
+PROVIDE ( _SPIFFS_block = 0x0 );
+
+INCLUDE "../ld/eagle.app.v6.common.ld"

code/espurna/eeprom.ino

@@ -9,8 +9,12 @@ EEPROM MODULE
 // -----------------------------------------------------------------------------
 
 bool eepromBackup() {
-    DEBUG_MSG_P(PSTR("[EEPROM] Backing up data to last sector\n"));
-    return EEPROMr.backup();
+    // Backup data to last sector if we are using more sectors than the
+    // reserved by the memory layout
+    if (EEPROMr.pool() > EEPROMr.reserved()) {
+        DEBUG_MSG_P(PSTR("[EEPROM] Backing up data to last sector\n"));
+        return EEPROMr.backup();
+    }
 }
 
 String eepromSectors() {
@@ -31,6 +35,21 @@ void _eepromInitCommands() {
         DEBUG_MSG_P(PSTR("\n+OK\n"));
     });
 
+    settingsRegisterCommand(F("FLASH.DUMP"), [](Embedis* e) {
+        if (e->argc < 2) {
+            DEBUG_MSG_P(PSTR("-ERROR: Wrong arguments\n"));
+            return;
+        }
+        uint32_t sector = String(e->argv[1]).toInt();
+        uint32_t max = ESP.getFlashChipSize() / SPI_FLASH_SEC_SIZE;
+        if (sector >= max) {
+            DEBUG_MSG_P(PSTR("-ERROR: Sector out of range\n"));
+            return;
+        }
+        EEPROMr.dump(settingsSerial(), sector);
+        DEBUG_MSG_P(PSTR("\n+OK\n"));
+    });
+
 }
 
 #endif
@@ -42,15 +61,15 @@ void eepromSetup() {
     #ifdef EEPROM_ROTATE_SECTORS
         EEPROMr.pool(EEPROM_ROTATE_SECTORS);
     #else
-        uint8_t sectors = 0;
-        if (EEPROMr.last() > 1000) { // 4Mb boards
-            sectors = 4;
-        } else if (EEPROMr.last() > 250) { // 1Mb boards
-            sectors = 2;
-        } else {
-            sectors = 1;
+        // If the memory layout has more than one sector reserved use those,
+        // otherwise calculate pool size based on memory size.
+        if (EEPROMr.pool() == 1) {
+            if (EEPROMr.last() > 1000) { // 4Mb boards
+                EEPROMr.pool(4);
+            } else if (EEPROMr.last() > 250) { // 1Mb boards
+                EEPROMr.pool(2);
+            }
         }
-        EEPROMr.pool(sectors);
     #endif
 
     EEPROMr.offset(EEPROM_ROTATE_DATA);

code/espurna/relay.ino

@@ -798,6 +798,7 @@ void _relayInitCommands() {
     settingsRegisterCommand(F("RELAY"), [](Embedis* e) {
         if (e->argc < 2) {
             DEBUG_MSG_P(PSTR("-ERROR: Wrong arguments\n"));
+            return;
         }
         int id = String(e->argv[1]).toInt();
         if (e->argc > 2) {

code/espurna/utils.ino

@@ -211,10 +211,42 @@ void heartbeat() {
 
 #endif /// HEARTBEAT_ENABLED
 
-unsigned int sectors(size_t size) {
+// -----------------------------------------------------------------------------
+// INFO
+// -----------------------------------------------------------------------------
+
+extern "C" uint32_t _SPIFFS_start;
+extern "C" uint32_t _SPIFFS_end;
+
+unsigned int info_bytes2sectors(size_t size) {
     return (int) (size + SPI_FLASH_SEC_SIZE - 1) / SPI_FLASH_SEC_SIZE;
 }
 
+unsigned long info_ota_space() {
+    return (ESP.getFreeSketchSpace() - 0x1000) & 0xFFFFF000;
+}
+
+unsigned long info_filesystem_space() {
+    return ((uint32_t)&_SPIFFS_end - (uint32_t)&_SPIFFS_start);
+}
+
+unsigned long info_eeprom_space() {
+    return EEPROMr.reserved() * SPI_FLASH_SEC_SIZE;
+}
+
+void _info_print_memory_layout_line(const char * name, unsigned long bytes, bool reset) {
+    static unsigned long index = 0;
+    if (reset) index = 0;
+    if (0 == bytes) return;
+    unsigned int _sectors = info_bytes2sectors(bytes);
+    DEBUG_MSG_P(PSTR("[INIT] %-20s: %8lu bytes / %4d sectors (%4d to %4d)\n"), name, bytes, _sectors, index, index + _sectors - 1);
+    index += _sectors;
+}
+
+void _info_print_memory_layout_line(const char * name, unsigned long bytes) {
+    _info_print_memory_layout_line(name, bytes, false);
+}
+
 void info() {
 
     DEBUG_MSG_P(PSTR("\n\n"));
@@ -235,13 +267,15 @@ void info() {
     DEBUG_MSG_P(PSTR("[INIT] Flash speed: %u Hz\n"), ESP.getFlashChipSpeed());
     DEBUG_MSG_P(PSTR("[INIT] Flash mode: %s\n"), mode == FM_QIO ? "QIO" : mode == FM_QOUT ? "QOUT" : mode == FM_DIO ? "DIO" : mode == FM_DOUT ? "DOUT" : "UNKNOWN");
     DEBUG_MSG_P(PSTR("\n"));
-    DEBUG_MSG_P(PSTR("[INIT] Flash sector size: %8u bytes\n"), SPI_FLASH_SEC_SIZE);
-    DEBUG_MSG_P(PSTR("[INIT] Flash size (CHIP): %8u bytes\n"), ESP.getFlashChipRealSize());
-    DEBUG_MSG_P(PSTR("[INIT] Flash size (SDK):  %8u bytes / %4d sectors\n"), ESP.getFlashChipSize(), sectors(ESP.getFlashChipSize()));
-    DEBUG_MSG_P(PSTR("[INIT] Firmware size:     %8u bytes / %4d sectors\n"), ESP.getSketchSize(), sectors(ESP.getSketchSize()));
-    DEBUG_MSG_P(PSTR("[INIT] Max OTA size:      %8u bytes / %4d sectors\n"), maxSketchSpace(), sectors(maxSketchSpace()));
-    DEBUG_MSG_P(PSTR("[INIT] EEPROM size:       %8u bytes / %4d sectors*\n"), EEPROMr.pool() * SPI_FLASH_SEC_SIZE, EEPROMr.pool());
-    DEBUG_MSG_P(PSTR("[INIT] Reserved space:    %8u bytes /    4 sectors\n"), 4 * SPI_FLASH_SEC_SIZE);
+
+    _info_print_memory_layout_line("Flash size (CHIP)", ESP.getFlashChipRealSize(), true);
+    _info_print_memory_layout_line("Flash size (SDK)", ESP.getFlashChipSize(), true);
+    _info_print_memory_layout_line("Reserved", 1 * SPI_FLASH_SEC_SIZE, true);
+    _info_print_memory_layout_line("Firmware size", ESP.getSketchSize());
+    _info_print_memory_layout_line("Max OTA size", info_ota_space());
+    _info_print_memory_layout_line("SPIFFS size", info_filesystem_space());
+    _info_print_memory_layout_line("EEPROM size", info_eeprom_space());
+    _info_print_memory_layout_line("Reserved", 4 * SPI_FLASH_SEC_SIZE);
     DEBUG_MSG_P(PSTR("\n"));
 
     DEBUG_MSG_P(PSTR("[INIT] EEPROM sectors: %s\n"), (char *) eepromSectors().c_str());