sdkconfig.h

Go to the documentation of this file.

 
#pragma once
 
/* ----------------------------------------------------------------------- */
/* Defined: role and feature switches this build turns ON */
/* ----------------------------------------------------------------------- */

#define CONFIG_ESP_HOSTED_ENABLED (1)

#define CONFIG_ESP_HOSTED_USE_MEMPOOL (0)

#define CONFIG_ESP_HOSTED_DFLT_TASK_STACK (4096)
 
/* ----------------------------------------------------------------------- */
/* Defined to zero: bare-#if symbols this build turns OFF */
/*                                                                          */
/* These must exist even when off, because the vendored code tests them with */
/* a bare #if and this project builds with -Wundef. */
/* ----------------------------------------------------------------------- */

#define CONFIG_H_LOWER_MEMCOPY (0)

#define CONFIG_ESP_HOSTED_WIFI_AUTO_CONNECT_ON_STA_START (0)

#define CONFIG_ESP_WIFI_ENABLE_WIFI_TX_STATS (0)

#define CONFIG_ESP_WIFI_ENABLE_WIFI_RX_STATS (0)
 
/*
 * -------------------------------------------------------------------------
 * Left UNDEFINED, on purpose. Each of these is tested with #ifdef, #ifndef or
 * `#if defined(X) && X`, so defining it -- even to zero -- would switch the
 * feature ON or change which branch compiles. They are listed here rather than
 * omitted so that "why is this not in sdkconfig.h" has an answer in the file
 * itself. Doxygen is not used on this block: a documented @def for a symbol
 * that does not exist would put a name in the generated docs that no
 * translation unit can see.
 *
 *   CONFIG_ESP_HOSTED_COPROCESSOR
 *       #ifdef, in esp_hosted_cli.{c,h}. This build is the host, not the
 *       ESP32-C6. Defining it would select the co-processor include set
 *       (iperf.h, wifi_cmd.h, host_power_save.h), none of which exists here.
 *
 *   CONFIG_ESP_HOSTED_CLI_ENABLED
 *       #ifdef, in esp_hosted_cli.h, and only consulted inside the
 *       CONFIG_ESP_HOSTED_COPROCESSOR branch: the CLI is a co-processor-side
 *       console. Leaving it undefined is what leaves H_ESP_HOSTED_CLI_ENABLED
 *       undefined, which in turn is what makes the whole body of
 *       esp_hosted_cli.c -- with its esp_console.h, freertos/, esp_wifi.h and
 *       lwip/sockets.h includes -- compile away to nothing. This is also why
 *       esp_err_to_name() is not declared in esp_err.h.
 *
 *   CONFIG_ESP_HOSTED_CLI_NEW_INSTANCE
 *       #ifdef, in esp_hosted_cli.c. Chooses between two ESP-IDF console
 *       initialisation styles inside code that is already switched off.
 *
 *   CONFIG_ESP_HOSTED_FW_VERSION_MISMATCH_WARNING_SUPPRESS
 *       #ifndef, twice in transport_drv.c. Undefined, so the warning is KEPT:
 *       a co-processor image whose esp-hosted version does not match this
 *       host's is exactly the fault this port most wants announced, and
 *       coprocessor/esp32c6/pins.env pins both ends precisely so the two agree.
 *
 *   CONFIG_ESP_WIFI_NVS_ENABLED
 *       #ifdef, in rpc_wrap.c, where it sets nvs_enable in the wifi_init RPC.
 *       Undefined: NVS is ESP-IDF's key-value store in the ESP32's own flash.
 *       This host has no NVS, and asking the co-processor to persist Wi-Fi
 *       credentials on the host's behalf is a decision the application layer
 *       should make explicitly if it ever wants it.
 *
 *   CONFIG_IDF_TARGET
 *       #ifdef, in sdio_drv.c, where its presence means "the host is itself an
 *       Espressif part" and lowers the maximum-SDIO-clock advisory from
 *       50 MHz to 40 MHz. The RA8D2 is not an Espressif part, so the symbol
 *       stays undefined and the 50 MHz branch compiles -- which is correct
 *       regardless, since SDIO is not the transport in use.
 *
 *   CONFIG_ESP_HOSTED_CP_EXT_COEX
 *   CONFIG_ESP_HOSTED_CP_EXT_COEX_ADVANCE
 *       `#if defined(X) && X`, in api/include/esp_hosted_cp_ext_coex.h. External
 *       radio coexistence needs a second radio sharing the antenna and a wired
 *       arbitration signal to it; this board has neither.
 *
 *   CONFIG_HEAP_TRACING
 *   CONFIG_FREERTOS_USE_TRACE_FACILITY
 *   CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS
 *       #ifdef / #ifndef, all in esp_hosted_cli.c. Each names an ESP-IDF or
 *       FreeRTOS instrumentation facility that does not exist in this build.
 *
 *   CONFIG_ESP_CONSOLE_UART_DEFAULT
 *   CONFIG_ESP_CONSOLE_UART_CUSTOM
 *   CONFIG_ESP_CONSOLE_USB_CDC
 *   CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
 *       #if defined / #elif defined, in esp_hosted_cli.c. They pick which
 *       ESP32 peripheral the CLI console binds to. This port's console is an
 *       RA8 SCI UART reached through esp_log.h's writer, and the CLI is off.
 * -------------------------------------------------------------------------
 */