blob: 5affbb069290383f3af6584cdd80bc97b6ce53f9 [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"
Jim Mussared96008ff2019-09-13 23:04:13 +100010
Damien Georgebc08c882016-12-06 12:20:10 +110011// object representation and NLR handling
12#define MICROPY_OBJ_REPR (MICROPY_OBJ_REPR_A)
13#define MICROPY_NLR_SETJMP (1)
Damien George68235142021-07-18 12:11:21 +100014#if CONFIG_IDF_TARGET_ESP32C3
15#define MICROPY_GCREGS_SETJMP (1)
16#endif
Damien Georgebc08c882016-12-06 12:20:10 +110017
18// memory allocation policies
19#define MICROPY_ALLOC_PATH_MAX (128)
20
21// emitters
22#define MICROPY_PERSISTENT_CODE_LOAD (1)
Damien George68235142021-07-18 12:11:21 +100023#if !CONFIG_IDF_TARGET_ESP32C3
Damien George917f0272019-09-10 13:47:44 +100024#define MICROPY_EMIT_XTENSAWIN (1)
Damien George68235142021-07-18 12:11:21 +100025#endif
Damien Georgebc08c882016-12-06 12:20:10 +110026
27// compiler configuration
28#define MICROPY_COMP_MODULE_CONST (1)
29#define MICROPY_COMP_TRIPLE_TUPLE_ASSIGN (1)
30
31// optimisations
32#define MICROPY_OPT_COMPUTED_GOTO (1)
33#define MICROPY_OPT_MPZ_BITWISE (1)
34
35// Python internal features
36#define MICROPY_READER_VFS (1)
37#define MICROPY_ENABLE_GC (1)
38#define MICROPY_ENABLE_FINALISER (1)
39#define MICROPY_STACK_CHECK (1)
40#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (1)
41#define MICROPY_KBD_EXCEPTION (1)
42#define MICROPY_HELPER_REPL (1)
43#define MICROPY_REPL_EMACS_KEYS (1)
44#define MICROPY_REPL_AUTO_INDENT (1)
45#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_MPZ)
46#define MICROPY_ENABLE_SOURCE_LINE (1)
47#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
48#define MICROPY_WARNINGS (1)
49#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_FLOAT)
Damien Georgebc08c882016-12-06 12:20:10 +110050#define MICROPY_CPYTHON_COMPAT (1)
51#define MICROPY_STREAMS_NON_BLOCK (1)
52#define MICROPY_STREAMS_POSIX_API (1)
53#define MICROPY_MODULE_BUILTIN_INIT (1)
54#define MICROPY_MODULE_WEAK_LINKS (1)
55#define MICROPY_MODULE_FROZEN_STR (0)
56#define MICROPY_MODULE_FROZEN_MPY (1)
57#define MICROPY_QSTR_EXTRA_POOL mp_qstr_frozen_const_pool
58#define MICROPY_CAN_OVERRIDE_BUILTINS (1)
Thorsten von Eicken902da052020-11-11 17:46:18 -080059#define MICROPY_USE_INTERNAL_ERRNO (0) // errno.h from xtensa-esp32-elf/sys-include/sys
Damien Georgebc08c882016-12-06 12:20:10 +110060#define MICROPY_USE_INTERNAL_PRINTF (0) // ESP32 SDK requires its own printf
61#define MICROPY_ENABLE_SCHEDULER (1)
62#define MICROPY_SCHEDULER_DEPTH (8)
63#define MICROPY_VFS (1)
Damien Georgebc08c882016-12-06 12:20:10 +110064
65// control over Python builtins
66#define MICROPY_PY_FUNCTION_ATTRS (1)
Damien George93150a02018-06-08 12:23:08 +100067#define MICROPY_PY_DESCRIPTORS (1)
Andrew Leech97108fc2020-10-21 08:54:46 +110068#define MICROPY_PY_DELATTR_SETATTR (1)
Jim Mussared5733c492020-07-16 13:07:41 +100069#define MICROPY_PY_FSTRINGS (1)
Damien Georgebc08c882016-12-06 12:20:10 +110070#define MICROPY_PY_STR_BYTES_CMP_WARN (1)
71#define MICROPY_PY_BUILTINS_STR_UNICODE (1)
72#define MICROPY_PY_BUILTINS_STR_CENTER (1)
73#define MICROPY_PY_BUILTINS_STR_PARTITION (1)
74#define MICROPY_PY_BUILTINS_STR_SPLITLINES (1)
75#define MICROPY_PY_BUILTINS_BYTEARRAY (1)
76#define MICROPY_PY_BUILTINS_MEMORYVIEW (1)
77#define MICROPY_PY_BUILTINS_SET (1)
78#define MICROPY_PY_BUILTINS_SLICE (1)
79#define MICROPY_PY_BUILTINS_SLICE_ATTRS (1)
Nicko van Someren4c939552019-11-16 17:07:11 -070080#define MICROPY_PY_BUILTINS_SLICE_INDICES (1)
Damien Georgebc08c882016-12-06 12:20:10 +110081#define MICROPY_PY_BUILTINS_FROZENSET (1)
82#define MICROPY_PY_BUILTINS_PROPERTY (1)
83#define MICROPY_PY_BUILTINS_RANGE_ATTRS (1)
Damien George20b4b852018-05-22 14:15:20 +100084#define MICROPY_PY_BUILTINS_ROUND_INT (1)
Damien Georgebc08c882016-12-06 12:20:10 +110085#define MICROPY_PY_ALL_SPECIAL_METHODS (1)
Jim Mussaredbfc8e882021-08-04 15:35:00 +100086#define MICROPY_PY_ALL_INPLACE_SPECIAL_METHODS (1)
87#define MICROPY_PY_REVERSE_SPECIAL_METHODS (1)
Damien Georgebc08c882016-12-06 12:20:10 +110088#define MICROPY_PY_BUILTINS_COMPILE (1)
89#define MICROPY_PY_BUILTINS_ENUMERATE (1)
90#define MICROPY_PY_BUILTINS_EXECFILE (1)
91#define MICROPY_PY_BUILTINS_FILTER (1)
92#define MICROPY_PY_BUILTINS_REVERSED (1)
93#define MICROPY_PY_BUILTINS_NOTIMPLEMENTED (1)
94#define MICROPY_PY_BUILTINS_INPUT (1)
95#define MICROPY_PY_BUILTINS_MIN_MAX (1)
96#define MICROPY_PY_BUILTINS_POW3 (1)
97#define MICROPY_PY_BUILTINS_HELP (1)
98#define MICROPY_PY_BUILTINS_HELP_TEXT esp32_help_text
99#define MICROPY_PY_BUILTINS_HELP_MODULES (1)
100#define MICROPY_PY___FILE__ (1)
101#define MICROPY_PY_MICROPYTHON_MEM_INFO (1)
102#define MICROPY_PY_ARRAY (1)
103#define MICROPY_PY_ARRAY_SLICE_ASSIGN (1)
104#define MICROPY_PY_ATTRTUPLE (1)
105#define MICROPY_PY_COLLECTIONS (1)
Damien George82828342018-02-21 22:55:13 +1100106#define MICROPY_PY_COLLECTIONS_DEQUE (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100107#define MICROPY_PY_COLLECTIONS_ORDEREDDICT (1)
108#define MICROPY_PY_MATH (1)
109#define MICROPY_PY_MATH_SPECIAL_FUNCTIONS (1)
stijnaf5c9982019-07-02 10:28:44 +0200110#define MICROPY_PY_MATH_ISCLOSE (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100111#define MICROPY_PY_CMATH (1)
112#define MICROPY_PY_GC (1)
113#define MICROPY_PY_IO (1)
Damien George565f5902018-06-04 16:04:28 +1000114#define MICROPY_PY_IO_IOBASE (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100115#define MICROPY_PY_IO_FILEIO (1)
116#define MICROPY_PY_IO_BYTESIO (1)
117#define MICROPY_PY_IO_BUFFEREDWRITER (1)
118#define MICROPY_PY_STRUCT (1)
119#define MICROPY_PY_SYS (1)
120#define MICROPY_PY_SYS_MAXSIZE (1)
121#define MICROPY_PY_SYS_MODULES (1)
122#define MICROPY_PY_SYS_EXIT (1)
123#define MICROPY_PY_SYS_STDFILES (1)
124#define MICROPY_PY_SYS_STDIO_BUFFER (1)
125#define MICROPY_PY_UERRNO (1)
126#define MICROPY_PY_USELECT (1)
127#define MICROPY_PY_UTIME_MP_HAL (1)
128#define MICROPY_PY_THREAD (1)
129#define MICROPY_PY_THREAD_GIL (1)
130#define MICROPY_PY_THREAD_GIL_VM_DIVISOR (32)
131
132// extended modules
Damien Georgeda2b5fa2021-02-14 01:36:30 +1100133#ifndef MICROPY_PY_BLUETOOTH
134#define MICROPY_PY_BLUETOOTH (1)
135#define MICROPY_PY_BLUETOOTH_ENABLE_CENTRAL_MODE (1)
136#define MICROPY_BLUETOOTH_NIMBLE (1)
137#define MICROPY_BLUETOOTH_NIMBLE_BINDINGS_ONLY (1)
138#endif
Damien Georgead004db2020-03-22 23:17:17 +1100139#define MICROPY_PY_UASYNCIO (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100140#define MICROPY_PY_UCTYPES (1)
141#define MICROPY_PY_UZLIB (1)
142#define MICROPY_PY_UJSON (1)
143#define MICROPY_PY_URE (1)
Damien George8f86fbf2018-07-02 15:13:18 +1000144#define MICROPY_PY_URE_SUB (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100145#define MICROPY_PY_UHEAPQ (1)
146#define MICROPY_PY_UTIMEQ (1)
Damien George05014272018-06-12 13:42:43 +1000147#define MICROPY_PY_UHASHLIB (1)
148#define MICROPY_PY_UHASHLIB_SHA1 (1)
149#define MICROPY_PY_UHASHLIB_SHA256 (1)
Damien George82bc4832018-06-27 16:39:26 +1000150#define MICROPY_PY_UCRYPTOLIB (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100151#define MICROPY_PY_UBINASCII (1)
152#define MICROPY_PY_UBINASCII_CRC32 (1)
153#define MICROPY_PY_URANDOM (1)
154#define MICROPY_PY_URANDOM_EXTRA_FUNCS (1)
robertb4062892020-08-22 20:56:26 +0200155#define MICROPY_PY_URANDOM_SEED_INIT_FUNC (esp_random())
Damien George98b05e32018-04-27 23:51:00 +1000156#define MICROPY_PY_OS_DUPTERM (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100157#define MICROPY_PY_MACHINE (1)
158#define MICROPY_PY_MACHINE_PIN_MAKE_NEW mp_pin_make_new
Jim Mussared71f4faa2021-08-11 14:26:23 +1000159#define MICROPY_PY_MACHINE_BITSTREAM (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100160#define MICROPY_PY_MACHINE_PULSE (1)
Damien Georgeaf64c2d2021-06-24 12:37:50 +1000161#define MICROPY_PY_MACHINE_PWM (1)
162#define MICROPY_PY_MACHINE_PWM_INIT (1)
163#define MICROPY_PY_MACHINE_PWM_DUTY (1)
164#define MICROPY_PY_MACHINE_PWM_INCLUDEFILE "ports/esp32/machine_pwm.c"
Damien Georgebc08c882016-12-06 12:20:10 +1100165#define MICROPY_PY_MACHINE_I2C (1)
Damien George122d9012021-09-02 12:37:00 +1000166#define MICROPY_PY_MACHINE_SOFTI2C (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100167#define MICROPY_PY_MACHINE_SPI (1)
168#define MICROPY_PY_MACHINE_SPI_MSB (0)
169#define MICROPY_PY_MACHINE_SPI_LSB (1)
Damien Georgeafe06342021-09-02 12:39:28 +1000170#define MICROPY_PY_MACHINE_SOFTSPI (1)
Damien George1f9243f2021-07-18 12:11:10 +1000171#ifndef MICROPY_PY_MACHINE_DAC
172#define MICROPY_PY_MACHINE_DAC (1)
173#endif
Damien George0fc0cca2021-07-18 12:11:15 +1000174#ifndef MICROPY_PY_MACHINE_I2S
175#define MICROPY_PY_MACHINE_I2S (1)
176#endif
Damien George66a86a02021-02-18 21:24:34 +1100177#ifndef MICROPY_HW_ENABLE_SDCARD
Nicko van Someren8e3af7d2019-05-04 19:00:35 -0600178#define MICROPY_HW_ENABLE_SDCARD (1)
Damien George66a86a02021-02-18 21:24:34 +1100179#endif
Damien George58ebeca2018-03-09 17:25:58 +1100180#define MICROPY_HW_SOFTSPI_MIN_DELAY (0)
181#define MICROPY_HW_SOFTSPI_MAX_BAUDRATE (ets_get_cpu_frequency() * 1000000 / 200) // roughly
Damien Georgebc08c882016-12-06 12:20:10 +1100182#define MICROPY_PY_USSL (1)
183#define MICROPY_SSL_MBEDTLS (1)
Damien George1c52d3e2017-10-30 16:19:52 +1100184#define MICROPY_PY_USSL_FINALISER (1)
Yonatan Goldschmidtbc4f8b42019-02-10 22:35:18 +0200185#define MICROPY_PY_UWEBSOCKET (1)
Damien Georgec1d43522018-04-27 23:57:57 +1000186#define MICROPY_PY_WEBREPL (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100187#define MICROPY_PY_FRAMEBUF (1)
Damien Georgeab9d47e2021-04-08 23:56:28 +1000188#define MICROPY_PY_BTREE (1)
Damien Georged41f6dd2021-09-02 12:39:50 +1000189#define MICROPY_PY_ONEWIRE (1)
Damien Georgec1d43522018-04-27 23:57:57 +1000190#define MICROPY_PY_USOCKET_EVENTS (MICROPY_PY_WEBREPL)
Jim Mussared6a9bd1c2019-10-01 23:47:37 +1000191#define MICROPY_PY_BLUETOOTH_RANDOM_ADDR (1)
Damien George3b6c9112020-05-08 13:54:10 +1000192#define MICROPY_PY_BLUETOOTH_DEFAULT_GAP_NAME ("ESP32")
Damien Georgebc08c882016-12-06 12:20:10 +1100193
194// fatfs configuration
195#define MICROPY_FATFS_ENABLE_LFN (1)
196#define MICROPY_FATFS_RPATH (2)
197#define MICROPY_FATFS_MAX_SS (4096)
Damien Georgeb5f33ac2019-02-25 23:46:17 +1100198#define MICROPY_FATFS_LFN_CODE_PAGE 437 /* 1=SFN/ANSI 437=LFN/U.S.(OEM) */
Damien Georgef35aae32018-06-06 12:00:23 +1000199#define mp_type_fileio mp_type_vfs_fat_fileio
200#define mp_type_textio mp_type_vfs_fat_textio
Damien Georgebc08c882016-12-06 12:20:10 +1100201
202// use vfs's functions for import stat and builtin open
203#define mp_import_stat mp_vfs_import_stat
204#define mp_builtin_open mp_vfs_open
205#define mp_builtin_open_obj mp_vfs_open_obj
206
207// extra built in names to add to the global namespace
208#define MICROPY_PORT_BUILTINS \
209 { MP_OBJ_NEW_QSTR(MP_QSTR_input), (mp_obj_t)&mp_builtin_input_obj }, \
210 { MP_OBJ_NEW_QSTR(MP_QSTR_open), (mp_obj_t)&mp_builtin_open_obj },
211
212// extra built in modules to add to the list of known ones
213extern const struct _mp_obj_module_t esp_module;
Eric Poulsenabec47a2018-02-15 07:59:28 -0800214extern const struct _mp_obj_module_t esp32_module;
Damien Georgebc08c882016-12-06 12:20:10 +1100215extern const struct _mp_obj_module_t utime_module;
216extern const struct _mp_obj_module_t uos_module;
217extern const struct _mp_obj_module_t mp_module_usocket;
218extern const struct _mp_obj_module_t mp_module_machine;
219extern const struct _mp_obj_module_t mp_module_network;
220extern const struct _mp_obj_module_t mp_module_onewire;
221
222#define MICROPY_PORT_BUILTIN_MODULES \
223 { MP_OBJ_NEW_QSTR(MP_QSTR_esp), (mp_obj_t)&esp_module }, \
Eric Poulsenabec47a2018-02-15 07:59:28 -0800224 { MP_OBJ_NEW_QSTR(MP_QSTR_esp32), (mp_obj_t)&esp32_module }, \
Damien Georgebc08c882016-12-06 12:20:10 +1100225 { MP_OBJ_NEW_QSTR(MP_QSTR_utime), (mp_obj_t)&utime_module }, \
226 { MP_OBJ_NEW_QSTR(MP_QSTR_uos), (mp_obj_t)&uos_module }, \
227 { MP_OBJ_NEW_QSTR(MP_QSTR_usocket), (mp_obj_t)&mp_module_usocket }, \
228 { MP_OBJ_NEW_QSTR(MP_QSTR_machine), (mp_obj_t)&mp_module_machine }, \
229 { MP_OBJ_NEW_QSTR(MP_QSTR_network), (mp_obj_t)&mp_module_network }, \
230 { MP_OBJ_NEW_QSTR(MP_QSTR__onewire), (mp_obj_t)&mp_module_onewire }, \
Damien Georgebc08c882016-12-06 12:20:10 +1100231
Damien Georgebc08c882016-12-06 12:20:10 +1100232#define MP_STATE_PORT MP_STATE_VM
233
Damien George9ac9aa92019-01-28 16:16:03 +1100234struct _machine_timer_obj_t;
235
Jim Mussared6a9bd1c2019-10-01 23:47:37 +1000236#if MICROPY_BLUETOOTH_NIMBLE
237struct mp_bluetooth_nimble_root_pointers_t;
238#define MICROPY_PORT_ROOT_POINTER_BLUETOOTH_NIMBLE struct _mp_bluetooth_nimble_root_pointers_t *bluetooth_nimble_root_pointers;
239#else
240#define MICROPY_PORT_ROOT_POINTER_BLUETOOTH_NIMBLE
241#endif
242
Damien Georgebc08c882016-12-06 12:20:10 +1100243#define MICROPY_PORT_ROOT_POINTERS \
244 const char *readline_hist[8]; \
245 mp_obj_t machine_pin_irq_handler[40]; \
Damien George9ac9aa92019-01-28 16:16:03 +1100246 struct _machine_timer_obj_t *machine_timer_obj_head; \
Jim Mussared6a9bd1c2019-10-01 23:47:37 +1000247 MICROPY_PORT_ROOT_POINTER_BLUETOOTH_NIMBLE
Damien Georgebc08c882016-12-06 12:20:10 +1100248
249// type definitions for the specific machine
250
Damien George69661f32020-02-27 15:36:53 +1100251#define MICROPY_MAKE_POINTER_CALLABLE(p) ((void *)((mp_uint_t)(p)))
Damien George69661f32020-02-27 15:36:53 +1100252void *esp_native_code_commit(void *, size_t, void *);
Damien Georgeb47e1552019-10-06 23:29:40 +1100253#define MP_PLAT_COMMIT_EXEC(buf, len, reloc) esp_native_code_commit(buf, len, reloc)
Damien Georgebc08c882016-12-06 12:20:10 +1100254#define MP_SSIZE_MAX (0x7fffffff)
255
256// Note: these "critical nested" macros do not ensure cross-CPU exclusion,
257// the only disable interrupts on the current CPU. To full manage exclusion
258// one should use portENTER_CRITICAL/portEXIT_CRITICAL instead.
259#include "freertos/FreeRTOS.h"
260#define MICROPY_BEGIN_ATOMIC_SECTION() portENTER_CRITICAL_NESTED()
261#define MICROPY_END_ATOMIC_SECTION(state) portEXIT_CRITICAL_NESTED(state)
262
Damien George999c8b92018-04-27 23:53:45 +1000263#if MICROPY_PY_USOCKET_EVENTS
264#define MICROPY_PY_USOCKET_EVENTS_HANDLER extern void usocket_events_handler(void); usocket_events_handler();
265#else
266#define MICROPY_PY_USOCKET_EVENTS_HANDLER
267#endif
268
Damien Georgebc08c882016-12-06 12:20:10 +1100269#if MICROPY_PY_THREAD
270#define MICROPY_EVENT_POLL_HOOK \
271 do { \
Damien George98a39112020-02-06 01:05:47 +1100272 extern void mp_handle_pending(bool); \
273 mp_handle_pending(true); \
Damien George999c8b92018-04-27 23:53:45 +1000274 MICROPY_PY_USOCKET_EVENTS_HANDLER \
Damien Georgebc08c882016-12-06 12:20:10 +1100275 MP_THREAD_GIL_EXIT(); \
276 MP_THREAD_GIL_ENTER(); \
277 } while (0);
278#else
279#define MICROPY_EVENT_POLL_HOOK \
280 do { \
Damien George98a39112020-02-06 01:05:47 +1100281 extern void mp_handle_pending(bool); \
282 mp_handle_pending(true); \
Damien George999c8b92018-04-27 23:53:45 +1000283 MICROPY_PY_USOCKET_EVENTS_HANDLER \
Damien George69661f32020-02-27 15:36:53 +1100284 asm ("waiti 0"); \
Damien Georgebc08c882016-12-06 12:20:10 +1100285 } while (0);
286#endif
287
Damien Georgef4641b22020-02-07 12:11:22 +1100288// Functions that should go in IRAM
Damien George7cbf8262021-04-28 10:52:19 +1000289#define MICROPY_WRAP_MP_SCHED_EXCEPTION(f) IRAM_ATTR f
Damien Georgee9e9c762021-04-28 10:57:34 +1000290#define MICROPY_WRAP_MP_SCHED_KEYBOARD_INTERRUPT(f) IRAM_ATTR f
Damien Georgef4641b22020-02-07 12:11:22 +1100291
Damien Georgebc08c882016-12-06 12:20:10 +1100292#define UINT_FMT "%u"
293#define INT_FMT "%d"
294
295typedef int32_t mp_int_t; // must be pointer size
296typedef uint32_t mp_uint_t; // must be pointer size
297typedef long mp_off_t;
298// ssize_t, off_t as required by POSIX-signatured functions in stream.h
299#include <sys/types.h>
300
301// board specifics
Damien Georgebc08c882016-12-06 12:20:10 +1100302#define MICROPY_PY_SYS_PLATFORM "esp32"
Damien George2ccf0302019-07-10 15:38:48 +1000303
304#ifndef MICROPY_HW_ENABLE_MDNS_QUERIES
305#define MICROPY_HW_ENABLE_MDNS_QUERIES (1)
306#endif
307
308#ifndef MICROPY_HW_ENABLE_MDNS_RESPONDER
309#define MICROPY_HW_ENABLE_MDNS_RESPONDER (1)
310#endif
Damien Georgef046b502021-09-22 00:00:26 +1000311
312#ifndef MICROPY_BOARD_STARTUP
313#define MICROPY_BOARD_STARTUP boardctrl_startup
314#endif
315
316void boardctrl_startup(void);