blob: 364b2de5c2e88d3fb7051d01f5cda67613e0f9d0 [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>
9#include "rom/ets_sys.h"
10
11// object representation and NLR handling
12#define MICROPY_OBJ_REPR (MICROPY_OBJ_REPR_A)
13#define MICROPY_NLR_SETJMP (1)
14
15// memory allocation policies
16#define MICROPY_ALLOC_PATH_MAX (128)
17
18// emitters
19#define MICROPY_PERSISTENT_CODE_LOAD (1)
20
21// compiler configuration
22#define MICROPY_COMP_MODULE_CONST (1)
23#define MICROPY_COMP_TRIPLE_TUPLE_ASSIGN (1)
24
25// optimisations
26#define MICROPY_OPT_COMPUTED_GOTO (1)
27#define MICROPY_OPT_MPZ_BITWISE (1)
28
29// Python internal features
30#define MICROPY_READER_VFS (1)
31#define MICROPY_ENABLE_GC (1)
32#define MICROPY_ENABLE_FINALISER (1)
33#define MICROPY_STACK_CHECK (1)
34#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (1)
35#define MICROPY_KBD_EXCEPTION (1)
36#define MICROPY_HELPER_REPL (1)
37#define MICROPY_REPL_EMACS_KEYS (1)
38#define MICROPY_REPL_AUTO_INDENT (1)
39#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_MPZ)
40#define MICROPY_ENABLE_SOURCE_LINE (1)
41#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_CPYTHON_COMPAT (1)
45#define MICROPY_STREAMS_NON_BLOCK (1)
46#define MICROPY_STREAMS_POSIX_API (1)
47#define MICROPY_MODULE_BUILTIN_INIT (1)
48#define MICROPY_MODULE_WEAK_LINKS (1)
49#define MICROPY_MODULE_FROZEN_STR (0)
50#define MICROPY_MODULE_FROZEN_MPY (1)
51#define MICROPY_QSTR_EXTRA_POOL mp_qstr_frozen_const_pool
52#define MICROPY_CAN_OVERRIDE_BUILTINS (1)
53#define MICROPY_USE_INTERNAL_ERRNO (1)
54#define MICROPY_USE_INTERNAL_PRINTF (0) // ESP32 SDK requires its own printf
55#define MICROPY_ENABLE_SCHEDULER (1)
56#define MICROPY_SCHEDULER_DEPTH (8)
57#define MICROPY_VFS (1)
58#define MICROPY_VFS_FAT (1)
59
60// control over Python builtins
61#define MICROPY_PY_FUNCTION_ATTRS (1)
Damien George93150a02018-06-08 12:23:08 +100062#define MICROPY_PY_DESCRIPTORS (1)
Damien Georgebc08c882016-12-06 12:20:10 +110063#define MICROPY_PY_STR_BYTES_CMP_WARN (1)
64#define MICROPY_PY_BUILTINS_STR_UNICODE (1)
65#define MICROPY_PY_BUILTINS_STR_CENTER (1)
66#define MICROPY_PY_BUILTINS_STR_PARTITION (1)
67#define MICROPY_PY_BUILTINS_STR_SPLITLINES (1)
68#define MICROPY_PY_BUILTINS_BYTEARRAY (1)
69#define MICROPY_PY_BUILTINS_MEMORYVIEW (1)
70#define MICROPY_PY_BUILTINS_SET (1)
71#define MICROPY_PY_BUILTINS_SLICE (1)
72#define MICROPY_PY_BUILTINS_SLICE_ATTRS (1)
73#define MICROPY_PY_BUILTINS_FROZENSET (1)
74#define MICROPY_PY_BUILTINS_PROPERTY (1)
75#define MICROPY_PY_BUILTINS_RANGE_ATTRS (1)
Damien George20b4b852018-05-22 14:15:20 +100076#define MICROPY_PY_BUILTINS_ROUND_INT (1)
Damien Georgebc08c882016-12-06 12:20:10 +110077#define MICROPY_PY_BUILTINS_TIMEOUTERROR (1)
78#define MICROPY_PY_ALL_SPECIAL_METHODS (1)
79#define MICROPY_PY_BUILTINS_COMPILE (1)
80#define MICROPY_PY_BUILTINS_ENUMERATE (1)
81#define MICROPY_PY_BUILTINS_EXECFILE (1)
82#define MICROPY_PY_BUILTINS_FILTER (1)
83#define MICROPY_PY_BUILTINS_REVERSED (1)
84#define MICROPY_PY_BUILTINS_NOTIMPLEMENTED (1)
85#define MICROPY_PY_BUILTINS_INPUT (1)
86#define MICROPY_PY_BUILTINS_MIN_MAX (1)
87#define MICROPY_PY_BUILTINS_POW3 (1)
88#define MICROPY_PY_BUILTINS_HELP (1)
89#define MICROPY_PY_BUILTINS_HELP_TEXT esp32_help_text
90#define MICROPY_PY_BUILTINS_HELP_MODULES (1)
91#define MICROPY_PY___FILE__ (1)
92#define MICROPY_PY_MICROPYTHON_MEM_INFO (1)
93#define MICROPY_PY_ARRAY (1)
94#define MICROPY_PY_ARRAY_SLICE_ASSIGN (1)
95#define MICROPY_PY_ATTRTUPLE (1)
96#define MICROPY_PY_COLLECTIONS (1)
Damien George82828342018-02-21 22:55:13 +110097#define MICROPY_PY_COLLECTIONS_DEQUE (1)
Damien Georgebc08c882016-12-06 12:20:10 +110098#define MICROPY_PY_COLLECTIONS_ORDEREDDICT (1)
99#define MICROPY_PY_MATH (1)
100#define MICROPY_PY_MATH_SPECIAL_FUNCTIONS (1)
101#define MICROPY_PY_CMATH (1)
102#define MICROPY_PY_GC (1)
103#define MICROPY_PY_IO (1)
Damien George565f5902018-06-04 16:04:28 +1000104#define MICROPY_PY_IO_IOBASE (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100105#define MICROPY_PY_IO_FILEIO (1)
106#define MICROPY_PY_IO_BYTESIO (1)
107#define MICROPY_PY_IO_BUFFEREDWRITER (1)
108#define MICROPY_PY_STRUCT (1)
109#define MICROPY_PY_SYS (1)
110#define MICROPY_PY_SYS_MAXSIZE (1)
111#define MICROPY_PY_SYS_MODULES (1)
112#define MICROPY_PY_SYS_EXIT (1)
113#define MICROPY_PY_SYS_STDFILES (1)
114#define MICROPY_PY_SYS_STDIO_BUFFER (1)
115#define MICROPY_PY_UERRNO (1)
116#define MICROPY_PY_USELECT (1)
117#define MICROPY_PY_UTIME_MP_HAL (1)
118#define MICROPY_PY_THREAD (1)
119#define MICROPY_PY_THREAD_GIL (1)
120#define MICROPY_PY_THREAD_GIL_VM_DIVISOR (32)
121
122// extended modules
123#define MICROPY_PY_UCTYPES (1)
124#define MICROPY_PY_UZLIB (1)
125#define MICROPY_PY_UJSON (1)
126#define MICROPY_PY_URE (1)
Damien George8f86fbf2018-07-02 15:13:18 +1000127#define MICROPY_PY_URE_SUB (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100128#define MICROPY_PY_UHEAPQ (1)
129#define MICROPY_PY_UTIMEQ (1)
Damien George05014272018-06-12 13:42:43 +1000130#define MICROPY_PY_UHASHLIB (1)
131#define MICROPY_PY_UHASHLIB_SHA1 (1)
132#define MICROPY_PY_UHASHLIB_SHA256 (1)
Damien George82bc4832018-06-27 16:39:26 +1000133#define MICROPY_PY_UCRYPTOLIB (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100134#define MICROPY_PY_UBINASCII (1)
135#define MICROPY_PY_UBINASCII_CRC32 (1)
136#define MICROPY_PY_URANDOM (1)
137#define MICROPY_PY_URANDOM_EXTRA_FUNCS (1)
Damien George98b05e32018-04-27 23:51:00 +1000138#define MICROPY_PY_OS_DUPTERM (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100139#define MICROPY_PY_MACHINE (1)
140#define MICROPY_PY_MACHINE_PIN_MAKE_NEW mp_pin_make_new
141#define MICROPY_PY_MACHINE_PULSE (1)
142#define MICROPY_PY_MACHINE_I2C (1)
Damien Georgea2933472019-07-10 13:43:52 +1000143#define MICROPY_PY_MACHINE_I2C_MAKE_NEW machine_hw_i2c_make_new
Damien Georgebc08c882016-12-06 12:20:10 +1100144#define MICROPY_PY_MACHINE_SPI (1)
145#define MICROPY_PY_MACHINE_SPI_MSB (0)
146#define MICROPY_PY_MACHINE_SPI_LSB (1)
147#define MICROPY_PY_MACHINE_SPI_MAKE_NEW machine_hw_spi_make_new
Nicko van Someren8e3af7d2019-05-04 19:00:35 -0600148#define MICROPY_HW_ENABLE_SDCARD (1)
Damien George58ebeca2018-03-09 17:25:58 +1100149#define MICROPY_HW_SOFTSPI_MIN_DELAY (0)
150#define MICROPY_HW_SOFTSPI_MAX_BAUDRATE (ets_get_cpu_frequency() * 1000000 / 200) // roughly
Damien Georgebc08c882016-12-06 12:20:10 +1100151#define MICROPY_PY_USSL (1)
152#define MICROPY_SSL_MBEDTLS (1)
Damien George1c52d3e2017-10-30 16:19:52 +1100153#define MICROPY_PY_USSL_FINALISER (1)
Yonatan Goldschmidtbc4f8b42019-02-10 22:35:18 +0200154#define MICROPY_PY_UWEBSOCKET (1)
Damien Georgec1d43522018-04-27 23:57:57 +1000155#define MICROPY_PY_WEBREPL (1)
Damien Georgebc08c882016-12-06 12:20:10 +1100156#define MICROPY_PY_FRAMEBUF (1)
Damien Georgec1d43522018-04-27 23:57:57 +1000157#define MICROPY_PY_USOCKET_EVENTS (MICROPY_PY_WEBREPL)
Damien Georgebc08c882016-12-06 12:20:10 +1100158
159// fatfs configuration
160#define MICROPY_FATFS_ENABLE_LFN (1)
161#define MICROPY_FATFS_RPATH (2)
162#define MICROPY_FATFS_MAX_SS (4096)
Damien Georgeb5f33ac2019-02-25 23:46:17 +1100163#define MICROPY_FATFS_LFN_CODE_PAGE 437 /* 1=SFN/ANSI 437=LFN/U.S.(OEM) */
Damien Georgef35aae32018-06-06 12:00:23 +1000164#define mp_type_fileio mp_type_vfs_fat_fileio
165#define mp_type_textio mp_type_vfs_fat_textio
Damien Georgebc08c882016-12-06 12:20:10 +1100166
167// use vfs's functions for import stat and builtin open
168#define mp_import_stat mp_vfs_import_stat
169#define mp_builtin_open mp_vfs_open
170#define mp_builtin_open_obj mp_vfs_open_obj
171
172// extra built in names to add to the global namespace
173#define MICROPY_PORT_BUILTINS \
174 { MP_OBJ_NEW_QSTR(MP_QSTR_input), (mp_obj_t)&mp_builtin_input_obj }, \
175 { MP_OBJ_NEW_QSTR(MP_QSTR_open), (mp_obj_t)&mp_builtin_open_obj },
176
177// extra built in modules to add to the list of known ones
178extern const struct _mp_obj_module_t esp_module;
Eric Poulsenabec47a2018-02-15 07:59:28 -0800179extern const struct _mp_obj_module_t esp32_module;
Damien Georgebc08c882016-12-06 12:20:10 +1100180extern const struct _mp_obj_module_t utime_module;
181extern const struct _mp_obj_module_t uos_module;
182extern const struct _mp_obj_module_t mp_module_usocket;
183extern const struct _mp_obj_module_t mp_module_machine;
184extern const struct _mp_obj_module_t mp_module_network;
185extern const struct _mp_obj_module_t mp_module_onewire;
186
187#define MICROPY_PORT_BUILTIN_MODULES \
188 { MP_OBJ_NEW_QSTR(MP_QSTR_esp), (mp_obj_t)&esp_module }, \
Eric Poulsenabec47a2018-02-15 07:59:28 -0800189 { MP_OBJ_NEW_QSTR(MP_QSTR_esp32), (mp_obj_t)&esp32_module }, \
Damien Georgebc08c882016-12-06 12:20:10 +1100190 { MP_OBJ_NEW_QSTR(MP_QSTR_utime), (mp_obj_t)&utime_module }, \
191 { MP_OBJ_NEW_QSTR(MP_QSTR_uos), (mp_obj_t)&uos_module }, \
192 { MP_OBJ_NEW_QSTR(MP_QSTR_usocket), (mp_obj_t)&mp_module_usocket }, \
193 { MP_OBJ_NEW_QSTR(MP_QSTR_machine), (mp_obj_t)&mp_module_machine }, \
194 { MP_OBJ_NEW_QSTR(MP_QSTR_network), (mp_obj_t)&mp_module_network }, \
195 { MP_OBJ_NEW_QSTR(MP_QSTR__onewire), (mp_obj_t)&mp_module_onewire }, \
Nick Mooreb74809c2017-09-12 10:12:22 +1000196 { MP_OBJ_NEW_QSTR(MP_QSTR_uhashlib), (mp_obj_t)&mp_module_uhashlib }, \
Damien Georgebc08c882016-12-06 12:20:10 +1100197
198#define MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS \
199 { MP_OBJ_NEW_QSTR(MP_QSTR_binascii), (mp_obj_t)&mp_module_ubinascii }, \
200 { MP_OBJ_NEW_QSTR(MP_QSTR_collections), (mp_obj_t)&mp_module_collections }, \
201 { MP_OBJ_NEW_QSTR(MP_QSTR_errno), (mp_obj_t)&mp_module_uerrno }, \
202 { MP_OBJ_NEW_QSTR(MP_QSTR_hashlib), (mp_obj_t)&mp_module_uhashlib }, \
203 { MP_OBJ_NEW_QSTR(MP_QSTR_heapq), (mp_obj_t)&mp_module_uheapq }, \
204 { MP_OBJ_NEW_QSTR(MP_QSTR_io), (mp_obj_t)&mp_module_io }, \
205 { MP_OBJ_NEW_QSTR(MP_QSTR_json), (mp_obj_t)&mp_module_ujson }, \
206 { MP_OBJ_NEW_QSTR(MP_QSTR_os), (mp_obj_t)&uos_module }, \
207 { MP_OBJ_NEW_QSTR(MP_QSTR_random), (mp_obj_t)&mp_module_urandom }, \
208 { MP_OBJ_NEW_QSTR(MP_QSTR_re), (mp_obj_t)&mp_module_ure }, \
209 { MP_OBJ_NEW_QSTR(MP_QSTR_select), (mp_obj_t)&mp_module_uselect }, \
210 { MP_OBJ_NEW_QSTR(MP_QSTR_socket), (mp_obj_t)&mp_module_usocket }, \
211 { MP_OBJ_NEW_QSTR(MP_QSTR_ssl), (mp_obj_t)&mp_module_ussl }, \
212 { MP_OBJ_NEW_QSTR(MP_QSTR_struct), (mp_obj_t)&mp_module_ustruct }, \
213 { MP_OBJ_NEW_QSTR(MP_QSTR_time), (mp_obj_t)&utime_module }, \
214 { MP_OBJ_NEW_QSTR(MP_QSTR_zlib), (mp_obj_t)&mp_module_uzlib }, \
215
216#define MP_STATE_PORT MP_STATE_VM
217
Damien George9ac9aa92019-01-28 16:16:03 +1100218struct _machine_timer_obj_t;
219
Damien Georgebc08c882016-12-06 12:20:10 +1100220#define MICROPY_PORT_ROOT_POINTERS \
221 const char *readline_hist[8]; \
222 mp_obj_t machine_pin_irq_handler[40]; \
Damien George9ac9aa92019-01-28 16:16:03 +1100223 struct _machine_timer_obj_t *machine_timer_obj_head; \
Damien Georgebc08c882016-12-06 12:20:10 +1100224
225// type definitions for the specific machine
226
227#define BYTES_PER_WORD (4)
228#define MICROPY_MAKE_POINTER_CALLABLE(p) ((void*)((mp_uint_t)(p)))
229#define MP_PLAT_PRINT_STRN(str, len) mp_hal_stdout_tx_strn_cooked(str, len)
230#define MP_SSIZE_MAX (0x7fffffff)
231
232// Note: these "critical nested" macros do not ensure cross-CPU exclusion,
233// the only disable interrupts on the current CPU. To full manage exclusion
234// one should use portENTER_CRITICAL/portEXIT_CRITICAL instead.
235#include "freertos/FreeRTOS.h"
236#define MICROPY_BEGIN_ATOMIC_SECTION() portENTER_CRITICAL_NESTED()
237#define MICROPY_END_ATOMIC_SECTION(state) portEXIT_CRITICAL_NESTED(state)
238
Damien George999c8b92018-04-27 23:53:45 +1000239#if MICROPY_PY_USOCKET_EVENTS
240#define MICROPY_PY_USOCKET_EVENTS_HANDLER extern void usocket_events_handler(void); usocket_events_handler();
241#else
242#define MICROPY_PY_USOCKET_EVENTS_HANDLER
243#endif
244
Damien Georgebc08c882016-12-06 12:20:10 +1100245#if MICROPY_PY_THREAD
246#define MICROPY_EVENT_POLL_HOOK \
247 do { \
248 extern void mp_handle_pending(void); \
249 mp_handle_pending(); \
Damien George999c8b92018-04-27 23:53:45 +1000250 MICROPY_PY_USOCKET_EVENTS_HANDLER \
Damien Georgebc08c882016-12-06 12:20:10 +1100251 MP_THREAD_GIL_EXIT(); \
252 MP_THREAD_GIL_ENTER(); \
253 } while (0);
254#else
255#define MICROPY_EVENT_POLL_HOOK \
256 do { \
257 extern void mp_handle_pending(void); \
258 mp_handle_pending(); \
Damien George999c8b92018-04-27 23:53:45 +1000259 MICROPY_PY_USOCKET_EVENTS_HANDLER \
Damien Georgebc08c882016-12-06 12:20:10 +1100260 asm("waiti 0"); \
261 } while (0);
262#endif
263
264#define UINT_FMT "%u"
265#define INT_FMT "%d"
266
267typedef int32_t mp_int_t; // must be pointer size
268typedef uint32_t mp_uint_t; // must be pointer size
269typedef long mp_off_t;
270// ssize_t, off_t as required by POSIX-signatured functions in stream.h
271#include <sys/types.h>
272
273// board specifics
Damien Georgebc08c882016-12-06 12:20:10 +1100274#define MICROPY_PY_SYS_PLATFORM "esp32"
Damien George2ccf0302019-07-10 15:38:48 +1000275
276#ifndef MICROPY_HW_ENABLE_MDNS_QUERIES
277#define MICROPY_HW_ENABLE_MDNS_QUERIES (1)
278#endif
279
280#ifndef MICROPY_HW_ENABLE_MDNS_RESPONDER
281#define MICROPY_HW_ENABLE_MDNS_RESPONDER (1)
282#endif