Skip to content

Commit

Permalink
[Core] RISC-V toolchain and picolibc fixes (#15109)
Browse files Browse the repository at this point in the history
* [Core] Fix RISC-V toolchain installation

The risc-v toolchain is only available on distributions based on Debian 11+
so we check for their availability before installing them.

* [Core] Fix heap symbols and syscalls for picolibc

picolibc internally uses __heap_start and __heap_end instead of the
defacto chibios linker script standard __heap_base__ and __heap_end__
therefore we introduce these symbols as an alias. Usually all memory
used within QMK is statically allocated, but some algorithms make usage
of malloc and friends.

Also the timeval struct is not defined by picolibc for syscalls, therefore it
is declared as stub.
  • Loading branch information
KarlK90 authored Nov 20, 2021
1 parent 32215d5 commit 5c2052f
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 12 deletions.
19 changes: 11 additions & 8 deletions platforms/chibios/platform.mk
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ endif
#

# Use defined stack sizes of the main thread in linker scripts
LDSYMBOLS =--defsym=__process_stack_size__=$(USE_PROCESS_STACKSIZE),--defsym=__main_stack_size__=$(USE_EXCEPTIONS_STACKSIZE)
SHARED_LDSYMBOLS = -Wl,--defsym=__process_stack_size__=$(USE_PROCESS_STACKSIZE),--defsym=__main_stack_size__=$(USE_EXCEPTIONS_STACKSIZE)

# Shared Compiler flags for all toolchains
SHARED_CFLAGS = -fomit-frame-pointer \
Expand All @@ -327,7 +327,6 @@ SHARED_CFLAGS = -fomit-frame-pointer \

# Shared Linker flags for all toolchains
SHARED_LDFLAGS = -T $(LDSCRIPT) \
-Wl,$(LDSYMBOLS) \
-Wl,--gc-sections \
-nostartfiles

Expand All @@ -346,14 +345,18 @@ ifeq ($(strip $(MCU)), risc-v)
endif
endif

# Default to compiling with picolibc for RISC-V targets if available,
# which is available by default on current (bullseye) debian based systems.
# Default to compiling with picolibc for RISC-V targets if available, which
# is available by default on distributions based on Debian 11+.
ifeq ($(shell $(TOOLCHAIN)gcc --specs=picolibc.specs -E - 2>/dev/null >/dev/null </dev/null ; echo $$?),0)
# Toolchain specific Compiler flags
# Note that we still link with our own linker script
# by providing it via the -T flag above.
# Toolchain specific Compiler flags Note that we still link with our own
# linker script by providing it via the -T flag in SHARED_LDFLAGS.
TOOLCHAIN_CFLAGS = --specs=picolibc.specs

# picolibc internally uses __heap_start and __heap_end instead of the
# defacto chibios linker script standard __heap_base__ and __heap_end__
# therefore we introduce these symbols as an alias.
TOOLCHAIN_LDSYMBOLS = -Wl,--defsym=__heap_start=__heap_base__,--defsym=__heap_end=__heap_end__

# Tell QMK that we are compiling with picolibc.
OPT_DEFS += -DUSE_PICOLIBC
endif
Expand Down Expand Up @@ -404,7 +407,7 @@ CFLAGS += $(SHARED_CFLAGS) $(TOOLCHAIN_CFLAGS)
CXXFLAGS += $(CFLAGS) $(SHARED_CXXFLAGS) $(TOOLCHAIN_CXXFLAGS) -fno-rtti

# Linker flags
LDFLAGS += $(SHARED_LDFLAGS) $(TOOLCHAIN_LDFLAGS) $(MCUFLAGS)
LDFLAGS += $(SHARED_LDFLAGS) $(SHARED_LDSYMBOLS) $(TOOLCHAIN_LDFLAGS) $(TOOLCHAIN_LDSYMBOLS) $(MCUFLAGS)

# Tell QMK that we are hosting it on ChibiOS.
OPT_DEFS += -DPROTOCOL_CHIBIOS
Expand Down
1 change: 1 addition & 0 deletions platforms/chibios/syscall-fallbacks.c
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
* the _reent struct has to be defined. */
#if defined(USE_PICOLIBC)
struct _reent;
struct timeval;
#endif

#pragma GCC diagnostic ignored "-Wmissing-prototypes"
Expand Down
14 changes: 10 additions & 4 deletions util/install/debian.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,18 @@ _qmk_install_prepare() {
_qmk_install() {
echo "Installing dependencies"

sudo apt-get -yq install \
sudo apt-get --quiet --yes install \
build-essential clang-format diffutils gcc git unzip wget zip \
python3-pip binutils-avr gcc-avr avr-libc binutils-arm-none-eabi \
gcc-arm-none-eabi libnewlib-arm-none-eabi avrdude dfu-programmer \
dfu-util teensy-loader-cli libhidapi-hidraw0 libusb-dev \
picolibc-riscv64-unknown-elf gcc-riscv64-unknown-elf binutils-riscv64-unknown-elf
dfu-util teensy-loader-cli libhidapi-hidraw0 libusb-dev

python3 -m pip install --user -r $QMK_FIRMWARE_DIR/requirements.txt
# RISC-V toolchains with picolibc support are only available for distributions based on Debian 11+.
if sudo apt-get install --simulate --quiet --yes picolibc-riscv64-unknown-elf gcc-riscv64-unknown-elf binutils-riscv64-unknown-elf > /dev/null 2>&1; then
sudo apt-get --quiet --yes install picolibc-riscv64-unknown-elf \
gcc-riscv64-unknown-elf \
binutils-riscv64-unknown-elf
fi

python3 -m pip install --user -r "$QMK_FIRMWARE_DIR"/requirements.txt
}

0 comments on commit 5c2052f

Please sign in to comment.