blob: c308c31bda5620c5c8efb7f6909c3ae96fe1b811 [file] [log] [blame]
Damien George04b91472014-05-03 23:27:38 +01001/*
Damien Georgec408ed92017-06-26 12:29:20 +10002 * This file is part of the MicroPython project, http://micropython.org/
Damien George04b91472014-05-03 23:27:38 +01003 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2013, 2014 Damien P. George
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
Alexander Steffen299bc622017-06-29 23:14:58 +020026#ifndef MICROPY_INCLUDED_PY_MPCONFIG_H
27#define MICROPY_INCLUDED_PY_MPCONFIG_H
Damien George04b91472014-05-03 23:27:38 +010028
Damien George7cd59c52018-12-15 15:13:33 +110029// Current version of MicroPython
Damien Georgeaba83e62019-01-26 00:44:35 +110030#define MICROPY_VERSION_MAJOR 1
Damien Georgeda4b38e2022-01-17 09:50:31 +110031#define MICROPY_VERSION_MINOR 18
Damien George3e25d612019-01-26 00:56:48 +110032#define MICROPY_VERSION_MICRO 0
Damien George7cd59c52018-12-15 15:13:33 +110033
34// Combined version as a 32-bit number for convenience
35#define MICROPY_VERSION ( \
36 MICROPY_VERSION_MAJOR << 16 \
Damien George69661f32020-02-27 15:36:53 +110037 | MICROPY_VERSION_MINOR << 8 \
38 | MICROPY_VERSION_MICRO)
Damien George7cd59c52018-12-15 15:13:33 +110039
40// String version
41#define MICROPY_VERSION_STRING \
42 MP_STRINGIFY(MICROPY_VERSION_MAJOR) "." \
43 MP_STRINGIFY(MICROPY_VERSION_MINOR) "." \
44 MP_STRINGIFY(MICROPY_VERSION_MICRO)
45
Paul Sokolovskyb372bfc2014-01-03 17:15:53 +020046// This file contains default configuration settings for MicroPython.
Paul Sokolovskyb1422de2014-10-29 04:08:49 +020047// You can override any of the options below using mpconfigport.h file
48// located in a directory of your port.
Paul Sokolovskyb372bfc2014-01-03 17:15:53 +020049
Paul Sokolovskyb1422de2014-10-29 04:08:49 +020050// mpconfigport.h is a file containing configuration settings for a
51// particular port. mpconfigport.h is actually a default name for
Ville Skyttäca16c382017-05-29 10:08:14 +030052// such config, and it can be overridden using MP_CONFIGFILE preprocessor
Paul Sokolovskyb1422de2014-10-29 04:08:49 +020053// define (you can do that by passing CFLAGS_EXTRA='-DMP_CONFIGFILE="<file.h>"'
54// argument to make when using standard MicroPython makefiles).
55// This is useful to have more than one config per port, for example,
56// release vs debug configs, etc. Note that if you switch from one config
57// to another, you must rebuild from scratch using "-B" switch to make.
58
59#ifdef MP_CONFIGFILE
60#include MP_CONFIGFILE
61#else
Damien George8340c482014-06-12 19:50:17 +010062#include <mpconfigport.h>
Paul Sokolovskyb1422de2014-10-29 04:08:49 +020063#endif
Paul Sokolovskyb372bfc2014-01-03 17:15:53 +020064
Jim Mussared01374d92021-08-14 01:43:15 +100065// Disable all optional features (i.e. minimal port).
66#define MICROPY_CONFIG_ROM_LEVEL_MINIMUM (0)
67// Only enable core features (constrained flash, e.g. STM32L072)
68#define MICROPY_CONFIG_ROM_LEVEL_CORE_FEATURES (10)
69// Enable most common features (small on-device flash, e.g. STM32F411)
70#define MICROPY_CONFIG_ROM_LEVEL_BASIC_FEATURES (20)
71// Enable convenience features (medium on-device flash, e.g. STM32F405)
72#define MICROPY_CONFIG_ROM_LEVEL_EXTRA_FEATURES (30)
73// Enable all common features (large/external flash, rp2, unix)
74#define MICROPY_CONFIG_ROM_LEVEL_FULL_FEATURES (40)
75// Enable everything (e.g. coverage)
76#define MICROPY_CONFIG_ROM_LEVEL_EVERYTHING (50)
77
78// Ports/boards should set this, but default to level=core.
79#ifndef MICROPY_CONFIG_ROM_LEVEL
80#define MICROPY_CONFIG_ROM_LEVEL (MICROPY_CONFIG_ROM_LEVEL_CORE_FEATURES)
81#endif
82
83// Helper macros for "have at least this level".
84#define MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES (MICROPY_CONFIG_ROM_LEVEL >= MICROPY_CONFIG_ROM_LEVEL_CORE_FEATURES)
85#define MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_BASIC_FEATURES (MICROPY_CONFIG_ROM_LEVEL >= MICROPY_CONFIG_ROM_LEVEL_BASIC_FEATURES)
86#define MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES (MICROPY_CONFIG_ROM_LEVEL >= MICROPY_CONFIG_ROM_LEVEL_EXTRA_FEATURES)
87#define MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_FULL_FEATURES (MICROPY_CONFIG_ROM_LEVEL >= MICROPY_CONFIG_ROM_LEVEL_FULL_FEATURES)
88#define MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EVERYTHING (MICROPY_CONFIG_ROM_LEVEL >= MICROPY_CONFIG_ROM_LEVEL_EVERYTHING)
89
Damien George136f6752014-01-07 14:54:15 +000090// Any options not explicitly set in mpconfigport.h will get default
91// values below.
92
93/*****************************************************************************/
Damien George567184e2015-03-29 14:05:46 +010094/* Object representation */
95
Damien Georgec408ed92017-06-26 12:29:20 +100096// A MicroPython object is a machine word having the following form:
Damien George567184e2015-03-29 14:05:46 +010097// - xxxx...xxx1 : a small int, bits 1 and above are the value
Damien George6f0c83f2020-01-08 23:58:40 +110098// - xxxx...x010 : a qstr, bits 3 and above are the value
99// - xxxx...x110 : an immediate object, bits 3 and above are the value
Damien George567184e2015-03-29 14:05:46 +0100100// - xxxx...xx00 : a pointer to an mp_obj_base_t (unless a fake object)
101#define MICROPY_OBJ_REPR_A (0)
102
Damien Georgec408ed92017-06-26 12:29:20 +1000103// A MicroPython object is a machine word having the following form:
Damien George567184e2015-03-29 14:05:46 +0100104// - xxxx...xx01 : a small int, bits 2 and above are the value
Damien George6f0c83f2020-01-08 23:58:40 +1100105// - xxxx...x011 : a qstr, bits 3 and above are the value
106// - xxxx...x111 : an immediate object, bits 3 and above are the value
Damien George567184e2015-03-29 14:05:46 +0100107// - xxxx...xxx0 : a pointer to an mp_obj_base_t (unless a fake object)
108#define MICROPY_OBJ_REPR_B (1)
109
Damien George8b8d1892015-11-06 23:25:10 +0000110// A MicroPython object is a machine word having the following form (called R):
Damien George183edef2015-10-17 23:20:57 +0100111// - iiiiiiii iiiiiiii iiiiiiii iiiiiii1 small int with 31-bit signed value
Damien George6f0c83f2020-01-08 23:58:40 +1100112// - 01111111 1qqqqqqq qqqqqqqq qqqq0110 str with 19-bit qstr value
113// - 01111111 10000000 00000000 ssss1110 immediate object with 4-bit value
Damien George183edef2015-10-17 23:20:57 +0100114// - s1111111 10000000 00000000 00000010 +/- inf
115// - s1111111 1xxxxxxx xxxxxxxx xxxxx010 nan, x != 0
116// - seeeeeee efffffff ffffffff ffffff10 30-bit fp, e != 0xff
117// - pppppppp pppppppp pppppppp pppppp00 ptr (4 byte alignment)
Damien George6f0c83f2020-01-08 23:58:40 +1100118// Str, immediate and float stored as O = R + 0x80800000, retrieved as R = O - 0x80800000.
119// This makes strs/immediates easier to encode/decode as they have zeros in the top 9 bits.
Damien George183edef2015-10-17 23:20:57 +0100120// This scheme only works with 32-bit word size and float enabled.
121#define MICROPY_OBJ_REPR_C (2)
122
Damien Georgeb8cfb0d2015-11-27 17:09:11 +0000123// A MicroPython object is a 64-bit word having the following form (called R):
124// - seeeeeee eeeeffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff 64-bit fp, e != 0x7ff
125// - s1111111 11110000 00000000 00000000 00000000 00000000 00000000 00000000 +/- inf
126// - 01111111 11111000 00000000 00000000 00000000 00000000 00000000 00000000 normalised nan
Damien George2759bec2017-12-11 22:39:12 +1100127// - 01111111 11111101 iiiiiiii iiiiiiii iiiiiiii iiiiiiii iiiiiiii iiiiiii1 small int
Damien Georgeb8cfb0d2015-11-27 17:09:11 +0000128// - 01111111 11111110 00000000 00000000 qqqqqqqq qqqqqqqq qqqqqqqq qqqqqqq1 str
Damien George6f0c83f2020-01-08 23:58:40 +1100129// - 01111111 11111111 ss000000 00000000 00000000 00000000 00000000 00000000 immediate object
Damien Georgeb8cfb0d2015-11-27 17:09:11 +0000130// - 01111111 11111100 00000000 00000000 pppppppp pppppppp pppppppp pppppp00 ptr (4 byte alignment)
131// Stored as O = R + 0x8004000000000000, retrieved as R = O - 0x8004000000000000.
132// This makes pointers have all zeros in the top 32 bits.
133// Small-ints and strs have 1 as LSB to make sure they don't look like pointers
134// to the garbage collector.
135#define MICROPY_OBJ_REPR_D (3)
136
Damien George567184e2015-03-29 14:05:46 +0100137#ifndef MICROPY_OBJ_REPR
138#define MICROPY_OBJ_REPR (MICROPY_OBJ_REPR_A)
139#endif
140
Damien Georged96cfd12020-01-09 00:00:27 +1100141// Whether to encode None/False/True as immediate objects instead of pointers to
142// real objects. Reduces code size by a decent amount without hurting
143// performance, for all representations except D on some architectures.
144#ifndef MICROPY_OBJ_IMMEDIATE_OBJS
145#define MICROPY_OBJ_IMMEDIATE_OBJS (MICROPY_OBJ_REPR != MICROPY_OBJ_REPR_D)
146#endif
147
Damien George567184e2015-03-29 14:05:46 +0100148/*****************************************************************************/
Damien George66e18f02014-05-05 13:19:03 +0100149/* Memory allocation policy */
150
Paul Sokolovsky75feece2015-12-03 01:40:52 +0200151// Number of bytes in memory allocation/GC block. Any size allocated will be
152// rounded up to be multiples of this.
Paul Sokolovskyb4eccfd2015-12-03 01:57:50 +0200153#ifndef MICROPY_BYTES_PER_GC_BLOCK
Damien Georgead4656b2021-02-04 16:39:09 +1100154#define MICROPY_BYTES_PER_GC_BLOCK (4 * MP_BYTES_PER_OBJ_WORD)
Paul Sokolovskyb4eccfd2015-12-03 01:57:50 +0200155#endif
Paul Sokolovsky75feece2015-12-03 01:40:52 +0200156
Damien Georgefd40a9c2015-01-01 22:04:46 +0000157// Number of words allocated (in BSS) to the GC stack (minimum is 1)
158#ifndef MICROPY_ALLOC_GC_STACK_SIZE
159#define MICROPY_ALLOC_GC_STACK_SIZE (64)
160#endif
161
Ayke van Laethem31cf5282018-02-23 18:59:31 +0100162// The C-type to use for entries in the GC stack. By default it allows the
163// heap to be as large as the address space, but the bit-width of this type can
164// be reduced to save memory when the heap is small enough. The type must be
165// big enough to index all blocks in the heap, which is set by
166// heap-size-in-bytes / MICROPY_BYTES_PER_GC_BLOCK.
167#ifndef MICROPY_GC_STACK_ENTRY_TYPE
168#define MICROPY_GC_STACK_ENTRY_TYPE size_t
169#endif
170
Damien George5ffe1d82016-08-26 15:35:26 +1000171// Be conservative and always clear to zero newly (re)allocated memory in the GC.
172// This helps eliminate stray pointers that hold on to memory that's no longer
173// used. It decreases performance due to unnecessary memory clearing.
Colin Hogben828df542016-10-31 14:52:11 +0000174// A memory manager which always clears memory can set this to 0.
Damien George5ffe1d82016-08-26 15:35:26 +1000175// TODO Do analysis to understand why some memory is not properly cleared and
176// find a more efficient way to clear it.
177#ifndef MICROPY_GC_CONSERVATIVE_CLEAR
Colin Hogben828df542016-10-31 14:52:11 +0000178#define MICROPY_GC_CONSERVATIVE_CLEAR (MICROPY_ENABLE_GC)
Damien George5ffe1d82016-08-26 15:35:26 +1000179#endif
180
Paul Sokolovsky93e353e2016-07-21 00:37:30 +0300181// Support automatic GC when reaching allocation threshold,
182// configurable by gc.threshold().
183#ifndef MICROPY_GC_ALLOC_THRESHOLD
Jim Mussared01374d92021-08-14 01:43:15 +1000184#define MICROPY_GC_ALLOC_THRESHOLD (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovsky93e353e2016-07-21 00:37:30 +0300185#endif
186
Damien Georgeade9a052015-06-13 21:53:22 +0100187// Number of bytes to allocate initially when creating new chunks to store
188// interned string data. Smaller numbers lead to more chunks being needed
189// and more wastage at the end of the chunk. Larger numbers lead to wasted
190// space at the end when no more strings need interning.
191#ifndef MICROPY_ALLOC_QSTR_CHUNK_INIT
192#define MICROPY_ALLOC_QSTR_CHUNK_INIT (128)
193#endif
194
Damien Georgee1199ec2014-05-10 17:48:01 +0100195// Initial amount for lexer indentation level
Damien George58ebde42014-05-21 20:32:59 +0100196#ifndef MICROPY_ALLOC_LEXER_INDENT_INIT
197#define MICROPY_ALLOC_LEXER_INDENT_INIT (10)
Damien Georgee1199ec2014-05-10 17:48:01 +0100198#endif
199
200// Increment for lexer indentation level
Damien George58ebde42014-05-21 20:32:59 +0100201#ifndef MICROPY_ALLOC_LEXEL_INDENT_INC
202#define MICROPY_ALLOC_LEXEL_INDENT_INC (8)
Damien Georgee1199ec2014-05-10 17:48:01 +0100203#endif
204
Damien George66e18f02014-05-05 13:19:03 +0100205// Initial amount for parse rule stack
Damien George58ebde42014-05-21 20:32:59 +0100206#ifndef MICROPY_ALLOC_PARSE_RULE_INIT
207#define MICROPY_ALLOC_PARSE_RULE_INIT (64)
Damien George66e18f02014-05-05 13:19:03 +0100208#endif
209
210// Increment for parse rule stack
Damien George58ebde42014-05-21 20:32:59 +0100211#ifndef MICROPY_ALLOC_PARSE_RULE_INC
212#define MICROPY_ALLOC_PARSE_RULE_INC (16)
Damien George66e18f02014-05-05 13:19:03 +0100213#endif
214
215// Initial amount for parse result stack
Damien George58ebde42014-05-21 20:32:59 +0100216#ifndef MICROPY_ALLOC_PARSE_RESULT_INIT
217#define MICROPY_ALLOC_PARSE_RESULT_INIT (32)
Damien George66e18f02014-05-05 13:19:03 +0100218#endif
219
220// Increment for parse result stack
Damien George58ebde42014-05-21 20:32:59 +0100221#ifndef MICROPY_ALLOC_PARSE_RESULT_INC
222#define MICROPY_ALLOC_PARSE_RESULT_INC (16)
Damien George66e18f02014-05-05 13:19:03 +0100223#endif
224
Damien George5042bce2014-05-25 22:06:06 +0100225// Strings this length or less will be interned by the parser
226#ifndef MICROPY_ALLOC_PARSE_INTERN_STRING_LEN
227#define MICROPY_ALLOC_PARSE_INTERN_STRING_LEN (10)
228#endif
229
Damien George58e0f4a2015-09-23 10:50:43 +0100230// Number of bytes to allocate initially when creating new chunks to store
231// parse nodes. Small leads to fragmentation, large leads to excess use.
232#ifndef MICROPY_ALLOC_PARSE_CHUNK_INIT
233#define MICROPY_ALLOC_PARSE_CHUNK_INIT (128)
234#endif
235
Damien George66e18f02014-05-05 13:19:03 +0100236// Initial amount for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100237#ifndef MICROPY_ALLOC_SCOPE_ID_INIT
238#define MICROPY_ALLOC_SCOPE_ID_INIT (4)
Damien George66e18f02014-05-05 13:19:03 +0100239#endif
240
241// Increment for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100242#ifndef MICROPY_ALLOC_SCOPE_ID_INC
243#define MICROPY_ALLOC_SCOPE_ID_INC (6)
244#endif
245
246// Maximum length of a path in the filesystem
247// So we can allocate a buffer on the stack for path manipulation in import
248#ifndef MICROPY_ALLOC_PATH_MAX
249#define MICROPY_ALLOC_PATH_MAX (512)
Damien George66e18f02014-05-05 13:19:03 +0100250#endif
251
Paul Sokolovsky346aacf2014-11-05 00:27:15 +0200252// Initial size of module dict
253#ifndef MICROPY_MODULE_DICT_SIZE
254#define MICROPY_MODULE_DICT_SIZE (1)
255#endif
256
matejcik1a2ffda2021-03-22 11:20:22 +0100257// Initial size of sys.modules dict
258#ifndef MICROPY_LOADED_MODULES_DICT_SIZE
259#define MICROPY_LOADED_MODULES_DICT_SIZE (3)
260#endif
261
Damien Georged8914522015-02-27 09:54:12 +0000262// Whether realloc/free should be passed allocated memory region size
263// You must enable this if MICROPY_MEM_STATS is enabled
264#ifndef MICROPY_MALLOC_USES_ALLOCATED_SIZE
265#define MICROPY_MALLOC_USES_ALLOCATED_SIZE (0)
266#endif
267
Damien George95836f82015-01-11 22:27:30 +0000268// Number of bytes used to store qstr length
269// Dictates hard limit on maximum Python identifier length, but 1 byte
270// (limit of 255 bytes in an identifier) should be enough for everyone
271#ifndef MICROPY_QSTR_BYTES_IN_LEN
272#define MICROPY_QSTR_BYTES_IN_LEN (1)
273#endif
274
Damien Georgec3bd9412015-07-20 11:03:13 +0000275// Number of bytes used to store qstr hash
276#ifndef MICROPY_QSTR_BYTES_IN_HASH
Jim Mussared01374d92021-08-14 01:43:15 +1000277#if MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES
Damien Georgec3bd9412015-07-20 11:03:13 +0000278#define MICROPY_QSTR_BYTES_IN_HASH (2)
Jim Mussared01374d92021-08-14 01:43:15 +1000279#else
280#define MICROPY_QSTR_BYTES_IN_HASH (1)
281#endif
Damien Georgec3bd9412015-07-20 11:03:13 +0000282#endif
283
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200284// Avoid using C stack when making Python function calls. C stack still
285// may be used if there's no free heap.
Paul Sokolovsky20397572015-03-28 01:14:44 +0200286#ifndef MICROPY_STACKLESS
287#define MICROPY_STACKLESS (0)
288#endif
289
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200290// Never use C stack when making Python function calls. This may break
291// testsuite as will subtly change which exception is thrown in case
292// of too deep recursion and other similar cases.
293#ifndef MICROPY_STACKLESS_STRICT
294#define MICROPY_STACKLESS_STRICT (0)
295#endif
296
Paul Sokolovskyf32020e2015-11-25 23:22:31 +0200297// Don't use alloca calls. As alloca() is not part of ANSI C, this
298// workaround option is provided for compilers lacking this de-facto
299// standard function. The way it works is allocating from heap, and
300// relying on garbage collection to free it eventually. This is of
301// course much less optimal than real alloca().
302#if defined(MICROPY_NO_ALLOCA) && MICROPY_NO_ALLOCA
303#undef alloca
304#define alloca(x) m_malloc(x)
305#endif
306
Damien George66e18f02014-05-05 13:19:03 +0100307/*****************************************************************************/
Damien Georgec408ed92017-06-26 12:29:20 +1000308/* MicroPython emitters */
Damien George136f6752014-01-07 14:54:15 +0000309
Damien Georged8c834c2015-11-02 21:55:42 +0000310// Whether to support loading of persistent code
311#ifndef MICROPY_PERSISTENT_CODE_LOAD
312#define MICROPY_PERSISTENT_CODE_LOAD (0)
313#endif
314
315// Whether to support saving of persistent code
316#ifndef MICROPY_PERSISTENT_CODE_SAVE
317#define MICROPY_PERSISTENT_CODE_SAVE (0)
318#endif
319
David CARLIERcb309282021-01-16 20:48:19 +0000320// Whether to support saving persistent code to a file via mp_raw_code_save_file
321#ifndef MICROPY_PERSISTENT_CODE_SAVE_FILE
322#define MICROPY_PERSISTENT_CODE_SAVE_FILE (0)
323#endif
324
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000325// Whether generated code can persist independently of the VM/runtime instance
Damien Georged8c834c2015-11-02 21:55:42 +0000326// This is enabled automatically when needed by other features
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000327#ifndef MICROPY_PERSISTENT_CODE
Damien George0a2e9652016-01-31 22:24:16 +0000328#define MICROPY_PERSISTENT_CODE (MICROPY_PERSISTENT_CODE_LOAD || MICROPY_PERSISTENT_CODE_SAVE || MICROPY_MODULE_FROZEN_MPY)
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000329#endif
330
Damien Georgef2040bf2021-10-22 22:22:47 +1100331// Whether bytecode uses a qstr_table to map internal qstr indices in the bytecode
332// to global qstr values in the runtime (behaviour when feature is enabled), or
333// just stores global qstr values directly in the bytecode. This must be enabled
334// if MICROPY_PERSISTENT_CODE is enabled.
335#ifndef MICROPY_EMIT_BYTECODE_USES_QSTR_TABLE
336#define MICROPY_EMIT_BYTECODE_USES_QSTR_TABLE (MICROPY_PERSISTENT_CODE)
337#endif
338
Damien George136f6752014-01-07 14:54:15 +0000339// Whether to emit x64 native code
340#ifndef MICROPY_EMIT_X64
341#define MICROPY_EMIT_X64 (0)
342#endif
343
Damien Georgec90f59e2014-09-06 23:06:36 +0100344// Whether to emit x86 native code
345#ifndef MICROPY_EMIT_X86
346#define MICROPY_EMIT_X86 (0)
347#endif
348
Damien George136f6752014-01-07 14:54:15 +0000349// Whether to emit thumb native code
350#ifndef MICROPY_EMIT_THUMB
351#define MICROPY_EMIT_THUMB (0)
352#endif
353
graham sanderson40d20102020-12-12 13:04:10 -0600354// Whether to emit ARMv7-M instruction support in thumb native code
355#ifndef MICROPY_EMIT_THUMB_ARMV7M
356#define MICROPY_EMIT_THUMB_ARMV7M (1)
357#endif
358
Damien George136f6752014-01-07 14:54:15 +0000359// Whether to enable the thumb inline assembler
360#ifndef MICROPY_EMIT_INLINE_THUMB
361#define MICROPY_EMIT_INLINE_THUMB (0)
362#endif
363
Damien Georgee8135412015-10-16 22:08:57 +0100364// Whether to enable ARMv7-M instruction support in the Thumb2 inline assembler
365#ifndef MICROPY_EMIT_INLINE_THUMB_ARMV7M
366#define MICROPY_EMIT_INLINE_THUMB_ARMV7M (1)
367#endif
368
=50089722015-04-14 13:14:57 +0100369// Whether to enable float support in the Thumb2 inline assembler
370#ifndef MICROPY_EMIT_INLINE_THUMB_FLOAT
371#define MICROPY_EMIT_INLINE_THUMB_FLOAT (1)
372#endif
373
Fabian Vogtfe3d16e2014-08-16 22:55:53 +0200374// Whether to emit ARM native code
375#ifndef MICROPY_EMIT_ARM
376#define MICROPY_EMIT_ARM (0)
377#endif
378
Damien George8e5aced2016-12-09 16:39:39 +1100379// Whether to emit Xtensa native code
380#ifndef MICROPY_EMIT_XTENSA
381#define MICROPY_EMIT_XTENSA (0)
382#endif
383
Damien Georgef76b1bf2016-12-09 17:03:33 +1100384// Whether to enable the Xtensa inline assembler
385#ifndef MICROPY_EMIT_INLINE_XTENSA
386#define MICROPY_EMIT_INLINE_XTENSA (0)
387#endif
388
Damien George9adedce2019-09-13 13:15:12 +1000389// Whether to emit Xtensa-Windowed native code
390#ifndef MICROPY_EMIT_XTENSAWIN
391#define MICROPY_EMIT_XTENSAWIN (0)
392#endif
393
Damien George2ac4af62014-08-15 16:45:41 +0100394// Convenience definition for whether any native emitter is enabled
Damien George9adedce2019-09-13 13:15:12 +1000395#define MICROPY_EMIT_NATIVE (MICROPY_EMIT_X64 || MICROPY_EMIT_X86 || MICROPY_EMIT_THUMB || MICROPY_EMIT_ARM || MICROPY_EMIT_XTENSA || MICROPY_EMIT_XTENSAWIN)
396
397// Select prelude-as-bytes-object for certain emitters
398#define MICROPY_EMIT_NATIVE_PRELUDE_AS_BYTES_OBJ (MICROPY_EMIT_XTENSAWIN)
Damien George2ac4af62014-08-15 16:45:41 +0100399
Damien Georgead297a12016-12-09 13:17:49 +1100400// Convenience definition for whether any inline assembler emitter is enabled
Damien Georgef76b1bf2016-12-09 17:03:33 +1100401#define MICROPY_EMIT_INLINE_ASM (MICROPY_EMIT_INLINE_THUMB || MICROPY_EMIT_INLINE_XTENSA)
Damien Georgead297a12016-12-09 13:17:49 +1100402
Jun Wub152bbd2019-05-06 00:31:11 -0700403// Convenience definition for whether any native or inline assembler emitter is enabled
404#define MICROPY_EMIT_MACHINE_CODE (MICROPY_EMIT_NATIVE || MICROPY_EMIT_INLINE_ASM)
405
Damien George9883d8e2020-07-27 23:52:38 +1000406// Whether native relocatable code loaded from .mpy files is explicitly tracked
407// so that the GC cannot reclaim it. Needed on architectures that allocate
408// executable memory on the MicroPython heap and don't explicitly track this
409// data some other way.
410#ifndef MICROPY_PERSISTENT_CODE_TRACK_RELOC_CODE
411#if !MICROPY_EMIT_MACHINE_CODE || defined(MP_PLAT_ALLOC_EXEC) || defined(MP_PLAT_COMMIT_EXEC)
412#define MICROPY_PERSISTENT_CODE_TRACK_RELOC_CODE (0)
413#else
414#define MICROPY_PERSISTENT_CODE_TRACK_RELOC_CODE (1)
415#endif
416#endif
417
Damien George136f6752014-01-07 14:54:15 +0000418/*****************************************************************************/
Damien George58ebde42014-05-21 20:32:59 +0100419/* Compiler configuration */
420
Damien Georgedd5353a2015-12-18 12:35:44 +0000421// Whether to include the compiler
422#ifndef MICROPY_ENABLE_COMPILER
Jim Mussared01374d92021-08-14 01:43:15 +1000423#define MICROPY_ENABLE_COMPILER (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien Georgedd5353a2015-12-18 12:35:44 +0000424#endif
425
Damien Georgeea235202016-02-11 22:30:53 +0000426// Whether the compiler is dynamically configurable (ie at runtime)
Damien Georgea4f1d822019-05-29 21:17:29 +1000427// This will disable the ability to execute native/viper code
Damien Georgeea235202016-02-11 22:30:53 +0000428#ifndef MICROPY_DYNAMIC_COMPILER
429#define MICROPY_DYNAMIC_COMPILER (0)
430#endif
431
432// Configure dynamic compiler macros
433#if MICROPY_DYNAMIC_COMPILER
Damien Georgeea235202016-02-11 22:30:53 +0000434#define MICROPY_PY_BUILTINS_STR_UNICODE_DYNAMIC (mp_dynamic_compiler.py_builtins_str_unicode)
435#else
Damien Georgeea235202016-02-11 22:30:53 +0000436#define MICROPY_PY_BUILTINS_STR_UNICODE_DYNAMIC MICROPY_PY_BUILTINS_STR_UNICODE
437#endif
438
Damien George64f2b212015-10-08 14:58:15 +0100439// Whether to enable constant folding; eg 1+2 rewritten as 3
440#ifndef MICROPY_COMP_CONST_FOLDING
Jim Mussared01374d92021-08-14 01:43:15 +1000441#define MICROPY_COMP_CONST_FOLDING (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien George64f2b212015-10-08 14:58:15 +0100442#endif
443
Damien George35c0cff2022-03-31 14:27:47 +1100444// Whether to compile constant tuples immediately to their respective objects; eg (1, True)
445// Otherwise the tuple will be built at runtime
446#ifndef MICROPY_COMP_CONST_TUPLE
447#define MICROPY_COMP_CONST_TUPLE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
448#endif
449
Damien George07796932019-02-27 00:10:04 +1100450// Whether to enable optimisations for constant literals, eg OrderedDict
451#ifndef MICROPY_COMP_CONST_LITERAL
Jim Mussared01374d92021-08-14 01:43:15 +1000452#define MICROPY_COMP_CONST_LITERAL (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien George07796932019-02-27 00:10:04 +1100453#endif
454
Damien Georgeddd1e182015-01-10 14:07:24 +0000455// Whether to enable lookup of constants in modules; eg module.CONST
456#ifndef MICROPY_COMP_MODULE_CONST
Jim Mussared0e236ee2021-09-15 23:18:23 +1000457#define MICROPY_COMP_MODULE_CONST (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgeddd1e182015-01-10 14:07:24 +0000458#endif
459
Damien George58ebde42014-05-21 20:32:59 +0100460// Whether to enable constant optimisation; id = const(value)
461#ifndef MICROPY_COMP_CONST
Jim Mussared01374d92021-08-14 01:43:15 +1000462#define MICROPY_COMP_CONST (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien George58ebde42014-05-21 20:32:59 +0100463#endif
464
Damien George42e0c592015-03-14 13:11:35 +0000465// Whether to enable optimisation of: a, b = c, d
466// Costs 124 bytes (Thumb2)
467#ifndef MICROPY_COMP_DOUBLE_TUPLE_ASSIGN
Jim Mussared01374d92021-08-14 01:43:15 +1000468#define MICROPY_COMP_DOUBLE_TUPLE_ASSIGN (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien George42e0c592015-03-14 13:11:35 +0000469#endif
470
471// Whether to enable optimisation of: a, b, c = d, e, f
Damien George253f2bd2018-02-04 13:35:21 +1100472// Requires MICROPY_COMP_DOUBLE_TUPLE_ASSIGN and costs 68 bytes (Thumb2)
Damien George42e0c592015-03-14 13:11:35 +0000473#ifndef MICROPY_COMP_TRIPLE_TUPLE_ASSIGN
Jim Mussared0e236ee2021-09-15 23:18:23 +1000474#define MICROPY_COMP_TRIPLE_TUPLE_ASSIGN (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George42e0c592015-03-14 13:11:35 +0000475#endif
476
Damien Georgeae54fbf2017-04-22 14:58:01 +1000477// Whether to enable optimisation of: return a if b else c
478// Costs about 80 bytes (Thumb2) and saves 2 bytes of bytecode for each use
479#ifndef MICROPY_COMP_RETURN_IF_EXPR
Jim Mussared0e236ee2021-09-15 23:18:23 +1000480#define MICROPY_COMP_RETURN_IF_EXPR (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgeae54fbf2017-04-22 14:58:01 +1000481#endif
482
Damien George58ebde42014-05-21 20:32:59 +0100483/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000484/* Internal debugging stuff */
485
486// Whether to collect memory allocation stats
487#ifndef MICROPY_MEM_STATS
488#define MICROPY_MEM_STATS (0)
489#endif
490
Damien Georgeda2d2b62018-08-02 14:04:44 +1000491// The mp_print_t printer used for debugging output
492#ifndef MICROPY_DEBUG_PRINTER
493#define MICROPY_DEBUG_PRINTER (&mp_plat_print)
494#endif
495
Damien Georgecbd2f742014-01-19 11:48:48 +0000496// Whether to build functions that print debugging info:
Damien George3417bc22014-05-10 10:36:38 +0100497// mp_bytecode_print
Damien Georgecbd2f742014-01-19 11:48:48 +0000498// mp_parse_node_print
499#ifndef MICROPY_DEBUG_PRINTERS
500#define MICROPY_DEBUG_PRINTERS (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000501#endif
502
Stefan Naumannace9fb52017-07-24 18:55:14 +0200503// Whether to enable all debugging outputs (it will be extremely verbose)
504#ifndef MICROPY_DEBUG_VERBOSE
505#define MICROPY_DEBUG_VERBOSE (0)
506#endif
507
Damien George02cc2882019-03-08 15:48:20 +1100508// Whether to enable debugging versions of MP_OBJ_NULL/STOP_ITERATION/SENTINEL
509#ifndef MICROPY_DEBUG_MP_OBJ_SENTINELS
510#define MICROPY_DEBUG_MP_OBJ_SENTINELS (0)
511#endif
512
Damien George843dcd42020-09-30 23:34:42 +1000513// Whether to print parse rule names (rather than integers) in mp_parse_node_print
514#ifndef MICROPY_DEBUG_PARSE_RULE_NAME
515#define MICROPY_DEBUG_PARSE_RULE_NAME (0)
516#endif
517
Damien George6d199342019-01-04 17:09:41 +1100518// Whether to enable a simple VM stack overflow check
519#ifndef MICROPY_DEBUG_VM_STACK_OVERFLOW
520#define MICROPY_DEBUG_VM_STACK_OVERFLOW (0)
521#endif
522
Damien George136f6752014-01-07 14:54:15 +0000523/*****************************************************************************/
Damien Georgeee3fd462014-05-24 23:03:12 +0100524/* Optimisations */
525
526// Whether to use computed gotos in the VM, or a switch
Jim Mussaredb51e7e92021-08-19 17:49:33 +1000527// Computed gotos are roughly 10% faster, and increase VM code size by a little,
528// e.g. ~1kiB on Cortex M4.
Damien George44f0a4d2017-09-18 23:53:33 +1000529// Note: enabling this will use the gcc-specific extensions of ranged designated
530// initialisers and addresses of labels, which are not part of the C99 standard.
Damien Georgeee3fd462014-05-24 23:03:12 +0100531#ifndef MICROPY_OPT_COMPUTED_GOTO
532#define MICROPY_OPT_COMPUTED_GOTO (0)
533#endif
534
Jim Mussared7b89ad82021-08-19 22:46:40 +1000535// Optimise the fast path for loading attributes from instance types. Increases
536// Thumb2 code size by about 48 bytes.
537#ifndef MICROPY_OPT_LOAD_ATTR_FAST_PATH
Jim Mussared0e236ee2021-09-15 23:18:23 +1000538#define MICROPY_OPT_LOAD_ATTR_FAST_PATH (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Jim Mussared7b89ad82021-08-19 22:46:40 +1000539#endif
540
Jim Mussared11ef8f22021-08-18 14:52:48 +1000541// Use extra RAM to cache map lookups by remembering the likely location of
542// the index. Avoids the hash computation on unordered maps, and avoids the
543// linear search on ordered (especially in-ROM) maps. Can provide a +10-15%
544// performance improvement on benchmarks involving lots of attribute access
545// or dictionary lookup.
546#ifndef MICROPY_OPT_MAP_LOOKUP_CACHE
Jim Mussared0e236ee2021-09-15 23:18:23 +1000547#define MICROPY_OPT_MAP_LOOKUP_CACHE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Jim Mussared11ef8f22021-08-18 14:52:48 +1000548#endif
549
550// How much RAM (in bytes) to use for the map lookup cache.
551#ifndef MICROPY_OPT_MAP_LOOKUP_CACHE_SIZE
552#define MICROPY_OPT_MAP_LOOKUP_CACHE_SIZE (128)
553#endif
554
Doug Currie2e2e15c2016-01-30 22:35:58 -0500555// Whether to use fast versions of bitwise operations (and, or, xor) when the
556// arguments are both positive. Increases Thumb2 code size by about 250 bytes.
557#ifndef MICROPY_OPT_MPZ_BITWISE
Jim Mussared0e236ee2021-09-15 23:18:23 +1000558#define MICROPY_OPT_MPZ_BITWISE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Doug Currie2e2e15c2016-01-30 22:35:58 -0500559#endif
560
Christopher Swenson8c656752018-08-27 10:32:21 +1000561
562// Whether math.factorial is large, fast and recursive (1) or small and slow (0).
563#ifndef MICROPY_OPT_MATH_FACTORIAL
Jim Mussared0e236ee2021-09-15 23:18:23 +1000564#define MICROPY_OPT_MATH_FACTORIAL (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Christopher Swenson8c656752018-08-27 10:32:21 +1000565#endif
566
Damien Georgeee3fd462014-05-24 23:03:12 +0100567/*****************************************************************************/
568/* Python internal features */
Damien George136f6752014-01-07 14:54:15 +0000569
Damien George20993682018-02-20 18:00:44 +1100570// Whether to enable import of external modules
571// When disabled, only importing of built-in modules is supported
572// When enabled, a port must implement mp_import_stat (among other things)
573#ifndef MICROPY_ENABLE_EXTERNAL_IMPORT
Jim Mussared01374d92021-08-14 01:43:15 +1000574#define MICROPY_ENABLE_EXTERNAL_IMPORT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien George20993682018-02-20 18:00:44 +1100575#endif
576
Damien George6b239c22016-11-16 16:04:57 +1100577// Whether to use the POSIX reader for importing files
578#ifndef MICROPY_READER_POSIX
579#define MICROPY_READER_POSIX (0)
580#endif
581
Damien Georgedcb9ea72017-01-27 15:10:09 +1100582// Whether to use the VFS reader for importing files
583#ifndef MICROPY_READER_VFS
584#define MICROPY_READER_VFS (0)
585#endif
586
Sean Burtone33bc592018-12-13 12:10:35 +0000587// Whether any readers have been defined
588#ifndef MICROPY_HAS_FILE_READER
589#define MICROPY_HAS_FILE_READER (MICROPY_READER_POSIX || MICROPY_READER_VFS)
590#endif
591
Damien George40d84302016-02-15 22:46:21 +0000592// Hook for the VM at the start of the opcode loop (can contain variable
593// definitions usable by the other hook functions)
594#ifndef MICROPY_VM_HOOK_INIT
595#define MICROPY_VM_HOOK_INIT
596#endif
597
598// Hook for the VM during the opcode loop (but only after jump opcodes)
599#ifndef MICROPY_VM_HOOK_LOOP
600#define MICROPY_VM_HOOK_LOOP
601#endif
602
603// Hook for the VM just before return opcode is finished being interpreted
604#ifndef MICROPY_VM_HOOK_RETURN
605#define MICROPY_VM_HOOK_RETURN
606#endif
607
Damien George916c3fd2021-04-25 22:24:49 +1000608// Hook for mp_sched_schedule when a function gets scheduled on sched_queue
609// (this macro executes within an atomic section)
610#ifndef MICROPY_SCHED_HOOK_SCHEDULED
611#define MICROPY_SCHED_HOOK_SCHEDULED
612#endif
613
Damien Georged3ebe482014-01-07 15:20:33 +0000614// Whether to include the garbage collector
615#ifndef MICROPY_ENABLE_GC
616#define MICROPY_ENABLE_GC (0)
617#endif
618
Laurens Valkfe120482021-10-26 10:47:04 +0200619// Hook to run code during time consuming garbage collector operations
620#ifndef MICROPY_GC_HOOK_LOOP
621#define MICROPY_GC_HOOK_LOOP
622#endif
623
Damien George12bab722014-04-05 20:35:48 +0100624// Whether to enable finalisers in the garbage collector (ie call __del__)
Damien George7860c2a2014-11-05 21:16:41 +0000625#ifndef MICROPY_ENABLE_FINALISER
Jim Mussared0e236ee2021-09-15 23:18:23 +1000626#define MICROPY_ENABLE_FINALISER (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George12bab722014-04-05 20:35:48 +0100627#endif
628
Damien George02d830c2017-11-26 23:28:40 +1100629// Whether to enable a separate allocator for the Python stack.
630// If enabled then the code must call mp_pystack_init before mp_init.
631#ifndef MICROPY_ENABLE_PYSTACK
632#define MICROPY_ENABLE_PYSTACK (0)
633#endif
634
635// Number of bytes that memory returned by mp_pystack_alloc will be aligned by.
636#ifndef MICROPY_PYSTACK_ALIGN
637#define MICROPY_PYSTACK_ALIGN (8)
638#endif
639
Paul Sokolovsky23668692014-06-25 03:03:34 +0300640// Whether to check C stack usage. C stack used for calling Python functions,
641// etc. Not checking means segfault on overflow.
642#ifndef MICROPY_STACK_CHECK
Jim Mussared0e236ee2021-09-15 23:18:23 +1000643#define MICROPY_STACK_CHECK (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky23668692014-06-25 03:03:34 +0300644#endif
645
Dave Hylands5b7fd202014-07-01 23:46:53 -0700646// Whether to have an emergency exception buffer
647#ifndef MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
648#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (0)
649#endif
650#if MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
Damien George69661f32020-02-27 15:36:53 +1100651#ifndef MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE
652#define MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE (0) // 0 - implies dynamic allocation
653#endif
Dave Hylands5b7fd202014-07-01 23:46:53 -0700654#endif
655
Damien Georgebbb4b982017-04-10 17:19:36 +1000656// Whether to provide the mp_kbd_exception object, and micropython.kbd_intr function
Damien George7f1da0a2016-12-15 13:00:19 +1100657#ifndef MICROPY_KBD_EXCEPTION
Jim Mussared0e236ee2021-09-15 23:18:23 +1000658#define MICROPY_KBD_EXCEPTION (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George7f1da0a2016-12-15 13:00:19 +1100659#endif
660
Paul Sokolovsky1c9210b2015-12-23 00:06:37 +0200661// Prefer to raise KeyboardInterrupt asynchronously (from signal or interrupt
662// handler) - if supported by a particular port.
663#ifndef MICROPY_ASYNC_KBD_INTR
664#define MICROPY_ASYNC_KBD_INTR (0)
665#endif
666
Damien George136f6752014-01-07 14:54:15 +0000667// Whether to include REPL helper function
Damien George58ebde42014-05-21 20:32:59 +0100668#ifndef MICROPY_HELPER_REPL
Jim Mussared0e236ee2021-09-15 23:18:23 +1000669#define MICROPY_HELPER_REPL (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George136f6752014-01-07 14:54:15 +0000670#endif
671
Yonatan Goldschmidt61d2b402019-12-25 09:27:38 +0200672// Allow enabling debug prints after each REPL line
673#ifndef MICROPY_REPL_INFO
Damien Georgec62351f2021-11-01 15:18:22 +1100674#define MICROPY_REPL_INFO (0)
Yonatan Goldschmidt61d2b402019-12-25 09:27:38 +0200675#endif
676
Tom Soulanille7d588b02015-07-09 16:32:36 -0700677// Whether to include emacs-style readline behavior in REPL
678#ifndef MICROPY_REPL_EMACS_KEYS
Jim Mussared0e236ee2021-09-15 23:18:23 +1000679#define MICROPY_REPL_EMACS_KEYS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Tom Soulanille7d588b02015-07-09 16:32:36 -0700680#endif
681
Yonatan Goldschmidt853aaa02019-12-14 23:42:03 +0200682// Whether to include emacs-style word movement/kill readline behavior in REPL.
683// This adds Alt+F, Alt+B, Alt+D and Alt+Backspace for forward-word, backward-word, forward-kill-word
684// and backward-kill-word, respectively.
685#ifndef MICROPY_REPL_EMACS_WORDS_MOVE
686#define MICROPY_REPL_EMACS_WORDS_MOVE (0)
687#endif
688
689// Whether to include extra convenience keys for word movement/kill in readline REPL.
690// This adds Ctrl+Right, Ctrl+Left and Ctrl+W for forward-word, backward-word and backward-kill-word
691// respectively. Ctrl+Delete is not implemented because it's a very different escape sequence.
692// Depends on MICROPY_REPL_EMACS_WORDS_MOVE.
693#ifndef MICROPY_REPL_EMACS_EXTRA_WORDS_MOVE
694#define MICROPY_REPL_EMACS_EXTRA_WORDS_MOVE (0)
695#endif
696
Damien George0af73012015-08-20 10:34:16 +0100697// Whether to implement auto-indent in REPL
698#ifndef MICROPY_REPL_AUTO_INDENT
Jim Mussared0e236ee2021-09-15 23:18:23 +1000699#define MICROPY_REPL_AUTO_INDENT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George0af73012015-08-20 10:34:16 +0100700#endif
701
Paul Sokolovsky87bc8e22015-01-15 10:46:27 +0200702// Whether port requires event-driven REPL functions
703#ifndef MICROPY_REPL_EVENT_DRIVEN
704#define MICROPY_REPL_EVENT_DRIVEN (0)
705#endif
706
Damien Georged3ebe482014-01-07 15:20:33 +0000707// Whether to include lexer helper function for unix
Damien George58ebde42014-05-21 20:32:59 +0100708#ifndef MICROPY_HELPER_LEXER_UNIX
709#define MICROPY_HELPER_LEXER_UNIX (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000710#endif
711
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200712// Long int implementation
713#define MICROPY_LONGINT_IMPL_NONE (0)
714#define MICROPY_LONGINT_IMPL_LONGLONG (1)
Damien George438c88d2014-02-22 19:25:23 +0000715#define MICROPY_LONGINT_IMPL_MPZ (2)
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200716
717#ifndef MICROPY_LONGINT_IMPL
718#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_NONE)
719#endif
720
721#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
722typedef long long mp_longint_impl_t;
723#endif
724
Damien George62ad1892014-01-29 21:51:51 +0000725// Whether to include information in the byte code to determine source
726// line number (increases RAM usage, but doesn't slow byte code execution)
727#ifndef MICROPY_ENABLE_SOURCE_LINE
Jim Mussared0e236ee2021-09-15 23:18:23 +1000728#define MICROPY_ENABLE_SOURCE_LINE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George62ad1892014-01-29 21:51:51 +0000729#endif
730
Damien George1463c1f2014-04-25 23:52:57 +0100731// Whether to include doc strings (increases RAM usage)
732#ifndef MICROPY_ENABLE_DOC_STRING
733#define MICROPY_ENABLE_DOC_STRING (0)
734#endif
735
Damien Georged4b706c2021-04-22 12:13:58 +1000736// Exception messages are removed (requires disabling MICROPY_ROM_TEXT_COMPRESSION)
737#define MICROPY_ERROR_REPORTING_NONE (0)
Damien George1e9a92f2014-11-06 17:36:16 +0000738// Exception messages are short static strings
Paul Sokolovsky1f85d622014-05-01 01:35:38 +0300739#define MICROPY_ERROR_REPORTING_TERSE (1)
740// Exception messages provide basic error details
741#define MICROPY_ERROR_REPORTING_NORMAL (2)
742// Exception messages provide full info, e.g. object names
743#define MICROPY_ERROR_REPORTING_DETAILED (3)
744
745#ifndef MICROPY_ERROR_REPORTING
Jim Mussared01374d92021-08-14 01:43:15 +1000746#if MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_FULL_FEATURES
747#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_DETAILED)
748#elif MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES
Paul Sokolovsky1f85d622014-05-01 01:35:38 +0300749#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
Jim Mussared01374d92021-08-14 01:43:15 +1000750#else
751#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_TERSE)
752#endif
Paul Sokolovsky1f85d622014-05-01 01:35:38 +0300753#endif
754
Paul Sokolovsky8a8c1fc2015-01-01 09:29:28 +0200755// Whether issue warnings during compiling/execution
756#ifndef MICROPY_WARNINGS
757#define MICROPY_WARNINGS (0)
758#endif
759
Paul Sokolovsky2f5d1132018-12-21 14:20:55 +0300760// Whether to support warning categories
761#ifndef MICROPY_WARNINGS_CATEGORY
762#define MICROPY_WARNINGS_CATEGORY (0)
763#endif
764
David Lechner62849b72017-09-24 20:15:48 -0500765// This macro is used when printing runtime warnings and errors
766#ifndef MICROPY_ERROR_PRINTER
767#define MICROPY_ERROR_PRINTER (&mp_plat_print)
768#endif
769
Damien George0c36da02014-03-08 15:24:39 +0000770// Float and complex implementation
771#define MICROPY_FLOAT_IMPL_NONE (0)
772#define MICROPY_FLOAT_IMPL_FLOAT (1)
773#define MICROPY_FLOAT_IMPL_DOUBLE (2)
774
775#ifndef MICROPY_FLOAT_IMPL
776#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_NONE)
777#endif
778
779#if MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_FLOAT
Damien Georgefb510b32014-06-01 13:32:54 +0100780#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George561844f2016-11-03 12:33:01 +1100781#define MICROPY_FLOAT_CONST(x) x##F
Damien George0c36da02014-03-08 15:24:39 +0000782#define MICROPY_FLOAT_C_FUN(fun) fun##f
783typedef float mp_float_t;
784#elif MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_DOUBLE
Damien Georgefb510b32014-06-01 13:32:54 +0100785#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George561844f2016-11-03 12:33:01 +1100786#define MICROPY_FLOAT_CONST(x) x
Damien George0c36da02014-03-08 15:24:39 +0000787#define MICROPY_FLOAT_C_FUN(fun) fun
788typedef double mp_float_t;
789#else
Damien Georgefb510b32014-06-01 13:32:54 +0100790#define MICROPY_PY_BUILTINS_FLOAT (0)
Damien George136f6752014-01-07 14:54:15 +0000791#endif
792
Paul Sokolovsky3b6f7b92014-06-20 01:48:35 +0300793#ifndef MICROPY_PY_BUILTINS_COMPLEX
794#define MICROPY_PY_BUILTINS_COMPLEX (MICROPY_PY_BUILTINS_FLOAT)
795#endif
796
Damien Georgea73501b2017-04-06 17:27:33 +1000797// Whether to provide a high-quality hash for float and complex numbers.
798// Otherwise the default is a very simple but correct hashing function.
799#ifndef MICROPY_FLOAT_HIGH_QUALITY_HASH
800#define MICROPY_FLOAT_HIGH_QUALITY_HASH (0)
801#endif
802
Paul Sokolovskydcac8802014-01-16 19:19:50 +0200803// Enable features which improve CPython compatibility
804// but may lead to more code size/memory usage.
805// TODO: Originally intended as generic category to not
806// add bunch of once-off options. May need refactoring later
807#ifndef MICROPY_CPYTHON_COMPAT
Jim Mussared01374d92021-08-14 01:43:15 +1000808#define MICROPY_CPYTHON_COMPAT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovskydcac8802014-01-16 19:19:50 +0200809#endif
810
Paul Sokolovsky9a973972017-04-02 21:20:07 +0300811// Perform full checks as done by CPython. Disabling this
812// may produce incorrect results, if incorrect data is fed,
813// but should not lead to MicroPython crashes or similar
814// grave issues (in other words, only user app should be,
815// affected, not system).
816#ifndef MICROPY_FULL_CHECKS
Jim Mussared01374d92021-08-14 01:43:15 +1000817#define MICROPY_FULL_CHECKS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovsky9a973972017-04-02 21:20:07 +0300818#endif
819
Paul Sokolovsky0ef015b2014-05-07 02:23:46 +0300820// Whether POSIX-semantics non-blocking streams are supported
821#ifndef MICROPY_STREAMS_NON_BLOCK
Jim Mussared0e236ee2021-09-15 23:18:23 +1000822#define MICROPY_STREAMS_NON_BLOCK (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky0ef015b2014-05-07 02:23:46 +0300823#endif
824
Paul Sokolovsky61e77a42016-07-30 20:05:56 +0300825// Whether to provide stream functions with POSIX-like signatures
826// (useful for porting existing libraries to MicroPython).
827#ifndef MICROPY_STREAMS_POSIX_API
828#define MICROPY_STREAMS_POSIX_API (0)
829#endif
830
Damien George3356b5e2021-07-27 00:38:21 +1000831// Whether modules can use MP_MODULE_ATTR_DELEGATION_ENTRY() to delegate failed
832// attribute lookups.
833#ifndef MICROPY_MODULE_ATTR_DELEGATION
834#define MICROPY_MODULE_ATTR_DELEGATION (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
835#endif
836
Damien George3c9c3682015-09-15 14:56:13 +0100837// Whether to call __init__ when importing builtin modules for the first time
838#ifndef MICROPY_MODULE_BUILTIN_INIT
Jim Mussared0e236ee2021-09-15 23:18:23 +1000839#define MICROPY_MODULE_BUILTIN_INIT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George3c9c3682015-09-15 14:56:13 +0100840#endif
841
Paul m. p. P454cca62018-10-22 18:34:29 +0200842// Whether to support module-level __getattr__ (see PEP 562)
843#ifndef MICROPY_MODULE_GETATTR
Jim Mussared01374d92021-08-14 01:43:15 +1000844#define MICROPY_MODULE_GETATTR (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul m. p. P454cca62018-10-22 18:34:29 +0200845#endif
846
Damien Georgec14a8162014-10-12 11:46:04 +0100847// Whether module weak links are supported
848#ifndef MICROPY_MODULE_WEAK_LINKS
Jim Mussared0e236ee2021-09-15 23:18:23 +1000849#define MICROPY_MODULE_WEAK_LINKS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgec14a8162014-10-12 11:46:04 +0100850#endif
851
Jim Mussareda7fa18c2020-02-26 15:24:09 +1100852// Whether to enable importing foo.py with __name__ set to '__main__'
853// Used by the unix port for the -m flag.
854#ifndef MICROPY_MODULE_OVERRIDE_MAIN_IMPORT
855#define MICROPY_MODULE_OVERRIDE_MAIN_IMPORT (0)
856#endif
857
Damien George0a2e9652016-01-31 22:24:16 +0000858// Whether frozen modules are supported in the form of strings
859#ifndef MICROPY_MODULE_FROZEN_STR
860#define MICROPY_MODULE_FROZEN_STR (0)
861#endif
862
863// Whether frozen modules are supported in the form of .mpy files
864#ifndef MICROPY_MODULE_FROZEN_MPY
865#define MICROPY_MODULE_FROZEN_MPY (0)
866#endif
867
868// Convenience macro for whether frozen modules are supported
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200869#ifndef MICROPY_MODULE_FROZEN
Damien George0a2e9652016-01-31 22:24:16 +0000870#define MICROPY_MODULE_FROZEN (MICROPY_MODULE_FROZEN_STR || MICROPY_MODULE_FROZEN_MPY)
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200871#endif
872
Damien George78d702c2014-12-09 16:19:48 +0000873// Whether you can override builtins in the builtins module
874#ifndef MICROPY_CAN_OVERRIDE_BUILTINS
Jim Mussared0e236ee2021-09-15 23:18:23 +1000875#define MICROPY_CAN_OVERRIDE_BUILTINS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George78d702c2014-12-09 16:19:48 +0000876#endif
877
Damien George06593fb2015-06-19 12:49:10 +0000878// Whether to check that the "self" argument of a builtin method has the
879// correct type. Such an explicit check is only needed if a builtin
880// method escapes to Python land without a first argument, eg
881// list.append([], 1). Without this check such calls will have undefined
882// behaviour (usually segfault) if the first argument is the wrong type.
883#ifndef MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG
Jim Mussared01374d92021-08-14 01:43:15 +1000884#define MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien George06593fb2015-06-19 12:49:10 +0000885#endif
886
Damien George3f56fd62016-05-10 10:54:06 +0100887// Whether to use internally defined errno's (otherwise system provided ones)
888#ifndef MICROPY_USE_INTERNAL_ERRNO
889#define MICROPY_USE_INTERNAL_ERRNO (0)
890#endif
891
Delio Brignolie2ac8bb2016-08-21 11:33:37 +0200892// Whether to use internally defined *printf() functions (otherwise external ones)
893#ifndef MICROPY_USE_INTERNAL_PRINTF
894#define MICROPY_USE_INTERNAL_PRINTF (1)
895#endif
896
Damien George6e74d242017-02-16 18:05:06 +1100897// Support for internal scheduler
898#ifndef MICROPY_ENABLE_SCHEDULER
Jim Mussared0e236ee2021-09-15 23:18:23 +1000899#define MICROPY_ENABLE_SCHEDULER (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George6e74d242017-02-16 18:05:06 +1100900#endif
901
Damien George75506e42022-03-23 17:13:03 +1100902// Whether the scheduler supports scheduling static nodes with C callbacks
903#ifndef MICROPY_SCHEDULER_STATIC_NODES
904#define MICROPY_SCHEDULER_STATIC_NODES (0)
905#endif
906
Damien George6e74d242017-02-16 18:05:06 +1100907// Maximum number of entries in the scheduler
908#ifndef MICROPY_SCHEDULER_DEPTH
909#define MICROPY_SCHEDULER_DEPTH (4)
910#endif
911
Damien Georgedcb9ea72017-01-27 15:10:09 +1100912// Support for generic VFS sub-system
913#ifndef MICROPY_VFS
914#define MICROPY_VFS (0)
915#endif
916
Damien George8d82b0e2018-06-06 13:11:33 +1000917// Support for VFS POSIX component, to mount a POSIX filesystem within VFS
918#ifndef MICROPY_VFS
919#define MICROPY_VFS_POSIX (0)
920#endif
921
Damien Georgea8b9e712018-06-06 14:31:29 +1000922// Support for VFS FAT component, to mount a FAT filesystem within VFS
923#ifndef MICROPY_VFS
924#define MICROPY_VFS_FAT (0)
925#endif
926
Damien Georgeee3fd462014-05-24 23:03:12 +0100927/*****************************************************************************/
928/* Fine control over Python builtins, classes, modules, etc */
929
Damien Georgeda154fd2017-04-01 23:52:24 +1100930// Whether to support multiple inheritance of Python classes. Multiple
931// inheritance makes some C functions inherently recursive, and adds a bit of
932// code overhead.
933#ifndef MICROPY_MULTIPLE_INHERITANCE
Jim Mussared01374d92021-08-14 01:43:15 +1000934#define MICROPY_MULTIPLE_INHERITANCE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien Georgeda154fd2017-04-01 23:52:24 +1100935#endif
936
stijn3cc17c62015-02-14 18:44:31 +0100937// Whether to implement attributes on functions
938#ifndef MICROPY_PY_FUNCTION_ATTRS
Jim Mussared0e236ee2021-09-15 23:18:23 +1000939#define MICROPY_PY_FUNCTION_ATTRS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
stijn3cc17c62015-02-14 18:44:31 +0100940#endif
941
Damien George36c10522018-05-25 17:09:54 +1000942// Whether to support the descriptors __get__, __set__, __delete__
943// This costs some code size and makes load/store/delete of instance
944// attributes slower for the classes that use this feature
stijn28fa84b2015-02-14 18:43:54 +0100945#ifndef MICROPY_PY_DESCRIPTORS
Jim Mussared0e236ee2021-09-15 23:18:23 +1000946#define MICROPY_PY_DESCRIPTORS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
stijn28fa84b2015-02-14 18:43:54 +0100947#endif
948
dmazzella18e65692017-01-03 11:00:12 +0100949// Whether to support class __delattr__ and __setattr__ methods
Damien George36c10522018-05-25 17:09:54 +1000950// This costs some code size and makes store/delete of instance
951// attributes slower for the classes that use this feature
dmazzella18e65692017-01-03 11:00:12 +0100952#ifndef MICROPY_PY_DELATTR_SETATTR
Jim Mussared0e236ee2021-09-15 23:18:23 +1000953#define MICROPY_PY_DELATTR_SETATTR (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
dmazzella18e65692017-01-03 11:00:12 +0100954#endif
955
pohmelie81ebba72016-01-27 23:23:11 +0300956// Support for async/await/async for/async with
957#ifndef MICROPY_PY_ASYNC_AWAIT
Jim Mussared01374d92021-08-14 01:43:15 +1000958#define MICROPY_PY_ASYNC_AWAIT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
pohmelie81ebba72016-01-27 23:23:11 +0300959#endif
960
Jim Mussared692d36d2021-08-13 01:44:08 +1000961// Support for literal string interpolation, f-strings (see PEP 498, Python 3.6+)
962#ifndef MICROPY_PY_FSTRINGS
Jim Mussared0e236ee2021-09-15 23:18:23 +1000963#define MICROPY_PY_FSTRINGS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Jim Mussared692d36d2021-08-13 01:44:08 +1000964#endif
965
Damien George17839502020-06-16 21:42:44 +1000966// Support for assignment expressions with := (see PEP 572, Python 3.8+)
967#ifndef MICROPY_PY_ASSIGN_EXPR
Jim Mussared01374d92021-08-14 01:43:15 +1000968#define MICROPY_PY_ASSIGN_EXPR (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien George17839502020-06-16 21:42:44 +1000969#endif
970
Paul Sokolovsky63644012017-10-21 12:13:44 +0300971// Non-standard .pend_throw() method for generators, allowing for
972// Future-like behavior with respect to exception handling: an
973// exception set with .pend_throw() will activate on the next call
974// to generator's .send() or .__next__(). (This is useful to implement
975// async schedulers.)
976#ifndef MICROPY_PY_GENERATOR_PEND_THROW
Jim Mussared01374d92021-08-14 01:43:15 +1000977#define MICROPY_PY_GENERATOR_PEND_THROW (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovsky63644012017-10-21 12:13:44 +0300978#endif
979
Paul Sokolovskya1b442b2016-07-22 00:46:24 +0300980// Issue a warning when comparing str and bytes objects
Paul Sokolovsky707cae72016-07-22 00:34:34 +0300981#ifndef MICROPY_PY_STR_BYTES_CMP_WARN
982#define MICROPY_PY_STR_BYTES_CMP_WARN (0)
983#endif
984
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300985// Whether str object is proper unicode
986#ifndef MICROPY_PY_BUILTINS_STR_UNICODE
Jim Mussared0e236ee2021-09-15 23:18:23 +1000987#define MICROPY_PY_BUILTINS_STR_UNICODE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George8546ce12014-06-28 10:29:22 +0100988#endif
Damien Georgeb3a50f02014-06-28 10:27:15 +0100989
tll68c28172017-06-24 08:38:32 +0800990// Whether to check for valid UTF-8 when converting bytes to str
991#ifndef MICROPY_PY_BUILTINS_STR_UNICODE_CHECK
992#define MICROPY_PY_BUILTINS_STR_UNICODE_CHECK (MICROPY_PY_BUILTINS_STR_UNICODE)
993#endif
994
Paul Sokolovsky1b5abfc2016-05-22 00:13:44 +0300995// Whether str.center() method provided
996#ifndef MICROPY_PY_BUILTINS_STR_CENTER
Jim Mussared0e236ee2021-09-15 23:18:23 +1000997#define MICROPY_PY_BUILTINS_STR_CENTER (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky1b5abfc2016-05-22 00:13:44 +0300998#endif
999
Paul Sokolovsky5a91fce2018-08-05 23:56:19 +03001000// Whether str.count() method provided
1001#ifndef MICROPY_PY_BUILTINS_STR_COUNT
Jim Mussared01374d92021-08-14 01:43:15 +10001002#define MICROPY_PY_BUILTINS_STR_COUNT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovsky5a91fce2018-08-05 23:56:19 +03001003#endif
1004
Paul Sokolovsky2da5d412018-08-15 15:17:41 +03001005// Whether str % (...) formatting operator provided
1006#ifndef MICROPY_PY_BUILTINS_STR_OP_MODULO
Jim Mussared01374d92021-08-14 01:43:15 +10001007#define MICROPY_PY_BUILTINS_STR_OP_MODULO (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovsky2da5d412018-08-15 15:17:41 +03001008#endif
1009
Paul Sokolovsky56eb25f2016-08-07 06:46:55 +03001010// Whether str.partition()/str.rpartition() method provided
1011#ifndef MICROPY_PY_BUILTINS_STR_PARTITION
Jim Mussared0e236ee2021-09-15 23:18:23 +10001012#define MICROPY_PY_BUILTINS_STR_PARTITION (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky56eb25f2016-08-07 06:46:55 +03001013#endif
1014
Paul Sokolovskyac2f7a72015-04-04 00:09:23 +03001015// Whether str.splitlines() method provided
1016#ifndef MICROPY_PY_BUILTINS_STR_SPLITLINES
Jim Mussared0e236ee2021-09-15 23:18:23 +10001017#define MICROPY_PY_BUILTINS_STR_SPLITLINES (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovskyac2f7a72015-04-04 00:09:23 +03001018#endif
1019
Paul Sokolovskycb78f862014-06-27 20:39:09 +03001020// Whether to support bytearray object
1021#ifndef MICROPY_PY_BUILTINS_BYTEARRAY
Jim Mussared01374d92021-08-14 01:43:15 +10001022#define MICROPY_PY_BUILTINS_BYTEARRAY (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +03001023#endif
1024
Paul Sokolovskyfbb83352018-08-06 01:25:41 +03001025// Whether to support dict.fromkeys() class method
1026#ifndef MICROPY_PY_BUILTINS_DICT_FROMKEYS
Jim Mussared01374d92021-08-14 01:43:15 +10001027#define MICROPY_PY_BUILTINS_DICT_FROMKEYS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovskyfbb83352018-08-06 01:25:41 +03001028#endif
1029
Damien Georgedd4f4532014-10-23 13:34:35 +01001030// Whether to support memoryview object
1031#ifndef MICROPY_PY_BUILTINS_MEMORYVIEW
Jim Mussared0e236ee2021-09-15 23:18:23 +10001032#define MICROPY_PY_BUILTINS_MEMORYVIEW (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgedd4f4532014-10-23 13:34:35 +01001033#endif
1034
stijn90fae912019-05-08 16:16:17 +02001035// Whether to support memoryview.itemsize attribute
1036#ifndef MICROPY_PY_BUILTINS_MEMORYVIEW_ITEMSIZE
1037#define MICROPY_PY_BUILTINS_MEMORYVIEW_ITEMSIZE (0)
1038#endif
1039
Damien George3ebd4d02014-06-01 13:46:47 +01001040// Whether to support set object
1041#ifndef MICROPY_PY_BUILTINS_SET
Jim Mussared01374d92021-08-14 01:43:15 +10001042#define MICROPY_PY_BUILTINS_SET (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien George3ebd4d02014-06-01 13:46:47 +01001043#endif
1044
Damien Georgefb510b32014-06-01 13:32:54 +01001045// Whether to support slice subscript operators and slice object
1046#ifndef MICROPY_PY_BUILTINS_SLICE
Jim Mussared01374d92021-08-14 01:43:15 +10001047#define MICROPY_PY_BUILTINS_SLICE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien Georgeee3fd462014-05-24 23:03:12 +01001048#endif
1049
Tom Soulanilleaeb62f92015-09-11 14:31:32 -07001050// Whether to support slice attribute read access,
1051// i.e. slice.start, slice.stop, slice.step
1052#ifndef MICROPY_PY_BUILTINS_SLICE_ATTRS
Jim Mussared0e236ee2021-09-15 23:18:23 +10001053#define MICROPY_PY_BUILTINS_SLICE_ATTRS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Tom Soulanilleaeb62f92015-09-11 14:31:32 -07001054#endif
1055
Nicko van Someren4c939552019-11-16 17:07:11 -07001056// Whether to support the .indices(len) method on slice objects
1057#ifndef MICROPY_PY_BUILTINS_SLICE_INDICES
Jim Mussared0e236ee2021-09-15 23:18:23 +10001058#define MICROPY_PY_BUILTINS_SLICE_INDICES (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Nicko van Someren4c939552019-11-16 17:07:11 -07001059#endif
1060
Damien Georgeee3fd462014-05-24 23:03:12 +01001061// Whether to support frozenset object
Damien Georgefb510b32014-06-01 13:32:54 +01001062#ifndef MICROPY_PY_BUILTINS_FROZENSET
Jim Mussared0e236ee2021-09-15 23:18:23 +10001063#define MICROPY_PY_BUILTINS_FROZENSET (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgeee3fd462014-05-24 23:03:12 +01001064#endif
1065
Damien Georgefb510b32014-06-01 13:32:54 +01001066// Whether to support property object
1067#ifndef MICROPY_PY_BUILTINS_PROPERTY
Jim Mussared01374d92021-08-14 01:43:15 +10001068#define MICROPY_PY_BUILTINS_PROPERTY (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien Georgeee3fd462014-05-24 23:03:12 +01001069#endif
1070
Peter D. Grayb2a237d2015-03-06 14:48:14 -05001071// Whether to implement the start/stop/step attributes (readback) on
1072// the "range" builtin type. Rarely used, and costs ~60 bytes (x86).
1073#ifndef MICROPY_PY_BUILTINS_RANGE_ATTRS
Jim Mussared01374d92021-08-14 01:43:15 +10001074#define MICROPY_PY_BUILTINS_RANGE_ATTRS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Peter D. Grayb2a237d2015-03-06 14:48:14 -05001075#endif
1076
Damien Georged77da832018-02-14 23:17:06 +11001077// Whether to support binary ops [only (in)equality is defined] between range
1078// objects. With this option disabled all range objects that are not exactly
1079// the same object will compare as not-equal. With it enabled the semantics
1080// match CPython and ranges are equal if they yield the same sequence of items.
1081#ifndef MICROPY_PY_BUILTINS_RANGE_BINOP
1082#define MICROPY_PY_BUILTINS_RANGE_BINOP (0)
1083#endif
1084
stijn42863832019-01-03 15:19:42 +01001085// Support for callling next() with second argument
1086#ifndef MICROPY_PY_BUILTINS_NEXT2
1087#define MICROPY_PY_BUILTINS_NEXT2 (0)
1088#endif
1089
Jan Klusacekb318ebf2018-01-09 22:47:35 +01001090// Whether to support rounding of integers (incl bignum); eg round(123,-1)=120
1091#ifndef MICROPY_PY_BUILTINS_ROUND_INT
Jim Mussared0e236ee2021-09-15 23:18:23 +10001092#define MICROPY_PY_BUILTINS_ROUND_INT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Jan Klusacekb318ebf2018-01-09 22:47:35 +01001093#endif
1094
Paul Sokolovsky0e80f342017-10-27 22:29:15 +03001095// Whether to support complete set of special methods for user
1096// classes, or only the most used ones. "Inplace" methods are
1097// controlled by MICROPY_PY_ALL_INPLACE_SPECIAL_METHODS below.
1098// "Reverse" methods are controlled by
1099// MICROPY_PY_REVERSE_SPECIAL_METHODS below.
Paul Sokolovsky98c4bc32015-01-30 01:42:49 +02001100#ifndef MICROPY_PY_ALL_SPECIAL_METHODS
Jim Mussared0e236ee2021-09-15 23:18:23 +10001101#define MICROPY_PY_ALL_SPECIAL_METHODS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky98c4bc32015-01-30 01:42:49 +02001102#endif
1103
Paul Sokolovsky0e80f342017-10-27 22:29:15 +03001104// Whether to support all inplace arithmetic operarion methods
1105// (__imul__, etc.)
1106#ifndef MICROPY_PY_ALL_INPLACE_SPECIAL_METHODS
1107#define MICROPY_PY_ALL_INPLACE_SPECIAL_METHODS (0)
1108#endif
1109
1110// Whether to support reverse arithmetic operarion methods
1111// (__radd__, etc.). Additionally gated by
1112// MICROPY_PY_ALL_SPECIAL_METHODS.
Paul Sokolovskyeb84a832017-09-10 17:05:20 +03001113#ifndef MICROPY_PY_REVERSE_SPECIAL_METHODS
Jim Mussared0e236ee2021-09-15 23:18:23 +10001114#define MICROPY_PY_REVERSE_SPECIAL_METHODS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovskyeb84a832017-09-10 17:05:20 +03001115#endif
1116
Damien Georgec9fc6202014-10-25 21:59:14 +01001117// Whether to support compile function
1118#ifndef MICROPY_PY_BUILTINS_COMPILE
Jim Mussared0e236ee2021-09-15 23:18:23 +10001119#define MICROPY_PY_BUILTINS_COMPILE (MICROPY_ENABLE_COMPILER && MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgec9fc6202014-10-25 21:59:14 +01001120#endif
1121
Paul Sokolovskye2d44e32015-04-06 23:50:37 +03001122// Whether to support enumerate function(type)
1123#ifndef MICROPY_PY_BUILTINS_ENUMERATE
Jim Mussared01374d92021-08-14 01:43:15 +10001124#define MICROPY_PY_BUILTINS_ENUMERATE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovskye2d44e32015-04-06 23:50:37 +03001125#endif
1126
Damien Georgedd5353a2015-12-18 12:35:44 +00001127// Whether to support eval and exec functions
1128// By default they are supported if the compiler is enabled
1129#ifndef MICROPY_PY_BUILTINS_EVAL_EXEC
1130#define MICROPY_PY_BUILTINS_EVAL_EXEC (MICROPY_ENABLE_COMPILER)
1131#endif
1132
Damien George2a3e2b92014-12-19 13:36:17 +00001133// Whether to support the Python 2 execfile function
1134#ifndef MICROPY_PY_BUILTINS_EXECFILE
Jim Mussared0e236ee2021-09-15 23:18:23 +10001135#define MICROPY_PY_BUILTINS_EXECFILE (MICROPY_ENABLE_COMPILER && MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George2a3e2b92014-12-19 13:36:17 +00001136#endif
1137
Paul Sokolovsky22ff3972015-08-20 01:01:56 +03001138// Whether to support filter function(type)
1139#ifndef MICROPY_PY_BUILTINS_FILTER
Jim Mussared01374d92021-08-14 01:43:15 +10001140#define MICROPY_PY_BUILTINS_FILTER (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovsky22ff3972015-08-20 01:01:56 +03001141#endif
1142
Paul Sokolovsky282ca092015-04-07 00:16:51 +03001143// Whether to support reversed function(type)
1144#ifndef MICROPY_PY_BUILTINS_REVERSED
Jim Mussared01374d92021-08-14 01:43:15 +10001145#define MICROPY_PY_BUILTINS_REVERSED (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovsky282ca092015-04-07 00:16:51 +03001146#endif
1147
Paul Sokolovsky5ab5ac52015-05-04 19:45:53 +03001148// Whether to define "NotImplemented" special constant
1149#ifndef MICROPY_PY_BUILTINS_NOTIMPLEMENTED
Jim Mussared0e236ee2021-09-15 23:18:23 +10001150#define MICROPY_PY_BUILTINS_NOTIMPLEMENTED (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky5ab5ac52015-05-04 19:45:53 +03001151#endif
1152
Damien Georgebc763022017-06-01 15:32:23 +10001153// Whether to provide the built-in input() function. The implementation of this
Damien George136369d2021-07-09 14:19:15 +10001154// uses shared/readline, so can only be enabled if the port uses this readline.
Damien Georgebc763022017-06-01 15:32:23 +10001155#ifndef MICROPY_PY_BUILTINS_INPUT
Jim Mussared0e236ee2021-09-15 23:18:23 +10001156#define MICROPY_PY_BUILTINS_INPUT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgebc763022017-06-01 15:32:23 +10001157#endif
1158
pohmelie354e6882015-12-07 15:35:48 +03001159// Whether to support min/max functions
1160#ifndef MICROPY_PY_BUILTINS_MIN_MAX
Jim Mussared01374d92021-08-14 01:43:15 +10001161#define MICROPY_PY_BUILTINS_MIN_MAX (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
pohmelie354e6882015-12-07 15:35:48 +03001162#endif
1163
Damien Georgea19b5a02017-02-03 12:35:48 +11001164// Support for calls to pow() with 3 integer arguments
1165#ifndef MICROPY_PY_BUILTINS_POW3
Jim Mussared0e236ee2021-09-15 23:18:23 +10001166#define MICROPY_PY_BUILTINS_POW3 (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgea19b5a02017-02-03 12:35:48 +11001167#endif
1168
Damien George9f04dfb2017-01-21 23:17:51 +11001169// Whether to provide the help function
1170#ifndef MICROPY_PY_BUILTINS_HELP
Jim Mussared0e236ee2021-09-15 23:18:23 +10001171#define MICROPY_PY_BUILTINS_HELP (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George9f04dfb2017-01-21 23:17:51 +11001172#endif
1173
1174// Use this to configure the help text shown for help(). It should be a
1175// variable with the type "const char*". A sensible default is provided.
1176#ifndef MICROPY_PY_BUILTINS_HELP_TEXT
1177#define MICROPY_PY_BUILTINS_HELP_TEXT mp_help_default_text
1178#endif
1179
Damien Georgef5172af2017-01-22 12:12:54 +11001180// Add the ability to list the available modules when executing help('modules')
1181#ifndef MICROPY_PY_BUILTINS_HELP_MODULES
Jim Mussared0e236ee2021-09-15 23:18:23 +10001182#define MICROPY_PY_BUILTINS_HELP_MODULES (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgef5172af2017-01-22 12:12:54 +11001183#endif
1184
Paul Sokolovskyd0f5e612014-07-25 11:00:15 +03001185// Whether to set __file__ for imported modules
1186#ifndef MICROPY_PY___FILE__
Jim Mussared01374d92021-08-14 01:43:15 +10001187#define MICROPY_PY___FILE__ (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovskyd0f5e612014-07-25 11:00:15 +03001188#endif
1189
Damien George89deec02015-01-09 20:12:54 +00001190// Whether to provide mem-info related functions in micropython module
1191#ifndef MICROPY_PY_MICROPYTHON_MEM_INFO
Jim Mussared0e236ee2021-09-15 23:18:23 +10001192#define MICROPY_PY_MICROPYTHON_MEM_INFO (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George89deec02015-01-09 20:12:54 +00001193#endif
1194
Damien George7e2a4882018-02-20 18:30:22 +11001195// Whether to provide "micropython.stack_use" function
1196#ifndef MICROPY_PY_MICROPYTHON_STACK_USE
1197#define MICROPY_PY_MICROPYTHON_STACK_USE (MICROPY_PY_MICROPYTHON_MEM_INFO)
1198#endif
1199
Andrew Leech86bfabe2019-06-28 16:35:51 +10001200// Whether to provide the "micropython.heap_locked" function
1201#ifndef MICROPY_PY_MICROPYTHON_HEAP_LOCKED
1202#define MICROPY_PY_MICROPYTHON_HEAP_LOCKED (0)
1203#endif
1204
Paul Sokolovskycb78f862014-06-27 20:39:09 +03001205// Whether to provide "array" module. Note that large chunk of the
1206// underlying code is shared with "bytearray" builtin type, so to
1207// get real savings, it should be disabled too.
1208#ifndef MICROPY_PY_ARRAY
Jim Mussared01374d92021-08-14 01:43:15 +10001209#define MICROPY_PY_ARRAY (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Paul Sokolovskycb78f862014-06-27 20:39:09 +03001210#endif
1211
Paul Sokolovskycefcbb22015-02-27 22:16:05 +02001212// Whether to support slice assignments for array (and bytearray).
1213// This is rarely used, but adds ~0.5K of code.
1214#ifndef MICROPY_PY_ARRAY_SLICE_ASSIGN
Jim Mussared0e236ee2021-09-15 23:18:23 +10001215#define MICROPY_PY_ARRAY_SLICE_ASSIGN (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovskycefcbb22015-02-27 22:16:05 +02001216#endif
1217
Damien George5aa311d2015-04-21 14:14:24 +00001218// Whether to support attrtuple type (MicroPython extension)
1219// It provides space-efficient tuples with attribute access
1220#ifndef MICROPY_PY_ATTRTUPLE
Jim Mussared01374d92021-08-14 01:43:15 +10001221#define MICROPY_PY_ATTRTUPLE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien George5aa311d2015-04-21 14:14:24 +00001222#endif
1223
Damien Georgeee3fd462014-05-24 23:03:12 +01001224// Whether to provide "collections" module
1225#ifndef MICROPY_PY_COLLECTIONS
Jim Mussared01374d92021-08-14 01:43:15 +10001226#define MICROPY_PY_COLLECTIONS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien Georgeee3fd462014-05-24 23:03:12 +01001227#endif
1228
Paul Sokolovsky970eedc2018-02-06 00:06:42 +02001229// Whether to provide "ucollections.deque" type
1230#ifndef MICROPY_PY_COLLECTIONS_DEQUE
Jim Mussared0e236ee2021-09-15 23:18:23 +10001231#define MICROPY_PY_COLLECTIONS_DEQUE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky970eedc2018-02-06 00:06:42 +02001232#endif
1233
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +02001234// Whether to provide "collections.OrderedDict" type
1235#ifndef MICROPY_PY_COLLECTIONS_ORDEREDDICT
Jim Mussared0e236ee2021-09-15 23:18:23 +10001236#define MICROPY_PY_COLLECTIONS_ORDEREDDICT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +02001237#endif
1238
stijn79ed58f2017-11-06 12:21:53 +01001239// Whether to provide the _asdict function for namedtuple
1240#ifndef MICROPY_PY_COLLECTIONS_NAMEDTUPLE__ASDICT
1241#define MICROPY_PY_COLLECTIONS_NAMEDTUPLE__ASDICT (0)
1242#endif
1243
Damien Georgeee3fd462014-05-24 23:03:12 +01001244// Whether to provide "math" module
1245#ifndef MICROPY_PY_MATH
Jim Mussared01374d92021-08-14 01:43:15 +10001246#define MICROPY_PY_MATH (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien Georgeee3fd462014-05-24 23:03:12 +01001247#endif
1248
stijndd696722019-11-20 13:38:33 +01001249// Whether to provide all math module constants (Python 3.5+), or just pi and e.
1250#ifndef MICROPY_PY_MATH_CONSTANTS
1251#define MICROPY_PY_MATH_CONSTANTS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
1252#endif
1253
Damien George5cbeace2015-02-22 14:48:18 +00001254// Whether to provide special math functions: math.{erf,erfc,gamma,lgamma}
1255#ifndef MICROPY_PY_MATH_SPECIAL_FUNCTIONS
Jim Mussared0e236ee2021-09-15 23:18:23 +10001256#define MICROPY_PY_MATH_SPECIAL_FUNCTIONS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George5cbeace2015-02-22 14:48:18 +00001257#endif
1258
Christopher Swenson8c656752018-08-27 10:32:21 +10001259// Whether to provide math.factorial function
1260#ifndef MICROPY_PY_MATH_FACTORIAL
Jim Mussared0e236ee2021-09-15 23:18:23 +10001261#define MICROPY_PY_MATH_FACTORIAL (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Christopher Swenson8c656752018-08-27 10:32:21 +10001262#endif
1263
stijnaf5c9982019-07-02 10:28:44 +02001264// Whether to provide math.isclose function
1265#ifndef MICROPY_PY_MATH_ISCLOSE
Jim Mussared0e236ee2021-09-15 23:18:23 +10001266#define MICROPY_PY_MATH_ISCLOSE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
stijnaf5c9982019-07-02 10:28:44 +02001267#endif
1268
stijn81db22f2020-05-17 12:29:25 +02001269// Whether to provide fix for atan2 Inf handling.
1270#ifndef MICROPY_PY_MATH_ATAN2_FIX_INFNAN
1271#define MICROPY_PY_MATH_ATAN2_FIX_INFNAN (0)
1272#endif
1273
1274// Whether to provide fix for fmod Inf handling.
1275#ifndef MICROPY_PY_MATH_FMOD_FIX_INFNAN
1276#define MICROPY_PY_MATH_FMOD_FIX_INFNAN (0)
1277#endif
1278
1279// Whether to provide fix for modf negative zero handling.
1280#ifndef MICROPY_PY_MATH_MODF_FIX_NEGZERO
1281#define MICROPY_PY_MATH_MODF_FIX_NEGZERO (0)
1282#endif
1283
stijn2e54d9d2020-09-08 15:22:34 +02001284// Whether to provide fix for pow(1, NaN) and pow(NaN, 0), which both should be 1 not NaN.
1285#ifndef MICROPY_PY_MATH_POW_FIX_NAN
1286#define MICROPY_PY_MATH_POW_FIX_NAN (0)
1287#endif
1288
Damien Georgeee3fd462014-05-24 23:03:12 +01001289// Whether to provide "cmath" module
1290#ifndef MICROPY_PY_CMATH
Jim Mussared0e236ee2021-09-15 23:18:23 +10001291#define MICROPY_PY_CMATH (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgeee3fd462014-05-24 23:03:12 +01001292#endif
1293
1294// Whether to provide "gc" module
1295#ifndef MICROPY_PY_GC
Jim Mussared01374d92021-08-14 01:43:15 +10001296#define MICROPY_PY_GC (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien Georgeee3fd462014-05-24 23:03:12 +01001297#endif
1298
Paul Sokolovsky755a55f2014-06-05 22:48:02 +03001299// Whether to return number of collected objects from gc.collect()
1300#ifndef MICROPY_PY_GC_COLLECT_RETVAL
1301#define MICROPY_PY_GC_COLLECT_RETVAL (0)
1302#endif
1303
Damien Georgeee3fd462014-05-24 23:03:12 +01001304// Whether to provide "io" module
1305#ifndef MICROPY_PY_IO
Jim Mussared01374d92021-08-14 01:43:15 +10001306#define MICROPY_PY_IO (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien Georgeee3fd462014-05-24 23:03:12 +01001307#endif
1308
Damien Georgeaf0932a2018-06-04 15:54:26 +10001309// Whether to provide "io.IOBase" class to support user streams
1310#ifndef MICROPY_PY_IO_IOBASE
Jim Mussared0e236ee2021-09-15 23:18:23 +10001311#define MICROPY_PY_IO_IOBASE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgeaf0932a2018-06-04 15:54:26 +10001312#endif
1313
Damien Georgeee3fd462014-05-24 23:03:12 +01001314// Whether to provide "io.FileIO" class
1315#ifndef MICROPY_PY_IO_FILEIO
Jim Mussared0e236ee2021-09-15 23:18:23 +10001316#define MICROPY_PY_IO_FILEIO (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgeee3fd462014-05-24 23:03:12 +01001317#endif
1318
1319// Whether to provide "io.BytesIO" class
1320#ifndef MICROPY_PY_IO_BYTESIO
1321#define MICROPY_PY_IO_BYTESIO (1)
1322#endif
1323
Paul Sokolovsky5d93dfb2016-03-25 01:10:49 +02001324// Whether to provide "io.BufferedWriter" class
1325#ifndef MICROPY_PY_IO_BUFFEREDWRITER
1326#define MICROPY_PY_IO_BUFFEREDWRITER (0)
1327#endif
1328
Damien Georgeee3fd462014-05-24 23:03:12 +01001329// Whether to provide "struct" module
1330#ifndef MICROPY_PY_STRUCT
Jim Mussared01374d92021-08-14 01:43:15 +10001331#define MICROPY_PY_STRUCT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien Georgeee3fd462014-05-24 23:03:12 +01001332#endif
1333
1334// Whether to provide "sys" module
1335#ifndef MICROPY_PY_SYS
Jim Mussared01374d92021-08-14 01:43:15 +10001336#define MICROPY_PY_SYS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_CORE_FEATURES)
Damien Georgeee3fd462014-05-24 23:03:12 +01001337#endif
1338
Damien Georgede43b502021-12-17 23:35:32 +11001339// Whether to initialise "sys.path" and "sys.argv" to their defaults in mp_init()
1340#ifndef MICROPY_PY_SYS_PATH_ARGV_DEFAULTS
Damien Georgefe9ffff2021-12-19 08:55:40 +11001341#define MICROPY_PY_SYS_PATH_ARGV_DEFAULTS (MICROPY_PY_SYS)
Damien Georgede43b502021-12-17 23:35:32 +11001342#endif
1343
Paul Sokolovsky4e0eeeb2014-07-03 16:50:11 +03001344// Whether to provide "sys.maxsize" constant
1345#ifndef MICROPY_PY_SYS_MAXSIZE
Jim Mussared0e236ee2021-09-15 23:18:23 +10001346#define MICROPY_PY_SYS_MAXSIZE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky4e0eeeb2014-07-03 16:50:11 +03001347#endif
1348
Paul Sokolovsky1a1d11f2015-12-05 00:09:10 +02001349// Whether to provide "sys.modules" dictionary
1350#ifndef MICROPY_PY_SYS_MODULES
1351#define MICROPY_PY_SYS_MODULES (1)
1352#endif
1353
Paul Sokolovsky8b85d142015-04-25 03:17:41 +03001354// Whether to provide "sys.exc_info" function
1355// Avoid enabling this, this function is Python2 heritage
1356#ifndef MICROPY_PY_SYS_EXC_INFO
1357#define MICROPY_PY_SYS_EXC_INFO (0)
1358#endif
1359
Damien Georgeee3fd462014-05-24 23:03:12 +01001360// Whether to provide "sys.exit" function
1361#ifndef MICROPY_PY_SYS_EXIT
Paul Sokolovsky403c9302016-12-14 21:10:22 +03001362#define MICROPY_PY_SYS_EXIT (1)
Damien Georgeee3fd462014-05-24 23:03:12 +01001363#endif
1364
Milan Rossacb364702019-08-05 15:06:41 +02001365// Whether to provide "sys.atexit" function (MicroPython extension)
1366#ifndef MICROPY_PY_SYS_ATEXIT
1367#define MICROPY_PY_SYS_ATEXIT (0)
1368#endif
1369
Damien Georgeac229312021-07-27 00:43:35 +10001370// Whether to provide sys.{ps1,ps2} mutable attributes, to control REPL prompts
1371#ifndef MICROPY_PY_SYS_PS1_PS2
1372#define MICROPY_PY_SYS_PS1_PS2 (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
1373#endif
1374
Milan Rossa310b3d12019-08-14 16:09:36 +02001375// Whether to provide "sys.settrace" function
1376#ifndef MICROPY_PY_SYS_SETTRACE
1377#define MICROPY_PY_SYS_SETTRACE (0)
1378#endif
1379
Paul Sokolovskybfc20922017-08-11 09:42:39 +03001380// Whether to provide "sys.getsizeof" function
1381#ifndef MICROPY_PY_SYS_GETSIZEOF
1382#define MICROPY_PY_SYS_GETSIZEOF (0)
1383#endif
1384
Damien Georgeee3fd462014-05-24 23:03:12 +01001385// Whether to provide sys.{stdin,stdout,stderr} objects
1386#ifndef MICROPY_PY_SYS_STDFILES
Jim Mussared0e236ee2021-09-15 23:18:23 +10001387#define MICROPY_PY_SYS_STDFILES (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George3bb8bd82014-04-14 21:20:30 +01001388#endif
1389
Damien George3c4b5d42015-05-13 23:49:21 +01001390// Whether to provide sys.{stdin,stdout,stderr}.buffer object
1391// This is implemented per-port
1392#ifndef MICROPY_PY_SYS_STDIO_BUFFER
Jim Mussared0e236ee2021-09-15 23:18:23 +10001393#define MICROPY_PY_SYS_STDIO_BUFFER (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George3c4b5d42015-05-13 23:49:21 +01001394#endif
Paul Sokolovsky82158472014-06-28 03:03:47 +03001395
Damien Georgecac939d2021-07-27 00:41:27 +10001396// Whether to provide sys.tracebacklimit mutable attribute
1397#ifndef MICROPY_PY_SYS_TRACEBACKLIMIT
1398#define MICROPY_PY_SYS_TRACEBACKLIMIT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EVERYTHING)
1399#endif
1400
Damien Georgebc181552021-07-27 00:39:04 +10001401// Whether the sys module supports attribute delegation
1402// This is enabled automatically when needed by other features
1403#ifndef MICROPY_PY_SYS_ATTR_DELEGATION
Damien Georgeac229312021-07-27 00:43:35 +10001404#define MICROPY_PY_SYS_ATTR_DELEGATION (MICROPY_PY_SYS_PS1_PS2 || MICROPY_PY_SYS_TRACEBACKLIMIT)
Damien Georgebc181552021-07-27 00:39:04 +10001405#endif
1406
Damien George596a3fe2016-05-10 10:54:25 +01001407// Whether to provide "uerrno" module
1408#ifndef MICROPY_PY_UERRNO
Jim Mussared0e236ee2021-09-15 23:18:23 +10001409#define MICROPY_PY_UERRNO (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George596a3fe2016-05-10 10:54:25 +01001410#endif
1411
Damien Georgef5634062017-02-22 12:53:42 +11001412// Whether to provide the uerrno.errorcode dict
1413#ifndef MICROPY_PY_UERRNO_ERRORCODE
1414#define MICROPY_PY_UERRNO_ERRORCODE (1)
1415#endif
1416
Paul Sokolovsky8f5bc3f2016-11-20 23:49:45 +03001417// Whether to provide "uselect" module (baremetal implementation)
1418#ifndef MICROPY_PY_USELECT
Jim Mussared0e236ee2021-09-15 23:18:23 +10001419#define MICROPY_PY_USELECT (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky8f5bc3f2016-11-20 23:49:45 +03001420#endif
1421
David Lechner87585042021-07-06 18:08:18 -05001422// Whether to enable the select() function in the "uselect" module (baremetal
1423// implementation). This is present for compatibility but can be disabled to
1424// save space.
1425#ifndef MICROPY_PY_USELECT_SELECT
1426#define MICROPY_PY_USELECT_SELECT (1)
1427#endif
1428
Paul Sokolovskya9728442016-10-14 20:13:02 +03001429// Whether to provide "utime" module functions implementation
1430// in terms of mp_hal_* functions.
1431#ifndef MICROPY_PY_UTIME_MP_HAL
1432#define MICROPY_PY_UTIME_MP_HAL (0)
1433#endif
1434
Paul Sokolovsky76146b32016-10-30 03:02:07 +03001435// Period of values returned by utime.ticks_ms(), ticks_us(), ticks_cpu()
1436// functions. Should be power of two. All functions above use the same
1437// period, so if underlying hardware/API has different periods, the
1438// minimum of them should be used. The value below is the maximum value
1439// this parameter can take (corresponding to 30 bit tick values on 32-bit
1440// system).
1441#ifndef MICROPY_PY_UTIME_TICKS_PERIOD
1442#define MICROPY_PY_UTIME_TICKS_PERIOD (MP_SMALL_INT_POSITIVE_MASK + 1)
1443#endif
1444
Damien George27cc0772016-04-22 22:52:33 +00001445// Whether to provide "_thread" module
1446#ifndef MICROPY_PY_THREAD
1447#define MICROPY_PY_THREAD (0)
1448#endif
1449
Damien George4cec63a2016-05-26 10:42:53 +00001450// Whether to make the VM/runtime thread-safe using a global lock
1451// If not enabled then thread safety must be provided at the Python level
1452#ifndef MICROPY_PY_THREAD_GIL
1453#define MICROPY_PY_THREAD_GIL (MICROPY_PY_THREAD)
1454#endif
1455
Damien Georgef6c22a02017-02-06 10:50:43 +11001456// Number of VM jump-loops to do before releasing the GIL.
1457// Set this to 0 to disable the divisor.
1458#ifndef MICROPY_PY_THREAD_GIL_VM_DIVISOR
1459#define MICROPY_PY_THREAD_GIL_VM_DIVISOR (32)
1460#endif
1461
Paul Sokolovsky82158472014-06-28 03:03:47 +03001462// Extended modules
Paul Sokolovsky510296f2014-08-08 22:51:40 +03001463
Damien Georgebc009fd2020-03-12 16:46:20 +11001464#ifndef MICROPY_PY_UASYNCIO
Jim Mussared0e236ee2021-09-15 23:18:23 +10001465#define MICROPY_PY_UASYNCIO (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgebc009fd2020-03-12 16:46:20 +11001466#endif
1467
Paul Sokolovsky82158472014-06-28 03:03:47 +03001468#ifndef MICROPY_PY_UCTYPES
Jim Mussared0e236ee2021-09-15 23:18:23 +10001469#define MICROPY_PY_UCTYPES (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky82158472014-06-28 03:03:47 +03001470#endif
1471
Paul Sokolovsky38151f32018-10-06 23:34:58 +03001472// Whether to provide SHORT, INT, LONG, etc. types in addition to
1473// exact-bitness types like INT16, INT32, etc.
1474#ifndef MICROPY_PY_UCTYPES_NATIVE_C_TYPES
1475#define MICROPY_PY_UCTYPES_NATIVE_C_TYPES (1)
1476#endif
1477
Paul Sokolovsky34162872014-10-12 08:16:34 -07001478#ifndef MICROPY_PY_UZLIB
Jim Mussared0e236ee2021-09-15 23:18:23 +10001479#define MICROPY_PY_UZLIB (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovsky34162872014-10-12 08:16:34 -07001480#endif
1481
Damien George612045f2014-09-17 22:56:34 +01001482#ifndef MICROPY_PY_UJSON
Jim Mussared0e236ee2021-09-15 23:18:23 +10001483#define MICROPY_PY_UJSON (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George612045f2014-09-17 22:56:34 +01001484#endif
1485
Peter Zügerffc854f2021-02-03 09:24:25 +01001486// Whether to support the "separators" argument to dump, dumps
1487#ifndef MICROPY_PY_UJSON_SEPARATORS
1488#define MICROPY_PY_UJSON_SEPARATORS (1)
1489#endif
1490
Damien George926b5542022-03-03 17:59:30 +11001491#ifndef MICROPY_PY_UOS
1492#define MICROPY_PY_UOS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
1493#endif
1494
Damien George0149cd62022-03-09 12:45:06 +11001495#ifndef MICROPY_PY_UOS_STATVFS
1496#define MICROPY_PY_UOS_STATVFS (MICROPY_PY_UOS)
1497#endif
1498
Paul Sokolovskyc71e0452014-09-12 18:48:07 +03001499#ifndef MICROPY_PY_URE
Jim Mussared0e236ee2021-09-15 23:18:23 +10001500#define MICROPY_PY_URE (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovskyc71e0452014-09-12 18:48:07 +03001501#endif
1502
Damien George7d851a22019-08-17 23:50:19 +10001503#ifndef MICROPY_PY_URE_DEBUG
1504#define MICROPY_PY_URE_DEBUG (0)
1505#endif
1506
Damien George1f864602018-05-24 13:07:42 +10001507#ifndef MICROPY_PY_URE_MATCH_GROUPS
1508#define MICROPY_PY_URE_MATCH_GROUPS (0)
1509#endif
1510
Damien George1e9b8712018-05-24 13:08:15 +10001511#ifndef MICROPY_PY_URE_MATCH_SPAN_START_END
1512#define MICROPY_PY_URE_MATCH_SPAN_START_END (0)
1513#endif
1514
Damien Georgee30a5fc2018-05-24 13:08:51 +10001515#ifndef MICROPY_PY_URE_SUB
Jim Mussared0e236ee2021-09-15 23:18:23 +10001516#define MICROPY_PY_URE_SUB (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgee30a5fc2018-05-24 13:08:51 +10001517#endif
1518
Damien Georgef5d69792014-10-22 17:37:18 +00001519#ifndef MICROPY_PY_UHEAPQ
Jim Mussared0e236ee2021-09-15 23:18:23 +10001520#define MICROPY_PY_UHEAPQ (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgef5d69792014-10-22 17:37:18 +00001521#endif
1522
Jim Mussared0e236ee2021-09-15 23:18:23 +10001523// Optimized heap queue for relative timestamps (only used by uasyncio v2)
Paul Sokolovskyd02f6a92016-12-22 00:29:32 +03001524#ifndef MICROPY_PY_UTIMEQ
1525#define MICROPY_PY_UTIMEQ (0)
1526#endif
1527
Paul Sokolovskyf4b19c82014-11-22 01:19:13 +02001528#ifndef MICROPY_PY_UHASHLIB
Jim Mussared0e236ee2021-09-15 23:18:23 +10001529#define MICROPY_PY_UHASHLIB (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovskyf4b19c82014-11-22 01:19:13 +02001530#endif
1531
Paul Sokolovsky5fe37302018-08-19 11:58:22 +03001532#ifndef MICROPY_PY_UHASHLIB_MD5
1533#define MICROPY_PY_UHASHLIB_MD5 (0)
1534#endif
1535
Yonatan Goldschmidt66303542018-06-09 02:48:29 +03001536#ifndef MICROPY_PY_UHASHLIB_SHA1
1537#define MICROPY_PY_UHASHLIB_SHA1 (0)
1538#endif
1539
1540#ifndef MICROPY_PY_UHASHLIB_SHA256
1541#define MICROPY_PY_UHASHLIB_SHA256 (1)
1542#endif
1543
Paul Sokolovsky567bc2d2018-01-07 15:13:56 +02001544#ifndef MICROPY_PY_UCRYPTOLIB
1545#define MICROPY_PY_UCRYPTOLIB (0)
1546#endif
1547
Yonatan Goldschmidtef984362019-04-23 12:39:05 +03001548// Depends on MICROPY_PY_UCRYPTOLIB
1549#ifndef MICROPY_PY_UCRYPTOLIB_CTR
1550#define MICROPY_PY_UCRYPTOLIB_CTR (0)
1551#endif
1552
Yonatan Goldschmidt473fe452018-06-15 17:07:47 +03001553#ifndef MICROPY_PY_UCRYPTOLIB_CONSTS
1554#define MICROPY_PY_UCRYPTOLIB_CONSTS (0)
1555#endif
1556
Paul Sokolovskybfdc2052014-11-29 06:19:30 +02001557#ifndef MICROPY_PY_UBINASCII
Jim Mussared0e236ee2021-09-15 23:18:23 +10001558#define MICROPY_PY_UBINASCII (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovskybfdc2052014-11-29 06:19:30 +02001559#endif
1560
Paul Sokolovskyc4283672016-08-24 18:28:43 +03001561// Depends on MICROPY_PY_UZLIB
1562#ifndef MICROPY_PY_UBINASCII_CRC32
Jim Mussared0e236ee2021-09-15 23:18:23 +10001563#define MICROPY_PY_UBINASCII_CRC32 (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovskyc4283672016-08-24 18:28:43 +03001564#endif
1565
Paul Sokolovskya58a91e2016-01-17 12:10:28 +02001566#ifndef MICROPY_PY_URANDOM
Jim Mussared0e236ee2021-09-15 23:18:23 +10001567#define MICROPY_PY_URANDOM (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Paul Sokolovskya58a91e2016-01-17 12:10:28 +02001568#endif
1569
Damien Georgea53af6c2016-01-22 16:19:32 +00001570// Whether to include: randrange, randint, choice, random, uniform
1571#ifndef MICROPY_PY_URANDOM_EXTRA_FUNCS
Jim Mussared0e236ee2021-09-15 23:18:23 +10001572#define MICROPY_PY_URANDOM_EXTRA_FUNCS (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien Georgea53af6c2016-01-22 16:19:32 +00001573#endif
1574
Paul Sokolovsky01162182015-05-03 20:25:40 +03001575#ifndef MICROPY_PY_MACHINE
1576#define MICROPY_PY_MACHINE (0)
1577#endif
1578
Jim Mussared870000f2021-08-10 01:09:04 +10001579// Whether to include: bitstream
1580#ifndef MICROPY_PY_MACHINE_BITSTREAM
1581#define MICROPY_PY_MACHINE_BITSTREAM (0)
1582#endif
1583
Damien George33168082016-05-31 14:25:19 +01001584// Whether to include: time_pulse_us
1585#ifndef MICROPY_PY_MACHINE_PULSE
1586#define MICROPY_PY_MACHINE_PULSE (0)
1587#endif
1588
Damien Georged0837122016-04-12 13:42:35 +01001589#ifndef MICROPY_PY_MACHINE_I2C
1590#define MICROPY_PY_MACHINE_I2C (0)
1591#endif
1592
Damien George122d9012021-09-02 12:37:00 +10001593// Whether to provide the "machine.SoftI2C" class
1594#ifndef MICROPY_PY_MACHINE_SOFTI2C
1595#define MICROPY_PY_MACHINE_SOFTI2C (0)
1596#endif
1597
Damien George0823c1b2016-09-01 15:07:20 +10001598#ifndef MICROPY_PY_MACHINE_SPI
1599#define MICROPY_PY_MACHINE_SPI (0)
1600#endif
1601
Damien Georgeafe06342021-09-02 12:39:28 +10001602// Whether to provide the "machine.SoftSPI" class
1603#ifndef MICROPY_PY_MACHINE_SOFTSPI
1604#define MICROPY_PY_MACHINE_SOFTSPI (0)
1605#endif
1606
Damien Georgeaab005c2022-04-04 23:07:35 +10001607// The default backlog value for socket.listen(backlog)
1608#ifndef MICROPY_PY_USOCKET_LISTEN_BACKLOG_DEFAULT
1609#define MICROPY_PY_USOCKET_LISTEN_BACKLOG_DEFAULT (2)
1610#endif
1611
Paul Sokolovskyaaa88672015-10-06 18:10:00 +03001612#ifndef MICROPY_PY_USSL
1613#define MICROPY_PY_USSL (0)
Damien George772058a2022-01-07 23:59:17 +11001614#endif
1615
Eric Poulsen74ec52d2017-10-26 21:17:35 -07001616// Whether to add finaliser code to ussl objects
Damien George772058a2022-01-07 23:59:17 +11001617#ifndef MICROPY_PY_USSL_FINALISER
Eric Poulsen74ec52d2017-10-26 21:17:35 -07001618#define MICROPY_PY_USSL_FINALISER (0)
Paul Sokolovskyaaa88672015-10-06 18:10:00 +03001619#endif
1620
Yonatan Goldschmidtbc4f8b42019-02-10 22:35:18 +02001621#ifndef MICROPY_PY_UWEBSOCKET
1622#define MICROPY_PY_UWEBSOCKET (0)
Paul Sokolovsky24342dd2016-03-24 19:14:12 +02001623#endif
1624
Damien George53ad6812016-04-08 11:08:37 +01001625#ifndef MICROPY_PY_FRAMEBUF
Jim Mussared0e236ee2021-09-15 23:18:23 +10001626#define MICROPY_PY_FRAMEBUF (MICROPY_CONFIG_ROM_LEVEL_AT_LEAST_EXTRA_FEATURES)
Damien George53ad6812016-04-08 11:08:37 +01001627#endif
1628
Paul Sokolovsky737bd9c2016-07-02 14:57:42 +03001629#ifndef MICROPY_PY_BTREE
1630#define MICROPY_PY_BTREE (0)
1631#endif
1632
Damien Georged41f6dd2021-09-02 12:39:50 +10001633// Whether to provide the low-level "_onewire" module
1634#ifndef MICROPY_PY_ONEWIRE
1635#define MICROPY_PY_ONEWIRE (0)
1636#endif
1637
Damien George58ebde42014-05-21 20:32:59 +01001638/*****************************************************************************/
1639/* Hooks for a port to add builtins */
1640
Yonatan Goldschmidt343401c2019-02-03 21:24:16 +02001641// Additional builtin function definitions - see modbuiltins.c:mp_module_builtins_globals_table for format.
Damien George58ebde42014-05-21 20:32:59 +01001642#ifndef MICROPY_PORT_BUILTINS
1643#define MICROPY_PORT_BUILTINS
Paul Sokolovsky910843e2014-02-14 12:02:34 +02001644#endif
Damien Georgecaac5422014-03-25 14:18:18 +00001645
stijn22cf0942022-01-05 16:04:58 +01001646// Additional builtin function definitions for extension by command-line, boards or variants.
1647// See modbuiltins.c:mp_module_builtins_globals_table for format.
1648#ifndef MICROPY_PORT_EXTRA_BUILTINS
1649#define MICROPY_PORT_EXTRA_BUILTINS
1650#endif
1651
Yonatan Goldschmidt343401c2019-02-03 21:24:16 +02001652// Additional builtin module definitions - see objmodule.c:mp_builtin_module_table for format.
Damien George58ebde42014-05-21 20:32:59 +01001653#ifndef MICROPY_PORT_BUILTIN_MODULES
1654#define MICROPY_PORT_BUILTIN_MODULES
Damien Georgecaac5422014-03-25 14:18:18 +00001655#endif
1656
Damien George57e99eb2014-04-10 22:42:11 +01001657// Additional constant definitions for the compiler - see compile.c:mp_constants_table.
Damien George58ebde42014-05-21 20:32:59 +01001658#ifndef MICROPY_PORT_CONSTANTS
1659#define MICROPY_PORT_CONSTANTS
Damien George57e99eb2014-04-10 22:42:11 +01001660#endif
1661
Damien Georgeb4b10fd2015-01-01 23:30:53 +00001662// Any root pointers for GC scanning - see mpstate.c
1663#ifndef MICROPY_PORT_ROOT_POINTERS
1664#define MICROPY_PORT_ROOT_POINTERS
1665#endif
1666
Damien George136f6752014-01-07 14:54:15 +00001667/*****************************************************************************/
Damien George8fb5c8f2020-02-07 12:07:50 +11001668/* Hooks for a port to wrap functions with attributes */
1669
Damien George84125682021-09-24 12:49:51 +10001670#ifndef MICROPY_WRAP_MP_BINARY_OP
1671#define MICROPY_WRAP_MP_BINARY_OP(f) f
1672#endif
1673
1674#ifndef MICROPY_WRAP_MP_EXECUTE_BYTECODE
1675#define MICROPY_WRAP_MP_EXECUTE_BYTECODE(f) f
1676#endif
1677
1678#ifndef MICROPY_WRAP_MP_LOAD_GLOBAL
1679#define MICROPY_WRAP_MP_LOAD_GLOBAL(f) f
1680#endif
1681
1682#ifndef MICROPY_WRAP_MP_LOAD_NAME
1683#define MICROPY_WRAP_MP_LOAD_NAME(f) f
1684#endif
1685
1686#ifndef MICROPY_WRAP_MP_MAP_LOOKUP
1687#define MICROPY_WRAP_MP_MAP_LOOKUP(f) f
1688#endif
1689
1690#ifndef MICROPY_WRAP_MP_OBJ_GET_TYPE
1691#define MICROPY_WRAP_MP_OBJ_GET_TYPE(f) f
1692#endif
1693
Damien George7cbf8262021-04-28 10:52:19 +10001694#ifndef MICROPY_WRAP_MP_SCHED_EXCEPTION
1695#define MICROPY_WRAP_MP_SCHED_EXCEPTION(f) f
1696#endif
1697
Damien Georgee9e9c762021-04-28 10:57:34 +10001698#ifndef MICROPY_WRAP_MP_SCHED_KEYBOARD_INTERRUPT
1699#define MICROPY_WRAP_MP_SCHED_KEYBOARD_INTERRUPT(f) f
Damien George8fb5c8f2020-02-07 12:07:50 +11001700#endif
1701
Damien George544c3082020-04-23 16:18:14 +10001702#ifndef MICROPY_WRAP_MP_SCHED_SCHEDULE
1703#define MICROPY_WRAP_MP_SCHED_SCHEDULE(f) f
1704#endif
1705
Damien George8fb5c8f2020-02-07 12:07:50 +11001706/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +00001707/* Miscellaneous settings */
1708
Damien George28631532015-02-08 13:42:00 +00001709// All uPy objects in ROM must be aligned on at least a 4 byte boundary
1710// so that the small-int/qstr/pointer distinction can be made. For machines
1711// that don't do this (eg 16-bit CPU), define the following macro to something
1712// like __attribute__((aligned(4))).
1713#ifndef MICROPY_OBJ_BASE_ALIGNMENT
1714#define MICROPY_OBJ_BASE_ALIGNMENT
1715#endif
1716
Dave Hylands5b7fd202014-07-01 23:46:53 -07001717// On embedded platforms, these will typically enable/disable irqs.
1718#ifndef MICROPY_BEGIN_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +00001719#define MICROPY_BEGIN_ATOMIC_SECTION() (0)
Dave Hylands5b7fd202014-07-01 23:46:53 -07001720#endif
1721#ifndef MICROPY_END_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +00001722#define MICROPY_END_ATOMIC_SECTION(state) (void)(state)
Dave Hylands5b7fd202014-07-01 23:46:53 -07001723#endif
1724
Paul Sokolovskyd5df6cd2014-02-12 18:15:40 +02001725// Allow to override static modifier for global objects, e.g. to use with
1726// object code analysis tools which don't support static symbols.
1727#ifndef STATIC
1728#define STATIC static
1729#endif
1730
Damien Georgead4656b2021-02-04 16:39:09 +11001731// Number of bytes in an object word: mp_obj_t, mp_uint_t, mp_uint_t
1732#ifndef MP_BYTES_PER_OBJ_WORD
1733#define MP_BYTES_PER_OBJ_WORD (sizeof(mp_uint_t))
Damien George4c307bf2017-04-01 11:39:38 +11001734#endif
1735
Damien George7e956fa2021-02-04 15:32:59 +11001736// Number of bits in a byte
1737#ifndef MP_BITS_PER_BYTE
1738#define MP_BITS_PER_BYTE (8)
Yonatan Goldschmidt1c849d62019-12-01 01:10:12 +02001739#endif
Damien George40f3c022014-07-03 13:25:24 +01001740// mp_int_t value with most significant bit set
Damien Georgec8911902021-02-04 16:39:46 +11001741#define MP_OBJ_WORD_MSBIT_HIGH (((mp_uint_t)1) << (MP_BYTES_PER_OBJ_WORD * MP_BITS_PER_BYTE - 1))
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +02001742
Damien Georgea9bcd512014-10-06 13:44:59 +00001743// Make sure both MP_ENDIANNESS_LITTLE and MP_ENDIANNESS_BIG are
1744// defined and that they are the opposite of each other.
1745#if defined(MP_ENDIANNESS_LITTLE)
1746#define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
1747#elif defined(MP_ENDIANNESS_BIG)
1748#define MP_ENDIANNESS_LITTLE (!MP_ENDIANNESS_BIG)
1749#else
Damien George69661f32020-02-27 15:36:53 +11001750// Endianness not defined by port so try to autodetect it.
Damien Georgea9bcd512014-10-06 13:44:59 +00001751 #if defined(__BYTE_ORDER__)
1752 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
1753 #define MP_ENDIANNESS_LITTLE (1)
Damien George96303762018-05-07 13:36:52 +10001754 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
Damien Georgea9bcd512014-10-06 13:44:59 +00001755 #define MP_ENDIANNESS_LITTLE (0)
1756 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +00001757 #else
Damien George4e4772b2015-05-30 23:12:30 +01001758 #include <endian.h>
1759 #if defined(__BYTE_ORDER)
1760 #if __BYTE_ORDER == __LITTLE_ENDIAN
1761 #define MP_ENDIANNESS_LITTLE (1)
Damien George96303762018-05-07 13:36:52 +10001762 #elif __BYTE_ORDER == __BIG_ENDIAN
Damien George4e4772b2015-05-30 23:12:30 +01001763 #define MP_ENDIANNESS_LITTLE (0)
1764 #endif
Damien George4e4772b2015-05-30 23:12:30 +01001765 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +00001766 #endif
Damien George96303762018-05-07 13:36:52 +10001767 #ifndef MP_ENDIANNESS_LITTLE
1768 #error endianness not defined and cannot detect it
1769 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +00001770 #define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
Andrew Schellercc837372014-04-14 02:39:56 +01001771#endif
Paul Sokolovsky2da81fa2014-04-11 03:44:00 +03001772
Damien George3c658a42014-08-24 16:28:17 +01001773// Make a pointer to RAM callable (eg set lower bit for Thumb code)
1774// (This scheme won't work if we want to mix Thumb and normal ARM code.)
1775#ifndef MICROPY_MAKE_POINTER_CALLABLE
1776#define MICROPY_MAKE_POINTER_CALLABLE(p) (p)
1777#endif
1778
Damien George7f9d1d62015-04-09 23:56:15 +01001779// If these MP_PLAT_*_EXEC macros are overridden then the memory allocated by them
Damien George2127e9a2015-01-14 00:11:09 +00001780// must be somehow reachable for marking by the GC, since the native code
1781// generators store pointers to GC managed memory in the code.
Fabian Vogtb7235b82014-09-03 16:59:33 +02001782#ifndef MP_PLAT_ALLOC_EXEC
Damien George4dea9222015-04-09 15:29:54 +00001783#define MP_PLAT_ALLOC_EXEC(min_size, ptr, size) do { *ptr = m_new(byte, min_size); *size = min_size; } while (0)
Fabian Vogtb7235b82014-09-03 16:59:33 +02001784#endif
1785
1786#ifndef MP_PLAT_FREE_EXEC
1787#define MP_PLAT_FREE_EXEC(ptr, size) m_del(byte, ptr, size)
1788#endif
1789
Damien George7f9d1d62015-04-09 23:56:15 +01001790// This macro is used to do all output (except when MICROPY_PY_IO is defined)
1791#ifndef MP_PLAT_PRINT_STRN
Damien George4300c7d2015-10-15 00:05:55 +01001792#define MP_PLAT_PRINT_STRN(str, len) mp_hal_stdout_tx_strn_cooked(str, len)
Damien George7f9d1d62015-04-09 23:56:15 +01001793#endif
1794
Paul Sokolovsky722e5622014-09-06 19:17:23 +03001795#ifndef MP_SSIZE_MAX
1796#define MP_SSIZE_MAX SSIZE_MAX
1797#endif
1798
Damien George40f3c022014-07-03 13:25:24 +01001799// printf format spec to use for mp_int_t and friends
Damien George136f6752014-01-07 14:54:15 +00001800#ifndef INT_FMT
stijn3baf6b52015-11-20 15:59:06 +01001801#if defined(__LP64__)
Damien George40f3c022014-07-03 13:25:24 +01001802// Archs where mp_int_t == long, long != int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001803#define UINT_FMT "%lu"
1804#define INT_FMT "%ld"
stijn3baf6b52015-11-20 15:59:06 +01001805#elif defined(_WIN64)
stijn0a4eb4d2015-12-18 10:20:33 +01001806#define UINT_FMT "%llu"
1807#define INT_FMT "%lld"
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001808#else
Damien George40f3c022014-07-03 13:25:24 +01001809// Archs where mp_int_t == int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001810#define UINT_FMT "%u"
1811#define INT_FMT "%d"
1812#endif
stijn84fa3312020-04-16 09:13:57 +02001813#endif // INT_FMT
Paul Sokolovskye9085912014-04-30 05:35:18 +03001814
1815// Modifier for function which doesn't return
stijn01d6be42014-05-05 12:18:27 +02001816#ifndef NORETURN
Paul Sokolovskye9085912014-04-30 05:35:18 +03001817#define NORETURN __attribute__((noreturn))
stijn01d6be42014-05-05 12:18:27 +02001818#endif
mux5c8db482014-06-21 17:24:55 +02001819
1820// Modifier for weak functions
1821#ifndef MP_WEAK
1822#define MP_WEAK __attribute__((weak))
1823#endif
Paul Sokolovsky361909e2014-12-29 00:51:06 +02001824
Paul Sokolovsky0f5bf1a2016-06-15 23:52:00 +03001825// Modifier for functions which should be never inlined
1826#ifndef MP_NOINLINE
1827#define MP_NOINLINE __attribute__((noinline))
1828#endif
1829
Paul Sokolovsky1bc29112016-08-07 22:36:05 +03001830// Modifier for functions which should be always inlined
1831#ifndef MP_ALWAYSINLINE
1832#define MP_ALWAYSINLINE __attribute__((always_inline))
1833#endif
1834
Paul Sokolovsky361909e2014-12-29 00:51:06 +02001835// Condition is likely to be true, to help branch prediction
1836#ifndef MP_LIKELY
1837#define MP_LIKELY(x) __builtin_expect((x), 1)
1838#endif
1839
1840// Condition is likely to be false, to help branch prediction
1841#ifndef MP_UNLIKELY
1842#define MP_UNLIKELY(x) __builtin_expect((x), 0)
1843#endif
Damien George9ddbe292014-12-29 01:02:19 +00001844
Damien George0c80cb32019-08-19 15:50:02 +10001845// To annotate that code is unreachable
1846#ifndef MP_UNREACHABLE
1847#if defined(__GNUC__)
1848#define MP_UNREACHABLE __builtin_unreachable();
1849#else
1850#define MP_UNREACHABLE for (;;);
1851#endif
1852#endif
1853
Emil Renner Berthingccd92332019-11-28 12:47:21 +01001854// Explicitly annotate switch case fall throughs
1855#if defined(__GNUC__) && __GNUC__ >= 7
1856#define MP_FALLTHROUGH __attribute__((fallthrough));
1857#else
1858#define MP_FALLTHROUGH
1859#endif
1860
Paul Sokolovsky1b146e92017-11-08 19:45:18 +02001861#ifndef MP_HTOBE16
1862#if MP_ENDIANNESS_LITTLE
Damien Georgefeb25772020-03-20 21:47:07 +11001863#define MP_HTOBE16(x) ((uint16_t)((((x) & 0xff) << 8) | (((x) >> 8) & 0xff)))
Damien George69661f32020-02-27 15:36:53 +11001864#define MP_BE16TOH(x) MP_HTOBE16(x)
Paul Sokolovsky1b146e92017-11-08 19:45:18 +02001865#else
Damien George69661f32020-02-27 15:36:53 +11001866#define MP_HTOBE16(x) (x)
1867#define MP_BE16TOH(x) (x)
Paul Sokolovsky1b146e92017-11-08 19:45:18 +02001868#endif
1869#endif
1870
1871#ifndef MP_HTOBE32
1872#if MP_ENDIANNESS_LITTLE
Damien Georgefeb25772020-03-20 21:47:07 +11001873#define MP_HTOBE32(x) ((uint32_t)((((x) & 0xff) << 24) | (((x) & 0xff00) << 8) | (((x) >> 8) & 0xff00) | (((x) >> 24) & 0xff)))
Damien George69661f32020-02-27 15:36:53 +11001874#define MP_BE32TOH(x) MP_HTOBE32(x)
Paul Sokolovsky1b146e92017-11-08 19:45:18 +02001875#else
Damien George69661f32020-02-27 15:36:53 +11001876#define MP_HTOBE32(x) (x)
1877#define MP_BE32TOH(x) (x)
Paul Sokolovsky1b146e92017-11-08 19:45:18 +02001878#endif
1879#endif
1880
Paul Sokolovsky2f5d1132018-12-21 14:20:55 +03001881// Warning categories are by default implemented as strings, though
1882// hook is left for a port to define them as something else.
1883#if MICROPY_WARNINGS_CATEGORY
Damien George69661f32020-02-27 15:36:53 +11001884#ifndef MP_WARN_CAT
1885#define MP_WARN_CAT(x) #x
1886#endif
Paul Sokolovsky2f5d1132018-12-21 14:20:55 +03001887#else
Damien George69661f32020-02-27 15:36:53 +11001888#undef MP_WARN_CAT
1889#define MP_WARN_CAT(x) (NULL)
Paul Sokolovsky2f5d1132018-12-21 14:20:55 +03001890#endif
1891
Milan Rossa310b3d12019-08-14 16:09:36 +02001892// Feature dependency check.
1893#if MICROPY_PY_SYS_SETTRACE
1894#if !MICROPY_PERSISTENT_CODE_SAVE
1895#error "MICROPY_PY_SYS_SETTRACE requires MICROPY_PERSISTENT_CODE_SAVE to be enabled"
1896#endif
1897#if MICROPY_COMP_CONST
1898#error "MICROPY_PY_SYS_SETTRACE requires MICROPY_COMP_CONST to be disabled"
1899#endif
1900#endif
1901
Alexander Steffen299bc622017-06-29 23:14:58 +02001902#endif // MICROPY_INCLUDED_PY_MPCONFIG_H