python-on-a-chip online compiler
pm.h File Reference
PyMite Header. More...
Go to the source code of this file.
Typedefs | |
typedef enum PmReturn_e | PmReturn_t |
Return values for system functions to report status, errors, exceptions, etc. | |
typedef PmReturn_t(* | pPmNativeFxn_t )(pPmFrame_t *) |
Pointer to a native function used for lookup tables in interp.c. | |
Enumerations | |
enum | PmReturn_e { PM_RET_OK = 0, PM_RET_NO = 0xFF, PM_RET_ERR = 0xFE, PM_RET_STUB = 0xFD, PM_RET_ASSERT_FAIL = 0xFC, PM_RET_FRAME_SWITCH = 0xFB, PM_RET_ALIGNMENT = 0xFA, PM_RET_EX = 0xE0, PM_RET_EX_EXIT = 0xE1, PM_RET_EX_IO = 0xE2, PM_RET_EX_ZDIV = 0xE3, PM_RET_EX_ASSRT = 0xE4, PM_RET_EX_ATTR = 0xE5, PM_RET_EX_IMPRT = 0xE6, PM_RET_EX_INDX = 0xE7, PM_RET_EX_KEY = 0xE8, PM_RET_EX_MEM = 0xE9, PM_RET_EX_NAME = 0xEA, PM_RET_EX_SYNTAX = 0xEB, PM_RET_EX_SYS = 0xEC, PM_RET_EX_TYPE = 0xED, PM_RET_EX_VAL = 0xEE, PM_RET_EX_STOP = 0xEF, PM_RET_EX_WARN = 0xF0, PM_RET_EX_OFLOW = 0xF1 } |
Return values for system functions to report status, errors, exceptions, etc. More... | |
Functions | |
PmReturn_t | pm_init (uint8_t *heap_base, uint32_t heap_size, PmMemSpace_t memspace, uint8_t const *const pusrimg) |
Initializes the PyMite virtual machine and indexes the user's application image. | |
PmReturn_t | pm_run (uint8_t const *modstr) |
Executes the named module. | |
PmReturn_t | pm_vmPeriodic (uint16_t usecsSinceLastCall) |
Needs to be called periodically by the host program. | |
Variables | |
volatile uint32_t | pm_timerMsTicks |
Stores the timer millisecond-ticks since system start. |
Detailed Description
PyMite Header.
Include things that are needed by nearly everything.
Definition in file pm.h.
Typedef Documentation
typedef enum PmReturn_e PmReturn_t |
Return values for system functions to report status, errors, exceptions, etc.
Normally, functions which use these values should propagate the same return value up the call tree to the interpreter.
typedef PmReturn_t(* pPmNativeFxn_t)(pPmFrame_t *) |
Enumeration Type Documentation
enum PmReturn_e |
Return values for system functions to report status, errors, exceptions, etc.
Normally, functions which use these values should propagate the same return value up the call tree to the interpreter.
- Enumerator:
Function Documentation
PmReturn_t pm_init | ( | uint8_t * | heap_base, |
uint32_t | heap_size, | ||
PmMemSpace_t | memspace, | ||
uint8_t const *const | pusrimg | ||
) |
Initializes the PyMite virtual machine and indexes the user's application image.
The VM heap and globals are reset. The argument, pusrimg, may be null for interactive sessions.
- Parameters:
-
heap_base The address where the contiguous heap begins heap_size The size in bytes (octets) of the given heap. Must be a multiple of four. memspace Memory space in which the user image is located pusrimg Address of the user image in the memory space
- Returns:
- Return status
PmReturn_t pm_run | ( | uint8_t const * | modstr ) |
PmReturn_t pm_vmPeriodic | ( | uint16_t | usecsSinceLastCall ) |
Needs to be called periodically by the host program.
For the desktop target, it is periodically called using a signal. For embedded targets, it needs to be called periodically. It should be called from a timer interrupt.
- Parameters:
-
usecsSinceLastCall Microseconds (not less than those) that passed since last call. This must be <64535.
- Returns:
- Return status
Variable Documentation
volatile uint32_t pm_timerMsTicks |
Generated on Tue Jul 12 2022 23:13:47 by 1.7.2