lbmk/include/rom.sh

# SPDX-License-Identifier: GPL-3.0-or-later
# Copyright (c) 2014-2016,2020-2021,2023-2025 Leah Rowe <leah@libreboot.org>
# Copyright (c) 2021-2022 Ferass El Hafidi <vitali64pmemail@protonmail.com>
# Copyright (c) 2022 Caleb La Grange <thonkpeasant@protonmail.com>
# Copyright (c) 2022-2023 Alper Nebi Yasak <alpernebiyasak@gmail.com>
# Copyright (c) 2023-2024 Riku Viitanen <riku.viitanen@protonmail.com>

grubdata="config/data/grub"

buildser()
{
	[ "$1" = "pico" ] && x_ cmake -DPICO_BOARD="$2" \
	    -DPICO_SDK_PATH="$picosdk" -B "$sersrc/build" "$sersrc" && \
	    x_ cmake --build "$sersrc/build"
	[ "$1" = "stm32" ] && x_ make -C "$sersrc" libopencm3-just-make \
	    BOARD=$2 && x_ make -C "$sersrc" BOARD=$2
	x_ mkdir -p "bin/serprog_$1"
	x_ mv "$serx" "bin/serprog_$1/serprog_$2.${serx##*.}"
}

copyps1bios()
{
	[ "$dry" = ":" ] && return 0; :

	remkdir "bin/playstation"
	x_ cp src/pcsx-redux/src/mips/openbios/openbios.bin bin/playstation

	printf "MIT License\n\nCopyright (c) 2019-2025 PCSX-Redux authors\n\n" \
	    > bin/playstation/COPYING.txt || err "!pcsx-redux copyright"
	cat config/snippet/mit >>bin/playstation/COPYING.txt || err "!pcsx MIT"
}

mkpayload_grub()
{
	eval "`setvars "" grub_modules grub_install_modules`"
	$dry eval "`setcfg "$grubdata/module/$tree"`"
	$dry x_ rm -f "$srcdir/grub.elf"; $dry \
	x_ "$srcdir/grub-mkstandalone" --grub-mkimage="$srcdir/grub-mkimage" \
	    -O i386-coreboot -o "$srcdir/grub.elf" -d "${srcdir}/grub-core/" \
	    --fonts= --themes= --locales=  --modules="$grub_modules" \
	    --install-modules="$grub_install_modules" \
	    "/boot/grub/grub_default.cfg=${srcdir}/.config" \
	    "/boot/grub/grub.cfg=$grubdata/memdisk.cfg"; :
}

corebootpremake()
{
	[ "$XBMK_RELEASE" = "y" ] && [ "$release" = "n" ] && return 0; :

	[ -n "$mode" ] || [ ! -f "$srcdir/.config" ] || $dry printf \
	    "CONFIG_CCACHE=y\n" >> "$srcdir/.config" || err "$srcdir: !cook"; :
	fx_ check_coreboot_util printf "cbfstool\nifdtool\n"
	printf "%s\n" "${version%%-*}" > "$srcdir/.coreboot-version" || \
	    err "!mk $srcdir .coreboot-version"
	[ -z "$mode" ] && [ "$target" != "$tree" ] && \
	    x_ ./mk download "$target"; :
}

check_coreboot_util()
{
	[ "$badhash" = "y" ] && x_ rm -f "elf/coreboot/$tree/$1"
	e "elf/coreboot/$tree/$1" f && return 0

	utilelfdir="elf/coreboot/$tree"
	utilsrcdir="src/coreboot/$tree/util/$1"

	utilmode="" && [ -n "$mode" ] && utilmode="clean"
	x_ make -C "$utilsrcdir" $utilmode -j$XBMK_THREADS $makeargs
	[ -n "$mode" ] && x_ rm -Rf "$utilelfdir" && return 0
	[ -z "$mode" ] || return 0
	[ -f "$utilelfdir/$1" ] && return 0

	x_ mkdir -p "$utilelfdir"
	x_ cp "$utilsrcdir/$1" "$utilelfdir"
	[ "$1" = "cbfstool" ] || return 0
	x_ cp "$utilsrcdir/rmodtool" "$utilelfdir"
}

coreboot_pad_one_byte()
{
	[ "$XBMK_RELEASE" = "y" ] && [ "$release" = "n" ] && return 0; :
	$dry pad_one_byte "$srcdir/build/coreboot.rom"
}

mkcorebootbin()
{
	[ "$XBMK_RELEASE" = "y" ] && [ "$release" = "n" ] && return 0; :

	$dry fx_ check_coreboot_util printf "cbfstool\nifdtool\n"

	for y in "$target_dir/config"/*; do
		defconfig="$y"
		mkcorebootbin_real
	done

	mkcoreboottar
}

mkcorebootbin_real()
{
	[ "$target" = "$tree" ] && return 0

	tmprom="$xbtmp/coreboot.rom"

	initmode="${defconfig##*/}"
	displaymode="${initmode##*_}"
	[ "$displaymode" = "$initmode" ] && displaymode="" # "normal" config
	initmode="${initmode%%_*}"
	cbfstool="elf/coreboot/$tree/cbfstool"

	elfrom="elf/coreboot/$tree/$target/$initmode"
	[ -n "$displaymode" ] && elfrom="${elfrom}_$displaymode"
	elfrom="$elfrom/coreboot.rom"

	$dry x_ cp "$elfrom" "$tmprom"
	$dry unpad_one_byte "$tmprom"

	[ -z "$payload_uboot" ] || [ "$payload_uboot" = "amd64" ] || \
	    [ "$payload_uboot" = "i386" ] || [ "$payload_uboot" = "arm64" ] \
		|| err "'$target' defines bad u-boot type '$payload_uboot'"

	[ -z "$payload_uboot" ] || [ "$payload_uboot" = "arm64" ] || \
		payload_seabios="y"

	[ -n "$uboot_config" ] || uboot_config="default"
	[ "$payload_grub" = "y" ] && payload_seabios="y"
	[ "$payload_seabios" = "y" ] && [ "$payload_uboot" = "arm64" ] && \
	    $dry err "$target: U-Boot(arm64) and SeaBIOS/GRUB both enabled."

	[ -z "$grub_scan_disk" ] && grub_scan_disk="nvme ahci ata"

	[ -n "$grubtree" ] || grubtree="default"
	grubelf="elf/grub/$grubtree/$grubtree/payload/grub.elf"

	[ "$payload_memtest" = "y" ] || payload_memtest="n"
	[ "$(uname -m)" = "x86_64" ] || payload_memtest="n"

	[ "$payload_grubsea" = "y" ] && [ "$initmode" = "normal" ] && \
	    payload_grubsea="n"
	[ "$payload_grub" = "y" ] || payload_grubsea="n"

	if $dry grep "CONFIG_PAYLOAD_NONE=y" "$defconfig"; then
		[ "$payload_seabios" = "y" ] && pname="seabios" && \
		    $dry add_seabios
		[ "$payload_uboot" = "arm64" ] && pname="uboot" && \
		    $dry add_uboot; :
	else
		pname="custom"
		$dry cprom
	fi; :
}

add_seabios()
{
	[ -z "$payload_uboot" ] || [ "$payload_uboot" = "arm64" ] || \
	    $dry add_uboot

	_seabioself="elf/seabios/default/default/$initmode/bios.bin.elf"
	_seaname="fallback/payload" && [ "$payload_grubsea" = "y" ] && \
	    _seaname="seabios.elf"

	cbfs "$tmprom" "$_seabioself" "$_seaname"
	x_ "$cbfstool" "$tmprom" add-int -i 3000 -n etc/ps2-keyboard-spinup

	_z="2" && [ "$initmode" = "vgarom" ] && _z="0"
	x_ "$cbfstool" "$tmprom" add-int -i $_z -n etc/pci-optionrom-exec
	x_ "$cbfstool" "$tmprom" add-int -i 0 -n etc/optionroms-checksum
	[ "$initmode" = "libgfxinit" ] && \
	    cbfs "$tmprom" "$seavgabiosrom" vgaroms/seavgabios.bin raw

	[ "$payload_memtest" = "y" ] && cbfs "$tmprom" \
	    "elf/memtest86plus/memtest.bin" img/memtest

	[ "$payload_grub" = "y" ] && add_grub

	[ "$payload_grubsea" != "y" ] && cprom
	[ "$payload_uboot" = "amd64" ] && [ "$displaymode" != "txtmode" ] && \
	    [ "$initmode" != "normal" ] && [ "$payload_grubsea" != "y" ] && \
	    pname="seauboot" && cprom "seauboot"
	[ "$payload_grub" = "y" ] && pname="seagrub" && mkseagrub; :
}

add_grub()
{
	_grubname="img/grub2" && [ "$payload_grubsea" = "y" ] && \
	    _grubname="fallback/payload"
	cbfs "$tmprom" "$grubelf" "$_grubname"
	printf "set grub_scan_disk=\"%s\"\n" "$grub_scan_disk" \
	    > "$xbtmp/tmpcfg" || err "$target: !insert scandisk"
	cbfs "$tmprom" "$xbtmp/tmpcfg" scan.cfg raw
	[ "$initmode" != "normal" ] && [ "$displaymode" != "txtmode" ] && \
	    cbfs "$tmprom" "$grubdata/background/background1280x800.png" \
	    "background.png" raw; :
}

mkseagrub()
{
	[ "$payload_grubsea" = "y" ] && pname="grub"
	[ "$payload_grubsea" = "y" ] || \
	    cbfs "$tmprom" "$grubdata/bootorder" bootorder raw
	fx_ cprom x_ find "$grubdata/keymap" -type f -name "*.gkb"
}

add_uboot()
{
	if [ "$displaymode" = "txtmode" ]; then
		printf "cb/%s: Cannot use U-Boot in text mode\n" \
		    "$target" 1>&2
		return 0
	elif [ "$initmode" = "normal" ]; then
		printf "cb/%s: Cannot use U-Boot in normal initmode\n" \
		    "$target" 1>&2
		return 0
	fi

	# TODO: re-work to allow each coreboot target to say which ub tree
	# instead of hardcoding as in the current logic below:

	# aarch64 targets:
	ubcbfsargs=""
	ubpath="fallback/payload"
	ubtree="default"
	ubtarget="$target"
	# override for x86/x86_64 targets:
	if [ -n "$payload_uboot" ] && [ "$payload_uboot" != "arm64" ]; then
		ubcbfsargs="-l 0x1110000 -e 0x1110000" # 64-bit and 32-bit
			# on 64-bit, 0x1120000 is the SPL, and stub before that
		ubpath="img/u-boot" # 64-bit
		ubtree="x86_64"
		ubtarget="amd64coreboot"
		[ "$payload_uboot" = "i386" ] && ubpath="u-boot" # 32-bit
		[ "$payload_uboot" = "i386" ] && ubtree="x86"
		[ "$payload_uboot" = "i386" ] && ubtarget="i386coreboot"; :
	fi

	ubdir="elf/u-boot/$ubtree/$ubtarget/$uboot_config"

	# aarch64 targets:
	ubootelf="$ubdir/u-boot.elf" && [ ! -f "$ubootelf" ] && \
	    ubootelf="$ubdir/u-boot"
	# override for x86/x86_64 targets:
	[ "$payload_uboot" = "i386" ] && ubootelf="$ubdir/u-boot-dtb.bin"
	[ "$payload_uboot" = "amd64" ] && \
	    ubootelf="$ubdir/u-boot-x86-with-spl.bin" # EFI-compatible

	cbfs "$tmprom" "$ubootelf" "$ubpath" $ubcbfsargs
	[ "$payload_seabios" = "y" ] || cprom; :
}

cprom()
{
	cpcmd="cp"

	tmpnew=""; newrom="bin/$target/${pname}_${target}_$initmode.rom"
	[ -n "$displaymode" ] && newrom="${newrom%.rom}_$displaymode.rom"
	[ $# -gt 0 ] && [ "${1%.gkb}" != "$1" ] && tmpnew="${1##*/}" && \
	    newrom="${newrom%.rom}_${tmpnew%.gkb}.rom"

	irom="$tmprom"
	[ $# -lt 1 ] || irom="`mktemp`" || err "!mk irom, $(echo "$@")"
	[ $# -gt 0 ] && x_ cp "$tmprom" "$irom" && cpcmd="mv"

	[ $# -gt 0 ] && [ "${1%.gkb}" != "$1" ] && \
	    cbfs "$irom" "$grubdata/keymap/$tmpnew" keymap.gkb raw
	[ $# -gt 0 ] && [ "$1" = "seauboot" ] && \
	    cbfs "$irom" "$grubdata/bootorder_uboot" bootorder raw; :

	printf "Creating new %s image: '%s'\n" "$projectname" "$newrom"
	x_ mkdir -p "bin/$target"
	x_ $cpcmd "$irom" "$newrom"
}

cbfs()
{
	ccmd="add-payload" && [ $# -gt 3 ] && [ $# -lt 5 ] && ccmd="add"
	lzma="-c lzma" && [ $# -gt 3 ] && [ $# -lt 5 ] && lzma="-t $4"

	[ $# -gt 4 ] && [ "$5" = "0x1110000" ] && \
	    ccmd="add-flat-binary" && \
	    lzma="-c lzma -l 0x1110000 -e 0x1110000"

	x_ "$cbfstool" "$1" $ccmd -f "$2" -n "$3" $lzma
}

mkcoreboottar()
{
	[ "$target" != "$tree" ] && [ "$XBMK_RELEASE" = "y" ] && \
	    [ "$release" != "n" ] && $dry mkrom_tarball "bin/$target" && \
	    $dry x_ ./mk inject "bin/${relname}_${target}.tar.xz" nuke; :
}