OVMS3-idf/docs
Michael (XIAO Xufeng) 44bd6f72bc 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-04 21:35:20 +08:00
..
_static Added CN version of 'Getting Started' guides for 'ESP32-DevKitC' and 'ESP-WROVER-KIT' 2018-10-22 09:10:58 +08:00
en spi: fix the crash when callbacks are not in the IRAM 2018-12-04 21:35:20 +08:00
zh_CN (doc)update_CN/EN_partition_tables 2018-11-05 18:58:54 +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 Fix Python 3 compatibility issues 2018-10-24 11:20:54 +02:00
docs_common.mk Fix Python 3 compatibility issues 2018-10-24 11:20:54 +02:00
Doxyfile event: Implement event loop library 2018-10-26 13:14:19 +08:00
gen-dxd.py docs: Make the Python scripts Python 2&3 compatible 2018-09-10 08:37:43 +02:00
gen-toolchain-links.py docs: fix instructions for building toolchain on macOS 2018-10-26 12:42:38 +08:00
gen-version-specific-includes.py Fix Python 3 compatibility issues 2018-10-24 11:20:54 +02:00
issue_template.md doc: include compiler version in issue template 2018-10-26 12:47:32 +08:00
link-roles.py docs: Make the Python scripts Python 2&3 compatible 2018-09-10 08:37:43 +02:00
local_util.py docs: Make the Python scripts Python 2&3 compatible 2018-09-10 08:37:43 +02:00
README.md Replace all DOS line endings with Unix 2018-07-12 19:10:37 +08:00
requirements.txt Encourage to install python packages without administrative rights 2018-09-11 08:54:37 +02: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
TEMPLATE_EXAMPLE_README.md docs: Add "Creating Examples" docs page, template example README 2018-06-14 16:49:22 +10: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.