Portování MicroPythonu¶

Projekt MicroPython obsahuje několik portů na různé rodiny mikrokontrolérů a architektury. Repozitář projektu má adresář ports obsahující podadresář pro každý podporovaný port.

Port obvykle obsahuje definice pro více „desek“, z nichž každá je konkrétním kusem hardwaru, na kterém daný port může běžet, např. vývojová sada nebo zařízení.

Minimální port je k dispozici jako zjednodušená referenční implementace portu MicroPython. Může běžet jak na hostitelském systému, tak na MCU STM32F4xx.

Obecně platí, že zahájení portu vyžaduje:

Nastavení toolchainu (konfigurace Makefilů atd.).
Implementaci konfigurace bootování a inicializace CPU.
Inicializaci základních ovladačů potřebných pro vývoj a ladění (např. GPIO, UART).
Provedení konfigurací specifických pro desku.
Implementaci modulů specifických pro port.

Minimální firmware MicroPython¶

Nejlepším způsobem, jak začít s portováním MicroPythonu na novou desku, je integrace minimálního interpretu MicroPython. Pro tento návod vytvořte podadresář pro nový port v adresáři ports:

$ cd ports
$ mkdir example_port

Základní firmware MicroPython je implementován v hlavním souboru portu, např. main.c:

#include "py/builtin.h"
#include "py/compile.h"
#include "py/gc.h"
#include "py/mperrno.h"
#include "shared/runtime/gchelper.h"
#include "shared/runtime/pyexec.h"

// Allocate memory for the MicroPython GC heap.
static char heap[4096];

int main(int argc, char **argv) {
    // Initialise the MicroPython runtime.
    mp_cstack_init_with_sp_here(2048);
    gc_init(heap, heap + sizeof(heap));
    mp_init();

    // Start a normal REPL; will exit when ctrl-D is entered on a blank line.
    pyexec_friendly_repl();

    // Deinitialise the runtime.
    gc_sweep_all();
    mp_deinit();
    return 0;
}

// Handle uncaught exceptions (should never be reached in a correct C implementation).
void nlr_jump_fail(void *val) {
    for (;;) {
    }
}

// Do a garbage collection cycle.
void gc_collect(void) {
    gc_collect_start();
    gc_helper_collect_regs_and_stack();
    gc_collect_end();
}

// There is no filesystem so stat'ing returns nothing.
mp_import_stat_t mp_import_stat(const char *path) {
    return MP_IMPORT_STAT_NO_EXIST;
}

// There is no filesystem so opening a file raises an exception.
mp_lexer_t *mp_lexer_new_from_file(qstr filename) {
    mp_raise_OSError(MP_ENOENT);
}

V tomto okamžiku také pro port potřebujeme Makefile:

# Include the core environment definitions; this will set $(TOP).
include ../../py/mkenv.mk

# Include py core make definitions.
include $(TOP)/py/py.mk
include $(TOP)/extmod/extmod.mk

# Set CFLAGS and libraries.
CFLAGS += -I. -I$(BUILD) -I$(TOP)
LIBS += -lm

# Define the required source files.
SRC_C = \
    main.c \
    mphalport.c \
    shared/readline/readline.c \
    shared/runtime/gchelper_generic.c \
    shared/runtime/pyexec.c \
    shared/runtime/stdout_helpers.c \

# Define source files containing qstrs.
SRC_QSTR += shared/readline/readline.c shared/runtime/pyexec.c

# Define the required object files.
OBJ = $(PY_CORE_O) $(addprefix $(BUILD)/, $(SRC_C:.c=.o))

# Define the top-level target, the main firmware.
all: $(BUILD)/firmware.elf

# Define how to build the firmware.
$(BUILD)/firmware.elf: $(OBJ)
    $(ECHO) "LINK $@"
    $(Q)$(CC) $(LDFLAGS) -o $@ $^ $(LIBS)
    $(Q)$(SIZE) $@

# Include remaining core make rules.
include $(TOP)/py/mkrules.mk

Nezapomeňte k odsazení Makefile použít správné tabulátory.

Konfigurace MicroPythonu¶

Po integraci minimálního kódu výše je dalším krokem vytvoření konfiguračních souborů MicroPythonu pro port. Konfigurace v době kompilace jsou specifikovány v mpconfigport.h a dodatečné funkce hardwarové abstrakce, jako je měření času, v mphalport.h.

Následuje příklad souboru mpconfigport.h:

#include <stdint.h>

// Python internal features.
#define MICROPY_ENABLE_GC                       (1)
#define MICROPY_HELPER_REPL                     (1)
#define MICROPY_ERROR_REPORTING                 (MICROPY_ERROR_REPORTING_TERSE)
#define MICROPY_FLOAT_IMPL                      (MICROPY_FLOAT_IMPL_FLOAT)

// Fine control over Python builtins, classes, modules, etc.
#define MICROPY_PY_ASYNC_AWAIT                  (0)
#define MICROPY_PY_BUILTINS_SET                 (0)
#define MICROPY_PY_ATTRTUPLE                    (0)
#define MICROPY_PY_COLLECTIONS                  (0)
#define MICROPY_PY_MATH                         (0)
#define MICROPY_PY_IO                           (0)
#define MICROPY_PY_STRUCT                       (0)

// Type definitions for the specific machine.

typedef long mp_off_t;

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

// Define the port's name and hardware.
#define MICROPY_HW_BOARD_NAME "example-board"
#define MICROPY_HW_MCU_NAME   "unknown-cpu"

#define MP_STATE_PORT MP_STATE_VM

Tento konfigurační soubor obsahuje konfigurace specifické pro stroj včetně aspektů jako, zda mají být povoleny různé funkce MicroPythonu, např. #define MICROPY_ENABLE_GC (1). Nastavení této hodnoty na (0) funkci zakáže.

Mezi další konfigurace patří definice typů, kořenové ukazatele, název desky, název mikrokontroléru atd.

Podobně minimální příklad souboru mphalport.h vypadá takto:

static inline void mp_hal_set_interrupt_char(char c) {}

Podpora standardního vstupu/výstupu¶

MicroPython vyžaduje alespoň způsob, jak vypisovat znaky, a pro REPL také vyžaduje způsob, jak znaky zadávat. Funkce pro toto lze implementovat v souboru mphalport.c, například:

#include <unistd.h>
#include "py/mpconfig.h"

// Receive single character, blocking until one is available.
int mp_hal_stdin_rx_chr(void) {
    unsigned char c = 0;
    int r = read(STDIN_FILENO, &c, 1);
    (void)r;
    return c;
}

// Send the string of given length.
void mp_hal_stdout_tx_strn(const char *str, mp_uint_t len) {
    int r = write(STDOUT_FILENO, str, len);
    (void)r;
}

Tyto vstupní a výstupní funkce je třeba upravit v závislosti na konkrétním API desky. Tento příklad používá standardní vstupní/výstupní proud.

Sestavení a spuštění¶

V této fázi by adresář nového portu měl obsahovat:

ports/example_port/
├── main.c
├── Makefile
├── mpconfigport.h
├── mphalport.c
└── mphalport.h

Port lze nyní sestavit spuštěním make (nebo jinak, v závislosti na vašem systému).

Pokud používáte výchozí nastavení kompilátoru v Makefile uvedeném výše, vytvoří se tím spustitelný soubor s názvem build/firmware.elf, který lze spustit přímo. Pro získání funkčního REPL možná budete muset nejprve nakonfigurovat terminál do režimu raw:

$ stty raw opost -echo
$ ./build/firmware.elf

To by mělo poskytnout REPL MicroPythonu. Poté můžete spouštět příkazy jako:

MicroPython v1.26.0-preview on 2025-08-01; minimal with unknown-cpu
>>> def sum(n, m):
...     return n + m
...
>>> 3, 4, sum(3, 4)
(3, 4, 7)
>>>

K ukončení použijte Ctrl-D a poté spuštěním reset resetujte terminál.

Přidání modulu do portu¶

Chcete-li přidat vlastní modul jako myport, nejprve přidejte definici modulu do souboru modmyport.c:

#include "py/runtime.h"

static mp_obj_t myport_info(void) {
    mp_printf(&mp_plat_print, "info about my port\n");
    return mp_const_none;
}
static MP_DEFINE_CONST_FUN_OBJ_0(myport_info_obj, myport_info);

static const mp_rom_map_elem_t myport_module_globals_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR_myport) },
    { MP_ROM_QSTR(MP_QSTR_info), MP_ROM_PTR(&myport_info_obj) },
};
static MP_DEFINE_CONST_DICT(myport_module_globals, myport_module_globals_table);

const mp_obj_module_t myport_module = {
    .base = { &mp_type_module },
    .globals = (mp_obj_dict_t *)&myport_module_globals,
};

MP_REGISTER_MODULE(MP_QSTR_myport, myport_module);

Budete také muset upravit Makefile, abyste přidali modmyport.c do seznamu SRC_C a nový řádek přidávající stejný soubor do SRC_QSTR (aby se v tomto novém souboru vyhledávaly qstr), takto:

SRC_C = \
    main.c \
    modmyport.c \
    mphalport.c \
    ...

SRC_QSTR += modmyport.c

Pokud vše proběhlo správně, měli byste být po opětovném sestavení schopni importovat nový modul:

>>> import myport
>>> myport.info()
info about my port
>>>