Merge branch 'bugfix/minor_doc_fixes' into 'master'
Documentation fixes See merge request idf/esp-idf!3529
This commit is contained in:
Angus Gratton
commit
a51d5706f6
|
|
@ -17,6 +17,12 @@ Timer callbacks are dispatched from a high-priority ``esp_timer`` task. Because
|
|||
|
||||
.. note: Provisions are made to dispatch some simple callbacks directly from the interrupt handler, if needed. However this option is not implemented at the moment.
|
||||
|
||||
If other tasks with priority higher than ``esp_timer`` are running, callback dispatching will be delayed until ``esp_timer`` task has a chance to run. For example, this will happen if a SPI Flash operation is in progress.
|
||||
|
||||
Creating and starting a timer, and dispatching the callback takes some time. Therefore there is a lower limit to the timeout value of one-shot ``esp_timer``. If :cpp:func:`esp_timer_start_once` is called with a timeout value less than 20us, the callback will be dispatched only after approximately 20us.
|
||||
|
||||
Periodic ``esp_timer`` also imposes a 50us restriction on the minimal timer period. Periodic software timers with period of less than 50us are not practical since they would consume most of the CPU time. Consider using dedicated hardware peripherals or DMA features if you find that a timer with small period is required.
|
||||
|
||||
Using ``esp_timer`` APIs
|
||||
------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -51,12 +51,14 @@ Compile the Toolchain from Source
|
|||
|
||||
TODO
|
||||
|
||||
Download ``crosstool-NG`` and build it::
|
||||
Create the working directory and go into it::
|
||||
|
||||
cd ~/esp
|
||||
git clone -b xtensa-1.22.x https://github.com/espressif/crosstool-NG.git
|
||||
cd crosstool-NG
|
||||
./bootstrap && ./configure --enable-local && make install
|
||||
mkdir -p ~/esp
|
||||
cd ~/esp
|
||||
|
||||
Download ``crosstool-NG`` and build it:
|
||||
|
||||
.. include:: /_build/inc/scratch-build-code.inc
|
||||
|
||||
Build the toolchain::
|
||||
|
||||
|
|
|
|||
|
|
@ -27,21 +27,27 @@ To compile with ESP-IDF you need to get the following packages:
|
|||
Toolchain Setup
|
||||
===============
|
||||
|
||||
.. include:: /_build/inc/download-links.inc
|
||||
|
||||
ESP32 toolchain for Linux is available for download from Espressif website:
|
||||
|
||||
- for 64-bit Linux:
|
||||
|
||||
https://dl.espressif.com/dl/xtensa-esp32-elf-linux64-1.22.0-80-g6c4433a-5.2.0.tar.gz
|
||||
|download_link_linux64|
|
||||
|
||||
- for 32-bit Linux:
|
||||
|
||||
https://dl.espressif.com/dl/xtensa-esp32-elf-linux32-1.22.0-80-g6c4433a-5.2.0.tar.gz
|
||||
|download_link_linux32|
|
||||
|
||||
1. Download this file, then extract it in ``~/esp`` directory::
|
||||
1. Download this file, then extract it in ``~/esp`` directory:
|
||||
|
||||
mkdir -p ~/esp
|
||||
cd ~/esp
|
||||
tar -xzf ~/Downloads/xtensa-esp32-elf-linux64-1.22.0-80-g6c4433a-5.2.0.tar.gz
|
||||
- for 64-bit Linux:
|
||||
|
||||
.. include:: /_build/inc/unpack-code-linux64.inc
|
||||
|
||||
- for 32-bit Linux:
|
||||
|
||||
.. include:: /_build/inc/unpack-code-linux32.inc
|
||||
|
||||
.. _setup-linux-toolchain-add-it-to-path-cmake:
|
||||
|
||||
|
|
|
|||
|
|
@ -14,6 +14,8 @@ MacPorts needs a full XCode installation, while homebrew only needs XCode comman
|
|||
.. _homebrew: https://brew.sh/
|
||||
.. _MacPorts: https://www.macports.org/install.php
|
||||
|
||||
See :ref:`Customized Setup of Toolchain <get-started-customized-setup>` section for some of the reasons why installing the toolchain from scratch may be necessary.
|
||||
|
||||
Install Prerequisites
|
||||
=====================
|
||||
|
||||
|
|
@ -58,15 +60,16 @@ Mount it::
|
|||
|
||||
Create a symlink to your work directory::
|
||||
|
||||
cd ~/esp
|
||||
ln -s /Volumes/ctng crosstool-NG
|
||||
mkdir -p ~/esp
|
||||
ln -s /Volumes/ctng ~/esp/ctng-volume
|
||||
|
||||
Download ``crosstool-NG`` and build it::
|
||||
Go into the newly created directory::
|
||||
|
||||
cd ~/esp
|
||||
git clone -b xtensa-1.22.x https://github.com/espressif/crosstool-NG.git
|
||||
cd crosstool-NG
|
||||
./bootstrap && ./configure --enable-local && make install
|
||||
cd ~/esp/ctng-volume
|
||||
|
||||
Download ``crosstool-NG`` and build it:
|
||||
|
||||
.. include:: /_build/inc/scratch-build-code.inc
|
||||
|
||||
Build the toolchain::
|
||||
|
||||
|
|
@ -74,7 +77,7 @@ Build the toolchain::
|
|||
./ct-ng build
|
||||
chmod -R u+w builds/xtensa-esp32-elf
|
||||
|
||||
Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup <setup-macos-toolchain-add-it-to-path-cmake>` to add the toolchain to your ``PATH``.
|
||||
Toolchain will be built in ``~/esp/ctng-volume/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup <setup-macos-toolchain-add-it-to-path-cmake>` to add the toolchain to your ``PATH``.
|
||||
|
||||
|
||||
Next Steps
|
||||
|
|
|
|||
|
|
@ -41,15 +41,15 @@ ESP-IDF will use the version of Python installed by default on Mac OS.
|
|||
Toolchain Setup
|
||||
===============
|
||||
|
||||
.. include:: /_build/inc/download-links.inc
|
||||
|
||||
ESP32 toolchain for macOS is available for download from Espressif website:
|
||||
|
||||
https://dl.espressif.com/dl/xtensa-esp32-elf-osx-1.22.0-80-g6c4433a-5.2.0.tar.gz
|
||||
|download_link_osx|
|
||||
|
||||
Download this file, then extract it in ``~/esp`` directory::
|
||||
Download this file, then extract it in ``~/esp`` directory:
|
||||
|
||||
mkdir -p ~/esp
|
||||
cd ~/esp
|
||||
tar -xzf ~/Downloads/xtensa-esp32-elf-osx-1.22.0-80-g6c4433a-5.2.0.tar.gz
|
||||
.. include:: /_build/inc/unpack-code-osx.inc
|
||||
|
||||
.. _setup-macos-toolchain-add-it-to-path-cmake:
|
||||
|
||||
|
|
|
|||
|
|
@ -54,9 +54,11 @@ This tool will also need to be unzipped to a directory which is then `added to y
|
|||
Toolchain Setup
|
||||
===============
|
||||
|
||||
Download the precompiled Windows toolchain from dl.espressif.com:
|
||||
.. include:: /_build/inc/download-links.inc
|
||||
|
||||
https://dl.espressif.com/dl/xtensa-esp32-elf-win32-1.22.0-80-g6c4433a-5.2.0.zip
|
||||
Download the precompiled Windows toolchain:
|
||||
|
||||
|download_link_win32|
|
||||
|
||||
Unzip the zip file to ``C:\Program Files`` (or some other location). The zip file contains a single directory ``xtensa-esp32-elf``.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
Setup Linux Toolchain from Scratch
|
||||
**********************************
|
||||
|
||||
The following instructions are alternative to downloading binary toolchain from Espressif website. To quickly setup the binary toolchain, instead of compiling it yourself, backup and proceed to section :doc:`linux-setup`.
|
||||
|
||||
.. note::
|
||||
|
||||
Standard process for installing the toolchain is described :doc:`here <linux-setup>`. See :ref:`Customized Setup of Toolchain <get-started-customized-setup>` section for some of the reasons why installing the toolchain from scratch may be necessary.
|
||||
|
||||
Install Prerequisites
|
||||
=====================
|
||||
|
|
@ -49,6 +50,11 @@ Compile the Toolchain from Source
|
|||
|
||||
TODO
|
||||
|
||||
Create the working directory and go into it::
|
||||
|
||||
mkdir -p ~/esp
|
||||
cd ~/esp
|
||||
|
||||
Download ``crosstool-NG`` and build it:
|
||||
|
||||
.. include:: /_build/inc/scratch-build-code.inc
|
||||
|
|
|
|||
|
|
@ -2,6 +2,10 @@
|
|||
Setup Toolchain for Mac OS from Scratch
|
||||
***************************************
|
||||
|
||||
.. note::
|
||||
|
||||
Standard process for installing the toolchain is described :doc:`here <macos-setup>`. See :ref:`Customized Setup of Toolchain <get-started-customized-setup>` section for some of the reasons why installing the toolchain from scratch may be necessary.
|
||||
|
||||
Install Prerequisites
|
||||
=====================
|
||||
|
||||
|
|
@ -41,8 +45,12 @@ Mount it::
|
|||
|
||||
Create a symlink to your work directory::
|
||||
|
||||
cd ~/esp
|
||||
ln -s /Volumes/ctng crosstool-NG
|
||||
mkdir -p ~/esp
|
||||
ln -s /Volumes/ctng ~/esp/ctng-volume
|
||||
|
||||
Go into the newly created directory::
|
||||
|
||||
cd ~/esp/ctng-volume
|
||||
|
||||
Download ``crosstool-NG`` and build it:
|
||||
|
||||
|
|
@ -54,7 +62,7 @@ Build the toolchain::
|
|||
./ct-ng build
|
||||
chmod -R u+w builds/xtensa-esp32-elf
|
||||
|
||||
Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup <setup-macos-toolchain-add-it-to-path>` to add the toolchain to your ``PATH``.
|
||||
Toolchain will be built in ``~/esp/ctng-volume/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup <setup-macos-toolchain-add-it-to-path>` to add the toolchain to your ``PATH``.
|
||||
|
||||
|
||||
Next Steps
|
||||
|
|
|
|||
|
|
@ -166,7 +166,7 @@ For example, to follow the branch for ESP-IDF v3.1, including any bugfixes for f
|
|||
git fetch
|
||||
git checkout release/v3.1
|
||||
git pull
|
||||
git submodule --update --init --recursive
|
||||
git submodule update --init --recursive
|
||||
|
||||
Each time you ``git pull`` this branch, ESP-IDF will be updated with fixes for this release.
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,6 @@ def main():
|
|||
scratch_build_code_linux_macos = """
|
||||
::
|
||||
|
||||
cd ~/esp
|
||||
git clone -b xtensa-1.22.x https://github.com/espressif/crosstool-NG.git
|
||||
cd crosstool-NG
|
||||
./bootstrap && ./configure --enable-local && make install
|
||||
|
|
|
|||
|
|
@ -2,7 +2,9 @@
|
|||
从零开始设置 Linux 环境下的工具链
|
||||
**********************************
|
||||
|
||||
除了直接从 Espressif 官网下载二进制格式的工具链，下面将再介绍一种可替代的办法。如果想要快速设置二进制工具链而不是手动从源码编译，请做好备份，并前往 :doc:`Linux 环境下的设置 <linux-setup>` 章节。
|
||||
.. note::
|
||||
|
||||
安装工具链的标准流程可以通过阅读文档 :doc:`Linux 平台工具链的标准设置 <linux-setup>` 来获得，:ref:`工具链的自定义设置 <get-started-customized-setup>` 章节会介绍哪些情况下我们必须要重新定义工具链。
|
||||
|
||||
|
||||
安装必要的工具
|
||||
|
|
@ -48,6 +50,12 @@
|
|||
|
||||
TODO
|
||||
|
||||
新建工作目录，然后进入::
|
||||
|
||||
mkdir -p ~/esp
|
||||
cd ~/esp
|
||||
|
||||
|
||||
下载 ``crosstool-NG`` 然后编译:
|
||||
|
||||
.. include:: /_build/inc/scratch-build-code.inc
|
||||
|
|
|
|||
|
|
@ -2,6 +2,10 @@
|
|||
从零开始设置 Mac OS 环境下的工具链
|
||||
**********************************
|
||||
|
||||
.. note::
|
||||
|
||||
安装工具链的标准流程可以通过阅读文档 :doc:`在 MacOS 上安装 ESP32 工具链 <macos-setup>` 来获得， :ref:`工具链的自定义设置 <get-started-customized-setup>` 章节会介绍哪些情况下我们必须要重新定义工具链。
|
||||
|
||||
安装必要的工具
|
||||
=====================
|
||||
|
||||
|
|
@ -41,8 +45,12 @@
|
|||
|
||||
创建指向你工作目录的符号链接::
|
||||
|
||||
cd ~/esp
|
||||
ln -s /Volumes/ctng crosstool-NG
|
||||
mkdir -p ~/esp
|
||||
ln -s /Volumes/ctng ~/esp/ctng-volume
|
||||
|
||||
进入新创建的工作目录::
|
||||
|
||||
cd ~/esp/ctng-volume
|
||||
|
||||
下载 ``crosstool-NG`` 然后编译:
|
||||
|
||||
|
|
@ -54,7 +62,7 @@
|
|||
./ct-ng build
|
||||
chmod -R u+w builds/xtensa-esp32-elf
|
||||
|
||||
编译得到的工具链会被保存到 ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``。根据 :ref:`Mac OS 下设置环境变量的标准方法 <setup-macos-toolchain-add-it-to-path>` 中的介绍，将工具链添加到 ``PATH`` 中。
|
||||
编译得到的工具链会被保存到 ``~/esp/ctng-volume/crosstool-NG/builds/xtensa-esp32-elf``。根据 :ref:`Mac OS 下设置环境变量的标准方法 <setup-macos-toolchain-add-it-to-path>` 中的介绍，将工具链添加到 ``PATH`` 中。
|
||||
|
||||
|
||||
下一步
|
||||
|
|
|
|||
Loading…
Reference in a new issue