Loading...
Searching...
No Matches
sdkconfig.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2022 Gunar Schorcht
3 * SPDX-License-Identifier: LGPL-2.1-only
4 */
5
6#pragma once
7
20
21/*
22 * The SoC capability definitions are often included indirectly in the
23 * ESP-IDF files, although all ESP-IDF files require them. Since not all
24 * ESP-IDF header files are included in RIOT, the SoC capability definitions
25 * are unknown if they are only indirectly included. Therefore, the SoC
26 * capabilities are included in this file and are thus available to all
27 * ESP-IDF files. This avoids to update vendor code.
28 */
29#ifndef LD_FILE_GEN
30# include "soc/soc_caps.h"
31#endif
32
38#if !defined(IDF_VER)
39# include "esp_idf_ver.h"
40#endif
41
42#ifndef DOXYGEN
43
50#ifdef CONFIG_CONSOLE_UART_NUM
51# define CONFIG_ESP_CONSOLE_UART_NUM CONFIG_CONSOLE_UART_NUM
52#else
53# define CONFIG_ESP_CONSOLE_UART_NUM 0
54#endif
55#define CONFIG_ESP_CONSOLE_UART_BAUDRATE STDIO_UART_BAUDRATE
56
57#define CONFIG_ESP_CONSOLE_ROM_SERIAL_PORT_NUM CONFIG_ESP_CONSOLE_UART_NUM
58
62#ifndef CONFIG_LOG_DEFAULT_LEVEL
63# define CONFIG_LOG_DEFAULT_LEVEL LOG_LEVEL
64#endif
65#define CONFIG_LOG_MAXIMUM_LEVEL LOG_LEVEL
66
70#if MODULE_NEWLIB_NANO
71# define CONFIG_NEWLIB_NANO_FORMAT 1
72#endif
73
74#define CONFIG_ESP_SYSTEM_CHECK_INT_LEVEL_4 1
75#define CONFIG_ESP_SYSTEM_EVENT_QUEUE_SIZE 32
76#define CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE 2560
77#define CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE 1
78
79#define CONFIG_ESP_TIME_FUNCS_USE_ESP_TIMER 1
80#define CONFIG_ESP_TIMER_TASK_STACK_SIZE 3584
81#define CONFIG_ESP_TIMER_INTERRUPT_LEVEL 1
82#define CONFIG_ESP_TIMER_TASK_AFFINITY 0
83#define CONFIG_ESP_TIMER_ISR_AFFINITY_CPU0 1
84
85#define CONFIG_TIMER_TASK_STACK_SIZE CONFIG_ESP_TIMER_TASK_STACK_SIZE
86
87#define CONFIG_APP_BUILD_TYPE_APP_2NDBOOT 1
88#define CONFIG_APP_BUILD_GENERATE_BINARIES 1
89#define CONFIG_APP_BUILD_BOOTLOADER 1
90#define CONFIG_APP_BUILD_USE_FLASH_SECTIONS 1
91#define CONFIG_APP_COMPILE_TIME_DATE 1
92#define CONFIG_APP_EXCLUDE_PROJECT_VER_VAR 1
93#define CONFIG_APP_RETRIEVE_LEN_ELF_SHA 9
94
95#define CONFIG_PARTITION_TABLE_CUSTOM_FILENAME "partitions.csv"
96#define CONFIG_PARTITION_TABLE_FILENAME "partitions_singleapp.csv"
97#define CONFIG_PARTITION_TABLE_SINGLE_APP 1
98#define CONFIG_PARTITION_TABLE_OFFSET 0x8000
99
103#if MODULE_ESP_BLE
104# define CONFIG_BT_ENABLED 1
105# define CONFIG_BT_CONTROLLER_ENABLED 1
106# define CONFIG_BT_CONTROLLER_ONLY 1
107# define CONFIG_SOC_BT_SUPPORTED SOC_BT_SUPPORTED
108# define CONFIG_SOC_PM_SUPPORT_BT_PD SOC_PM_SUPPORT_BT_PD
109# define CONFIG_SOC_PM_SUPPORT_BT_WAKEUP SOC_PM_SUPPORT_BT_WAKEUP
110#endif
111
115#if MODULE_ESP_IEEE802154
116# define CONFIG_IEEE802154_ENABLED 1
117# define CONFIG_IEEE802154_CCA_ED 1
118# define CONFIG_IEEE802154_CCA_MODE 1
119# define CONFIG_IEEE802154_CCA_THRESHOLD -60
120# define CONFIG_IEEE802154_PENDING_TABLE_SIZE 20
121# define CONFIG_IEEE802154_RX_BUFFER_SIZE 20
122#endif
123
127#if MODULE_ESP_SPI_RAM
128# define CONFIG_SPIRAM 1
129# define CONFIG_SPIRAM_TYPE_AUTO 1
130# define CONFIG_SPIRAM_SIZE -1
131# define CONFIG_SPIRAM_SPEED_40M 1
132# define CONFIG_SPIRAM_SPEED 40
133# define CONFIG_SPIRAM_BOOT_INIT 1
134# define CONFIG_SPIRAM_USE_MALLOC 1 /* using malloc requires QStaticQueue */
135# define CONFIG_SPIRAM_USE_CAPS_ALLOC 0 /* using cap instead of malloc */
136# define CONFIG_SPIRAM_MEMTEST 1
137# define CONFIG_SPIRAM_MALLOC_ALWAYSINTERNAL 16384
138# define CONFIG_SPIRAM_MALLOC_RESERVE_INTERNAL 32768
139# define CONFIG_SOC_SPIRAM_SUPPORTED SOC_SPIRAM_SUPPORTED
140# define CONFIG_ESP_SLEEP_PSRAM_LEAKAGE_WORKAROUND 1
141#endif
142
146#define CONFIG_SPI_FLASH_ROM_DRIVER_PATCH 1
147#define CONFIG_SPI_FLASH_DANGEROUS_WRITE_ABORTS 1
148#define CONFIG_SPI_FLASH_YIELD_DURING_ERASE 1
149#define CONFIG_SPI_FLASH_ERASE_YIELD_DURATION_MS 20
150#define CONFIG_SPI_FLASH_ERASE_YIELD_TICKS 1
151#define CONFIG_SPI_FLASH_WRITE_CHUNK_SIZE 8192
152
153/*
154 * Flash chip drivers as enabled by default in ESP-IDF for the respective SoC,
155 * has to be consistent with the drivers compiled in esp-idf/spi_flash/Makefile
156 */
157#define CONFIG_SPI_FLASH_SUPPORT_GD_CHIP 1
158#if defined(CPU_FAM_ESP32) || defined(CPU_FAM_ESP32S2) || \
159 defined(CPU_FAM_ESP32S3) || defined(CPU_FAM_ESP32C3)
160# define CONFIG_SPI_FLASH_SUPPORT_ISSI_CHIP 1
161# define CONFIG_SPI_FLASH_SUPPORT_MXIC_CHIP 1
162# define CONFIG_SPI_FLASH_SUPPORT_WINBOND_CHIP 1
163#endif
164#if defined(CPU_FAM_ESP32S2) || defined(CPU_FAM_ESP32S3) || defined(CPU_FAM_ESP32C3)
165# define CONFIG_SPI_FLASH_SUPPORT_BOYA_CHIP 1
166# define CONFIG_SPI_FLASH_SUPPORT_TH_CHIP 1
167#endif
168#if defined(CPU_FAM_ESP32S3)
169# define CONFIG_SPI_FLASH_SUPPORT_MXIC_OPI_CHIP 1
170#endif
171
175#if MODULE_ESP_RTC_TIMER_32K
176# define CONFIG_RTC_CLK_SRC_EXT_CRYS 1
177# define CONFIG_ESP_SYSTEM_RTC_EXT_XTAL 1
178# ifndef CONFIG_RTC_CLK_CAL_CYCLES
179/* the 32 kHz crystal requires more cycles for calibration (ESP-IDF default) */
180# define CONFIG_RTC_CLK_CAL_CYCLES 3000
181# endif
182#else
183# define CONFIG_RTC_CLK_SRC_INT_RC 1
184#endif
185
189#if MODULE_ESP_ETH
190# define CONFIG_ETH_ENABLED 1
191#endif
192
196#if !defined(CONFIG_FLASHMODE_DOUT) && \
197 !defined(CONFIG_FLASHMODE_DIO) && \
198 !defined(CONFIG_FLASHMODE_QOUT) && \
199 !defined(CONFIG_FLASHMODE_QIO)
200# error "Flash mode not configured"
201#endif
202
206#if MODULE_ESP_WIFI_ANY
207# define CONFIG_ESP_WIFI_ENABLED 1
208# define CONFIG_ESP_WIFI_AMPDU_RX_ENABLED 1
209# define CONFIG_ESP_WIFI_AMPDU_TX_ENABLED 1
210# define CONFIG_ESP_WIFI_AUTH_WPA2_PSK 1
211# define CONFIG_ESP_WIFI_CACHE_TX_BUFFER_NUM 32
212# define CONFIG_ESP_WIFI_DYNAMIC_RX_BUFFER_NUM 32
213# define CONFIG_ESP_WIFI_DYNAMIC_RX_MGMT_BUF 0
214# define CONFIG_ESP_WIFI_DYNAMIC_TX_BUFFER 1
215# define CONFIG_ESP_WIFI_DYNAMIC_TX_BUFFER_NUM 32
216# define CONFIG_ESP_WIFI_ENABLE_SAE_PK 0 /* default 1 for WPA3 */
217# define CONFIG_ESP_WIFI_ENABLE_WPA3_OWE_STA 0 /* default 1 for WPA3 */
218# define CONFIG_ESP_WIFI_ENABLE_WPA3_SAE 0 /* default 1 for WPA3 */
219# define CONFIG_ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM 7
220# define CONFIG_ESP_WIFI_GMAC_SUPPORT 1
221# define CONFIG_ESP_WIFI_IRAM_OPT 0 /* default 1 */
222# define CONFIG_ESP_WIFI_MBEDTLS_CRYPTO 0 /* default 1 for WPA3 */
223# define CONFIG_ESP_WIFI_MBEDTLS_TLS_CLIENT 0 /* default 1 for WPA3 */
224# define CONFIG_ESP_WIFI_MGMT_SBUF_NUM 32
225# define CONFIG_ESP_WIFI_NVS_ENABLED MODULE_ESP_IDF_NVS_FLASH
226# define CONFIG_ESP_WIFI_PW_ID ""
227# define CONFIG_ESP_WIFI_RX_BA_WIN 6
228# define CONFIG_ESP_WIFI_RX_IRAM_OPT 0 /* default 1 */
229# define CONFIG_ESP_WIFI_RX_MGMT_BUF_NUM_DEF 5
230# define CONFIG_ESP_WIFI_SOFTAP_BEACON_MAX_LEN 752
231# define CONFIG_ESP_WIFI_STA_DISCONNECTED_PM_ENABLE 1
232# define CONFIG_ESP_WIFI_STATIC_RX_BUFFER_NUM 10
233# define CONFIG_ESP_WIFI_STATIC_RX_MGMT_BUFFER 1
234# define CONFIG_ESP_WIFI_TASK_PINNED_TO_CORE_0 1
235# define CONFIG_ESP_WIFI_TX_BA_WIN 6
236# define CONFIG_ESP_WIFI_TX_BUFFER_TYPE 1
237
238# define CONFIG_CRYPTO_INTERNAL 1
239
240# if MODULE_ESP_WIFI_AP || MODULE_ESP_NOW
241# define CONFIG_ESP_WIFI_SOFTAP_SUPPORT 1
242# endif
243
244# if MODULE_ESP_WIFI_ENTERPRISE
245# define CONFIG_ESP_WIFI_ENTERPRISE_SUPPORT 1
246# endif
247
248#endif
249
250#define CONFIG_ESP_WIFI_SLP_DEFAULT_MAX_ACTIVE_TIME 10
251#define CONFIG_ESP_WIFI_SLP_DEFAULT_MIN_ACTIVE_TIME 50
252#define CONFIG_ESP_WIFI_SLP_DEFAULT_WAIT_BROADCAST_DATA_TIME 15
253
257#if SOC_PHY_SUPPORTED
258# define CONFIG_ESP_PHY_ENABLED 1
259# define CONFIG_ESP_PHY_CALIBRATION_MODE 0
260# define CONFIG_ESP_PHY_MAX_TX_POWER 20
261# define CONFIG_ESP_PHY_MAX_WIFI_TX_POWER 20
262# define CONFIG_ESP_PHY_RF_CAL_PARTIAL 1
263# if MODULE_ESP_IDF_NVS_FLASH
264# define CONFIG_ESP_PHY_CALIBRATION_AND_DATA_STORAGE 1
265# endif
266#endif
267
271#if !SOC_WIRELESS_HOST_SUPPORTED
272# define CONFIG_ESP_COEX_ENABLED 1
273 /*
274 * As in ESP-IDF, the software coexistence is enabled if at least two
275 * of the radio modules WiFi, BT and IEEE 802.15.4 are used. For WiFi
276 * and IEEE 802.15.4 it is even required, since the IEEE 802.15.4 radio
277 * blocks the RF in receive mode otherwise.
278 */
279# if (CONFIG_ESP_WIFI_ENABLED && CONFIG_BT_ENABLED) || \
280 (CONFIG_ESP_WIFI_ENABLED && CONFIG_IEEE802154_ENABLED) || \
281 (CONFIG_IEEE802154_ENABLED && CONFIG_BT_ENABLED)
282# define CONFIG_ESP_COEX_SW_COEXIST_ENABLE 1
283 /*
284 * CONFIG_SW_COEXIST_ENABLE is the deprecated name of this option,
285 * which is still used by ESP-IDF code. As in the sdkconfig.h generated
286 * by ESP-IDF, it is defined as alias.
287 */
288# define CONFIG_SW_COEXIST_ENABLE CONFIG_ESP_COEX_SW_COEXIST_ENABLE
289# if CONFIG_IEEE802154_ENABLED
290 /* required for the declaration of the IEEE 802.15.4 coexistence API */
291# define CONFIG_SOC_IEEE802154_SUPPORTED SOC_IEEE802154_SUPPORTED
292# endif
293# endif
294#endif /* !SOC_WIRELESS_HOST_SUPPORTED */
295
299#ifndef CONFIG_ESP_FLASHPAGE_CAPACITY
300
301#if MODULE_PERIPH_FLASHPAGE
302# if CONFIG_ESP_FLASHPAGE_CAPACITY_64K
303# define CONFIG_ESP_FLASHPAGE_CAPACITY 0x10000
304# elif CONFIG_ESP_FLASHPAGE_CAPACITY_128K
305# define CONFIG_ESP_FLASHPAGE_CAPACITY 0x20000
306# elif CONFIG_ESP_FLASHPAGE_CAPACITY_256K
307# define CONFIG_ESP_FLASHPAGE_CAPACITY 0x40000
308# elif CONFIG_ESP_FLASHPAGE_CAPACITY_512K
309# define CONFIG_ESP_FLASHPAGE_CAPACITY 0x80000
310# elif CONFIG_ESP_FLASHPAGE_CAPACITY_1M
311# define CONFIG_ESP_FLASHPAGE_CAPACITY 0x100000
312# elif CONFIG_ESP_FLASHPAGE_CAPACITY_2M
313# define CONFIG_ESP_FLASHPAGE_CAPACITY 0x200000
314# else
315# define CONFIG_ESP_FLASHPAGE_CAPACITY 0x80000
316# endif
317#else /* MODULE_PERIPH_FLASHPAGE */
318# define CONFIG_ESP_FLASHPAGE_CAPACITY 0x0
319#endif /* MODULE_PERIPH_FLASHPAGE */
320
321#endif /* !CONFIG_ESP_FLASHPAGE_CAPACITY */
322
326#if MODULE_ESP_IDF_LCD
327# ifndef CONFIG_LCD_DATA_BUF_SIZE
328# define CONFIG_LCD_DATA_BUF_SIZE 512
329# endif
330# define CONFIG_LCD_PANEL_IO_FORMAT_BUF_SIZE CONFIG_LCD_DATA_BUF_SIZE
331#endif
332
336#if defined(CPU_FAM_ESP32)
337# include "sdkconfig_esp32.h"
338#elif defined(CPU_FAM_ESP32C3)
339# include "sdkconfig_esp32c3.h"
340#elif defined(CPU_FAM_ESP32C6)
341# include "sdkconfig_esp32c6.h"
342#elif defined(CPU_FAM_ESP32H2)
343# include "sdkconfig_esp32h2.h"
344#elif defined(CPU_FAM_ESP32S2)
345# include "sdkconfig_esp32s2.h"
346#elif defined(CPU_FAM_ESP32S3)
347# include "sdkconfig_esp32s3.h"
348#else
349# error "ESP32x family implementation missing"
350#endif
351
356#ifndef CONFIG_RTC_CLK_CAL_CYCLES
357# define CONFIG_RTC_CLK_CAL_CYCLES 1024
358#endif
359
360#ifndef CONFIG_MMU_PAGE_SIZE
361# define CONFIG_MMU_PAGE_SIZE_64KB 1
362# define CONFIG_MMU_PAGE_SIZE 0x10000
363#endif
364
365#ifndef CONFIG_FREERTOS_NUMBER_OF_CORES
366# define CONFIG_FREERTOS_NUMBER_OF_CORES 1
367#endif
368
369#define CONFIG_ESP_DEBUG_OCDAWARE 1
370
371#define CONFIG_ADC_SUPPRESS_DEPRECATE_WARN 1
372
373#define CONFIG_HEAP_POISONING_DISABLED 1
374#define CONFIG_HEAP_TRACING_OFF 1
375#define CONFIG_LOG_TAG_LEVEL_CACHE_BINARY_MIN_HEAP 1
376
377#define CONFIG_ULP_COPROC_RESERVE_MEM 0
378
379#ifdef SOC_RTC_MEM_SUPPORTED
380# define CONFIG_SOC_RTC_MEM_SUPPORTED 1
381#endif
382#ifdef SOC_RTC_FAST_MEM_SUPPORTED
383# define CONFIG_SOC_RTC_FAST_MEM_SUPPORTED 1
384#endif
385#ifdef SOC_RTC_SLOW_SUPPORTED
386# define CONFIG_SOC_RTC_SLOW_MEM_SUPPORTED 1
387#endif
388
392#ifdef SOC_SDMMC_HOST_SUPPORTED
393# define CONFIG_SOC_SDMMC_HOST_SUPPORTED SOC_SDMMC_HOST_SUPPORTED
394# define CONFIG_SOC_SDMMC_DELAY_PHASE_NUM SOC_SDMMC_DELAY_PHASE_NUM
395# define CONFIG_SOC_SDMMC_NUM_SLOTS SOC_SDMMC_NUM_SLOTS
396# define CONFIG_SOC_SDMMC_SUPPORT_XTAL_CLOCK SOC_SDMMC_SUPPORT_XTAL_CLOCK
397# define CONFIG_SOC_SDMMC_USE_GPIO_MATRIX SOC_SDMMC_USE_GPIO_MATRIX
398# define CONFIG_SOC_SDMMC_USE_IOMUX SOC_SDMMC_USE_IOMUX
399#endif /* SOC_SDMMC_HOST_SUPPORTED */
400
404#ifdef SOC_USB_SERIAL_JTAG_SUPPORTED
405# ifndef CONFIG_ESP_CONSOLE_SECONDARY_USB_SERIAL_JTAG
406# define CONFIG_ESP_CONSOLE_SECONDARY_USB_SERIAL_JTAG 1
407# endif
408# ifndef CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
409# define CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG 0
410# endif
411# define CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG_ENABLED (CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG || \
412 CONFIG_ESP_CONSOLE_SECONDARY_USB_SERIAL_JTAG)
413# define CONFIG_SOC_EFUSE_DIS_USB_JTAG SOC_EFUSE_DIS_USB_JTAG
414# define CONFIG_SOC_EFUSE_HARD_DIS_JTAG SOC_EFUSE_HARD_DIS_JTAG
415# define CONFIG_SOC_EFUSE_SOFT_DIS_JTAG SOC_EFUSE_SOFT_DIS_JTAG
416# define CONFIG_SOC_USB_SERIAL_JTAG_SUPPORTED 1
417# define CONFIG_USJ_ENABLE_USB_SERIAL_JTAG CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG_ENABLED
418#endif /* SOC_USB_SERIAL_JTAG_SUPPORTED */
419
420/* should be RIOT_APPLICATION but PROJECT_NAME must be less than 24 characters */
421#define PROJECT_NAME "RIOT-OS Application"
422
423#endif /* DOXYGEN */
424
425#ifdef __cplusplus
426extern "C" {
427#endif
428
429#ifdef __cplusplus
430}
431#endif
432
SDK configuration used by the ESP-IDF for ESP32 SoC variant (family)
SDK configuration used by the ESP-IDF for ESP32-C3 SoC variant (family)
SDK configuration used by the ESP-IDF for ESP32-C6 SoC variant (family)
SDK configuration used by the ESP-IDF for ESP32-H2 SoC variant (family)
SDK configuration used by the ESP-IDF for ESP32-S2 SoC variant (family)
SDK configuration used by the ESP-IDF for ESP32-S3 SoC variant (family)