esp-idf/docs/en/api-reference/system/index.rst

System API
**********

:link_to_translation:`zh_CN:[中文]`

.. toctree::
    :maxdepth: 1

    app_image_format
    bootloader_image_format
    app_trace
    esp_function_with_shared_stack
    chip_revision
    console
    efuse
    esp_err
    esp_https_ota
    esp_event
    freertos
    freertos_idf
    freertos_additions
    mem_alloc
    mm
    :SOC_PSRAM_DMA_CAPABLE or SOC_CACHE_INTERNAL_MEM_VIA_L1CACHE: mm_sync
    heap_debug
    esp_timer
    internal-unstable
    :SOC_HP_CPU_HAS_MULTIPLE_CORES: ipc
    intr_alloc
    log
    misc_system_api
    ota
    :CONFIG_IDF_TARGET_ARCH_XTENSA: perfmon
    power_management
    pthread
    random
    sleep_modes
    soc_caps
    system_time
    :SOC_ASYNC_MEMCPY_SUPPORTED: async_memcpy
    :esp32: himem
    :SOC_ULP_FSM_SUPPORTED: ulp
    :SOC_RISCV_COPROC_SUPPORTED: ulp-risc-v
    :SOC_LP_CORE_SUPPORTED: ulp-lp-core
    wdts


Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples.
Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01:00			`System API`
			`**********`

docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 18:50:55 +08:00			:link_to_translation:`zh_CN:[中文]`

Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01:00			`.. toctree::`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 16:01:50 +08:00			`:maxdepth: 1`
Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01:00
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 18:50:55 +08:00			`app_image_format`
esp_bootloader_format: Adds bootloader description structure to read bootloader version from app Closes https://github.com/espressif/esp-idf/issues/8800 Closes https://github.com/espressif/esp-idf/issues/9132 2022-12-14 01:16:56 +08:00			`bootloader_image_format`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 18:50:55 +08:00			`app_trace`
			`esp_function_with_shared_stack`
all: Apply new version logic (major * 100 + minor) 2022-03-17 21:58:15 +08:00			`chip_revision`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 18:50:55 +08:00			`console`
			`efuse`
			`esp_err`
			`esp_https_ota`
			`esp_event`
			`freertos`
freertos: Rename SMP changes document to ESP-IDF FreeRTOS This commit renames "freertos-smp" docuemnt to "freertos_idf". This fits better with the current dual FreeRTOS implementation (i.e., IDF FreeRTOS and Amazon SMP FreeRTOS), both of which are SMP capable. 2023-02-07 21:54:05 +08:00			`freertos_idf`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 18:50:55 +08:00			`freertos_additions`
			`mem_alloc`
doc: added memory management programming guides 2023-03-21 16:15:13 +08:00			`mm`
feat(cache): added cache msync doc 2023-09-27 13:08:28 +08:00			`:SOC_PSRAM_DMA_CAPABLE or SOC_CACHE_INTERNAL_MEM_VIA_L1CACHE: mm_sync`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 18:50:55 +08:00			`heap_debug`
			`esp_timer`
			`internal-unstable`
change(docs): Update multicore tags to SOC_HP_CPU_HAS_MULTIPLE_CORES Previously, documentation sections that were only meant for multicore ESP targets would use tags that depend on CONFIG_FREERTOS_UNICORE or CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE. This is not ideal as project configuration can be changed by the user. This commit updates those tags to use SOC_HP_CPU_HAS_MULTIPLE_CORES which is always defined in multicore targets regardless of project configuration. 2023-11-30 17:57:39 +08:00			`:SOC_HP_CPU_HAS_MULTIPLE_CORES: ipc`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 18:50:55 +08:00			`intr_alloc`
			`log`
docs: add cn trans for system.rst 2022-03-30 10:31:50 +08:00			`misc_system_api`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 18:50:55 +08:00			`ota`
			`:CONFIG_IDF_TARGET_ARCH_XTENSA: perfmon`
			`power_management`
			`pthread`
			`random`
			`sleep_modes`
docs: add cn trans for system.rst 2022-03-30 10:31:50 +08:00			`soc_caps`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 18:50:55 +08:00			`system_time`
			`:SOC_ASYNC_MEMCPY_SUPPORTED: async_memcpy`
			`:esp32: himem`
ulp: added sleep support for lp core Added support for running LP core while hp core sleeps, as well as waking up the hp core. 2023-03-09 14:14:09 +08:00			`:SOC_ULP_FSM_SUPPORTED: ulp`
docs: Updated ULP documentation This commit updates documentation for ULP. 2022-02-21 16:13:02 +05:30			`:SOC_RISCV_COPROC_SUPPORTED: ulp-risc-v`
ulp/lp-core: added docs describing the lp core 2023-06-01 10:08:31 +08:00			`:SOC_LP_CORE_SUPPORTED: ulp-lp-core`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 18:50:55 +08:00			`wdts`
docs: fix broken references to misc API functions and types. 2022-03-24 14:57:51 +08:00

Review log.rst and index.rst files in api-reference/system 2019-04-11 15:33:38 +08:00			Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples.