blob: 714871d4fc926b3b0228e536bb91f8c52d9e4959 [file] [log] [blame]
Damien Georgebc08c882016-12-06 12:20:10 +11001// Options to control how MicroPython is built for this port,
2// overriding defaults in py/mpconfig.h.
3
Jim Mussared8db517f2019-08-09 18:07:50 +10004// Board-specific definitions
5#include "mpconfigboard.h"
6
Damien Georgebc08c882016-12-06 12:20:10 +11007#include <stdint.h>
8#include <alloca.h>
Damien Georgee4650122023-05-09 09:52:54 +10009#include "esp_random.h"
robertb4062892020-08-22 20:56:26 +020010#include "esp_system.h"
MikeTeachman6d5296e2021-11-09 20:41:34 -080011#include "freertos/FreeRTOS.h"
12#include "driver/i2s.h"
Damien Georgee4650122023-05-09 09:52:54 +100013#include "esp_wifi_types.h"
Jim Mussared96008ff2019-09-13 23:04:13 +100014
Damien Georgec8cd5a92022-02-18 15:50:01 +110015#ifndef MICROPY_CONFIG_ROM_LEVEL
16#define MICROPY_CONFIG_ROM_LEVEL (MICROPY_CONFIG_ROM_LEVEL_EXTRA_FEATURES)
17#endif
18
Damien Georgebc08c882016-12-06 12:20:10 +110019// object representation and NLR handling
20#define MICROPY_OBJ_REPR (MICROPY_OBJ_REPR_A)
21#define MICROPY_NLR_SETJMP (1)
Damien George68235142021-07-18 12:11:21 +100022#if CONFIG_IDF_TARGET_ESP32C3
23#define MICROPY_GCREGS_SETJMP (1)
24#endif
Damien Georgebc08c882016-12-06 12:20:10 +110025
26// memory allocation policies
27#define MICROPY_ALLOC_PATH_MAX (128)
28
29// emitters
30#define MICROPY_PERSISTENT_CODE_LOAD (1)
Damien George68235142021-07-18 12:11:21 +100031#if !CONFIG_IDF_TARGET_ESP32C3
Damien George917f0272019-09-10 13:47:44 +100032#define MICROPY_EMIT_XTENSAWIN (1)
Damien George68235142021-07-18 12:11:21 +100033#endif
Damien Georgebc08c882016-12-06 12:20:10 +110034
Damien Georgef63b4f82022-06-09 12:36:45 +100035// workaround for xtensa-esp32-elf-gcc esp-2020r3, which can generate wrong code for loops
36// see https://github.com/espressif/esp-idf/issues/9130
37// this was fixed in newer versions of the compiler by:
38// "gas: use literals/const16 for xtensa loop relaxation"
39// https://github.com/jcmvbkbc/binutils-gdb-xtensa/commit/403b0b61f6d4358aee8493cb1d11814e368942c9
40#define MICROPY_COMP_CONST_FOLDING_COMPILER_WORKAROUND (1)
41
Damien Georgebc08c882016-12-06 12:20:10 +110042// optimisations
43#define MICROPY_OPT_COMPUTED_GOTO (1)
Damien Georgebc08c882016-12-06 12:20:10 +110044
45// Python internal features
46#define MICROPY_READER_VFS (1)
47#define MICROPY_ENABLE_GC (1)
Damien Georgebc08c882016-12-06 12:20:10 +110048#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (1)
Damien Georgebc08c882016-12-06 12:20:10 +110049#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_MPZ)
Damien Georgebc08c882016-12-06 12:20:10 +110050#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
51#define MICROPY_WARNINGS (1)
52#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_FLOAT)
Damien Georgebc08c882016-12-06 12:20:10 +110053#define MICROPY_STREAMS_POSIX_API (1)
Thorsten von Eicken902da052020-11-11 17:46:18 -080054#define MICROPY_USE_INTERNAL_ERRNO (0) // errno.h from xtensa-esp32-elf/sys-include/sys
Damien Georgebc08c882016-12-06 12:20:10 +110055#define MICROPY_USE_INTERNAL_PRINTF (0) // ESP32 SDK requires its own printf
Damien Georgebc08c882016-12-06 12:20:10 +110056#define MICROPY_SCHEDULER_DEPTH (8)
57#define MICROPY_VFS (1)
Damien Georgebc08c882016-12-06 12:20:10 +110058
59// control over Python builtins
Damien Georgebc08c882016-12-06 12:20:10 +110060#define MICROPY_PY_STR_BYTES_CMP_WARN (1)
Jim Mussaredbfc8e882021-08-04 15:35:00 +100061#define MICROPY_PY_ALL_INPLACE_SPECIAL_METHODS (1)
Damien Georgebc08c882016-12-06 12:20:10 +110062#define MICROPY_PY_BUILTINS_HELP_TEXT esp32_help_text
Damien Georgebc08c882016-12-06 12:20:10 +110063#define MICROPY_PY_IO_BUFFEREDWRITER (1)
Jim Mussaredf5f9edf2022-08-18 15:01:26 +100064#define MICROPY_PY_TIME_GMTIME_LOCALTIME_MKTIME (1)
65#define MICROPY_PY_TIME_TIME_TIME_NS (1)
66#define MICROPY_PY_TIME_INCLUDEFILE "ports/esp32/modtime.c"
Damien Georgebc08c882016-12-06 12:20:10 +110067#define MICROPY_PY_THREAD (1)
68#define MICROPY_PY_THREAD_GIL (1)
69#define MICROPY_PY_THREAD_GIL_VM_DIVISOR (32)
70
71// extended modules
Glenn Moloney7fa322a2020-09-24 15:37:04 +100072#ifndef MICROPY_ESPNOW
73#define MICROPY_ESPNOW (1)
74#endif
Damien Georgeda2b5fa2021-02-14 01:36:30 +110075#ifndef MICROPY_PY_BLUETOOTH
76#define MICROPY_PY_BLUETOOTH (1)
Damien George5dbb8222021-03-17 12:35:59 +110077#define MICROPY_PY_BLUETOOTH_USE_SYNC_EVENTS (1)
78#define MICROPY_PY_BLUETOOTH_USE_SYNC_EVENTS_WITH_INTERLOCK (1)
79#define MICROPY_PY_BLUETOOTH_SYNC_EVENT_STACK_SIZE (CONFIG_BT_NIMBLE_TASK_STACK_SIZE)
Damien Georgeda2b5fa2021-02-14 01:36:30 +110080#define MICROPY_PY_BLUETOOTH_ENABLE_CENTRAL_MODE (1)
Damien George5dbb8222021-03-17 12:35:59 +110081#define MICROPY_PY_BLUETOOTH_ENABLE_PAIRING_BONDING (1)
Damien Georgeda2b5fa2021-02-14 01:36:30 +110082#define MICROPY_BLUETOOTH_NIMBLE (1)
83#define MICROPY_BLUETOOTH_NIMBLE_BINDINGS_ONLY (1)
84#endif
Jim Mussaredf5f9edf2022-08-18 15:01:26 +100085#define MICROPY_PY_HASHLIB_SHA1 (1)
86#define MICROPY_PY_HASHLIB_SHA256 (1)
87#define MICROPY_PY_CRYPTOLIB (1)
88#define MICROPY_PY_RANDOM_SEED_INIT_FUNC (esp_random())
Jim Mussared45ac6512022-08-18 16:24:27 +100089#define MICROPY_PY_OS_INCLUDEFILE "ports/esp32/modos.c"
Damien George98b05e32018-04-27 23:51:00 +100090#define MICROPY_PY_OS_DUPTERM (1)
Jim Mussaredf5f9edf2022-08-18 15:01:26 +100091#define MICROPY_PY_OS_DUPTERM_NOTIFY (1)
92#define MICROPY_PY_OS_SYNC (1)
93#define MICROPY_PY_OS_UNAME (1)
94#define MICROPY_PY_OS_URANDOM (1)
Damien Georgebc08c882016-12-06 12:20:10 +110095#define MICROPY_PY_MACHINE (1)
96#define MICROPY_PY_MACHINE_PIN_MAKE_NEW mp_pin_make_new
Jim Mussared71f4faa2021-08-11 14:26:23 +100097#define MICROPY_PY_MACHINE_BITSTREAM (1)
Damien Georgebc08c882016-12-06 12:20:10 +110098#define MICROPY_PY_MACHINE_PULSE (1)
Damien Georgeaf64c2d2021-06-24 12:37:50 +100099#define MICROPY_PY_MACHINE_PWM (1)
Damien Georgeaf64c2d2021-06-24 12:37:50 +1000100#define MICROPY_PY_MACHINE_PWM_DUTY (1)
101#define MICROPY_PY_MACHINE_PWM_INCLUDEFILE "ports/esp32/machine_pwm.c"
Damien Georgebc08c882016-12-06 12:20:10 +1100102#define MICROPY_PY_MACHINE_I2C (1)
Damien George6bda80d2022-06-01 11:58:30 +1000103#define MICROPY_PY_MACHINE_I2C_TRANSFER_WRITE1 (1)
Damien George122d9012021-09-02 12:37:00 +1000104#define MICROPY_PY_MACHINE_SOFTI2C (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100105#define MICROPY_PY_MACHINE_SPI (1)
106#define MICROPY_PY_MACHINE_SPI_MSB (0)
107#define MICROPY_PY_MACHINE_SPI_LSB (1)
Damien Georgeafe06342021-09-02 12:39:28 +1000108#define MICROPY_PY_MACHINE_SOFTSPI (1)
Damien George1f9243f2021-07-18 12:11:10 +1000109#ifndef MICROPY_PY_MACHINE_DAC
110#define MICROPY_PY_MACHINE_DAC (1)
111#endif
Damien George0fc0cca2021-07-18 12:11:15 +1000112#ifndef MICROPY_PY_MACHINE_I2S
113#define MICROPY_PY_MACHINE_I2S (1)
114#endif
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100115#define MICROPY_PY_NETWORK (1)
116#ifndef MICROPY_PY_NETWORK_HOSTNAME_DEFAULT
117#if CONFIG_IDF_TARGET_ESP32
118#define MICROPY_PY_NETWORK_HOSTNAME_DEFAULT "mpy-esp32"
119#elif CONFIG_IDF_TARGET_ESP32S2
120#define MICROPY_PY_NETWORK_HOSTNAME_DEFAULT "mpy-esp32s2"
121#elif CONFIG_IDF_TARGET_ESP32S3
122#define MICROPY_PY_NETWORK_HOSTNAME_DEFAULT "mpy-esp32s3"
123#elif CONFIG_IDF_TARGET_ESP32C3
124#define MICROPY_PY_NETWORK_HOSTNAME_DEFAULT "mpy-esp32c3"
125#endif
126#endif
127#define MICROPY_PY_NETWORK_INCLUDEFILE "ports/esp32/modnetwork.h"
128#define MICROPY_PY_NETWORK_MODULE_GLOBALS_INCLUDEFILE "ports/esp32/modnetwork_globals.h"
Damien Georgeea186de2021-09-22 00:35:46 +1000129#ifndef MICROPY_PY_NETWORK_WLAN
130#define MICROPY_PY_NETWORK_WLAN (1)
131#endif
Damien George66a86a02021-02-18 21:24:34 +1100132#ifndef MICROPY_HW_ENABLE_SDCARD
Nicko van Someren8e3af7d2019-05-04 19:00:35 -0600133#define MICROPY_HW_ENABLE_SDCARD (1)
Damien George66a86a02021-02-18 21:24:34 +1100134#endif
Damien George58ebeca2018-03-09 17:25:58 +1100135#define MICROPY_HW_SOFTSPI_MIN_DELAY (0)
Damien Georgee4650122023-05-09 09:52:54 +1000136#define MICROPY_HW_SOFTSPI_MAX_BAUDRATE (esp_rom_get_cpu_ticks_per_us() * 1000000 / 200) // roughly
Jim Mussaredf5f9edf2022-08-18 15:01:26 +1000137#define MICROPY_PY_SSL (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100138#define MICROPY_SSL_MBEDTLS (1)
Jim Mussaredf5f9edf2022-08-18 15:01:26 +1000139#define MICROPY_PY_SSL_FINALISER (1)
140#define MICROPY_PY_WEBSOCKET (1)
Damien Georgec1d43522018-04-27 23:57:57 +1000141#define MICROPY_PY_WEBREPL (1)
Damien Georged41f6dd2021-09-02 12:39:50 +1000142#define MICROPY_PY_ONEWIRE (1)
Jim Mussaredf5f9edf2022-08-18 15:01:26 +1000143#define MICROPY_PY_PLATFORM (1)
144#define MICROPY_PY_SOCKET_EVENTS (MICROPY_PY_WEBREPL)
Jim Mussared6a9bd1c2019-10-01 23:47:37 +1000145#define MICROPY_PY_BLUETOOTH_RANDOM_ADDR (1)
Damien George3b6c9112020-05-08 13:54:10 +1000146#define MICROPY_PY_BLUETOOTH_DEFAULT_GAP_NAME ("ESP32")
Damien Georgebc08c882016-12-06 12:20:10 +1100147
148// fatfs configuration
149#define MICROPY_FATFS_ENABLE_LFN (1)
150#define MICROPY_FATFS_RPATH (2)
151#define MICROPY_FATFS_MAX_SS (4096)
Damien Georgeb5f33ac2019-02-25 23:46:17 +1100152#define MICROPY_FATFS_LFN_CODE_PAGE 437 /* 1=SFN/ANSI 437=LFN/U.S.(OEM) */
Damien Georgebc08c882016-12-06 12:20:10 +1100153
Damien Georgebc08c882016-12-06 12:20:10 +1100154#define MP_STATE_PORT MP_STATE_VM
155
Damien Georgebc08c882016-12-06 12:20:10 +1100156// type definitions for the specific machine
157
Damien George69661f32020-02-27 15:36:53 +1100158#define MICROPY_MAKE_POINTER_CALLABLE(p) ((void *)((mp_uint_t)(p)))
Damien George69661f32020-02-27 15:36:53 +1100159void *esp_native_code_commit(void *, size_t, void *);
Damien Georgeb47e1552019-10-06 23:29:40 +1100160#define MP_PLAT_COMMIT_EXEC(buf, len, reloc) esp_native_code_commit(buf, len, reloc)
Damien Georgebc08c882016-12-06 12:20:10 +1100161#define MP_SSIZE_MAX (0x7fffffff)
162
163// Note: these "critical nested" macros do not ensure cross-CPU exclusion,
164// the only disable interrupts on the current CPU. To full manage exclusion
165// one should use portENTER_CRITICAL/portEXIT_CRITICAL instead.
166#include "freertos/FreeRTOS.h"
Damien Georgee4650122023-05-09 09:52:54 +1000167#define MICROPY_BEGIN_ATOMIC_SECTION() portSET_INTERRUPT_MASK_FROM_ISR()
168#define MICROPY_END_ATOMIC_SECTION(state) portCLEAR_INTERRUPT_MASK_FROM_ISR(state)
Damien Georgebc08c882016-12-06 12:20:10 +1100169
Jim Mussaredf5f9edf2022-08-18 15:01:26 +1000170#if MICROPY_PY_SOCKET_EVENTS
171#define MICROPY_PY_SOCKET_EVENTS_HANDLER extern void socket_events_handler(void); socket_events_handler();
Damien George999c8b92018-04-27 23:53:45 +1000172#else
Jim Mussaredf5f9edf2022-08-18 15:01:26 +1000173#define MICROPY_PY_SOCKET_EVENTS_HANDLER
Damien George999c8b92018-04-27 23:53:45 +1000174#endif
175
Damien Georgebc08c882016-12-06 12:20:10 +1100176#if MICROPY_PY_THREAD
177#define MICROPY_EVENT_POLL_HOOK \
178 do { \
Damien George98a39112020-02-06 01:05:47 +1100179 extern void mp_handle_pending(bool); \
180 mp_handle_pending(true); \
Jim Mussaredf5f9edf2022-08-18 15:01:26 +1000181 MICROPY_PY_SOCKET_EVENTS_HANDLER \
Damien Georgebc08c882016-12-06 12:20:10 +1100182 MP_THREAD_GIL_EXIT(); \
Daniƫl van de Giessen665f0e22022-02-23 17:28:32 +0100183 ulTaskNotifyTake(pdFALSE, 1); \
Damien Georgebc08c882016-12-06 12:20:10 +1100184 MP_THREAD_GIL_ENTER(); \
185 } while (0);
186#else
187#define MICROPY_EVENT_POLL_HOOK \
188 do { \
Damien George98a39112020-02-06 01:05:47 +1100189 extern void mp_handle_pending(bool); \
190 mp_handle_pending(true); \
Jim Mussaredf5f9edf2022-08-18 15:01:26 +1000191 MICROPY_PY_SOCKET_EVENTS_HANDLER \
Damien George69661f32020-02-27 15:36:53 +1100192 asm ("waiti 0"); \
Damien Georgebc08c882016-12-06 12:20:10 +1100193 } while (0);
194#endif
195
Damien Georgef4641b22020-02-07 12:11:22 +1100196// Functions that should go in IRAM
Damien George549448e2021-09-24 12:50:59 +1000197#define MICROPY_WRAP_MP_BINARY_OP(f) IRAM_ATTR f
198#define MICROPY_WRAP_MP_EXECUTE_BYTECODE(f) IRAM_ATTR f
199#define MICROPY_WRAP_MP_LOAD_GLOBAL(f) IRAM_ATTR f
200#define MICROPY_WRAP_MP_LOAD_NAME(f) IRAM_ATTR f
201#define MICROPY_WRAP_MP_MAP_LOOKUP(f) IRAM_ATTR f
202#define MICROPY_WRAP_MP_OBJ_GET_TYPE(f) IRAM_ATTR f
Damien George7cbf8262021-04-28 10:52:19 +1000203#define MICROPY_WRAP_MP_SCHED_EXCEPTION(f) IRAM_ATTR f
Damien Georgee9e9c762021-04-28 10:57:34 +1000204#define MICROPY_WRAP_MP_SCHED_KEYBOARD_INTERRUPT(f) IRAM_ATTR f
Damien Georgef4641b22020-02-07 12:11:22 +1100205
Damien Georgebc08c882016-12-06 12:20:10 +1100206#define UINT_FMT "%u"
207#define INT_FMT "%d"
208
209typedef int32_t mp_int_t; // must be pointer size
210typedef uint32_t mp_uint_t; // must be pointer size
211typedef long mp_off_t;
212// ssize_t, off_t as required by POSIX-signatured functions in stream.h
213#include <sys/types.h>
214
215// board specifics
Damien Georgebc08c882016-12-06 12:20:10 +1100216#define MICROPY_PY_SYS_PLATFORM "esp32"
Damien George2ccf0302019-07-10 15:38:48 +1000217
Seon Rozenblum19048332021-11-12 11:23:49 +1100218// ESP32-S3 extended IO for 47 & 48
219#ifndef MICROPY_HW_ESP32S3_EXTENDED_IO
220#define MICROPY_HW_ESP32S3_EXTENDED_IO (1)
221#endif
222
Damien George2ccf0302019-07-10 15:38:48 +1000223#ifndef MICROPY_HW_ENABLE_MDNS_QUERIES
Carlosgg1f355762023-06-25 22:48:39 +0100224#define MICROPY_HW_ENABLE_MDNS_QUERIES (1)
Damien George2ccf0302019-07-10 15:38:48 +1000225#endif
226
227#ifndef MICROPY_HW_ENABLE_MDNS_RESPONDER
Carlosgg1f355762023-06-25 22:48:39 +0100228#define MICROPY_HW_ENABLE_MDNS_RESPONDER (1)
Damien George2ccf0302019-07-10 15:38:48 +1000229#endif
Damien Georgef046b502021-09-22 00:00:26 +1000230
Luca Burelli904ccfa2023-07-04 11:54:53 +0200231#ifndef MICROPY_BOARD_ENTER_BOOTLOADER
232#define MICROPY_BOARD_ENTER_BOOTLOADER(nargs, args)
233#endif
234
Damien Georgef046b502021-09-22 00:00:26 +1000235#ifndef MICROPY_BOARD_STARTUP
236#define MICROPY_BOARD_STARTUP boardctrl_startup
237#endif
238
239void boardctrl_startup(void);
Damien Tournoude982c1d2023-01-12 21:04:07 -0800240
241#ifndef MICROPY_PY_NETWORK_LAN
Damien Georgee4650122023-05-09 09:52:54 +1000242#if CONFIG_IDF_TARGET_ESP32 || (CONFIG_ETH_USE_SPI_ETHERNET && (CONFIG_ETH_SPI_ETHERNET_KSZ8851SNL || CONFIG_ETH_SPI_ETHERNET_DM9051 || CONFIG_ETH_SPI_ETHERNET_W5500))
Damien Tournoude982c1d2023-01-12 21:04:07 -0800243#define MICROPY_PY_NETWORK_LAN (1)
244#else
245#define MICROPY_PY_NETWORK_LAN (0)
246#endif
247#endif
248
249#if MICROPY_PY_NETWORK_LAN && CONFIG_ETH_USE_SPI_ETHERNET
250#ifndef MICROPY_PY_NETWORK_LAN_SPI_CLOCK_SPEED_MZ
251#if CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32C3 || CONFIG_IDF_TARGET_ESP32C2
252#define MICROPY_PY_NETWORK_LAN_SPI_CLOCK_SPEED_MZ (12)
253#else
254#define MICROPY_PY_NETWORK_LAN_SPI_CLOCK_SPEED_MZ (36)
255#endif
256#endif
257#endif