Merge remote-tracking branch 'origin/master' into ralio_update_mercury_board

Author: mcspr

.github/workflows/build-ide.yml

@@ -52,7 +52,6 @@ jobs:
     - name: Build Sketches
       env:
         ESP8266_ARDUINO_BUILDER: "arduino"
-        ESP8266_ARDUINO_IDE: "${{ runner.temp }}/arduino_ide"
         ESP8266_ARDUINO_LWIP: ${{ matrix.lwip }}
       run: |
         bash ./tests/build.sh 8 ${{ matrix.chunk }}
@@ -75,8 +74,6 @@ jobs:
         key: ${{ runner.os }}-${{ hashFiles('package/package_esp8266com_index.template.json', 'tests/common.sh', 'tests/build.sh') }}
     - name: Build Sketch
       env:
-        ESP8266_ARDUINO_HARDWARE: "${{ runner.temp }}/hardware"
-        ESP8266_ARDUINO_IDE: "${{ runner.temp }}/arduino_ide"
         ESP8266_ARDUINO_SKETCHES: "libraries/esp8266/examples/Blink/Blink.ino"
       run: |
         bash ./tests/build.sh
@@ -100,8 +97,6 @@ jobs:
         key: ${{ runner.os }}-${{ hashFiles('package/package_esp8266com_index.template.json', 'tests/common.sh', 'tests/build.sh') }}
     - name: Build Sketch
       env:
-        ESP8266_ARDUINO_HARDWARE: "${{ runner.temp }}/hardware"
-        ESP8266_ARDUINO_IDE: "${{ runner.temp }}/arduino_ide"
         ESP8266_ARDUINO_SKETCHES: "libraries/esp8266/examples/Blink/Blink.ino"
       run: |
         bash ./tests/build.sh

cores/esp8266/Esp-version.cpp

@@ -20,10 +20,11 @@
 
 #include <Arduino.h>
 #include <user_interface.h>
-#include <core_version.h>
 #include <lwipopts.h>       // LWIP_HASH_STR (lwip2)
 #include <bearssl/bearssl_git.h>  // BEARSSL_GIT short hash
 
+#include <core_version.h>
+
 #define STRHELPER(x) #x
 #define STR(x) STRHELPER(x) // stringifier
 

cores/esp8266/Esp.cpp

@@ -254,7 +254,7 @@ String EspClass::getCoreVersion()
         return String(core_release);
     }
     char buf[12];
-    snprintf(buf, sizeof(buf), "%08x", core_version);
+    snprintf(buf, sizeof(buf), PSTR("%08x"), core_version);
     return String(buf);
 }
 

cores/esp8266/StackThunk.cpp

@@ -73,6 +73,7 @@ void stack_thunk_add_ref()
     }
     stack_thunk_top = stack_thunk_ptr + _stackSize - 1;
     stack_thunk_save = NULL;
+    stack_thunk_yield_save = NULL;
     stack_thunk_repaint();
   }
 }
@@ -90,6 +91,7 @@ void stack_thunk_del_ref()
     stack_thunk_ptr = NULL;
     stack_thunk_top = NULL;
     stack_thunk_save = NULL;
+    stack_thunk_yield_save = NULL;
   }
 }
 
@@ -175,15 +177,18 @@ asm(
     "movi         a2, stack_thunk_yield_save\n\t"
     "s32i.n       a1, a2, 0\n\t"
     "movi         a2, stack_thunk_save\n\t"
+/* But, only when inside of bssl stack (saved a1 != 0) */
+    "l32i.n       a3, a2, 0\n\t"
+    "beqz         a3, stack_thunk_yield_do_yield\n\t"
     "l32i.n       a1, a2, 0\n\t"
 /* optimistic_yield(10000) without extra l32r */
+"stack_thunk_yield_do_yield:\n\t"
     "movi         a2, 0x10\n\t"
     "addmi        a2, a2, 0x2700\n\t"
     "call0        optimistic_yield\n\t"
 /* Swap bearssl <-> cont stacks, again */
     "movi         a2, stack_thunk_yield_save\n\t"
     "l32i.n       a1, a2, 0\n\t"
-    "\n"
 /* Restore caller */
     "l32i.n       a0, a1, 12\n\t"
     "addi         a1, a1, 16\n\t"

cores/esp8266/StackThunk.h

@@ -27,6 +27,8 @@
 #ifndef _STACKTHUNK_H
 #define _STACKTHUNK_H
 
+#include <stdint.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -80,9 +82,11 @@ thunk_"#fcnToThunk":\n\
   call0 stack_thunk_fatal_smashing\n\
 .L1"#fcnToThunk":\n\
   movi a15, stack_thunk_save  /* Restore A1(SP) */\n\
-  l32i.n a1, a15, 0\n\
-  l32i.n a15, a1, 8     /* Restore the saved registers */\n\
-  l32i.n a0, a1, 12\n\
+  l32i.n a1, a15, 0/* Restore A1(SP) */\n\
+  movi a0, 0 /* Purge temporary storage */\n\
+  s32i.n a0, a15, 0\n\
+  l32i.n a15, a1, 8/* Restore A15 */\n\
+  l32i.n a0, a1, 12/* Restore A0 */\n\
   addi a1, a1, 16       /* Free up stack and return to caller */\n\
   ret\n\
 .size thunk_"#fcnToThunk", . - thunk_"#fcnToThunk"\n");

doc/conf.py

@@ -34,7 +34,9 @@
 extensions = [
     'nbsphinx',
     'sphinx.ext.mathjax',
+    'sphinx_rtd_theme',
 ]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -49,8 +51,9 @@
 
 # General information about the project.
 project = u'ESP8266 Arduino Core'
-copyright = u'2017, Ivan Grokhotkov'
+slug = re.sub(r'\W+', '-', project.lower())
 author = u'Ivan Grokhotkov'
+copyright = author
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -71,7 +74,13 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_venv', '_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = [
+    '_readthedocs',
+    '_venv',
+    '_build',
+    'Thumbs.db',
+    '.DS_Store',
+]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -85,7 +94,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'default'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -98,12 +107,12 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-
 # -- Options for HTMLHelp output ------------------------------------------
 
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'ESP8266ArduinoCoredoc'
+html_show_sourcelink = True
 
+# Output file base name for HTML help builder.
+htmlhelp_basename = slug
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -129,8 +138,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'ESP8266ArduinoCore.tex', u'ESP8266 Arduino Core Documentation',
-     u'Ivan Grokhotkov', 'manual'),
+    (master_doc, f'{slug}.tex', f'{project} Documentation', author, 'manual'),
 ]
 
 
@@ -139,8 +147,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'esp8266arduinocore', u'ESP8266 Arduino Core Documentation',
-     [author], 1)
+    (master_doc, slug, f'{project} Documentation', [author], 1)
 ]
 
 
@@ -150,19 +157,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'ESP8266ArduinoCore', u'ESP8266 Arduino Core Documentation',
-     author, 'ESP8266ArduinoCore', 'One line description of project.',
-     'Miscellaneous'),
+    (master_doc, slug, f'{project} Documentation', author, slug, project, 'Miscellaneous'),
 ]
 
 linkcheck_anchors_ignore = ["/#!"]
-
-# -- Use sphinx_rtd_theme for local builds --------------------------------
-# ref. https://github.com/snide/sphinx_rtd_theme#using-this-theme-locally-then-building-on-read-the-docs
-#
-# on_rtd is whether we are on readthedocs.org
-env_readthedocs = os.environ.get('READTHEDOCS', None)
-
-if not env_readthedocs:  # only import and set the theme if we're building docs locally
-    import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'

doc/faq/readme.rst renamed to doc/faq.rst

@@ -13,14 +13,14 @@ Please feel free to contribute if you believe that some frequent issues
 are not covered below.
 
 
-I am getting "espcomm\_sync failed" error when trying to upload my ESP. How to resolve this issue?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+I am getting "espcomm\_sync failed", "esptool.FatalError", etc. How to resolve this issue?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This message indicates issue with uploading ESP module over a serial
 connection. There are couple of possible causes, that depend on the type
 of your module, if you use separate USB to serial converter.
 
-`Read more <a01-espcomm_sync-failed.rst>`__.
+`Read more <faq/a01-upload-failed.rst>`__.
 
 Why esptool is not listed in "Programmer" menu? How do I upload ESP without it?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -38,7 +38,7 @@ My ESP crashes running some code. How to troubleshoot it?
 The code may crash because of s/w bug or issue with your h/w. Before
 entering an issue report, please perform initial troubleshooting.
 
-`Read more <a02-my-esp-crashes.rst>`__.
+`Read more <faq/a02-my-esp-crashes.rst>`__.
 
 How can I get some extra KBs in flash ?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -50,7 +50,7 @@ How can I get some extra KBs in flash ?
 
 * Use the debug level option ``NoAssert-NDEBUG`` (in the Tools menu)
 
-`Read more <a05-board-generator.rst>`__.
+`Read more <faq/a05-board-generator.rst>`__.
 
 About WPS
 ~~~~~~~~~
@@ -63,7 +63,7 @@ required to enable it:
 
 ``./tools/boards.txt.py --allowWPS --boardsgen``
 
-`Read more <a05-board-generator.rst>`__.
+`Read more <faq/a05-board-generator.rst>`__.
 
 For platformIO (and maybe other build environments), you will also need to add the build flag: -D NO_EXTRA_4K_HEAP
 
@@ -77,7 +77,7 @@ This Arduino library doesn't work on ESP. How do I make it work?
 You would like to use this Arduino library with ESP8266 and it does not
 perform. It is not listed among libraries verified to work with ESP8266.
 
-`Read more <a03-library-does-not-work.rst>`__.
+`Read more <faq/a03-library-does-not-work.rst>`__.
 
 In the IDE, for ESP-12E that has 4M flash, I can choose 4M (1M FS) or 4M (3M FS). No matter what I select, the IDE tells me the maximum code space is about 1M. Where does my flash go?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -118,7 +118,7 @@ This error may pop up after switching between
 `staging <https://github.com/esp8266/Arduino#staging-version->`__ and
 `stable <https://github.com/esp8266/Arduino#stable-version->`__ esp8266
 / Arduino package installations, or after upgrading the package version
-`Read more <a04-board-generic-is-unknown.rst>`__.
+`Read more <faq/a04-board-generic-is-unknown.rst>`__.
 
 
 How to clear TCP PCBs in time-wait state ?
@@ -199,4 +199,4 @@ By using a uniquely named `.h` file, macro definitions can be created and
 globally used. Additionally, compiler command-line options can be embedded in
 this file as a unique block comment.
 
-`Read more <a06-global-build-options.rst>`__.
+`Read more <faq/a06-global-build-options.rst>`__.