Re-add deprecated _SPIFFS_xxx linker symbols (#6543)

In order to give user libs a change to update to the new symbols, re-add
the _SPIFFS_XX symbols to the linker file with a comment that they are
deprecated.

Also add back spiffs_hal_xxx functions, also marked as deprecated.

Fixes #6542

Author: earlephilhower

cores/esp8266/spiffs_api.cpp

@@ -25,6 +25,21 @@
 
 using namespace fs;
 
+
+// Deprecated functions, to be deleted in next release
+int32_t spiffs_hal_write(uint32_t addr, uint32_t size, uint8_t *src) {
+    return flash_hal_write(addr, size, src);
+}
+int32_t spiffs_hal_erase(uint32_t addr, uint32_t size) {
+    return flash_hal_erase(addr, size);
+}
+int32_t spiffs_hal_read(uint32_t addr, uint32_t size, uint8_t *dst) {
+    return flash_hal_read(addr, size, dst);
+}
+
+
+
+
 namespace spiffs_impl {
 
 FileImplPtr SPIFFSImpl::open(const char* path, OpenMode openMode, AccessMode accessMode)

cores/esp8266/spiffs_api.h

@@ -39,6 +39,26 @@ extern "C" {
 
 using namespace fs;
 
+// The following are deprecated symbols and functions, to be removed at the next major release.
+// They are provided only for backwards compatibility and to give libs a chance to update.
+
+extern "C" uint32_t _SPIFFS_start __attribute__((deprecated));
+extern "C" uint32_t _SPIFFS_end __attribute__((deprecated));
+extern "C" uint32_t _SPIFFS_page __attribute__((deprecated));
+extern "C" uint32_t _SPIFFS_block __attribute__((deprecated));
+
+#define SPIFFS_PHYS_ADDR ((uint32_t) (&_SPIFFS_start) - 0x40200000)
+#define SPIFFS_PHYS_SIZE ((uint32_t) (&_SPIFFS_end) - (uint32_t) (&_SPIFFS_start))
+#define SPIFFS_PHYS_PAGE ((uint32_t) &_SPIFFS_page)
+#define SPIFFS_PHYS_BLOCK ((uint32_t) &_SPIFFS_block)
+
+extern int32_t spiffs_hal_write(uint32_t addr, uint32_t size, uint8_t *src) __attribute__((deprecated));
+extern int32_t spiffs_hal_erase(uint32_t addr, uint32_t size) __attribute__((deprecated));
+extern int32_t spiffs_hal_read(uint32_t addr, uint32_t size, uint8_t *dst) __attribute__((deprecated));
+
+
+
+
 namespace spiffs_impl {
 
 int getSpiffsMode(OpenMode openMode, AccessMode accessMode);

tools/boards.txt.py

@@ -1274,6 +1274,12 @@ def flash_map (flashsize_kb, fs_kb = 0):
         print("PROVIDE ( _FS_page = 0x%X );" % page)
         print("PROVIDE ( _FS_block = 0x%X );" % fs_blocksize)
         print("PROVIDE ( _EEPROM_start = 0x%08x );" % (0x40200000 + eeprom_start))
+        # Re-add deprecated symbols pointing to the same address as the new standard ones
+        print("/* The following symbols are DEPRECATED and will be REMOVED in a future release */")
+        print("PROVIDE ( _SPIFFS_start = 0x%08X );" % (0x40200000 + fs_start))
+        print("PROVIDE ( _SPIFFS_end = 0x%08X );" % (0x40200000 + fs_end))
+        print("PROVIDE ( _SPIFFS_page = 0x%X );" % page)
+        print("PROVIDE ( _SPIFFS_block = 0x%X );" % fs_blocksize)
         print("")
         print('INCLUDE "local.eagle.app.v6.common.ld"')
 

tools/sdk/ld/eagle.flash.16m14m.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x411FA000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x2000 );
 PROVIDE ( _EEPROM_start = 0x411fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x40400000 );
+PROVIDE ( _SPIFFS_end = 0x411FA000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.16m15m.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x411FA000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x2000 );
 PROVIDE ( _EEPROM_start = 0x411fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x40300000 );
+PROVIDE ( _SPIFFS_end = 0x411FA000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.1m.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x402FB000 );
 PROVIDE ( _FS_page = 0x0 );
 PROVIDE ( _FS_block = 0x0 );
 PROVIDE ( _EEPROM_start = 0x402fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x402FB000 );
+PROVIDE ( _SPIFFS_end = 0x402FB000 );
+PROVIDE ( _SPIFFS_page = 0x0 );
+PROVIDE ( _SPIFFS_block = 0x0 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.1m128.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x402FB000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x1000 );
 PROVIDE ( _EEPROM_start = 0x402fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x402DB000 );
+PROVIDE ( _SPIFFS_end = 0x402FB000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x1000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.1m144.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x402FB000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x1000 );
 PROVIDE ( _EEPROM_start = 0x402fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x402D7000 );
+PROVIDE ( _SPIFFS_end = 0x402FB000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x1000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.1m160.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x402FB000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x1000 );
 PROVIDE ( _EEPROM_start = 0x402fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x402D3000 );
+PROVIDE ( _SPIFFS_end = 0x402FB000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x1000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.1m192.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x402FB000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x1000 );
 PROVIDE ( _EEPROM_start = 0x402fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x402CB000 );
+PROVIDE ( _SPIFFS_end = 0x402FB000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x1000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.1m256.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x402FB000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x1000 );
 PROVIDE ( _EEPROM_start = 0x402fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x402BB000 );
+PROVIDE ( _SPIFFS_end = 0x402FB000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x1000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.1m512.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x402FB000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x2000 );
 PROVIDE ( _EEPROM_start = 0x402fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x4027B000 );
+PROVIDE ( _SPIFFS_end = 0x402FB000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.1m64.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x402FB000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x1000 );
 PROVIDE ( _EEPROM_start = 0x402fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x402EB000 );
+PROVIDE ( _SPIFFS_end = 0x402FB000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x1000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.2m.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x403FB000 );
 PROVIDE ( _FS_page = 0x0 );
 PROVIDE ( _FS_block = 0x0 );
 PROVIDE ( _EEPROM_start = 0x403fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x403FB000 );
+PROVIDE ( _SPIFFS_end = 0x403FB000 );
+PROVIDE ( _SPIFFS_page = 0x0 );
+PROVIDE ( _SPIFFS_block = 0x0 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.2m128.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x403FB000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x1000 );
 PROVIDE ( _EEPROM_start = 0x403fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x403E0000 );
+PROVIDE ( _SPIFFS_end = 0x403FB000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x1000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.2m1m.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x403FA000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x2000 );
 PROVIDE ( _EEPROM_start = 0x403fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x40300000 );
+PROVIDE ( _SPIFFS_end = 0x403FA000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.2m256.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x403FB000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x1000 );
 PROVIDE ( _EEPROM_start = 0x403fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x403C0000 );
+PROVIDE ( _SPIFFS_end = 0x403FB000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x1000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.2m512.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x403FA000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x2000 );
 PROVIDE ( _EEPROM_start = 0x403fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x40380000 );
+PROVIDE ( _SPIFFS_end = 0x403FA000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.4m.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x405FB000 );
 PROVIDE ( _FS_page = 0x0 );
 PROVIDE ( _FS_block = 0x0 );
 PROVIDE ( _EEPROM_start = 0x405fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x405FB000 );
+PROVIDE ( _SPIFFS_end = 0x405FB000 );
+PROVIDE ( _SPIFFS_page = 0x0 );
+PROVIDE ( _SPIFFS_block = 0x0 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.4m1m.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x405FA000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x2000 );
 PROVIDE ( _EEPROM_start = 0x405fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x40500000 );
+PROVIDE ( _SPIFFS_end = 0x405FA000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.4m2m.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x405FA000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x2000 );
 PROVIDE ( _EEPROM_start = 0x405fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x40400000 );
+PROVIDE ( _SPIFFS_end = 0x405FA000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.4m3m.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x405FA000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x2000 );
 PROVIDE ( _EEPROM_start = 0x405fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x40300000 );
+PROVIDE ( _SPIFFS_end = 0x405FA000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.512k.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x4027B000 );
 PROVIDE ( _FS_page = 0x0 );
 PROVIDE ( _FS_block = 0x0 );
 PROVIDE ( _EEPROM_start = 0x4027b000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x4027B000 );
+PROVIDE ( _SPIFFS_end = 0x4027B000 );
+PROVIDE ( _SPIFFS_page = 0x0 );
+PROVIDE ( _SPIFFS_block = 0x0 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.512k128.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x4027B000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x1000 );
 PROVIDE ( _EEPROM_start = 0x4027b000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x4025B000 );
+PROVIDE ( _SPIFFS_end = 0x4027B000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x1000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.512k32.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x4027B000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x1000 );
 PROVIDE ( _EEPROM_start = 0x4027b000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x40273000 );
+PROVIDE ( _SPIFFS_end = 0x4027B000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x1000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.512k64.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x4027B000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x1000 );
 PROVIDE ( _EEPROM_start = 0x4027b000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x4026B000 );
+PROVIDE ( _SPIFFS_end = 0x4027B000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x1000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.8m6m.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x409FA000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x2000 );
 PROVIDE ( _EEPROM_start = 0x409fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x40400000 );
+PROVIDE ( _SPIFFS_end = 0x409FA000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"

tools/sdk/ld/eagle.flash.8m7m.ld

@@ -19,5 +19,10 @@ PROVIDE ( _FS_end = 0x409FA000 );
 PROVIDE ( _FS_page = 0x100 );
 PROVIDE ( _FS_block = 0x2000 );
 PROVIDE ( _EEPROM_start = 0x409fb000 );
+/* The following symbols are DEPRECATED and will be REMOVED in a future release */
+PROVIDE ( _SPIFFS_start = 0x40300000 );
+PROVIDE ( _SPIFFS_end = 0x409FA000 );
+PROVIDE ( _SPIFFS_page = 0x100 );
+PROVIDE ( _SPIFFS_block = 0x2000 );
 
 INCLUDE "local.eagle.app.v6.common.ld"