blob: a64d6de995757ad011f5be8711a638301488c0b0 [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 Georgebc08c882016-12-06 12:20:10 +110033// optimisations
34#define MICROPY_OPT_COMPUTED_GOTO (1)
Damien Georgebc08c882016-12-06 12:20:10 +110035
36// Python internal features
37#define MICROPY_READER_VFS (1)
38#define MICROPY_ENABLE_GC (1)
Damien Georgebc08c882016-12-06 12:20:10 +110039#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (1)
Damien Georgebc08c882016-12-06 12:20:10 +110040#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_MPZ)
Damien Georgebc08c882016-12-06 12:20:10 +110041#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
42#define MICROPY_WARNINGS (1)
43#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_FLOAT)
Damien Georgebc08c882016-12-06 12:20:10 +110044#define MICROPY_STREAMS_POSIX_API (1)
Damien Georgebc08c882016-12-06 12:20:10 +110045#define MICROPY_MODULE_FROZEN_STR (0)
46#define MICROPY_MODULE_FROZEN_MPY (1)
47#define MICROPY_QSTR_EXTRA_POOL mp_qstr_frozen_const_pool
Thorsten von Eicken902da052020-11-11 17:46:18 -080048#define MICROPY_USE_INTERNAL_ERRNO (0) // errno.h from xtensa-esp32-elf/sys-include/sys
Damien Georgebc08c882016-12-06 12:20:10 +110049#define MICROPY_USE_INTERNAL_PRINTF (0) // ESP32 SDK requires its own printf
Damien Georgebc08c882016-12-06 12:20:10 +110050#define MICROPY_SCHEDULER_DEPTH (8)
51#define MICROPY_VFS (1)
Damien Georgebc08c882016-12-06 12:20:10 +110052
53// control over Python builtins
Damien Georgebc08c882016-12-06 12:20:10 +110054#define MICROPY_PY_STR_BYTES_CMP_WARN (1)
Jim Mussaredbfc8e882021-08-04 15:35:00 +100055#define MICROPY_PY_ALL_INPLACE_SPECIAL_METHODS (1)
Damien Georgebc08c882016-12-06 12:20:10 +110056#define MICROPY_PY_BUILTINS_HELP_TEXT esp32_help_text
Damien Georgebc08c882016-12-06 12:20:10 +110057#define MICROPY_PY_IO_BUFFEREDWRITER (1)
Damien Georgebc08c882016-12-06 12:20:10 +110058#define MICROPY_PY_UTIME_MP_HAL (1)
59#define MICROPY_PY_THREAD (1)
60#define MICROPY_PY_THREAD_GIL (1)
61#define MICROPY_PY_THREAD_GIL_VM_DIVISOR (32)
62
63// extended modules
Damien Georgeda2b5fa2021-02-14 01:36:30 +110064#ifndef MICROPY_PY_BLUETOOTH
65#define MICROPY_PY_BLUETOOTH (1)
66#define MICROPY_PY_BLUETOOTH_ENABLE_CENTRAL_MODE (1)
67#define MICROPY_BLUETOOTH_NIMBLE (1)
68#define MICROPY_BLUETOOTH_NIMBLE_BINDINGS_ONLY (1)
69#endif
Damien Georgebc08c882016-12-06 12:20:10 +110070#define MICROPY_PY_UTIMEQ (1)
Damien George05014272018-06-12 13:42:43 +100071#define MICROPY_PY_UHASHLIB_SHA1 (1)
72#define MICROPY_PY_UHASHLIB_SHA256 (1)
Damien George82bc4832018-06-27 16:39:26 +100073#define MICROPY_PY_UCRYPTOLIB (1)
robertb4062892020-08-22 20:56:26 +020074#define MICROPY_PY_URANDOM_SEED_INIT_FUNC (esp_random())
Damien George1c53d852022-03-03 19:09:01 +110075#define MICROPY_PY_UOS_INCLUDEFILE "ports/esp32/moduos.c"
Damien George98b05e32018-04-27 23:51:00 +100076#define MICROPY_PY_OS_DUPTERM (1)
Damien George1c53d852022-03-03 19:09:01 +110077#define MICROPY_PY_UOS_DUPTERM_NOTIFY (1)
Damien George818be102022-03-03 19:17:12 +110078#define MICROPY_PY_UOS_UNAME (1)
Damien George1c53d852022-03-03 19:09:01 +110079#define MICROPY_PY_UOS_URANDOM (1)
Damien Georgebc08c882016-12-06 12:20:10 +110080#define MICROPY_PY_MACHINE (1)
81#define MICROPY_PY_MACHINE_PIN_MAKE_NEW mp_pin_make_new
Jim Mussared71f4faa2021-08-11 14:26:23 +100082#define MICROPY_PY_MACHINE_BITSTREAM (1)
Damien Georgebc08c882016-12-06 12:20:10 +110083#define MICROPY_PY_MACHINE_PULSE (1)
Damien Georgeaf64c2d2021-06-24 12:37:50 +100084#define MICROPY_PY_MACHINE_PWM (1)
85#define MICROPY_PY_MACHINE_PWM_INIT (1)
86#define MICROPY_PY_MACHINE_PWM_DUTY (1)
IhorNehrutsab4919672021-10-15 14:04:40 -070087#define MICROPY_PY_MACHINE_PWM_DUTY_U16_NS (1)
Damien Georgeaf64c2d2021-06-24 12:37:50 +100088#define MICROPY_PY_MACHINE_PWM_INCLUDEFILE "ports/esp32/machine_pwm.c"
Damien Georgebc08c882016-12-06 12:20:10 +110089#define MICROPY_PY_MACHINE_I2C (1)
Damien George122d9012021-09-02 12:37:00 +100090#define MICROPY_PY_MACHINE_SOFTI2C (1)
Damien Georgebc08c882016-12-06 12:20:10 +110091#define MICROPY_PY_MACHINE_SPI (1)
92#define MICROPY_PY_MACHINE_SPI_MSB (0)
93#define MICROPY_PY_MACHINE_SPI_LSB (1)
Damien Georgeafe06342021-09-02 12:39:28 +100094#define MICROPY_PY_MACHINE_SOFTSPI (1)
Damien George1f9243f2021-07-18 12:11:10 +100095#ifndef MICROPY_PY_MACHINE_DAC
96#define MICROPY_PY_MACHINE_DAC (1)
97#endif
Damien George0fc0cca2021-07-18 12:11:15 +100098#ifndef MICROPY_PY_MACHINE_I2S
99#define MICROPY_PY_MACHINE_I2S (1)
100#endif
Damien Georgeea186de2021-09-22 00:35:46 +1000101#ifndef MICROPY_PY_NETWORK_WLAN
102#define MICROPY_PY_NETWORK_WLAN (1)
103#endif
Damien George66a86a02021-02-18 21:24:34 +1100104#ifndef MICROPY_HW_ENABLE_SDCARD
Nicko van Someren8e3af7d2019-05-04 19:00:35 -0600105#define MICROPY_HW_ENABLE_SDCARD (1)
Damien George66a86a02021-02-18 21:24:34 +1100106#endif
Damien George58ebeca2018-03-09 17:25:58 +1100107#define MICROPY_HW_SOFTSPI_MIN_DELAY (0)
108#define MICROPY_HW_SOFTSPI_MAX_BAUDRATE (ets_get_cpu_frequency() * 1000000 / 200) // roughly
Damien Georgebc08c882016-12-06 12:20:10 +1100109#define MICROPY_PY_USSL (1)
110#define MICROPY_SSL_MBEDTLS (1)
Damien George1c52d3e2017-10-30 16:19:52 +1100111#define MICROPY_PY_USSL_FINALISER (1)
Yonatan Goldschmidtbc4f8b42019-02-10 22:35:18 +0200112#define MICROPY_PY_UWEBSOCKET (1)
Damien Georgec1d43522018-04-27 23:57:57 +1000113#define MICROPY_PY_WEBREPL (1)
Damien Georgeab9d47e2021-04-08 23:56:28 +1000114#define MICROPY_PY_BTREE (1)
Damien Georged41f6dd2021-09-02 12:39:50 +1000115#define MICROPY_PY_ONEWIRE (1)
Damien Georgeb96318a2022-01-06 18:25:29 +1100116#define MICROPY_PY_UPLATFORM (1)
Damien Georgec1d43522018-04-27 23:57:57 +1000117#define MICROPY_PY_USOCKET_EVENTS (MICROPY_PY_WEBREPL)
Jim Mussared6a9bd1c2019-10-01 23:47:37 +1000118#define MICROPY_PY_BLUETOOTH_RANDOM_ADDR (1)
Damien George3b6c9112020-05-08 13:54:10 +1000119#define MICROPY_PY_BLUETOOTH_DEFAULT_GAP_NAME ("ESP32")
Damien Georgebc08c882016-12-06 12:20:10 +1100120
121// fatfs configuration
122#define MICROPY_FATFS_ENABLE_LFN (1)
123#define MICROPY_FATFS_RPATH (2)
124#define MICROPY_FATFS_MAX_SS (4096)
Damien Georgeb5f33ac2019-02-25 23:46:17 +1100125#define MICROPY_FATFS_LFN_CODE_PAGE 437 /* 1=SFN/ANSI 437=LFN/U.S.(OEM) */
Damien Georgef35aae32018-06-06 12:00:23 +1000126#define mp_type_fileio mp_type_vfs_fat_fileio
127#define mp_type_textio mp_type_vfs_fat_textio
Damien Georgebc08c882016-12-06 12:20:10 +1100128
129// use vfs's functions for import stat and builtin open
130#define mp_import_stat mp_vfs_import_stat
131#define mp_builtin_open mp_vfs_open
132#define mp_builtin_open_obj mp_vfs_open_obj
133
134// extra built in names to add to the global namespace
135#define MICROPY_PORT_BUILTINS \
136 { MP_OBJ_NEW_QSTR(MP_QSTR_input), (mp_obj_t)&mp_builtin_input_obj }, \
137 { MP_OBJ_NEW_QSTR(MP_QSTR_open), (mp_obj_t)&mp_builtin_open_obj },
138
Damien Georgebc08c882016-12-06 12:20:10 +1100139#define MP_STATE_PORT MP_STATE_VM
140
Damien George9ac9aa92019-01-28 16:16:03 +1100141struct _machine_timer_obj_t;
142
Jim Mussared6a9bd1c2019-10-01 23:47:37 +1000143#if MICROPY_BLUETOOTH_NIMBLE
144struct mp_bluetooth_nimble_root_pointers_t;
145#define MICROPY_PORT_ROOT_POINTER_BLUETOOTH_NIMBLE struct _mp_bluetooth_nimble_root_pointers_t *bluetooth_nimble_root_pointers;
146#else
147#define MICROPY_PORT_ROOT_POINTER_BLUETOOTH_NIMBLE
148#endif
149
Damien Georgebc08c882016-12-06 12:20:10 +1100150#define MICROPY_PORT_ROOT_POINTERS \
151 const char *readline_hist[8]; \
152 mp_obj_t machine_pin_irq_handler[40]; \
Damien George9ac9aa92019-01-28 16:16:03 +1100153 struct _machine_timer_obj_t *machine_timer_obj_head; \
MikeTeachman6d5296e2021-11-09 20:41:34 -0800154 struct _machine_i2s_obj_t *machine_i2s_obj[I2S_NUM_MAX]; \
Damien Georgec70f96f2022-05-19 15:04:52 +1000155 mp_obj_t native_code_pointers; \
Jim Mussared6a9bd1c2019-10-01 23:47:37 +1000156 MICROPY_PORT_ROOT_POINTER_BLUETOOTH_NIMBLE
Damien Georgebc08c882016-12-06 12:20:10 +1100157
158// type definitions for the specific machine
159
Damien George69661f32020-02-27 15:36:53 +1100160#define MICROPY_MAKE_POINTER_CALLABLE(p) ((void *)((mp_uint_t)(p)))
Damien George69661f32020-02-27 15:36:53 +1100161void *esp_native_code_commit(void *, size_t, void *);
Damien Georgeb47e1552019-10-06 23:29:40 +1100162#define MP_PLAT_COMMIT_EXEC(buf, len, reloc) esp_native_code_commit(buf, len, reloc)
Damien Georgebc08c882016-12-06 12:20:10 +1100163#define MP_SSIZE_MAX (0x7fffffff)
164
165// Note: these "critical nested" macros do not ensure cross-CPU exclusion,
166// the only disable interrupts on the current CPU. To full manage exclusion
167// one should use portENTER_CRITICAL/portEXIT_CRITICAL instead.
168#include "freertos/FreeRTOS.h"
169#define MICROPY_BEGIN_ATOMIC_SECTION() portENTER_CRITICAL_NESTED()
170#define MICROPY_END_ATOMIC_SECTION(state) portEXIT_CRITICAL_NESTED(state)
171
Damien George999c8b92018-04-27 23:53:45 +1000172#if MICROPY_PY_USOCKET_EVENTS
173#define MICROPY_PY_USOCKET_EVENTS_HANDLER extern void usocket_events_handler(void); usocket_events_handler();
174#else
175#define MICROPY_PY_USOCKET_EVENTS_HANDLER
176#endif
177
Damien Georgebc08c882016-12-06 12:20:10 +1100178#if MICROPY_PY_THREAD
179#define MICROPY_EVENT_POLL_HOOK \
180 do { \
Damien George98a39112020-02-06 01:05:47 +1100181 extern void mp_handle_pending(bool); \
182 mp_handle_pending(true); \
Damien George999c8b92018-04-27 23:53:45 +1000183 MICROPY_PY_USOCKET_EVENTS_HANDLER \
Damien Georgebc08c882016-12-06 12:20:10 +1100184 MP_THREAD_GIL_EXIT(); \
Daniƫl van de Giessen665f0e22022-02-23 17:28:32 +0100185 ulTaskNotifyTake(pdFALSE, 1); \
Damien Georgebc08c882016-12-06 12:20:10 +1100186 MP_THREAD_GIL_ENTER(); \
187 } while (0);
188#else
189#define MICROPY_EVENT_POLL_HOOK \
190 do { \
Damien George98a39112020-02-06 01:05:47 +1100191 extern void mp_handle_pending(bool); \
192 mp_handle_pending(true); \
Damien George999c8b92018-04-27 23:53:45 +1000193 MICROPY_PY_USOCKET_EVENTS_HANDLER \
Damien George69661f32020-02-27 15:36:53 +1100194 asm ("waiti 0"); \
Damien Georgebc08c882016-12-06 12:20:10 +1100195 } while (0);
196#endif
197
Damien Georgef4641b22020-02-07 12:11:22 +1100198// Functions that should go in IRAM
Damien George549448e2021-09-24 12:50:59 +1000199#define MICROPY_WRAP_MP_BINARY_OP(f) IRAM_ATTR f
200#define MICROPY_WRAP_MP_EXECUTE_BYTECODE(f) IRAM_ATTR f
201#define MICROPY_WRAP_MP_LOAD_GLOBAL(f) IRAM_ATTR f
202#define MICROPY_WRAP_MP_LOAD_NAME(f) IRAM_ATTR f
203#define MICROPY_WRAP_MP_MAP_LOOKUP(f) IRAM_ATTR f
204#define MICROPY_WRAP_MP_OBJ_GET_TYPE(f) IRAM_ATTR f
Damien George7cbf8262021-04-28 10:52:19 +1000205#define MICROPY_WRAP_MP_SCHED_EXCEPTION(f) IRAM_ATTR f
Damien Georgee9e9c762021-04-28 10:57:34 +1000206#define MICROPY_WRAP_MP_SCHED_KEYBOARD_INTERRUPT(f) IRAM_ATTR f
Damien Georgef4641b22020-02-07 12:11:22 +1100207
Damien Georgebc08c882016-12-06 12:20:10 +1100208#define UINT_FMT "%u"
209#define INT_FMT "%d"
210
211typedef int32_t mp_int_t; // must be pointer size
212typedef uint32_t mp_uint_t; // must be pointer size
213typedef long mp_off_t;
214// ssize_t, off_t as required by POSIX-signatured functions in stream.h
215#include <sys/types.h>
216
217// board specifics
Damien Georgebc08c882016-12-06 12:20:10 +1100218#define MICROPY_PY_SYS_PLATFORM "esp32"
Damien George2ccf0302019-07-10 15:38:48 +1000219
Seon Rozenblum19048332021-11-12 11:23:49 +1100220// ESP32-S3 extended IO for 47 & 48
221#ifndef MICROPY_HW_ESP32S3_EXTENDED_IO
222#define MICROPY_HW_ESP32S3_EXTENDED_IO (1)
223#endif
224
Damien George2ccf0302019-07-10 15:38:48 +1000225#ifndef MICROPY_HW_ENABLE_MDNS_QUERIES
226#define MICROPY_HW_ENABLE_MDNS_QUERIES (1)
227#endif
228
229#ifndef MICROPY_HW_ENABLE_MDNS_RESPONDER
230#define MICROPY_HW_ENABLE_MDNS_RESPONDER (1)
231#endif
Damien Georgef046b502021-09-22 00:00:26 +1000232
233#ifndef MICROPY_BOARD_STARTUP
234#define MICROPY_BOARD_STARTUP boardctrl_startup
235#endif
236
237void boardctrl_startup(void);