Skip to content

Apple's open-source XNU kernel on Android phones: its own loader and drivers, Metal on the Adreno. Runs from RAM; a reboot gives the phone back to Android.

C
4.8 KB
Raw Blame

Commands

Every make target is a script below it; run the script itself for its options (--help, or the comment at its top).

make

Target Does
make the list below
make doctor checks this machine (and a phone on adb) for what HakiOS needs
make unpack IPSW=F the OS files out of your own Darwin userland 16.5 IPSW into sysimage/ (nothing is downloaded)
make images userland/root.apfs and userland/system.apfs
make kernel the kernel from source, with the .config's drivers
make loader / make loader-open the boot loader with your IPSW's identity / the placeholder that boots the open kernel only
make qemu / make qemu-open a session in QEMU with Darwin / the open kernel with nothing of Apple's
make phone a session on the phone with the .config's arguments
make firmware the phone's firmware off the phone (devices/$(DEVICE)/pull-firmware.sh)
make esp an EFI system partition tree for a UEFI-native boot (UEFI boot)
make u-boot / make u-boot-img HakiOS's U-Boot for $(DEVICE) / it as a boot image for fastboot boot that starts the loader from RAM (U-Boot)
make qemu-u-boot make qemu-open's payload booted the phone's way: U-Boot, the hakios command, bootefi (U-Boot)
make prebuilt refresh prebuilt/ from what was built
make clean the build output of the kernel, loader and images
make NAME_defconfig .config from a defconfig of any repository (FRAGMENTS="open trace" on top)
make NAME.config a fragment over the .config
make config / make savedefconfig what the .config is / it as a minimal defconfig
make devices the device and SoC repositories

tools/

Tool Does Page
hakios-config.py defconfigs, fragments, .config, boot-arguments, the drivers' choice into the kernel tree Configuration
hakios-device.py device and SoC repositories: list, check, new, sync, lock, split Repositories
new-device.py a device's directory from the phone's own device tree: soc.args, how far the SoC code carries Port a device
boot-args.py the catalogue of every boot-argument the source reads Boot arguments
docs-gen.py the pages of this documentation made from the source
drivers-check.py drivers/map and drivers/*/conf agree Drivers in the configuration
make-kernel.sh the kernel build make kernel runs, judged by what failed Building
mkubootimg.py HakiOS's U-Boot as an Android boot image, with the loader and a payload in its ramdisk (an HKUB container); or the container alone U-Boot
kernel-version.py the kernel's version string, kernel.ver Versioning
provenance-check.py nothing in the tree that must not be, and every piece of code that can write to a phone declared
metallib.py a .metallib taken apart AIR
metallib-test.sh, metal-plugin-test.sh the Metal plug-in's reading of libraries and its objects, under sanitizers Metal plan
metal-run.sh one Metal run on the phone, measured, with a summary in logs/ Metal
frames.py how evenly the frames of a run's gestures came, and what held up the slow ones Metal
ca-metallib.py QuartzCore's default.metallib for the window server, on your machine, from what you supply Metal
metal-cache-seed.sh the window server's compiled shader stages off the phone, into the next image Windows
mk-mesa.sh, mk-turnip.sh Mesa 25.0.7 for the Darwin user space, and its Vulkan driver Metal
mk-m2v.sh UniXNU's Metal on Vulkan: AdrenoMetal's frontend over metal2vulkan, fetched at pinned revisions Metal
modem-cycle.sh a whole phone session in one command On the phone
soc-args.py the soc_* addresses out of a device tree
backup-partitions.py a read-only backup of the phone's partitions, each copy proven Install, safely

xnu/

Script Does
xnu/apply.sh Apple's XNU at the tag, with hakios.patch, files/, the drivers and the drivers' choice laid over it, into xnu-src/
xnu/sync-drivers.sh the drivers edited in drivers/ (and the SoC's and device's) into the tree
xnu/export.sh the tree back into hakios.patch, files/ and drivers/