Skip to content

freebsd: Document how to build UEFI app on FreeBSD#52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
JohnAZoidberg wants to merge 2 commits into
base:main
Choose a base branch
from
Draft

freebsd: Document how to build UEFI app on FreeBSD #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4892be
freebsd: Document how to build on FreeBSD
JohnAZoidberg Aug 6, 2024
6fba9fa
freebsd: Build UEFI QEMU image
JohnAZoidberg Aug 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,8 @@ cargo build -p framework_tool
ls -l target/debug/framework_tool

# Build the UEFI application
# Needs mtools installed via your OS package manager
# See in FreeBSD section for building on FreeBSD
# Can't be built with cargo! That's why we need to exclude it in the other commands.
make -C framework_uefi
ls -l framework_uefi/build/x86_64-unknown-uefi/boot.efi
Expand DownExpand Up@@ -311,3 +313,14 @@ cargo build --no-default-features --features freebsd
# Running the tool
cargo run --no-default-features --features freebsd
```

Build UEFI tool

```
# Build just tool
gmake -C framework_uefi build/x86_64-unknown-uefi/boot.efi

# Build QEMU image
# TODO: Does not work yet, need a replacement for GNU parted

@JohnAZoidbergJohnAZoidbergAug 6, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aokblast is there a scripted way to format a disk image on FreeBSD?
On Linux I used GNU parted.

@aokblastaokblastAug 6, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello, we have gpart which is the abbriviate of geom part that enable you to create and add partition. I found a post on stack exchange that have examples about this. Do I answer your question?

@aokblastaokblastAug 6, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, you are talking about image. We have mkimg which can be used as following pattern (stolen from my previous commit :) )

cfgdirname=$(mktemp -d /tmp/config.XXXXX)
cp ${BASEBITSDIR}/etc/bsdinstall.example ${cfgdirname}
makefs -D -B little -t msdos -o fat_type=16 -o volume_label=CONFIG -o create_size=16m ${2}.config ${cfgdirname}
mkimg -s mbr \
-b ${BASEBITSDIR}/boot/mbr \
-p efi:=${espfilename} \
-p freebsd:-"mkimg -s bsd -b ${BASEBITSDIR}/boot/boot -p freebsd-ufs:=${2}.part" \
-p fat16b:=${2}.config\

@JohnAZoidbergJohnAZoidbergAug 7, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh! That's cool. That looks super easy!

@JohnAZoidbergJohnAZoidbergAug 7, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't tried, but might be as simple as this:

$(BUILD)/boot.img: $(BUILD)/boot.efi
mkimg -s gpt \
-p efi:=$<

But how can I use different make rules on FreeBSD 🤔

@aokblastaokblastAug 7, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the make rules you mentioned? Could you give me some detailed example?

@aokblastaokblastAug 7, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, I forget some code segment. You have to create a partition image by mkfs than put file into it by directory. After that, you can use mkimg to create a full disk image. Here is a patch use this feature. You can take a release/amd64/make-memstick.sh as example. Hope I answered your question.

@JohnAZoidbergJohnAZoidbergAug 9, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done! Now we just need to make sure it uses different commands on linux vs bsd

gmake -C framework_uefi MKFS=newfs_msdos
```
32 changes: 13 additions & 19 deletions framework_uefi/Makefile
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,42 +3,36 @@ BUILD=build/$(TARGET)

SRC_DIR=.

# sudo pkg install qemu edk2-qemu-x64
QEMU?=qemu-system-x86_64
OVMF_FD?=/usr/local/share/edk2-qemu/QEMU_UEFI-x86_64.fd
QEMU_FLAGS=\
-M q35 \
-m 1024 \
-net none \
-vga std \
-bios /usr/share/OVMF/OVMF_CODE.fd
-bios /usr/local/share/edk2-qemu/QEMU_UEFI-x86_64.fd

.PHONY: qemu clean

all: $(BUILD)/boot.img

$(BUILD)/boot.img: $(BUILD)/boot.efi
mkdir -p temp/EFI/BOOT
cp $(BUILD)/boot.efi temp/EFI/BOOT/bootx64.efi
makefs -t msdos \
-o fat_type=16 \
-o sectors_per_cluster=1 \
-s 10000k \
$(BUILD)/boot.img temp
rm -rf temp

clean:
rm -r $(BUILD)

qemu: $(BUILD)/boot.img
$(QEMU) $(QEMU_FLAGS) $<

# Create ESP partition and filesystem
$(BUILD)/boot.img: $(BUILD)/efi.img
dd if=/dev/zero of=$@.tmp bs=512 count=100352
parted $@.tmp -s -a minimal mklabel gpt
parted $@.tmp -s -a minimal mkpart EFI FAT16 2048s 93716s
parted $@.tmp -s -a minimal toggle 1 boot
dd if=$< of=$@.tmp bs=512 count=98304 seek=2048 conv=notrunc
mv $@.tmp $@

# Create filesystem with updater (bootx64.efi)
$(BUILD)/efi.img: $(BUILD)/boot.efi
dd if=/dev/zero of=$@.tmp bs=512 count=98304
mkfs.vfat $@.tmp
mmd -i $@.tmp efi
mmd -i $@.tmp efi/boot
mcopy -i $@.tmp $< ::efi/boot/bootx64.efi
mv $@.tmp $@

$(BUILD)/boot.efi: ../Cargo.lock $(SRC_DIR)/Cargo.toml $(SRC_DIR)/src/*
mkdir -p $(BUILD)
cargo rustc \
Expand Down