blob: 38468cf9cfbb3a66718850040a9e8cb7a46787b1 [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>
robertb4062892020-08-22 20:56:26 +02009#include "esp_system.h"
MikeTeachman6d5296e2021-11-09 20:41:34 -080010#include "freertos/FreeRTOS.h"
11#include "driver/i2s.h"
Jim Mussared96008ff2019-09-13 23:04:13 +100012
Damien Georgec8cd5a92022-02-18 15:50:01 +110013#ifndef MICROPY_CONFIG_ROM_LEVEL
14#define MICROPY_CONFIG_ROM_LEVEL (MICROPY_CONFIG_ROM_LEVEL_EXTRA_FEATURES)
15#endif
16
Damien Georgebc08c882016-12-06 12:20:10 +110017// object representation and NLR handling
18#define MICROPY_OBJ_REPR (MICROPY_OBJ_REPR_A)
19#define MICROPY_NLR_SETJMP (1)
Damien George68235142021-07-18 12:11:21 +100020#if CONFIG_IDF_TARGET_ESP32C3
21#define MICROPY_GCREGS_SETJMP (1)
22#endif
Damien Georgebc08c882016-12-06 12:20:10 +110023
24// memory allocation policies
25#define MICROPY_ALLOC_PATH_MAX (128)
26
27// emitters
28#define MICROPY_PERSISTENT_CODE_LOAD (1)
Damien George68235142021-07-18 12:11:21 +100029#if !CONFIG_IDF_TARGET_ESP32C3
Damien George917f0272019-09-10 13:47:44 +100030#define MICROPY_EMIT_XTENSAWIN (1)
Damien George68235142021-07-18 12:11:21 +100031#endif
Damien Georgebc08c882016-12-06 12:20:10 +110032
Damien Georgef63b4f82022-06-09 12:36:45 +100033// workaround for xtensa-esp32-elf-gcc esp-2020r3, which can generate wrong code for loops
34// see https://github.com/espressif/esp-idf/issues/9130
35// this was fixed in newer versions of the compiler by:
36// "gas: use literals/const16 for xtensa loop relaxation"
37// https://github.com/jcmvbkbc/binutils-gdb-xtensa/commit/403b0b61f6d4358aee8493cb1d11814e368942c9
38#define MICROPY_COMP_CONST_FOLDING_COMPILER_WORKAROUND (1)
39
Damien Georgebc08c882016-12-06 12:20:10 +110040// optimisations
41#define MICROPY_OPT_COMPUTED_GOTO (1)
Damien Georgebc08c882016-12-06 12:20:10 +110042
43// Python internal features
44#define MICROPY_READER_VFS (1)
45#define MICROPY_ENABLE_GC (1)
Damien Georgebc08c882016-12-06 12:20:10 +110046#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (1)
Damien Georgebc08c882016-12-06 12:20:10 +110047#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_MPZ)
Damien Georgebc08c882016-12-06 12:20:10 +110048#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
49#define MICROPY_WARNINGS (1)
50#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_FLOAT)
Damien Georgebc08c882016-12-06 12:20:10 +110051#define MICROPY_STREAMS_POSIX_API (1)
Damien Georgebc08c882016-12-06 12:20:10 +110052#define MICROPY_MODULE_FROZEN_STR (0)
53#define MICROPY_MODULE_FROZEN_MPY (1)
54#define MICROPY_QSTR_EXTRA_POOL mp_qstr_frozen_const_pool
Thorsten von Eicken902da052020-11-11 17:46:18 -080055#define MICROPY_USE_INTERNAL_ERRNO (0) // errno.h from xtensa-esp32-elf/sys-include/sys
Damien Georgebc08c882016-12-06 12:20:10 +110056#define MICROPY_USE_INTERNAL_PRINTF (0) // ESP32 SDK requires its own printf
Damien Georgebc08c882016-12-06 12:20:10 +110057#define MICROPY_SCHEDULER_DEPTH (8)
58#define MICROPY_VFS (1)
Damien Georgebc08c882016-12-06 12:20:10 +110059
60// control over Python builtins
Damien Georgebc08c882016-12-06 12:20:10 +110061#define MICROPY_PY_STR_BYTES_CMP_WARN (1)
Jim Mussaredbfc8e882021-08-04 15:35:00 +100062#define MICROPY_PY_ALL_INPLACE_SPECIAL_METHODS (1)
Damien Georgebc08c882016-12-06 12:20:10 +110063#define MICROPY_PY_BUILTINS_HELP_TEXT esp32_help_text
Damien Georgebc08c882016-12-06 12:20:10 +110064#define MICROPY_PY_IO_BUFFEREDWRITER (1)
Damien Georgebc08c882016-12-06 12:20:10 +110065#define MICROPY_PY_UTIME_MP_HAL (1)
66#define MICROPY_PY_THREAD (1)
67#define MICROPY_PY_THREAD_GIL (1)
68#define MICROPY_PY_THREAD_GIL_VM_DIVISOR (32)
69
70// extended modules
Damien Georgeda2b5fa2021-02-14 01:36:30 +110071#ifndef MICROPY_PY_BLUETOOTH
72#define MICROPY_PY_BLUETOOTH (1)
Damien George5dbb8222021-03-17 12:35:59 +110073#define MICROPY_PY_BLUETOOTH_USE_SYNC_EVENTS (1)
74#define MICROPY_PY_BLUETOOTH_USE_SYNC_EVENTS_WITH_INTERLOCK (1)
75#define MICROPY_PY_BLUETOOTH_SYNC_EVENT_STACK_SIZE (CONFIG_BT_NIMBLE_TASK_STACK_SIZE)
Damien Georgeda2b5fa2021-02-14 01:36:30 +110076#define MICROPY_PY_BLUETOOTH_ENABLE_CENTRAL_MODE (1)
Damien George5dbb8222021-03-17 12:35:59 +110077#define MICROPY_PY_BLUETOOTH_ENABLE_PAIRING_BONDING (1)
Damien Georgeda2b5fa2021-02-14 01:36:30 +110078#define MICROPY_BLUETOOTH_NIMBLE (1)
79#define MICROPY_BLUETOOTH_NIMBLE_BINDINGS_ONLY (1)
80#endif
Damien Georgebc08c882016-12-06 12:20:10 +110081#define MICROPY_PY_UTIMEQ (1)
Damien George05014272018-06-12 13:42:43 +100082#define MICROPY_PY_UHASHLIB_SHA1 (1)
83#define MICROPY_PY_UHASHLIB_SHA256 (1)
Damien George82bc4832018-06-27 16:39:26 +100084#define MICROPY_PY_UCRYPTOLIB (1)
robertb4062892020-08-22 20:56:26 +020085#define MICROPY_PY_URANDOM_SEED_INIT_FUNC (esp_random())
Damien George1c53d852022-03-03 19:09:01 +110086#define MICROPY_PY_UOS_INCLUDEFILE "ports/esp32/moduos.c"
Damien George98b05e32018-04-27 23:51:00 +100087#define MICROPY_PY_OS_DUPTERM (1)
Damien George1c53d852022-03-03 19:09:01 +110088#define MICROPY_PY_UOS_DUPTERM_NOTIFY (1)
Damien George818be102022-03-03 19:17:12 +110089#define MICROPY_PY_UOS_UNAME (1)
Damien George1c53d852022-03-03 19:09:01 +110090#define MICROPY_PY_UOS_URANDOM (1)
Damien Georgebc08c882016-12-06 12:20:10 +110091#define MICROPY_PY_MACHINE (1)
92#define MICROPY_PY_MACHINE_PIN_MAKE_NEW mp_pin_make_new
Jim Mussared71f4faa2021-08-11 14:26:23 +100093#define MICROPY_PY_MACHINE_BITSTREAM (1)
Damien Georgebc08c882016-12-06 12:20:10 +110094#define MICROPY_PY_MACHINE_PULSE (1)
Damien Georgeaf64c2d2021-06-24 12:37:50 +100095#define MICROPY_PY_MACHINE_PWM (1)
96#define MICROPY_PY_MACHINE_PWM_INIT (1)
97#define MICROPY_PY_MACHINE_PWM_DUTY (1)
IhorNehrutsab4919672021-10-15 14:04:40 -070098#define MICROPY_PY_MACHINE_PWM_DUTY_U16_NS (1)
Damien Georgeaf64c2d2021-06-24 12:37:50 +100099#define MICROPY_PY_MACHINE_PWM_INCLUDEFILE "ports/esp32/machine_pwm.c"
Damien Georgebc08c882016-12-06 12:20:10 +1100100#define MICROPY_PY_MACHINE_I2C (1)
Damien George6bda80d2022-06-01 11:58:30 +1000101#define MICROPY_PY_MACHINE_I2C_TRANSFER_WRITE1 (1)
Damien George122d9012021-09-02 12:37:00 +1000102#define MICROPY_PY_MACHINE_SOFTI2C (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100103#define MICROPY_PY_MACHINE_SPI (1)
104#define MICROPY_PY_MACHINE_SPI_MSB (0)
105#define MICROPY_PY_MACHINE_SPI_LSB (1)
Damien Georgeafe06342021-09-02 12:39:28 +1000106#define MICROPY_PY_MACHINE_SOFTSPI (1)
Damien George1f9243f2021-07-18 12:11:10 +1000107#ifndef MICROPY_PY_MACHINE_DAC
108#define MICROPY_PY_MACHINE_DAC (1)
109#endif
Damien George0fc0cca2021-07-18 12:11:15 +1000110#ifndef MICROPY_PY_MACHINE_I2S
111#define MICROPY_PY_MACHINE_I2S (1)
112#endif
Damien Georgeea186de2021-09-22 00:35:46 +1000113#ifndef MICROPY_PY_NETWORK_WLAN
114#define MICROPY_PY_NETWORK_WLAN (1)
115#endif
Damien George66a86a02021-02-18 21:24:34 +1100116#ifndef MICROPY_HW_ENABLE_SDCARD
Nicko van Someren8e3af7d2019-05-04 19:00:35 -0600117#define MICROPY_HW_ENABLE_SDCARD (1)
Damien George66a86a02021-02-18 21:24:34 +1100118#endif
Damien George58ebeca2018-03-09 17:25:58 +1100119#define MICROPY_HW_SOFTSPI_MIN_DELAY (0)
120#define MICROPY_HW_SOFTSPI_MAX_BAUDRATE (ets_get_cpu_frequency() * 1000000 / 200) // roughly
Damien Georgebc08c882016-12-06 12:20:10 +1100121#define MICROPY_PY_USSL (1)
122#define MICROPY_SSL_MBEDTLS (1)
Damien George1c52d3e2017-10-30 16:19:52 +1100123#define MICROPY_PY_USSL_FINALISER (1)
Yonatan Goldschmidtbc4f8b42019-02-10 22:35:18 +0200124#define MICROPY_PY_UWEBSOCKET (1)
Damien Georgec1d43522018-04-27 23:57:57 +1000125#define MICROPY_PY_WEBREPL (1)
Damien Georged41f6dd2021-09-02 12:39:50 +1000126#define MICROPY_PY_ONEWIRE (1)
Damien Georgeb96318a2022-01-06 18:25:29 +1100127#define MICROPY_PY_UPLATFORM (1)
Damien Georgec1d43522018-04-27 23:57:57 +1000128#define MICROPY_PY_USOCKET_EVENTS (MICROPY_PY_WEBREPL)
Jim Mussared6a9bd1c2019-10-01 23:47:37 +1000129#define MICROPY_PY_BLUETOOTH_RANDOM_ADDR (1)
Damien George3b6c9112020-05-08 13:54:10 +1000130#define MICROPY_PY_BLUETOOTH_DEFAULT_GAP_NAME ("ESP32")
Damien Georgebc08c882016-12-06 12:20:10 +1100131
132// fatfs configuration
133#define MICROPY_FATFS_ENABLE_LFN (1)
134#define MICROPY_FATFS_RPATH (2)
135#define MICROPY_FATFS_MAX_SS (4096)
Damien Georgeb5f33ac2019-02-25 23:46:17 +1100136#define MICROPY_FATFS_LFN_CODE_PAGE 437 /* 1=SFN/ANSI 437=LFN/U.S.(OEM) */
Damien Georgebc08c882016-12-06 12:20:10 +1100137
Damien Georgebc08c882016-12-06 12:20:10 +1100138#define MP_STATE_PORT MP_STATE_VM
139
Damien Georgebc08c882016-12-06 12:20:10 +1100140// type definitions for the specific machine
141
Damien George69661f32020-02-27 15:36:53 +1100142#define MICROPY_MAKE_POINTER_CALLABLE(p) ((void *)((mp_uint_t)(p)))
Damien George69661f32020-02-27 15:36:53 +1100143void *esp_native_code_commit(void *, size_t, void *);
Damien Georgeb47e1552019-10-06 23:29:40 +1100144#define MP_PLAT_COMMIT_EXEC(buf, len, reloc) esp_native_code_commit(buf, len, reloc)
Damien Georgebc08c882016-12-06 12:20:10 +1100145#define MP_SSIZE_MAX (0x7fffffff)
146
147// Note: these "critical nested" macros do not ensure cross-CPU exclusion,
148// the only disable interrupts on the current CPU. To full manage exclusion
149// one should use portENTER_CRITICAL/portEXIT_CRITICAL instead.
150#include "freertos/FreeRTOS.h"
151#define MICROPY_BEGIN_ATOMIC_SECTION() portENTER_CRITICAL_NESTED()
152#define MICROPY_END_ATOMIC_SECTION(state) portEXIT_CRITICAL_NESTED(state)
153
Damien George999c8b92018-04-27 23:53:45 +1000154#if MICROPY_PY_USOCKET_EVENTS
155#define MICROPY_PY_USOCKET_EVENTS_HANDLER extern void usocket_events_handler(void); usocket_events_handler();
156#else
157#define MICROPY_PY_USOCKET_EVENTS_HANDLER
158#endif
159
Damien Georgebc08c882016-12-06 12:20:10 +1100160#if MICROPY_PY_THREAD
161#define MICROPY_EVENT_POLL_HOOK \
162 do { \
Damien George98a39112020-02-06 01:05:47 +1100163 extern void mp_handle_pending(bool); \
164 mp_handle_pending(true); \
Damien George999c8b92018-04-27 23:53:45 +1000165 MICROPY_PY_USOCKET_EVENTS_HANDLER \
Damien Georgebc08c882016-12-06 12:20:10 +1100166 MP_THREAD_GIL_EXIT(); \
Daniƫl van de Giessen665f0e22022-02-23 17:28:32 +0100167 ulTaskNotifyTake(pdFALSE, 1); \
Damien Georgebc08c882016-12-06 12:20:10 +1100168 MP_THREAD_GIL_ENTER(); \
169 } while (0);
170#else
171#define MICROPY_EVENT_POLL_HOOK \
172 do { \
Damien George98a39112020-02-06 01:05:47 +1100173 extern void mp_handle_pending(bool); \
174 mp_handle_pending(true); \
Damien George999c8b92018-04-27 23:53:45 +1000175 MICROPY_PY_USOCKET_EVENTS_HANDLER \
Damien George69661f32020-02-27 15:36:53 +1100176 asm ("waiti 0"); \
Damien Georgebc08c882016-12-06 12:20:10 +1100177 } while (0);
178#endif
179
Damien Georgef4641b22020-02-07 12:11:22 +1100180// Functions that should go in IRAM
Damien George549448e2021-09-24 12:50:59 +1000181#define MICROPY_WRAP_MP_BINARY_OP(f) IRAM_ATTR f
182#define MICROPY_WRAP_MP_EXECUTE_BYTECODE(f) IRAM_ATTR f
183#define MICROPY_WRAP_MP_LOAD_GLOBAL(f) IRAM_ATTR f
184#define MICROPY_WRAP_MP_LOAD_NAME(f) IRAM_ATTR f
185#define MICROPY_WRAP_MP_MAP_LOOKUP(f) IRAM_ATTR f
186#define MICROPY_WRAP_MP_OBJ_GET_TYPE(f) IRAM_ATTR f
Damien George7cbf8262021-04-28 10:52:19 +1000187#define MICROPY_WRAP_MP_SCHED_EXCEPTION(f) IRAM_ATTR f
Damien Georgee9e9c762021-04-28 10:57:34 +1000188#define MICROPY_WRAP_MP_SCHED_KEYBOARD_INTERRUPT(f) IRAM_ATTR f
Damien Georgef4641b22020-02-07 12:11:22 +1100189
Damien Georgebc08c882016-12-06 12:20:10 +1100190#define UINT_FMT "%u"
191#define INT_FMT "%d"
192
193typedef int32_t mp_int_t; // must be pointer size
194typedef uint32_t mp_uint_t; // must be pointer size
195typedef long mp_off_t;
196// ssize_t, off_t as required by POSIX-signatured functions in stream.h
197#include <sys/types.h>
198
199// board specifics
Damien Georgebc08c882016-12-06 12:20:10 +1100200#define MICROPY_PY_SYS_PLATFORM "esp32"
Damien George2ccf0302019-07-10 15:38:48 +1000201
Seon Rozenblum19048332021-11-12 11:23:49 +1100202// ESP32-S3 extended IO for 47 & 48
203#ifndef MICROPY_HW_ESP32S3_EXTENDED_IO
204#define MICROPY_HW_ESP32S3_EXTENDED_IO (1)
205#endif
206
Damien George2ccf0302019-07-10 15:38:48 +1000207#ifndef MICROPY_HW_ENABLE_MDNS_QUERIES
208#define MICROPY_HW_ENABLE_MDNS_QUERIES (1)
209#endif
210
211#ifndef MICROPY_HW_ENABLE_MDNS_RESPONDER
212#define MICROPY_HW_ENABLE_MDNS_RESPONDER (1)
213#endif
Damien Georgef046b502021-09-22 00:00:26 +1000214
215#ifndef MICROPY_BOARD_STARTUP
216#define MICROPY_BOARD_STARTUP boardctrl_startup
217#endif
218
219void boardctrl_startup(void);
Damien Tournoude982c1d2023-01-12 21:04:07 -0800220
221#ifndef MICROPY_PY_NETWORK_LAN
222#if (ESP_IDF_VERSION_MAJOR == 4) && (ESP_IDF_VERSION_MINOR >= 1) && (CONFIG_IDF_TARGET_ESP32 || (CONFIG_ETH_USE_SPI_ETHERNET && (CONFIG_ETH_SPI_ETHERNET_KSZ8851SNL || CONFIG_ETH_SPI_ETHERNET_DM9051 || CONFIG_ETH_SPI_ETHERNET_W5500)))
223#define MICROPY_PY_NETWORK_LAN (1)
224#else
225#define MICROPY_PY_NETWORK_LAN (0)
226#endif
227#endif
228
229#if MICROPY_PY_NETWORK_LAN && CONFIG_ETH_USE_SPI_ETHERNET
230#ifndef MICROPY_PY_NETWORK_LAN_SPI_CLOCK_SPEED_MZ
231#if CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32C3 || CONFIG_IDF_TARGET_ESP32C2
232#define MICROPY_PY_NETWORK_LAN_SPI_CLOCK_SPEED_MZ (12)
233#else
234#define MICROPY_PY_NETWORK_LAN_SPI_CLOCK_SPEED_MZ (36)
235#endif
236#endif
237#endif