sdkconfig.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2022 Gunar Schorcht
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
9 #pragma once
10 
24 /*
25  * The SoC capability definitions are often included indirectly in the
26  * ESP-IDF files, although all ESP-IDF files require them. Since not all
27  * ESP-IDF header files are included in RIOT, the SoC capability definitions
28  * are unknown if they are only indirectly included. Therefore, the SoC
29  * capabilities are included in this file and are thus available to all
30  * ESP-IDF files. This avoids to update vendor code.
31  */
32 #ifndef LD_FILE_GEN
33 # include "soc/soc_caps.h"
34 #endif
35 
41 #if !defined(IDF_VER)
42 # include "esp_idf_ver.h"
43 #endif
44 
45 #ifndef DOXYGEN
46 
53 #ifdef CONFIG_CONSOLE_UART_NUM
54 # define CONFIG_ESP_CONSOLE_UART_NUM CONFIG_CONSOLE_UART_NUM
55 #else
56 # define CONFIG_ESP_CONSOLE_UART_NUM 0
57 #endif
58 #define CONFIG_ESP_CONSOLE_UART_BAUDRATE STDIO_UART_BAUDRATE
59 
60 #define CONFIG_ESP_CONSOLE_ROM_SERIAL_PORT_NUM CONFIG_ESP_CONSOLE_UART_NUM
61 
65 #ifndef CONFIG_LOG_DEFAULT_LEVEL
66 # define CONFIG_LOG_DEFAULT_LEVEL LOG_LEVEL
67 #endif
68 #define CONFIG_LOG_MAXIMUM_LEVEL LOG_LEVEL
69 
73 #if MODULE_NEWLIB_NANO
74 # define CONFIG_NEWLIB_NANO_FORMAT 1
75 #endif
76 
77 #define CONFIG_ESP_SYSTEM_CHECK_INT_LEVEL_4 1
78 #define CONFIG_ESP_SYSTEM_EVENT_QUEUE_SIZE 32
79 #define CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE 2560
80 #define CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE 1
81 
82 #define CONFIG_ESP_TIME_FUNCS_USE_ESP_TIMER 1
83 #define CONFIG_ESP_TIMER_TASK_STACK_SIZE 3584
84 #define CONFIG_ESP_TIMER_INTERRUPT_LEVEL 1
85 #define CONFIG_ESP_TIMER_TASK_AFFINITY 0
86 #define CONFIG_ESP_TIMER_ISR_AFFINITY_CPU0 1
87 
88 #define CONFIG_TIMER_TASK_STACK_SIZE CONFIG_ESP_TIMER_TASK_STACK_SIZE
89 
90 #define CONFIG_APP_BUILD_TYPE_APP_2NDBOOT 1
91 #define CONFIG_APP_BUILD_GENERATE_BINARIES 1
92 #define CONFIG_APP_BUILD_BOOTLOADER 1
93 #define CONFIG_APP_BUILD_USE_FLASH_SECTIONS 1
94 #define CONFIG_APP_COMPILE_TIME_DATE 1
95 #define CONFIG_APP_EXCLUDE_PROJECT_VER_VAR 1
96 #define CONFIG_APP_RETRIEVE_LEN_ELF_SHA 9
97 
98 #define CONFIG_PARTITION_TABLE_CUSTOM_FILENAME "partitions.csv"
99 #define CONFIG_PARTITION_TABLE_FILENAME "partitions_singleapp.csv"
100 #define CONFIG_PARTITION_TABLE_SINGLE_APP 1
101 #define CONFIG_PARTITION_TABLE_OFFSET 0x8000
102 
106 #if MODULE_ESP_BLE
107 # define CONFIG_BT_ENABLED 1
108 # define CONFIG_BT_CONTROLLER_ENABLED 1
109 # define CONFIG_BT_CONTROLLER_ONLY 1
110 # define CONFIG_SOC_BT_SUPPORTED SOC_BT_SUPPORTED
111 # define CONFIG_SOC_PM_SUPPORT_BT_PD SOC_PM_SUPPORT_BT_PD
112 # define CONFIG_SOC_PM_SUPPORT_BT_WAKEUP SOC_PM_SUPPORT_BT_WAKEUP
113 #endif
114 
118 #if MODULE_ESP_IEEE802154
119 # define CONFIG_IEEE802154_ENABLED 1
120 # define CONFIG_IEEE802154_CCA_ED 1
121 # define CONFIG_IEEE802154_CCA_MODE 1
122 # define CONFIG_IEEE802154_CCA_THRESHOLD -60
123 # define CONFIG_IEEE802154_PENDING_TABLE_SIZE 20
124 # define CONFIG_IEEE802154_RX_BUFFER_SIZE 20
125 #endif
126 
130 #if MODULE_ESP_SPI_RAM
131 # define CONFIG_SPIRAM 1
132 # define CONFIG_SPIRAM_TYPE_AUTO 1
133 # define CONFIG_SPIRAM_SIZE -1
134 # define CONFIG_SPIRAM_SPEED_40M 1
135 # define CONFIG_SPIRAM_SPEED 40
136 # define CONFIG_SPIRAM_BOOT_INIT 1
137 # define CONFIG_SPIRAM_USE_MALLOC 1 /* using malloc requires QStaticQueue */
138 # define CONFIG_SPIRAM_USE_CAPS_ALLOC 0 /* using cap instead of malloc */
139 # define CONFIG_SPIRAM_MEMTEST 1
140 # define CONFIG_SPIRAM_MALLOC_ALWAYSINTERNAL 16384
141 # define CONFIG_SPIRAM_MALLOC_RESERVE_INTERNAL 32768
142 # define CONFIG_SOC_SPIRAM_SUPPORTED SOC_SPIRAM_SUPPORTED
143 # define CONFIG_ESP_SLEEP_PSRAM_LEAKAGE_WORKAROUND 1
144 #endif
145 
149 #define CONFIG_SPI_FLASH_ROM_DRIVER_PATCH 1
150 #define CONFIG_SPI_FLASH_DANGEROUS_WRITE_ABORTS 1
151 #define CONFIG_SPI_FLASH_YIELD_DURING_ERASE 1
152 #define CONFIG_SPI_FLASH_ERASE_YIELD_DURATION_MS 20
153 #define CONFIG_SPI_FLASH_ERASE_YIELD_TICKS 1
154 #define CONFIG_SPI_FLASH_WRITE_CHUNK_SIZE 8192
155 #define CONFIG_SPI_FLASH_SUPPORT_ISSI_CHIP 1
156 #define CONFIG_SPI_FLASH_SUPPORT_MXIC_CHIP 1
157 #define CONFIG_SPI_FLASH_SUPPORT_GD_CHIP 1
158 #define CONFIG_SPI_FLASH_SUPPORT_WINBOND_CHIP 1
159 #define CONFIG_SPI_FLASH_SUPPORT_BOYA_CHIP 1
160 #define CONFIG_SPI_FLASH_SUPPORT_TH_CHIP 1
161 #define CONFIG_SPI_FLASH_SUPPORT_MXIC_OPI_CHIP 1
162 
166 #if MODULE_ESP_RTC_TIMER_32K
167 # define CONFIG_RTC_CLK_SRC_EXT_CRYS 1
168 #else
169 # define CONFIG_RTC_CLK_SRC_INT_RC 1
170 #endif
171 
175 #if MODULE_ESP_ETH
176 # define CONFIG_ETH_ENABLED 1
177 #endif
178 
182 #if !defined(CONFIG_FLASHMODE_DOUT) && \
183  !defined(CONFIG_FLASHMODE_DIO) && \
184  !defined(CONFIG_FLASHMODE_QOUT) && \
185  !defined(CONFIG_FLASHMODE_QIO)
186 # error "Flash mode not configured"
187 #endif
188 
192 #if MODULE_ESP_WIFI_ANY
193 # define CONFIG_ESP_WIFI_ENABLED 1
194 # define CONFIG_ESP_WIFI_AMPDU_RX_ENABLED 1
195 # define CONFIG_ESP_WIFI_AMPDU_TX_ENABLED 1
196 # define CONFIG_ESP_WIFI_AUTH_WPA2_PSK 1
197 # define CONFIG_ESP_WIFI_CACHE_TX_BUFFER_NUM 32
198 # define CONFIG_ESP_WIFI_DYNAMIC_RX_BUFFER_NUM 32
199 # define CONFIG_ESP_WIFI_DYNAMIC_RX_MGMT_BUF 0
200 # define CONFIG_ESP_WIFI_DYNAMIC_TX_BUFFER 1
201 # define CONFIG_ESP_WIFI_DYNAMIC_TX_BUFFER_NUM 32
202 # define CONFIG_ESP_WIFI_ENABLE_SAE_PK 0 /* default 1 for WPA3 */
203 # define CONFIG_ESP_WIFI_ENABLE_WPA3_OWE_STA 0 /* default 1 for WPA3 */
204 # define CONFIG_ESP_WIFI_ENABLE_WPA3_SAE 0 /* default 1 for WPA3 */
205 # define CONFIG_ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM 7
206 # define CONFIG_ESP_WIFI_GMAC_SUPPORT 1
207 # define CONFIG_ESP_WIFI_IRAM_OPT 0 /* default 1 */
208 # define CONFIG_ESP_WIFI_MBEDTLS_CRYPTO 0 /* default 1 for WPA3 */
209 # define CONFIG_ESP_WIFI_MBEDTLS_TLS_CLIENT 0 /* default 1 for WPA3 */
210 # define CONFIG_ESP_WIFI_MGMT_SBUF_NUM 32
211 # define CONFIG_ESP_WIFI_NVS_ENABLED MODULE_ESP_IDF_NVS_FLASH
212 # define CONFIG_ESP_WIFI_PW_ID ""
213 # define CONFIG_ESP_WIFI_RX_BA_WIN 6
214 # define CONFIG_ESP_WIFI_RX_IRAM_OPT 0 /* default 1 */
215 # define CONFIG_ESP_WIFI_RX_MGMT_BUF_NUM_DEF 5
216 # define CONFIG_ESP_WIFI_SOFTAP_BEACON_MAX_LEN 752
217 # define CONFIG_ESP_WIFI_STA_DISCONNECTED_PM_ENABLE 1
218 # define CONFIG_ESP_WIFI_STATIC_RX_BUFFER_NUM 10
219 # define CONFIG_ESP_WIFI_STATIC_RX_MGMT_BUFFER 1
220 # define CONFIG_ESP_WIFI_TASK_PINNED_TO_CORE_0 1
221 # define CONFIG_ESP_WIFI_TX_BA_WIN 6
222 # define CONFIG_ESP_WIFI_TX_BUFFER_TYPE 1
223 
224 # define CONFIG_CRYPTO_INTERNAL 1
225 
226 # if MODULE_ESP_WIFI_AP || MODULE_ESP_NOW
227 # define CONFIG_ESP_WIFI_SOFTAP_SUPPORT 1
228 # endif
229 
230 # if MODULE_ESP_WIFI_ENTERPRISE
231 # define CONFIG_ESP_WIFI_ENTERPRISE_SUPPORT 1
232 # endif
233 
234 #endif
235 
236 #define CONFIG_ESP_WIFI_SLP_DEFAULT_MAX_ACTIVE_TIME 10
237 #define CONFIG_ESP_WIFI_SLP_DEFAULT_MIN_ACTIVE_TIME 50
238 #define CONFIG_ESP_WIFI_SLP_DEFAULT_WAIT_BROADCAST_DATA_TIME 15
239 
243 #if SOC_PHY_SUPPORTED
244 # define CONFIG_ESP_PHY_ENABLED 1
245 # define CONFIG_ESP_PHY_CALIBRATION_MODE 0
246 # define CONFIG_ESP_PHY_MAX_TX_POWER 20
247 # define CONFIG_ESP_PHY_MAX_WIFI_TX_POWER 20
248 # define CONFIG_ESP_PHY_RF_CAL_PARTIAL 1
249 # if MODULE_ESP_IDF_NVS_FLASH
250 # define CONFIG_ESP_PHY_CALIBRATION_AND_DATA_STORAGE 1
251 # endif
252 #endif
253 
257 #if !SOC_WIRELESS_HOST_SUPPORTED
258 # define CONFIG_ESP_COEX_ENABLED 1
259 # if CONFIG_ESP_WIFI_ENABLED && CONFIG_BT_ENABLED
260 # define CONFIG_ESP_COEX_SW_COEXIST_ENABLE 1
261 # endif
262 # if 0
263  /* TODO:
264  * CONFIG_SW_COEXIST_ENABLE is deprecated but still used in code.
265  * It is not defined in IDF sdkconfigs and does not work if defined. */
266 # define CONFIG_SW_COEXIST_ENABLE 1
267 # endif
268 #endif /* !SOC_WIRELESS_HOST_SUPPORTED */
269 
273 #ifndef CONFIG_ESP_FLASHPAGE_CAPACITY
274 
275 #if MODULE_PERIPH_FLASHPAGE
276 # if CONFIG_ESP_FLASHPAGE_CAPACITY_64K
277 # define CONFIG_ESP_FLASHPAGE_CAPACITY 0x10000
278 # elif CONFIG_ESP_FLASHPAGE_CAPACITY_128K
279 # define CONFIG_ESP_FLASHPAGE_CAPACITY 0x20000
280 # elif CONFIG_ESP_FLASHPAGE_CAPACITY_256K
281 # define CONFIG_ESP_FLASHPAGE_CAPACITY 0x40000
282 # elif CONFIG_ESP_FLASHPAGE_CAPACITY_512K
283 # define CONFIG_ESP_FLASHPAGE_CAPACITY 0x80000
284 # elif CONFIG_ESP_FLASHPAGE_CAPACITY_1M
285 # define CONFIG_ESP_FLASHPAGE_CAPACITY 0x100000
286 # elif CONFIG_ESP_FLASHPAGE_CAPACITY_2M
287 # define CONFIG_ESP_FLASHPAGE_CAPACITY 0x200000
288 # else
289 # define CONFIG_ESP_FLASHPAGE_CAPACITY 0x80000
290 # endif
291 #else /* MODULE_PERIPH_FLASHPAGE */
292 # define CONFIG_ESP_FLASHPAGE_CAPACITY 0x0
293 #endif /* MODULE_PERIPH_FLASHPAGE */
294 
295 #endif /* !CONFIG_ESP_FLASHPAGE_CAPACITY */
296 
300 #if MODULE_ESP_IDF_LCD
301 # ifndef CONFIG_LCD_DATA_BUF_SIZE
302 # define CONFIG_LCD_DATA_BUF_SIZE 512
303 # endif
304 # define CONFIG_LCD_PANEL_IO_FORMAT_BUF_SIZE CONFIG_LCD_DATA_BUF_SIZE
305 #endif
306 
310 #if defined(CPU_FAM_ESP32)
311 # include "sdkconfig_esp32.h"
312 #elif defined(CPU_FAM_ESP32C3)
313 # include "sdkconfig_esp32c3.h"
314 #elif defined(CPU_FAM_ESP32H2)
315 # include "sdkconfig_esp32h2.h"
316 #elif defined(CPU_FAM_ESP32S2)
317 # include "sdkconfig_esp32s2.h"
318 #elif defined(CPU_FAM_ESP32S3)
319 # include "sdkconfig_esp32s3.h"
320 #else
321 # error "ESP32x family implementation missing"
322 #endif
323 
324 #ifndef CONFIG_MMU_PAGE_SIZE
325 # define CONFIG_MMU_PAGE_SIZE_64KB 1
326 # define CONFIG_MMU_PAGE_SIZE 0x10000
327 #endif
328 
329 #ifndef CONFIG_FREERTOS_NUMBER_OF_CORES
330 # define CONFIG_FREERTOS_NUMBER_OF_CORES 1
331 #endif
332 
333 #define CONFIG_ESP_DEBUG_OCDAWARE 1
334 
335 #define CONFIG_ADC_SUPPRESS_DEPRECATE_WARN 1
336 
337 #define CONFIG_HEAP_POISONING_DISABLED 1
338 #define CONFIG_HEAP_TRACING_OFF 1
339 #define CONFIG_LOG_TAG_LEVEL_CACHE_BINARY_MIN_HEAP 1
340 
341 #define CONFIG_ULP_COPROC_RESERVE_MEM 0
342 
343 #ifdef SOC_RTC_MEM_SUPPORTED
344 # define CONFIG_SOC_RTC_MEM_SUPPORTED 1
345 #endif
346 #ifdef SOC_RTC_FAST_MEM_SUPPORTED
347 # define CONFIG_SOC_RTC_FAST_MEM_SUPPORTED 1
348 #endif
349 #ifdef SOC_RTC_SLOW_SUPPORTED
350 # define CONFIG_SOC_RTC_SLOW_MEM_SUPPORTED 1
351 #endif
352 
356 #ifdef SOC_SDMMC_HOST_SUPPORTED
357 # define CONFIG_SOC_SDMMC_HOST_SUPPORTED SOC_SDMMC_HOST_SUPPORTED
358 # define CONFIG_SOC_SDMMC_DELAY_PHASE_NUM SOC_SDMMC_DELAY_PHASE_NUM
359 # define CONFIG_SOC_SDMMC_NUM_SLOTS SOC_SDMMC_NUM_SLOTS
360 # define CONFIG_SOC_SDMMC_SUPPORT_XTAL_CLOCK SOC_SDMMC_SUPPORT_XTAL_CLOCK
361 # define CONFIG_SOC_SDMMC_USE_GPIO_MATRIX SOC_SDMMC_USE_GPIO_MATRIX
362 # define CONFIG_SOC_SDMMC_USE_IOMUX SOC_SDMMC_USE_IOMUX
363 #endif /* SOC_SDMMC_HOST_SUPPORTED */
364 
368 #ifdef SOC_USB_SERIAL_JTAG_SUPPORTED
369 # ifndef CONFIG_ESP_CONSOLE_SECONDARY_USB_SERIAL_JTAG
370 # define CONFIG_ESP_CONSOLE_SECONDARY_USB_SERIAL_JTAG 1
371 # endif
372 # ifndef CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
373 # define CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG 0
374 # endif
375 # define CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG_ENABLED (CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG || \
376  CONFIG_ESP_CONSOLE_SECONDARY_USB_SERIAL_JTAG)
377 # define CONFIG_SOC_EFUSE_DIS_USB_JTAG SOC_EFUSE_DIS_USB_JTAG
378 # define CONFIG_SOC_EFUSE_HARD_DIS_JTAG SOC_EFUSE_HARD_DIS_JTAG
379 # define CONFIG_SOC_EFUSE_SOFT_DIS_JTAG SOC_EFUSE_SOFT_DIS_JTAG
380 # define CONFIG_SOC_USB_SERIAL_JTAG_SUPPORTED 1
381 # define CONFIG_USJ_ENABLE_USB_SERIAL_JTAG CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG_ENABLED
382 #endif /* SOC_USB_SERIAL_JTAG_SUPPORTED */
383 
384 /* should be RIOT_APPLICATION but PROJECT_NAME must be less than 24 characters */
385 #define PROJECT_NAME "RIOT-OS Application"
386 
387 #endif /* DOXYGEN */
388 
389 #ifdef __cplusplus
390 extern "C" {
391 #endif
392 
393 #ifdef __cplusplus
394 }
395 #endif
396 
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-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)