mirror of
https://github.com/rust-embedded/rust-raspberrypi-OS-tutorials.git
synced 2024-11-11 07:10:59 +00:00
218 lines
8.0 KiB
Makefile
218 lines
8.0 KiB
Makefile
## SPDX-License-Identifier: MIT OR Apache-2.0
|
|
##
|
|
## Copyright (c) 2018-2022 Andre Richter <andre.o.richter@gmail.com>
|
|
|
|
include ../common/color.mk
|
|
include ../common/docker.mk
|
|
|
|
##--------------------------------------------------------------------------------------------------
|
|
## Optional, user-provided configuration values
|
|
##--------------------------------------------------------------------------------------------------
|
|
|
|
# Default to the RPi3.
|
|
BSP ?= rpi3
|
|
|
|
# Default to a serial device name that is common in Linux.
|
|
DEV_SERIAL ?= /dev/ttyUSB0
|
|
|
|
|
|
|
|
##--------------------------------------------------------------------------------------------------
|
|
## Hardcoded configuration values
|
|
##--------------------------------------------------------------------------------------------------
|
|
|
|
# BSP-specific arguments.
|
|
ifeq ($(BSP),rpi3)
|
|
TARGET = aarch64-unknown-none-softfloat
|
|
KERNEL_BIN = kernel8.img
|
|
QEMU_BINARY = qemu-system-aarch64
|
|
QEMU_MACHINE_TYPE = raspi3
|
|
QEMU_RELEASE_ARGS = -serial stdio -display none
|
|
OBJDUMP_BINARY = aarch64-none-elf-objdump
|
|
NM_BINARY = aarch64-none-elf-nm
|
|
READELF_BINARY = aarch64-none-elf-readelf
|
|
LINKER_FILE = src/bsp/raspberrypi/link.ld
|
|
RUSTC_MISC_ARGS = -C target-cpu=cortex-a53
|
|
else ifeq ($(BSP),rpi4)
|
|
TARGET = aarch64-unknown-none-softfloat
|
|
KERNEL_BIN = kernel8.img
|
|
QEMU_BINARY = qemu-system-aarch64
|
|
QEMU_MACHINE_TYPE =
|
|
QEMU_RELEASE_ARGS = -serial stdio -display none
|
|
OBJDUMP_BINARY = aarch64-none-elf-objdump
|
|
NM_BINARY = aarch64-none-elf-nm
|
|
READELF_BINARY = aarch64-none-elf-readelf
|
|
LINKER_FILE = src/bsp/raspberrypi/link.ld
|
|
RUSTC_MISC_ARGS = -C target-cpu=cortex-a72
|
|
endif
|
|
|
|
QEMU_MISSING_STRING = "This board is not yet supported for QEMU."
|
|
|
|
# Export for build.rs.
|
|
export LINKER_FILE
|
|
|
|
KERNEL_ELF = target/$(TARGET)/release/kernel
|
|
|
|
|
|
|
|
##--------------------------------------------------------------------------------------------------
|
|
## Command building blocks
|
|
##--------------------------------------------------------------------------------------------------
|
|
RUSTFLAGS = -C link-arg=-T$(LINKER_FILE) $(RUSTC_MISC_ARGS)
|
|
RUSTFLAGS_PEDANTIC = $(RUSTFLAGS) -D warnings -D missing_docs
|
|
|
|
FEATURES = --features bsp_$(BSP)
|
|
COMPILER_ARGS = --target=$(TARGET) \
|
|
$(FEATURES) \
|
|
--release
|
|
|
|
RUSTC_CMD = cargo rustc $(COMPILER_ARGS)
|
|
DOC_CMD = cargo doc $(COMPILER_ARGS)
|
|
CLIPPY_CMD = cargo clippy $(COMPILER_ARGS)
|
|
CHECK_CMD = cargo check $(COMPILER_ARGS)
|
|
OBJCOPY_CMD = rust-objcopy \
|
|
--strip-all \
|
|
-O binary
|
|
|
|
EXEC_QEMU = $(QEMU_BINARY) -M $(QEMU_MACHINE_TYPE)
|
|
EXEC_TEST_DISPATCH = ruby ../common/tests/dispatch.rb
|
|
EXEC_MINITERM = ruby ../common/serial/miniterm.rb
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Dockerization
|
|
##------------------------------------------------------------------------------
|
|
DOCKER_CMD = docker run -t --rm -v $(shell pwd):/work/tutorial -w /work/tutorial
|
|
DOCKER_CMD_INTERACT = $(DOCKER_CMD) -i
|
|
DOCKER_ARG_DIR_COMMON = -v $(shell pwd)/../common:/work/common
|
|
DOCKER_ARG_DEV = --privileged -v /dev:/dev
|
|
|
|
# DOCKER_IMAGE defined in include file (see top of this file).
|
|
DOCKER_QEMU = $(DOCKER_CMD_INTERACT) $(DOCKER_IMAGE)
|
|
DOCKER_TOOLS = $(DOCKER_CMD) $(DOCKER_IMAGE)
|
|
DOCKER_TEST = $(DOCKER_CMD) $(DOCKER_ARG_DIR_COMMON) $(DOCKER_IMAGE)
|
|
|
|
# Dockerize commands, which require USB device passthrough, only on Linux.
|
|
ifeq ($(shell uname -s),Linux)
|
|
DOCKER_CMD_DEV = $(DOCKER_CMD_INTERACT) $(DOCKER_ARG_DEV)
|
|
|
|
DOCKER_MINITERM = $(DOCKER_CMD_DEV) $(DOCKER_ARG_DIR_COMMON) $(DOCKER_IMAGE)
|
|
endif
|
|
|
|
|
|
|
|
##--------------------------------------------------------------------------------------------------
|
|
## Targets
|
|
##--------------------------------------------------------------------------------------------------
|
|
.PHONY: all $(KERNEL_ELF) $(KERNEL_BIN) doc qemu miniterm clippy clean readelf objdump nm check
|
|
|
|
all: $(KERNEL_BIN)
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Build the kernel ELF
|
|
##------------------------------------------------------------------------------
|
|
$(KERNEL_ELF):
|
|
$(call colorecho, "\nCompiling kernel - $(BSP)")
|
|
@RUSTFLAGS="$(RUSTFLAGS_PEDANTIC)" $(RUSTC_CMD)
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Build the stripped kernel binary
|
|
##------------------------------------------------------------------------------
|
|
$(KERNEL_BIN): $(KERNEL_ELF)
|
|
@$(OBJCOPY_CMD) $(KERNEL_ELF) $(KERNEL_BIN)
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Build the documentation
|
|
##------------------------------------------------------------------------------
|
|
doc:
|
|
$(call colorecho, "\nGenerating docs")
|
|
@$(DOC_CMD) --document-private-items --open
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Run the kernel in QEMU
|
|
##------------------------------------------------------------------------------
|
|
ifeq ($(QEMU_MACHINE_TYPE),) # QEMU is not supported for the board.
|
|
|
|
qemu:
|
|
$(call colorecho, "\n$(QEMU_MISSING_STRING)")
|
|
|
|
else # QEMU is supported.
|
|
|
|
qemu: $(KERNEL_BIN)
|
|
$(call colorecho, "\nLaunching QEMU")
|
|
@$(DOCKER_QEMU) $(EXEC_QEMU) $(QEMU_RELEASE_ARGS) -kernel $(KERNEL_BIN)
|
|
endif
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Connect to the target's serial
|
|
##------------------------------------------------------------------------------
|
|
miniterm:
|
|
@$(DOCKER_MINITERM) $(EXEC_MINITERM) $(DEV_SERIAL)
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Run clippy
|
|
##------------------------------------------------------------------------------
|
|
clippy:
|
|
@RUSTFLAGS="$(RUSTFLAGS_PEDANTIC)" $(CLIPPY_CMD)
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Clean
|
|
##------------------------------------------------------------------------------
|
|
clean:
|
|
rm -rf target $(KERNEL_BIN)
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Run readelf
|
|
##------------------------------------------------------------------------------
|
|
readelf: $(KERNEL_ELF)
|
|
$(call colorecho, "\nLaunching readelf")
|
|
@$(DOCKER_TOOLS) $(READELF_BINARY) --headers $(KERNEL_ELF)
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Run objdump
|
|
##------------------------------------------------------------------------------
|
|
objdump: $(KERNEL_ELF)
|
|
$(call colorecho, "\nLaunching objdump")
|
|
@$(DOCKER_TOOLS) $(OBJDUMP_BINARY) --disassemble --demangle \
|
|
--section .text \
|
|
--section .rodata \
|
|
--section .got \
|
|
$(KERNEL_ELF) | rustfilt
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Run nm
|
|
##------------------------------------------------------------------------------
|
|
nm: $(KERNEL_ELF)
|
|
$(call colorecho, "\nLaunching nm")
|
|
@$(DOCKER_TOOLS) $(NM_BINARY) --demangle --print-size $(KERNEL_ELF) | sort | rustfilt
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Helper target for rust-analyzer
|
|
##------------------------------------------------------------------------------
|
|
check:
|
|
@RUSTFLAGS="$(RUSTFLAGS)" $(CHECK_CMD) --message-format=json
|
|
|
|
|
|
|
|
##--------------------------------------------------------------------------------------------------
|
|
## Testing targets
|
|
##--------------------------------------------------------------------------------------------------
|
|
.PHONY: test test_boot
|
|
|
|
ifeq ($(QEMU_MACHINE_TYPE),) # QEMU is not supported for the board.
|
|
|
|
test_boot test :
|
|
$(call colorecho, "\n$(QEMU_MISSING_STRING)")
|
|
|
|
else # QEMU is supported.
|
|
|
|
##------------------------------------------------------------------------------
|
|
## Run boot test
|
|
##------------------------------------------------------------------------------
|
|
test_boot: $(KERNEL_BIN)
|
|
$(call colorecho, "\nBoot test - $(BSP)")
|
|
@$(DOCKER_TEST) $(EXEC_TEST_DISPATCH) $(EXEC_QEMU) $(QEMU_RELEASE_ARGS) -kernel $(KERNEL_BIN)
|
|
|
|
test: test_boot
|
|
|
|
endif
|