2016-12-13 21:04:50 -05:00
/*
2017-08-27 15:02:50 -04:00
* This file is part of the MicroPython project , http : //micropython.org/
2016-12-13 21:04:50 -05:00
*
* The MIT License ( MIT )
*
2017-11-15 17:44:14 -05:00
* Copyright ( c ) 2016 - 2017 Scott Shawcroft for Adafruit Industries
2016-12-13 21:04:50 -05:00
*
* 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 .
*/
2020-10-29 11:39:06 -04:00
# include <string.h>
2018-07-25 08:06:30 -04:00
# include "py/obj.h"
# include "py/runtime.h"
# include "py/reload.h"
2020-10-29 11:39:06 -04:00
# include "py/objstr.h"
2018-05-14 16:57:50 -04:00
2018-07-25 08:06:30 -04:00
# include "lib/utils/interrupt_char.h"
# include "supervisor/shared/autoreload.h"
2021-04-16 19:18:01 -04:00
# include "supervisor/shared/status_leds.h"
2018-07-25 08:06:30 -04:00
# include "supervisor/shared/stack.h"
2020-09-27 06:58:51 -04:00
# include "supervisor/shared/traceback.h"
2018-07-31 19:53:54 -04:00
# include "supervisor/shared/translate.h"
2020-11-23 22:44:53 -05:00
# include "supervisor/shared/workflow.h"
2018-05-14 16:57:50 -04:00
2020-11-23 22:44:53 -05:00
# include "shared-bindings/microcontroller/__init__.h"
2018-07-25 08:06:30 -04:00
# include "shared-bindings/supervisor/__init__.h"
2021-06-27 17:09:54 -04:00
# include "shared-bindings/time/__init__.h"
2018-07-25 08:06:30 -04:00
# include "shared-bindings/supervisor/Runtime.h"
2018-05-14 16:57:50 -04:00
2020-05-12 20:15:28 -04:00
//| """Supervisor settings"""
2018-03-08 22:22:00 -05:00
//|
2016-12-13 21:04:50 -05:00
2020-07-25 04:58:37 -04:00
//| runtime: Runtime
2020-05-12 20:15:28 -04:00
//| """Runtime information, such as ``runtime.serial_connected``
2020-05-12 11:28:33 -04:00
//| (USB serial connection status).
//| This object is the sole instance of `supervisor.Runtime`."""
2018-03-08 21:19:51 -05:00
//|
2020-08-03 00:35:43 -04:00
//| def enable_autoreload() -> None:
2020-05-12 11:28:33 -04:00
//| """Enable autoreload based on USB file write activity."""
//| ...
2016-12-13 21:04:50 -05:00
//|
2017-11-15 17:44:14 -05:00
STATIC mp_obj_t supervisor_enable_autoreload ( void ) {
2017-05-12 19:45:38 -04:00
autoreload_enable ( ) ;
2016-12-13 21:04:50 -05:00
return mp_const_none ;
}
2017-11-15 17:44:14 -05:00
MP_DEFINE_CONST_FUN_OBJ_0 ( supervisor_enable_autoreload_obj , supervisor_enable_autoreload ) ;
2016-12-13 21:04:50 -05:00
2020-08-03 00:35:43 -04:00
//| def disable_autoreload() -> None:
2020-05-12 11:28:33 -04:00
//| """Disable autoreload based on USB file write activity until
//| `enable_autoreload` is called."""
//| ...
2016-12-13 21:04:50 -05:00
//|
2017-11-15 17:44:14 -05:00
STATIC mp_obj_t supervisor_disable_autoreload ( void ) {
2017-05-12 19:45:38 -04:00
autoreload_disable ( ) ;
2016-12-13 21:04:50 -05:00
return mp_const_none ;
}
2017-11-15 17:44:14 -05:00
MP_DEFINE_CONST_FUN_OBJ_0 ( supervisor_disable_autoreload_obj , supervisor_disable_autoreload ) ;
2016-12-13 21:04:50 -05:00
2020-08-03 00:35:43 -04:00
//| def set_rgb_status_brightness(brightness: int) -> None:
2020-05-12 11:28:33 -04:00
//| """Set brightness of status neopixel from 0-255
//| `set_rgb_status_brightness` is called."""
//| ...
2017-09-12 15:09:22 -04:00
//|
2021-03-15 09:57:36 -04:00
STATIC mp_obj_t supervisor_set_rgb_status_brightness ( mp_obj_t lvl ) {
// This must be int. If cast to uint8_t first, will never raise a ValueError.
int brightness_int = mp_obj_get_int ( lvl ) ;
if ( brightness_int < 0 | | brightness_int > 255 ) {
mp_raise_ValueError ( translate ( " Brightness must be between 0 and 255 " ) ) ;
}
2021-04-16 19:18:01 -04:00
set_status_brightness ( ( uint8_t ) brightness_int ) ;
2021-03-15 09:57:36 -04:00
return mp_const_none ;
2017-09-12 15:09:22 -04:00
}
2017-11-15 17:44:14 -05:00
MP_DEFINE_CONST_FUN_OBJ_1 ( supervisor_set_rgb_status_brightness_obj , supervisor_set_rgb_status_brightness ) ;
2017-09-12 15:09:22 -04:00
2020-08-03 00:35:43 -04:00
//| def reload() -> None:
2020-05-12 11:28:33 -04:00
//| """Reload the main Python code and run it (equivalent to hitting Ctrl-D at the REPL)."""
//| ...
2018-05-14 16:57:50 -04:00
//|
STATIC mp_obj_t supervisor_reload ( void ) {
2018-05-14 17:00:38 -04:00
reload_requested = true ;
2020-11-22 19:10:09 -05:00
supervisor_set_run_reason ( RUN_REASON_SUPERVISOR_RELOAD ) ;
2018-05-14 17:41:17 -04:00
mp_raise_reload_exception ( ) ;
2018-05-14 16:57:50 -04:00
return mp_const_none ;
}
MP_DEFINE_CONST_FUN_OBJ_0 ( supervisor_reload_obj , supervisor_reload ) ;
2020-08-03 00:35:43 -04:00
//| def set_next_stack_limit(size: int) -> None:
2020-05-12 11:28:33 -04:00
//| """Set the size of the stack for the next vm run. If its too large, the default will be used."""
//| ...
2018-05-24 16:12:18 -04:00
//|
2018-07-25 08:06:30 -04:00
STATIC mp_obj_t supervisor_set_next_stack_limit ( mp_obj_t size_obj ) {
mp_int_t size = mp_obj_get_int ( size_obj ) ;
if ( size < 256 ) {
2018-07-31 19:53:54 -04:00
mp_raise_ValueError ( translate ( " Stack size must be at least 256 " ) ) ;
2018-07-25 08:06:30 -04:00
}
set_next_stack_size ( size ) ;
2018-05-24 16:12:18 -04:00
return mp_const_none ;
}
2018-07-25 08:06:30 -04:00
MP_DEFINE_CONST_FUN_OBJ_1 ( supervisor_set_next_stack_limit_obj , supervisor_set_next_stack_limit ) ;
2018-05-14 16:57:50 -04:00
2020-10-29 11:39:06 -04:00
//| def set_next_code_file(filename: Optional[str], *, reload_on_success : bool = False, reload_on_error: bool = False, sticky_on_success: bool = False, sticky_on_error: bool = False, sticky_on_reload: bool = False) -> None:
//| """Set what file to run on the next vm run.
//|
//| When not ``None``, the given ``filename`` is inserted at the front of the usual ['code.py',
//| 'main.py'] search sequence.
//|
//| The optional keyword arguments specify what happens after the specified file has run:
//|
//| ``sticky_on_…`` determine whether the newly set filename and options stay in effect: If
//| True, further runs will continue to run that file (unless it says otherwise by calling
//| ``set_next_code_filename()`` itself). If False, the settings will only affect one run and
//| revert to the standard code.py/main.py afterwards.
//|
//| ``reload_on_…`` determine how to continue: If False, wait in the usual "Code done running.
//| Waiting for reload. / Press any key to enter the REPL. Use CTRL-D to reload." state. If
//| True, reload immediately as if CTRL-D was pressed.
//|
//| ``…_on_success`` take effect when the program runs to completion or calls ``sys.exit()``.
//|
//| ``…_on_error`` take effect when the program exits with an exception, including the
//| KeyboardInterrupt caused by CTRL-C.
//|
//| ``…_on_reload`` take effect when the program is interrupted by files being written to the USB
//| drive (auto-reload) or when it calls ``supervisor.reload()``.
//|
//| These settings are stored in RAM, not in persistent memory, and will therefore only affect
//| soft reloads. Powering off or resetting the device will always revert to standard settings.
//|
//| When called multiple times in the same run, only the last call takes effect, replacing any
//| settings made by previous ones. This is the main use of passing ``None`` as a filename: to
//| reset to the standard search sequence."""
//| ...
//|
STATIC mp_obj_t supervisor_set_next_code_file ( size_t n_args , const mp_obj_t * pos_args , mp_map_t * kw_args ) {
static const mp_arg_t allowed_args [ ] = {
{ MP_QSTR_filename , MP_ARG_REQUIRED | MP_ARG_OBJ , { . u_rom_obj = mp_const_none } } ,
{ MP_QSTR_reload_on_success , MP_ARG_KW_ONLY | MP_ARG_BOOL , { . u_bool = false } } ,
{ MP_QSTR_reload_on_error , MP_ARG_KW_ONLY | MP_ARG_BOOL , { . u_bool = false } } ,
{ MP_QSTR_sticky_on_success , MP_ARG_KW_ONLY | MP_ARG_BOOL , { . u_bool = false } } ,
{ MP_QSTR_sticky_on_error , MP_ARG_KW_ONLY | MP_ARG_BOOL , { . u_bool = false } } ,
{ MP_QSTR_sticky_on_reload , MP_ARG_KW_ONLY | MP_ARG_BOOL , { . u_bool = false } } ,
} ;
struct {
mp_arg_val_t filename ;
mp_arg_val_t reload_on_success ;
mp_arg_val_t reload_on_error ;
mp_arg_val_t sticky_on_success ;
mp_arg_val_t sticky_on_error ;
mp_arg_val_t sticky_on_reload ;
} args ;
2021-06-20 15:25:37 -04:00
mp_arg_parse_all ( n_args , pos_args , kw_args , MP_ARRAY_SIZE ( allowed_args ) , allowed_args , ( mp_arg_val_t * ) & args ) ;
if ( ! mp_obj_is_str_or_bytes ( args . filename . u_obj ) & & args . filename . u_obj ! = mp_const_none ) {
2020-10-29 11:39:06 -04:00
mp_raise_TypeError ( translate ( " argument has wrong type " ) ) ;
}
2021-06-20 15:25:37 -04:00
if ( args . filename . u_obj = = mp_const_none ) {
args . filename . u_obj = mp_const_empty_bytes ;
}
2020-10-29 11:39:06 -04:00
uint8_t options = 0 ;
2021-06-20 15:25:37 -04:00
if ( args . reload_on_success . u_bool ) {
options | = SUPERVISOR_NEXT_CODE_OPT_RELOAD_ON_SUCCESS ;
}
if ( args . reload_on_error . u_bool ) {
options | = SUPERVISOR_NEXT_CODE_OPT_RELOAD_ON_ERROR ;
}
if ( args . sticky_on_success . u_bool ) {
options | = SUPERVISOR_NEXT_CODE_OPT_STICKY_ON_SUCCESS ;
}
if ( args . sticky_on_error . u_bool ) {
options | = SUPERVISOR_NEXT_CODE_OPT_STICKY_ON_ERROR ;
}
if ( args . sticky_on_reload . u_bool ) {
options | = SUPERVISOR_NEXT_CODE_OPT_STICKY_ON_RELOAD ;
}
2020-10-29 11:39:06 -04:00
size_t len ;
2021-06-20 15:25:37 -04:00
const char * filename = mp_obj_str_get_data ( args . filename . u_obj , & len ) ;
2020-10-29 11:39:06 -04:00
free_memory ( next_code_allocation ) ;
if ( options ! = 0 | | len ! = 0 ) {
next_code_allocation = allocate_memory ( align32_size ( sizeof ( next_code_info_t ) + len + 1 ) , false , true ) ;
if ( next_code_allocation = = NULL ) {
m_malloc_fail ( sizeof ( next_code_info_t ) + len + 1 ) ;
}
2021-06-20 15:25:37 -04:00
next_code_info_t * next_code = ( next_code_info_t * ) next_code_allocation - > ptr ;
2020-10-29 11:39:06 -04:00
next_code - > options = options | SUPERVISOR_NEXT_CODE_OPT_NEWLY_SET ;
memcpy ( & next_code - > filename , filename , len ) ;
next_code - > filename [ len ] = ' \0 ' ;
2021-06-20 15:25:37 -04:00
} else {
2020-10-29 11:39:06 -04:00
next_code_allocation = NULL ;
}
return mp_const_none ;
}
MP_DEFINE_CONST_FUN_OBJ_KW ( supervisor_set_next_code_file_obj , 0 , supervisor_set_next_code_file ) ;
2021-06-27 17:09:54 -04:00
//| def ticks_ms() -> int:
//| """Return the time in milliseconds since an unspecified reference point, wrapping after 2**29ms.
//|
//| The value is initialized so that the first overflow occurs about 65
//| seconds after power-on, making it feasible to check that your program
//| works properly around an overflow.
//|
//| The wrap value was chosen so that it is always possible to add
//| or subtract two `ticks_ms` values without overflow on a board without
//| long ints (or without allocating any long integer objects, on boards with
//| long ints).
//|
//| This ticks value comes from a low-accuracy clock internal to the
//| microcontroller, just like `time.monotonic`. Due to its low accuracy
//| and the fact that it "wraps around" every few days, it is intended
//| for working with short term events like advancing an LED animation,
//| not for long term events like counting down the time until a holiday.
//|
//| Addition, subtraction, and comparison of ticks values can be done
//| with routines like the following::
//|
//| _TICKS_PERIOD = const(1<<29)
//| _TICKS_MAX = const(_TICKS_PERIOD-1)
//| _TICKS_HALFPERIOD = const(_TICKS_PERIOD//2)
//|
//| def ticks_add(ticks, delta):
//| "Add a delta to a base number of ticks, performing wraparound at 2**29ms."
//| return (a + b) % _TICKS_PERIOD
//|
//| def ticks_diff(ticks1, ticks2):
//| "Compute the signed difference between two ticks values, assuming that they are within 2**28 ticks"
//| diff = (ticks1 - ticks2) & _TICKS_MAX
//| diff = ((diff + _TICKS_HALFPERIOD) & _TICKS_MAX) - _TICKS_HALFPERIOD
//| return diff
//|
//| def ticks_less(ticks1, ticks2):
//| "Return true iff ticks1 is less than ticks2, assuming that they are within 2**28 ticks"
//| return ticks_diff(ticks1, ticks2) < 0
//|
//| """
//| ...
STATIC mp_obj_t supervisor_ticks_ms ( void ) {
uint64_t ticks_ms = common_hal_time_monotonic_ms ( ) ;
return mp_obj_new_int ( ( ticks_ms + 0x1fff0000 ) % ( 1 < < 29 ) ) ;
}
MP_DEFINE_CONST_FUN_OBJ_0 ( supervisor_ticks_ms_obj , supervisor_ticks_ms ) ;
2020-09-27 06:58:51 -04:00
//| def get_previous_traceback() -> Optional[str]:
//| """If the last vm run ended with an exception (including the KeyboardInterrupt caused by
//| CTRL-C), returns the traceback as a string.
//| Otherwise, returns ``None``.
//|
//| An exception traceback is only preserved over a soft reload, a hard reset clears it.
//|
//| Only code (main or boot) runs are considered, not REPL runs."""
//| ...
//|
STATIC mp_obj_t supervisor_get_previous_traceback ( void ) {
2021-07-22 12:57:10 -04:00
// TODO is this a safe and proper way of making a heap-allocated string object that points at long-lived (and likely long and unique) data outside the heap?
2020-09-27 06:58:51 -04:00
if ( prev_traceback_allocation ) {
2021-07-22 12:57:10 -04:00
size_t len = strlen ( ( const char * ) prev_traceback_allocation - > ptr ) ;
2020-09-27 06:58:51 -04:00
if ( len > 0 ) {
mp_obj_str_t * o = m_new_obj ( mp_obj_str_t ) ;
o - > base . type = & mp_type_str ;
o - > len = len ;
2021-07-22 12:57:10 -04:00
// TODO is it a good assumption that callers probably aren't going to compare this string, so skip computing the hash?
2020-09-27 06:58:51 -04:00
o - > hash = 0 ;
2021-07-22 12:57:10 -04:00
o - > data = ( const byte * ) prev_traceback_allocation - > ptr ;
2020-09-27 06:58:51 -04:00
return MP_OBJ_FROM_PTR ( o ) ;
}
}
return mp_const_none ;
}
MP_DEFINE_CONST_FUN_OBJ_0 ( supervisor_get_previous_traceback_obj , supervisor_get_previous_traceback ) ;
2021-06-27 17:09:54 -04:00
2017-11-15 17:44:14 -05:00
STATIC const mp_rom_map_elem_t supervisor_module_globals_table [ ] = {
{ MP_ROM_QSTR ( MP_QSTR___name__ ) , MP_ROM_QSTR ( MP_QSTR_supervisor ) } ,
2020-11-23 22:44:53 -05:00
{ MP_ROM_QSTR ( MP_QSTR_enable_autoreload ) , MP_ROM_PTR ( & supervisor_enable_autoreload_obj ) } ,
{ MP_ROM_QSTR ( MP_QSTR_disable_autoreload ) , MP_ROM_PTR ( & supervisor_disable_autoreload_obj ) } ,
{ MP_ROM_QSTR ( MP_QSTR_set_rgb_status_brightness ) , MP_ROM_PTR ( & supervisor_set_rgb_status_brightness_obj ) } ,
2018-03-08 21:19:51 -05:00
{ MP_ROM_QSTR ( MP_QSTR_runtime ) , MP_ROM_PTR ( & common_hal_supervisor_runtime_obj ) } ,
2018-05-14 16:57:50 -04:00
{ MP_ROM_QSTR ( MP_QSTR_reload ) , MP_ROM_PTR ( & supervisor_reload_obj ) } ,
2020-12-06 12:00:00 -05:00
{ MP_ROM_QSTR ( MP_QSTR_RunReason ) , MP_ROM_PTR ( & supervisor_run_reason_type ) } ,
2018-07-25 08:06:30 -04:00
{ MP_ROM_QSTR ( MP_QSTR_set_next_stack_limit ) , MP_ROM_PTR ( & supervisor_set_next_stack_limit_obj ) } ,
2020-10-29 11:39:06 -04:00
{ MP_ROM_QSTR ( MP_QSTR_set_next_code_file ) , MP_ROM_PTR ( & supervisor_set_next_code_file_obj ) } ,
2021-06-27 17:09:54 -04:00
{ MP_ROM_QSTR ( MP_QSTR_ticks_ms ) , MP_ROM_PTR ( & supervisor_ticks_ms_obj ) } ,
2020-09-27 06:58:51 -04:00
{ MP_ROM_QSTR ( MP_QSTR_get_previous_traceback ) , MP_ROM_PTR ( & supervisor_get_previous_traceback_obj ) } ,
2016-12-13 21:04:50 -05:00
} ;
2017-11-15 17:44:14 -05:00
STATIC MP_DEFINE_CONST_DICT ( supervisor_module_globals , supervisor_module_globals_table ) ;
2016-12-13 21:04:50 -05:00
2017-11-15 17:44:14 -05:00
const mp_obj_module_t supervisor_module = {
2016-12-13 21:04:50 -05:00
. base = { & mp_type_module } ,
2021-03-15 09:57:36 -04:00
. globals = ( mp_obj_dict_t * ) & supervisor_module_globals ,
2016-12-13 21:04:50 -05:00
} ;