esp-idf/docs/en/api-guides/index.rst

API Guides
**********
:link_to_translation:`zh_CN:[中文]`

.. toctree::
   :maxdepth: 1

   General Notes <general-notes>
   Build System <build-system>
   Build System (Legacy GNU Make) <build-system-legacy>
   Error Handling <error-handling>
   Fatal Errors <fatal-errors>
   Event Handling <event-handling>
   Deep Sleep Wake Stubs <deep-sleep-stub>
   ESP32 Core Dump <core_dump>
   Flash Encryption <../security/flash-encryption>
   FreeRTOS SMP Changes <freertos-smp>
   Thread Local Storage <thread-local-storage>
   High Level Interrupts <hlinterrupts>
   JTAG Debugging <jtag-debugging/index>
   Bootloader <bootloader>
   Partition Tables <partition-tables>
   Secure Boot <../security/secure-boot>
   ULP Coprocessor <ulp>
   ULP Coprocessor (Legacy GNU Make) <ulp-legacy>
   Unit Testing <unit-tests>
   Unit Testing (Legacy GNU Make) <unit-tests-legacy>
   Application Level Tracing <app_trace>
   Console Component <console>
   ROM debug console <romconsole>
   RF Calibration <RF_calibration>
   WiFi Driver <wifi>
   ESP-MESH <mesh>
   BluFi <blufi>
   External SPI-connected RAM <external-ram>
   Linker Script Generation <linker-script-generation>
   Tools <tools/index>
Getting started guides 2017-03-27 00:01:52 +02:00			`API Guides`
			`**********`
Included missing links between English and Chinese documentation, where translation into Chinese is available 2019-01-27 19:01:34 +01:00			:link_to_translation:`zh_CN:[中文]`
Getting started guides 2017-03-27 00:01:52 +02:00
			`.. toctree::`
			`:maxdepth: 1`

			`General Notes <general-notes>`
			`Build System <build-system>`
docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used 2019-06-25 11:26:53 +10:00			`Build System (Legacy GNU Make) <build-system-legacy>`
docs: add pages about error handling 2018-06-11 20:49:35 +08:00			`Error Handling <error-handling>`
			`Fatal Errors <fatal-errors>`
docs: add event handling API guide 2018-11-21 15:56:06 +08:00			`Event Handling <event-handling>`
JTAG Debugging - revamping of Debugging documentation 2017-06-11 21:12:30 +02:00			`Deep Sleep Wake Stubs <deep-sleep-stub>`
Getting started guides 2017-03-27 00:01:52 +02:00			`ESP32 Core Dump <core_dump>`
			`Flash Encryption <../security/flash-encryption>`
docs: Added documentation for FreeRTOS SMP changes Added documentation about the ESP-IDF changes to FreeRTOS. The documentation covers changes to the following FreeRTOS aspects. - Task Creation - Affects on scheduling (Task skipping, scheduler suspension, tick synchronicity) - Critical sections and disabling interrupts - Thread Local Storage Pointers and deletion callbacks - Configuring ESP-IDF FreeRTOS 2017-09-08 19:50:15 +08:00			`FreeRTOS SMP Changes <freertos-smp>`
freertos: Adds C11 TLS support 2018-02-05 01:06:45 +03:00			`Thread Local Storage <thread-local-storage>`
Break out high-level interrupts so a component can override them 2017-04-18 17:14:32 +08:00			`High Level Interrupts <hlinterrupts>`
JTAG Debugging - revamping of Debugging documentation 2017-06-11 21:12:30 +02:00			`JTAG Debugging <jtag-debugging/index>`
bootloader: Refactoring Need to make the bootloader modular so that users can redefine its functional part. - refactoring and moving functions to the bootloader_support component - Changed function to `void` bootloader_utility_load_image(...); TW19596 2018-04-16 20:35:41 +05:00			`Bootloader <bootloader>`
JTAG Debugging - revamping of Debugging documentation 2017-06-11 21:12:30 +02:00			`Partition Tables <partition-tables>`
Getting started guides 2017-03-27 00:01:52 +02:00			`Secure Boot <../security/secure-boot>`
			`ULP Coprocessor <ulp>`
docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used 2019-06-25 11:26:53 +10:00			`ULP Coprocessor (Legacy GNU Make) <ulp-legacy>`
Getting started guides 2017-03-27 00:01:52 +02:00			`Unit Testing <unit-tests>`
docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used 2019-06-25 11:26:53 +10:00			`Unit Testing (Legacy GNU Make) <unit-tests-legacy>`
esp32: SEGGER SystemView Tracing Support Implements support for system level traces compatible with SEGGER SystemView tool on top of ESP32 application tracing module. That kind of traces can help to analyse program's behaviour. SystemView can show timeline of tasks/ISRs execution, context switches, statistics related to the CPUs' load distribution etc. Also this commit adds useful feature to ESP32 application tracing module: - Trace data buffering is implemented to handle temporary peaks of events load 2017-03-22 06:07:37 +03:00			`Application Level Tracing <app_trace>`
add console component and example 2017-08-15 16:11:19 +08:00			`Console Component <console>`
Some documentation for the undocumented ROM console. 2017-06-29 19:01:50 +08:00			`ROM debug console <romconsole>`
doc: add documentation for RF calibration Add an API to erase phy namespace of NVS 2018-11-29 16:07:28 +08:00			`RF Calibration <RF_calibration>`
docs: add wifi.rst Add more documents about WiFi API/Event Mechanism/State Machine etc 2017-05-03 19:21:08 +08:00			`WiFi Driver <wifi>`
docs/rewrite_mesh_docs The following commit rewrites the ESP-MESH docs. This commit includes new diagrams and a structure approach to the mesh docs. Some mesh api references have also been modified. 2018-06-26 20:48:47 +08:00			`ESP-MESH <mesh>`
Update index.rst 2018-06-04 14:24:10 +08:00			`BluFi <blufi>`
Add logic to make external RAM usable with malloc() 2017-09-22 16:02:39 +08:00			`External SPI-connected RAM <external-ram>`
doc: add documentation for RF calibration Add an API to erase phy namespace of NVS 2018-11-29 16:07:28 +08:00			`Linker Script Generation <linker-script-generation>`
docs: add tools section and IDF docker image page 2019-07-17 11:35:28 +02:00			`Tools <tools/index>`