OVMS3-idf/docs
Michael (XIAO Xufeng) 3387d751d9 spi: fix the crash when callbacks are not in the IRAM
Introduced in 9c23b8e5 and 4f87a62f. To get higher speed, menuconfig
options are added to put ISR and other functions into the IRAM.  The
interrupt flag ESP_INTR_FLAG_IRAM is also mistakenly set when the ISR is
put into the IRAM. However callbacks, which are wrote by the user, are
called in the master and slave ISR. The user may not be aware of that
these callbacks are not disabled during flash operations. Any cache miss
during flash operation will cause panic.

Essentially IRAM functions and intrrupt flag ESP_INTR_FLAG_IRAM are
different, the latter means not disabling the ISR during flash
operations.  New bus_config flag intr_flags is offered to help set the
interrupt attribute, including priority level, SHARED, IRAM (not
disabled during flash operations).  It introduced a small BREAK to
IDFv3.1 (but the same as IDFv3.0) that the user has to manually set IRAM
flag now (therefore he's aware of the IRAM thing) to void the ISR being
disabled during flash operations.
2018-12-05 10:25:57 +08:00
..
_static docs/rewrite_mesh_docs 2018-09-03 13:03:32 +08:00
en spi: fix the crash when callbacks are not in the IRAM 2018-12-05 10:25:57 +08:00
zh_CN esp32: abort when running on single core chip in dual core mode 2018-09-27 13:35:11 +08:00
check_doc_warnings.sh Adjusted CI configuration to handle 'en' and 'zh_CN' language versions 2018-03-13 22:07:31 +01:00
check_lang_folder_sync.sh Revert "docs: Temporarily allow cmake docs to be in English only" 2018-05-07 18:45:49 +08:00
conf_common.py Merge branch 'release/v3.1' into feature/cmake_v3.1 2018-08-17 14:14:10 +10:00
docs_common.mk docs: Move version-related includes to run in sphinx-build not make 2018-08-13 16:01:20 +10:00
Doxyfile esp_https_ota: Add support for HTTPS based ota feature 2018-08-08 14:55:22 +05:30
gen-dxd.py Adjusted Sphinx configuration to handle 'en' and 'zh_CN' language versions 2018-03-13 22:07:31 +01:00
gen-version-specific-includes.py docs: Move version-related includes to run in sphinx-build not make 2018-08-13 16:01:20 +10:00
issue_template.md docs: Switch base URL from esp-idf.readthedocs.io to docs.espressif.com 2018-06-19 11:23:33 +00:00
kconfiglib.py Fail CI build on Sphinx warnings 2017-09-12 07:12:57 +02:00
link-roles.py Implemented docutils custom role that renders a link to current documentation page on Read The Docs in another language version 2018-05-21 10:30:07 +08:00
local_util.py docs: speed up incremental builds 2018-03-07 17:45:15 +08:00
README.md docs: Switch base URL from esp-idf.readthedocs.io to docs.espressif.com 2018-06-19 11:23:33 +00:00
requirements.txt docs : Add support for markdown files 2018-01-15 13:58:31 +08:00
sphinx-known-warnings.txt Upgraded Sphinx to latest release 1.6.5 that contains a fix to https://github.com/sphinx-doc/sphinx/issues/4041. Upgraded Breathe to latest release 4.7.3 as well. 2017-10-31 22:57:39 +01:00

Documentation Source Folder

This folder contains source files of ESP-IDF documentation available in English and 中文.

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated within about 20 minutes on each commit:

Hosted Documentation

The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.