circuitpython/ports/nrf/mpconfigport.h

/*
 * This file is part of the MicroPython project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Glenn Ruben Bakke
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef NRF5_MPCONFIGPORT_H__
#define NRF5_MPCONFIGPORT_H__

#include <mpconfigboard.h>

// options to control how MicroPython is built
#define MICROPY_ALLOC_PATH_MAX                   (512)
#define MICROPY_PERSISTENT_CODE_LOAD             (1)
#define MICROPY_EMIT_THUMB                       (0)
#define MICROPY_EMIT_INLINE_THUMB                (0)
#define MICROPY_COMP_MODULE_CONST                (0)
#define MICROPY_COMP_TRIPLE_TUPLE_ASSIGN         (0)
#define MICROPY_READER_VFS                       (MICROPY_VFS)
#define MICROPY_ENABLE_GC                        (1)
#define MICROPY_ENABLE_FINALISER                 (1)
#define MICROPY_STACK_CHECK                      (0)
#define MICROPY_HELPER_REPL                      (1)
#define MICROPY_REPL_EMACS_KEYS                  (0)
#define MICROPY_REPL_AUTO_INDENT                 (1)
#define MICROPY_ENABLE_SOURCE_LINE               (1)
//CP UPDATE: See mpconfigport.h for LONGINT implementation
#define MICROPY_LONGINT_IMPL                     (MICROPY_LONGINT_IMPL_MPZ)
#if NRF51
#define MICROPY_FLOAT_IMPL                       (MICROPY_FLOAT_IMPL_NONE)
#else
#define MICROPY_FLOAT_IMPL                       (MICROPY_FLOAT_IMPL_FLOAT)
#endif

#define MICROPY_OPT_COMPUTED_GOTO                (0)
#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE (0)
#define MICROPY_OPT_MPZ_BITWISE                  (0)

// fatfs configuration used in ffconf.h
#define MICROPY_FATFS_ENABLE_LFN                 (1)
#define MICROPY_FATFS_LFN_CODE_PAGE              (437) /* 1=SFN/ANSI 437=LFN/U.S.(OEM) */
#define MICROPY_FATFS_USE_LABEL                  (1)
#define MICROPY_FATFS_RPATH                      (2)
#define MICROPY_FATFS_MULTI_PARTITION            (0)
#define MICROPY_FATFS_NUM_PERSISTENT             (1)

//#define MICROPY_FATFS_MAX_SS                   (4096)
#define FILESYSTEM_BLOCK_SIZE                    (512)

#define MICROPY_VFS                              (1)
#define MICROPY_VFS_FAT                          (MICROPY_VFS)

// TODO these should be generic, not bound to fatfs
#define mp_type_fileio fatfs_type_fileio
#define mp_type_textio fatfs_type_textio

// use vfs's functions for import stat and builtin open
#if MICROPY_VFS
#define mp_import_stat mp_vfs_import_stat
#define mp_builtin_open mp_vfs_open
#define mp_builtin_open_obj mp_vfs_open_obj
#endif

#define MICROPY_CPYTHON_COMPAT                   (0)
#define MICROPY_STREAMS_NON_BLOCK                (1)
#define MICROPY_MODULE_WEAK_LINKS                (1)
#define MICROPY_CAN_OVERRIDE_BUILTINS            (1)
#define MICROPY_USE_INTERNAL_ERRNO               (1)
#define MICROPY_PY_FUNCTION_ATTRS                (1)
#define MICROPY_PY_BUILTINS_STR_UNICODE          (1)
#define MICROPY_PY_BUILTINS_STR_CENTER           (0)
#define MICROPY_PY_BUILTINS_STR_PARTITION        (0)
#define MICROPY_PY_BUILTINS_STR_SPLITLINES       (0)
#define MICROPY_PY_BUILTINS_MEMORYVIEW           (1)
#define MICROPY_PY_BUILTINS_FROZENSET            (1)
#define MICROPY_PY_BUILTINS_EXECFILE             (0)
#define MICROPY_PY_BUILTINS_COMPILE              (1)
#define MICROPY_PY_BUILTINS_HELP                 (1)
#define MICROPY_PY_BUILTINS_HELP_TEXT            nrf5_help_text
#define MICROPY_PY_BUILTINS_HELP_MODULES         (1)
#define MICROPY_PY_BUILTINS_INPUT                (1)
#define MICROPY_MODULE_BUILTIN_INIT              (1)
#define MICROPY_PY_ALL_SPECIAL_METHODS           (0)
#define MICROPY_PY_MICROPYTHON_MEM_INFO          (1)
#define MICROPY_PY_ARRAY_SLICE_ASSIGN            (0)
#define MICROPY_PY_BUILTINS_SLICE_ATTRS          (0)
#define MICROPY_PY_SYS_EXIT                      (1)
#define MICROPY_PY_SYS_MAXSIZE                   (1)
#define MICROPY_PY_SYS_STDFILES                  (0)
#define MICROPY_PY_SYS_STDIO_BUFFER              (0)
#define MICROPY_PY_COLLECTIONS_ORDEREDDICT       (0)
#define MICROPY_PY_MATH_SPECIAL_FUNCTIONS        (0)
#define MICROPY_PY_CMATH                         (0)
#define MICROPY_PY_IO                            (0)
#define MICROPY_PY_IO_FILEIO                     (0)
#define MICROPY_PY_UERRNO                        (0)
#define MICROPY_PY_UBINASCII                     (0)
#define MICROPY_PY_URANDOM                       (0)
#define MICROPY_PY_URANDOM_EXTRA_FUNCS           (0)
#define MICROPY_PY_UCTYPES                       (0)
#define MICROPY_PY_UZLIB                         (0)
#define MICROPY_PY_UJSON                         (0)
#define MICROPY_PY_URE                           (0)
#define MICROPY_PY_UHEAPQ                        (0)
#define MICROPY_PY_UHASHLIB                      (0)
#define MICROPY_PY_UTIME_MP_HAL                  (1)
#define MICROPY_PY_STRUCT                        (0)
#define MICROPY_PY_MACHINE                       (1)
#define MICROPY_PY_MACHINE_PULSE                 (0)
#define MICROPY_PY_MACHINE_I2C_MAKE_NEW          machine_hard_i2c_make_new
#define MICROPY_PY_MACHINE_SPI                   (0)
#define MICROPY_PY_FRAMEBUF                      (0)

#define MICROPY_KBD_EXCEPTION                    (1)

#ifndef MICROPY_HW_LED_COUNT
#define MICROPY_HW_LED_COUNT                     (0)
#endif

#ifndef MICROPY_HW_LED_PULLUP
#define MICROPY_HW_LED_PULLUP                    (0)
#endif

#ifndef MICROPY_PY_MUSIC
#define MICROPY_PY_MUSIC                         (0)
#endif

#ifndef MICROPY_PY_MACHINE_ADC
#define MICROPY_PY_MACHINE_ADC                   (0)
#endif

#ifndef MICROPY_PY_MACHINE_I2C
#define MICROPY_PY_MACHINE_I2C                   (0)
#endif

#ifndef MICROPY_PY_MACHINE_HW_SPI
#define MICROPY_PY_MACHINE_HW_SPI                (1)
#endif

#ifndef MICROPY_PY_MACHINE_HW_PWM
#define MICROPY_PY_MACHINE_HW_PWM                (0)
#endif

#ifndef MICROPY_PY_MACHINE_SOFT_PWM
#define MICROPY_PY_MACHINE_SOFT_PWM              (0)
#endif

#ifndef MICROPY_PY_MACHINE_TIMER
#define MICROPY_PY_MACHINE_TIMER                 (0)
#endif

#ifndef MICROPY_PY_MACHINE_RTC
#define MICROPY_PY_MACHINE_RTC                   (0)
#endif

#ifndef MICROPY_PY_HW_RNG
#define MICROPY_PY_HW_RNG                        (1)
#endif


#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF   (1)
#define MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE     (0)

// Scan gamepad every 32ms
#define CIRCUITPY_GAMEPAD_TICKS 0x1f

// if sdk is in use, import configuration
#if BLUETOOTH_SD
#include "bluetooth_conf.h"
#endif

#ifndef MICROPY_PY_UBLUEPY
#define MICROPY_PY_UBLUEPY                       (0)
#endif

#ifndef MICROPY_PY_BLE_NUS
#define MICROPY_PY_BLE_NUS                       (0)
#endif

// type definitions for the specific machine

#define BYTES_PER_WORD (4)

#define MICROPY_MAKE_POINTER_CALLABLE(p) ((void*)((mp_uint_t)(p) | 1))

#define MP_SSIZE_MAX (0x7fffffff)

#define UINT_FMT "%u"
#define INT_FMT "%d"
#define HEX2_FMT "%02x"

typedef int mp_int_t; // must be pointer size
typedef unsigned int mp_uint_t; // must be pointer size
typedef long mp_off_t;

// extra built in modules to add to the list of known ones

extern const struct _mp_obj_module_t microcontroller_module;
extern const struct _mp_obj_module_t bitbangio_module;
extern const struct _mp_obj_module_t analogio_module;
extern const struct _mp_obj_module_t digitalio_module;
extern const struct _mp_obj_module_t pulseio_module;
extern const struct _mp_obj_module_t busio_module;
extern const struct _mp_obj_module_t board_module;
extern const struct _mp_obj_module_t os_module;
extern const struct _mp_obj_module_t random_module;
extern const struct _mp_obj_module_t storage_module;
extern const struct _mp_obj_module_t struct_module;
extern const struct _mp_obj_module_t time_module;
extern const struct _mp_obj_module_t supervisor_module;
extern const struct _mp_obj_module_t gamepad_module;

extern const struct _mp_obj_module_t pyb_module;
extern const struct _mp_obj_module_t machine_module;
extern const struct _mp_obj_module_t mp_module_utime;
extern const struct _mp_obj_module_t mp_module_ubluepy;
extern const struct _mp_obj_module_t music_module;
extern const struct _mp_obj_module_t random_module;

extern const struct _mp_obj_module_t ble_module;

#if MICROPY_PY_MUSIC
#define MUSIC_MODULE                        { MP_ROM_QSTR(MP_QSTR_music), MP_ROM_PTR(&music_module) },
#else
#define MUSIC_MODULE
#endif

#if MICROPY_PY_HW_RNG
#define RANDOM_MODULE                        { MP_ROM_QSTR(MP_QSTR_random), MP_ROM_PTR(&random_module) },
#else
#define RANDOM_MODULE
#endif

#if MICROPY_PY_UBLUEPY
#define UBLUEPY_MODULE                      { MP_ROM_QSTR(MP_QSTR_ubluepy), MP_ROM_PTR(&mp_module_ubluepy) },
#else
#define UBLUEPY_MODULE
#endif

#if MICROPY_PY_BLE
extern const struct _mp_obj_module_t ble_module;
#define BLE_MODULE                        { MP_ROM_QSTR(MP_QSTR_ble), MP_ROM_PTR(&ble_module) },
#else
#define BLE_MODULE
#endif

#define MICROPY_PORT_BUILTIN_MODULES \
    { MP_OBJ_NEW_QSTR (MP_QSTR_board           ), (mp_obj_t)&board_module           }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_busio           ), (mp_obj_t)&busio_module           }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_analogio        ), (mp_obj_t)&analogio_module        }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_digitalio       ), (mp_obj_t)&digitalio_module       }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_pulseio         ), (mp_obj_t)&pulseio_module         }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_microcontroller ), (mp_obj_t)&microcontroller_module }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_bitbangio       ), (mp_obj_t)&bitbangio_module       }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_os              ), (mp_obj_t)&os_module              }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_random          ), (mp_obj_t)&random_module          }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_storage         ), (mp_obj_t)&storage_module         },\
    { MP_OBJ_NEW_QSTR (MP_QSTR_struct          ), (mp_obj_t)&struct_module          }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_supervisor      ), (mp_obj_t)&supervisor_module      }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_gamepad         ), (mp_obj_t)&gamepad_module         }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_time            ), (mp_obj_t)&time_module            }, \
    { MP_ROM_QSTR     (MP_QSTR_pyb             ), MP_ROM_PTR(&pyb_module)           }, \
    { MP_ROM_QSTR     (MP_QSTR_utime           ), MP_ROM_PTR(&mp_module_utime)      }, \
    MUSIC_MODULE \
    RANDOM_MODULE \
    BLE_MODULE \
    UBLUEPY_MODULE \


#define MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS \
    { MP_ROM_QSTR     (MP_QSTR_time    ), MP_ROM_PTR(&mp_module_utime)     }, \

// extra built in names to add to the global namespace
#define MICROPY_PORT_BUILTINS \
    { MP_ROM_QSTR     (MP_QSTR_help), MP_ROM_PTR(&mp_builtin_help_obj) }, \
    { MP_OBJ_NEW_QSTR (MP_QSTR_input), (mp_obj_t)&mp_builtin_input_obj  }, \
    { MP_ROM_QSTR     (MP_QSTR_open), MP_ROM_PTR(&mp_builtin_open_obj) }, \

// extra constants
#define MICROPY_PORT_CONSTANTS \
    { MP_ROM_QSTR     (MP_QSTR_pyb     ), MP_ROM_PTR(&pyb_module)          }, \
    { MP_ROM_QSTR     (MP_QSTR_machine ), MP_ROM_PTR(&machine_module)      }, \
    BLE_MODULE \

#define MP_STATE_PORT MP_STATE_VM

#define MICROPY_PORT_ROOT_POINTERS \
    const char *readline_hist[8]; \
    mp_obj_t pyb_config_main; \
    mp_obj_t pin_class_mapper; \
    mp_obj_t pin_class_map_dict; \
    /* Used to do callbacks to Python code on interrupt */ \
    struct _pyb_timer_obj_t *pyb_timer_obj_all[14]; \
    \
    /* stdio is repeated on this UART object if it's not null */ \
    struct _machine_hard_uart_obj_t *pyb_stdio_uart; \
    \
    /* pointers to all UART objects (if they have been created) */ \
    struct _machine_hard_uart_obj_t *pyb_uart_obj_all[1]; \
    \
    /* list of registered NICs */ \
    mp_obj_list_t mod_network_nic_list; \
    \
    /* microbit modules */ \
    struct _music_data_t *music_data; \
    const struct _pwm_events *pwm_active_events; \
    const struct _pwm_events *pwm_pending_events; \

#define MP_PLAT_PRINT_STRN(str, len) mp_hal_stdout_tx_strn_cooked(str, len)

// We need to provide a declaration/definition of alloca()
#include <alloca.h>

#define MICROPY_PIN_DEFS_PORT_H "pin_defs_nrf5.h"
#define CIRCUITPY_BOOT_OUTPUT_FILE "/boot_out.txt"

#endif