Allow reverting SDK by using boards.txt.py

This commit allows switching SDK firmware:

Some boards show erratic behavior (radio connection is quickly lost), with
an unknown cause, when using nonos-sdk-pre-v3 (shipped with release 2.5.0).

These boards work well with previous nonos-sdk-2.2.1 firmware.

Current firmware, which has brought long awaited fixes (WiFi sleep modes),
stays as default.

To switch:
           ./tools/boards.txt.py --sdk=NONOSDK221 --allgen
(default)  ./tools/boards.txt.py --sdk=NONOSDK3V0 --allgen

BREAKING for external build systems:
    new directories to add
        lib:     tools/sdk/lib/<version>/lib
        include: tools/sdk/lib/<version>/include

Fix esp8266#5736

Author: d-a-v

libraries/ESP8266WiFi/src/ESP8266WiFiGeneric.cpp

@@ -249,6 +249,13 @@ int32_t ESP8266WiFiGenericClass::channel(void) {
  * @param type sleep_type_t
  * @return bool
  */
+#ifdef NONOSDK221
+bool ESP8266WiFiGenericClass::setSleepMode(WiFiSleepType_t type, uint8_t listenInterval) {
+    (void)type;
+    (void)listenInterval;
+    return false;
+}
+#else // !defined(NONOSDK221)
 bool ESP8266WiFiGenericClass::setSleepMode(WiFiSleepType_t type, uint8_t listenInterval) {
 
    /**
@@ -315,6 +322,7 @@ bool ESP8266WiFiGenericClass::setSleepMode(WiFiSleepType_t type, uint8_t listenI
     }
     return ret;
 }
+#endif // !defined(NONOSDK221)
 
 /**
  * get Sleep mode
@@ -499,15 +507,23 @@ bool ESP8266WiFiGenericClass::forceSleepWake() {
  * @return interval
  */
 uint8_t ESP8266WiFiGenericClass::getListenInterval () {
+#ifdef NONOSDK221
+    return 0;
+#else
     return wifi_get_listen_interval();
+#endif
 }
 
 /**
  * Get sleep level of modem sleep and light sleep
  * @return true if max level
  */
 bool ESP8266WiFiGenericClass::isSleepLevelMax () {
+#ifdef NONOSDK221
+    return false;
+#else
     return wifi_get_sleep_level() == MAX_SLEEP_T;
+#endif
 }
 
 

libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp

@@ -138,7 +138,9 @@ wl_status_t ESP8266WiFiSTAClass::begin(const char* ssid, const char *passphrase,
     }
 
     conf.threshold.rssi = -127;
+#ifndef NONOSDK221
     conf.open_and_wep_mode_disable = !(_useInsecureWEP || *conf.password == 0);
+#endif
 
     if(bssid) {
         conf.bssid_set = 1;

platform.txt

@@ -30,18 +30,22 @@ build.stdcpp_lib=-lstdc++
 build.float=-u _printf_float -u _scanf_float
 build.led=
 
+# build.sdk: available: NONOSDK221 NONOSDK3V0 NONOSDK3V1
+build.sdk=NONOSDK3V0
+
 compiler.path={runtime.tools.xtensa-lx106-elf-gcc.path}/bin/
 compiler.sdk.path={runtime.platform.path}/tools/sdk
+
 compiler.libc.path={runtime.platform.path}/tools/sdk/libc/xtensa-lx106-elf
-compiler.cpreprocessor.flags=-D__ets__ -DICACHE_FLASH -U__STRICT_ANSI__ "-I{compiler.sdk.path}/include" "-I{compiler.sdk.path}/{build.lwip_include}" "-I{compiler.libc.path}/include" "-I{build.path}/core"
+compiler.cpreprocessor.flags=-D__ets__ -DICACHE_FLASH -U__STRICT_ANSI__ "-I{compiler.sdk.path}/include" "-I{compiler.sdk.path}/lib/{build.sdk}/include" "-I{compiler.sdk.path}/{build.lwip_include}" "-I{compiler.libc.path}/include" "-I{build.path}/core"
 
 compiler.c.cmd=xtensa-lx106-elf-gcc
 compiler.c.flags=-c {compiler.warning_flags} -Os -g -Wpointer-arith -Wno-implicit-function-declaration -Wl,-EL -fno-inline-functions -nostdlib -mlongcalls -mtext-section-literals -falign-functions=4 -MMD -std=gnu99 -ffunction-sections -fdata-sections {build.exception_flags}
 
 compiler.S.cmd=xtensa-lx106-elf-gcc
 compiler.S.flags=-c -g -x assembler-with-cpp -MMD -mlongcalls
 
-compiler.c.elf.flags=-g {compiler.warning_flags} -Os -nostdlib -Wl,--no-check-sections -u app_entry {build.float} -Wl,-static "-L{compiler.sdk.path}/lib" "-L{compiler.sdk.path}/ld" "-L{compiler.libc.path}/lib" "-T{build.flash_ld}" -Wl,--gc-sections -Wl,-wrap,system_restart_local -Wl,-wrap,spi_flash_read
+compiler.c.elf.flags=-g {compiler.warning_flags} -Os -nostdlib -Wl,--no-check-sections -u app_entry {build.float} -Wl,-static "-L{compiler.sdk.path}/lib" "-L{compiler.sdk.path}/lib/{build.sdk}" "-L{compiler.sdk.path}/ld" "-L{compiler.libc.path}/lib" "-T{build.flash_ld}" -Wl,--gc-sections -Wl,-wrap,system_restart_local -Wl,-wrap,spi_flash_read
 
 compiler.c.elf.cmd=xtensa-lx106-elf-gcc
 compiler.c.elf.libs=-lhal -lphy -lpp -lnet80211 {build.lwip_lib} -lwpa -lcrypto -lmain -lwps -lbearssl -laxtls -lespnow -lsmartconfig -lairkiss -lwpa2 {build.stdcpp_lib} -lm -lc -lgcc

tools/boards.txt.py

@@ -1404,6 +1404,8 @@ def all_boards ():
 
         if nofloat:
             print(id + '.build.float=')
+        if not sdk == sdkdefault:
+            print(id + '.build.sdk=' + sdk)
 
         print('')
 
@@ -1498,12 +1500,13 @@ def usage (name,ret):
     print("usage: %s [options]" % name)
     print("")
     print(" -h, --help")
-    print(" --lwip          - preferred default lwIP version (default %d)" % lwip)
-    print(" --led           - preferred default builtin led for generic boards (default %d)" % led_default)
-    print(" --board b       - board to modify:")
-    print(" --speed s       - change default serial speed")
-    print(" --customspeed s - new serial speed for all boards")
-    print(" --nofloat       - disable float support in printf/scanf")
+    print(" --lwip            - preferred default lwIP version (default %d)" % lwip)
+    print(" --led             - preferred default builtin led for generic boards (default %d)" % led_default)
+    print(" --board <b>       - board to modify:")
+    print(" --speed <s>       - change default serial speed")
+    print(" --customspeed <s> - new serial speed for all boards")
+    print(" --nofloat         - disable float support in printf/scanf")
+    print(" --sdk <sdkdir>    - default: %s" % sdkdefault)
     print("")
     print(" mandatory option (at least one):")
     print("")
@@ -1542,6 +1545,8 @@ def usage (name,ret):
 ################################################################
 # entry point
 
+sdkdefault = 'NONOSDK3V0'
+sdk = sdkdefault
 lwip = 2
 default_speed = '115'
 led_default = 2
@@ -1563,6 +1568,7 @@ def usage (name,ret):
 try:
     opts, args = getopt.getopt(sys.argv[1:], "h",
         [ "help", "lwip=", "led=", "speed=", "board=", "customspeed=", "nofloat",
+          "sdk=",
           "noextra4kheap", "allowWPS",
           "ld", "ldgen", "boards", "boardsgen", "package", "packagegen", "doc", "docgen",
           "allgen"] )
@@ -1607,10 +1613,16 @@ def usage (name,ret):
     elif o in ("--nofloat"):
         nofloat=True
 
+    elif o in ("--sdk"):
+        if not os.path.isdir('tools/sdk/lib/' + a):
+            print('cannot find sdk directory tools/sdk/lib/' + a + '/')
+            sys.exit(1)
+        sdk = a
+
     elif o in ("--noextra4kheap", "--allowWPS"):
         print('option ' + o + ' is now deprecated, without effect, and will be removed')
 
-    elif o in ("--ldshow"):
+    elif o in ("--ld"):
         ldshow = True
 
     elif o in ("--ldgen"):