First working CircuitPython port

Author: ccattuto

advanced/circuitpython/README.md

@@ -0,0 +1 @@
+Subproject commit 376e3ba1da34d65682ca78e52193d18102d1749d

advanced/circuitpython/circuitpython

@@ -0,0 +1,113 @@
+TOP = ../circuitpython
+
+BOARD ?= riscv-emu.py
+PORT_DIR := $(CURDIR)
+BUILD ?= $(PORT_DIR)/build-$(BOARD)
+
+include circuitpy_mkenv.mk
+
+CROSS_COMPILE = /opt/riscv/bin/riscv32-unknown-elf-
+
+INC += \
+        -I. \
+        -I../.. \
+        -I../lib/mp-readline \
+        -I../shared/runtime \
+		-I$(TOP) \
+        -Iboards/$(BOARD) \
+        -Iboards/ \
+        -I$(BUILD)
+
+CFLAGS += -Os
+
+DISABLE_WARNINGS = -Wno-cast-align
+CFLAGS += $(INC) -Wall -Werror -std=gnu11 -fshort-enums $(BASE_CFLAGS) $(CFLAGS_MOD) $(COPT) $(DISABLE_WARNINGS) -Werror=missing-prototypes
+
+CFLAGS += \
+	-march=rv32i_zicsr \
+	-mabi=ilp32 \
+	-D_REENT_SMALL \
+	-nostartfiles \
+	-static \
+	--specs=nano.specs
+
+CFLAGS += -DCIRCUITPY_CONSOLE_UART_RX -DCIRCUITPY_CONSOLE_UART_TX
+# Use toolchain libm if we're not using our own.
+ifndef INTERNAL_LIBM
+LIBS += -lm
+endif
+
+LIBS += -lc
+
+SRC_C += \
+	boards/$(BOARD)/board.c \
+	boards/$(BOARD)/pins.c \
+	background.c \
+	mphalport.c \
+	gccollect.c
+
+SRC_ASM = start.S gchelper_rv32i.S trap_handler.S
+
+SRC_COMMON_HAL_EXPANDED = $(addprefix shared-bindings/, $(SRC_COMMON_HAL)) \
+                          $(addprefix shared-bindings/, $(SRC_BINDINGS_ENUMS)) \
+                          $(addprefix common-hal/, $(SRC_COMMON_HAL))
+
+SRC_SHARED_MODULE_EXPANDED = $(addprefix shared-bindings/, $(SRC_SHARED_MODULE)) \
+                             $(addprefix shared-module/, $(SRC_SHARED_MODULE)) \
+                             $(addprefix shared-module/, $(SRC_SHARED_MODULE_INTERNAL))
+
+# There may be duplicates between SRC_COMMON_HAL_EXPANDED and SRC_SHARED_MODULE_EXPANDED,
+# because a few modules have files both in common-hal/ and shared-module/.
+# Doing a $(sort ...) removes duplicates as part of sorting.
+SRC_COMMON_HAL_SHARED_MODULE_EXPANDED = $(sort $(SRC_COMMON_HAL_EXPANDED) $(SRC_SHARED_MODULE_EXPANDED))
+
+SRC_S = # supervisor/riscvpy_cpu.s
+
+OBJ = $(PY_O) $(SUPERVISOR_O) $(addprefix $(BUILD)/, $(SRC_C:.c=.o))
+OBJ += $(addprefix $(BUILD)/, $(SRC_COMMON_HAL_SHARED_MODULE_EXPANDED:.c=.o))
+ifeq ($(INTERNAL_LIBM),1)
+OBJ += $(addprefix $(BUILD)/, $(SRC_LIBM:.c=.o))
+endif
+OBJ += $(addprefix $(BUILD)/, $(SRC_CIRCUITPY_COMMON:.c=.o))
+OBJ += $(addprefix $(BUILD)/, $(SRC_S:.s=.o))
+OBJ += $(addprefix $(BUILD)/, $(SRC_S_UPPER:.S=.o))
+OBJ += $(addprefix $(BUILD)/, $(SRC_MOD:.c=.o))
+OBJ += $(addprefix $(BUILD)/, $(SRC_ASM:.S=.o))
+
+$(BUILD)/%.o: %.S
+	$(STEPECHO) "AS $<"
+	$(Q)$(CC) $(CFLAGS) -c -o $@ $<
+
+SRC_QSTR += $(SRC_C) $(SRC_SUPERVISOR) $(SRC_COMMON_HAL_EXPANDED) $(SRC_SHARED_MODULE_EXPANDED) $(SRC_CIRCUITPY_COMMON)
+
+all: $(BUILD)/firmware.elf $(BUILD)/circuitpy.img
+
+BOARD_LD := $(wildcard boards/$(BOARD)/link.ld)
+
+ifneq ($(BOARD_LD),)
+	LINKER_SCRIPTS = -Wl,-T,$(BOARD_LD)
+endif
+
+LINKER_SCRIPTS += -Wl,-T,link.ld
+
+$(BUILD)/circuitpy.img: circuitpy/code.py
+	$(STEPECHO) "Create $@"
+	$(Q)dd if=/dev/zero of=$(BUILD)/circuitpy.img bs=1 count=0 seek=512K
+	/opt/homebrew/sbin/mkfs.fat -n CIRCUITPY --offset=0 $(BUILD)/circuitpy.img
+	$(Q)mcopy -i $(BUILD)/circuitpy.img circuitpy/* ::
+
+ifeq ($(VALID_BOARD),)
+$(BUILD)/firmware.elf: invalid-board
+else
+$(BUILD)/firmware.elf: $(OBJ) $(BOARD_LD) link.ld
+	$(STEPECHO) "LINK $@"
+	$(Q)echo $(OBJ) > $(BUILD)/firmware.objs
+	$(Q)echo $(PICO_LDFLAGS) > $(BUILD)/firmware.ldflags
+	$(Q)$(CC) -o $@ $(CFLAGS) @$(BUILD)/firmware.ldflags $(LINKER_SCRIPTS) -Wl,--print-memory-usage -Wl,-Map=$@.map -Wl,-cref -Wl,--gc-sections @$(BUILD)/firmware.objs -Wl,-lc
+endif
+
+$(BUILD)/firmware.bin: $(BUILD)/firmware.elf
+	$(STEPECHO) "Create $@"
+	$(Q)$(OBJCOPY) -O binary -R .dtcm_bss $^ $@
+
+include $(TOP)/py/mkrules.mk

advanced/circuitpython/riscv-emu.py/Makefile

@@ -0,0 +1,19 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2021 Scott Shawcroft for Adafruit Industries
+//
+// SPDX-License-Identifier: MIT
+
+#include "supervisor/port.h"
+
+void port_start_background_tick(void) {
+}
+
+void port_finish_background_tick(void) {
+}
+
+void port_background_tick(void) {
+}
+
+void port_background_task(void) {
+}

advanced/circuitpython/riscv-emu.py/background.c

@@ -0,0 +1,49 @@
+#include "supervisor/board.h"
+
+#include "common-hal/busio/UART.h"
+#include "shared-bindings/busio/UART.h"
+#include "supervisor/shared/serial.h"
+#include "supervisor/background_callback.h"
+#include "shared/runtime/interrupt_char.h"
+#include "py/mphal.h"
+#include "py/runtime.h"
+#include "supervisor/internal_flash.h"
+
+#include "riscv-py.h"
+
+extern busio_uart_obj_t console_uart;
+extern void setup_timer_interrupt(void);
+void kbd_interrupt_background_task(void *data);
+background_callback_t kbd_interrupt_background_cb;
+
+static uint32_t counter = 0;
+
+void kbd_interrupt_background_task(void *data) {
+	unsigned char c;
+
+	if ((++counter & 0xFF) == 0) {
+    	if (common_hal_busio_uart_rx_characters_available(&console_uart)) {
+        	common_hal_busio_uart_read(&console_uart, &c, 1, NULL);
+        	if ((c == mp_interrupt_char) && !mp_hal_is_interrupted()) {
+            	mp_sched_keyboard_interrupt();
+    			mp_handle_pending(true);
+        	}
+    	}
+   	}
+ 
+	background_callback_add_core(&kbd_interrupt_background_cb);
+}       
+
+void board_init(void) {
+    //mp_hal_set_interrupt_char(0x03);
+	kbd_interrupt_background_cb.fun = &kbd_interrupt_background_task;
+	kbd_interrupt_background_cb.data = NULL;
+	background_callback_add_core(&kbd_interrupt_background_cb);
+	setup_timer_interrupt();
+}
+
+void board_serial_write_substring(const char *text, uint32_t len) {
+    int errcode;
+    common_hal_busio_uart_write(&console_uart, (const uint8_t *)text, len, &errcode);
+}
+

advanced/circuitpython/riscv-emu.py/boards/riscv-emu.py/board.c

@@ -0,0 +1,5 @@
+#pragma once
+
+#define MICROPY_HW_BOARD_NAME       "riscv-emu.py"
+#define MICROPY_HW_MCU_NAME         "riscv-emu.py"
+

advanced/circuitpython/riscv-emu.py/boards/riscv-emu.py/mpconfigboard.h

@@ -0,0 +1,12 @@
+#include "shared-bindings/board/__init__.h"
+    
+static const mp_rom_map_elem_t board_module_globals_table[] = {
+    CIRCUITPYTHON_BOARD_DICT_STANDARD_ITEMS
+};
+
+MP_DEFINE_CONST_DICT(board_module_globals, board_module_globals_table);
+
+const mp_obj_dict_t mcu_pin_globals = {
+    // Pin definitions (must exist)
+};
+

advanced/circuitpython/riscv-emu.py/boards/riscv-emu.py/mpconfigboard.mk

@@ -0,0 +1,2 @@
+print("Hello from RISC-V CircuitPython!")
+

advanced/circuitpython/riscv-emu.py/boards/riscv-emu.py/pins.c

@@ -0,0 +1,66 @@
+# This file is part of the MicroPython project, http://micropython.org/
+#
+# The MIT License (MIT)
+#
+# SPDX-FileCopyrightText: Copyright (c) 2022 MicroDev
+#
+# 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.
+
+TOP := ../circuitpython
+
+# Common Makefile items that can be shared across CircuitPython ports.
+
+ALL_BOARDS_IN_PORT := $(patsubst boards/%/mpconfigboard.mk,%,$(wildcard boards/*/mpconfigboard.mk))
+# An incorrect BOARD might have been specified, so check against the list.
+# There is deliberately no space after the :=
+VALID_BOARD :=$(filter $(BOARD),$(ALL_BOARDS_IN_PORT))
+
+# If the flash PORT is not given, use the default /dev/tty.SLAB_USBtoUART.
+PORT ?= /dev/tty.SLAB_USBtoUART
+
+# If the build directory is not given, make it reflect the board name.
+BUILD ?= build-$(BOARD)
+
+# First makefile with targets. Defines the default target.
+include $(TOP)/py/mkenv.mk
+
+# Board-specific. Skip if the rule requested is not board-specific.
+ifneq ($(VALID_BOARD),)
+include boards/$(BOARD)/mpconfigboard.mk
+endif
+
+# Port-specific
+include mpconfigport.mk
+
+# Also board-specific. Skip if the rule requested is not board-specific.
+ifneq ($(VALID_BOARD),)
+# CircuitPython-specific
+include $(TOP)/py/circuitpy_mpconfig.mk
+endif
+
+# qstr definitions (must come before including py.mk)
+QSTR_DEFS = qstrdefsport.h
+
+# include py core make definitions
+include $(TOP)/py/py.mk
+
+include $(TOP)/supervisor/supervisor.mk
+
+# Include make rules and variables common across CircuitPython builds.
+include $(TOP)/py/circuitpy_defns.mk