kdrag0n/kramflash

A fast & simple bootable GKI kernel flasher for boot image v2 and v3 devices.

kramflash

kramflash is a simple bootable ramdisk that flashes a custom kernel on devices with boot image v2 or newer. It is not capable of flashing real GKIs because it doesn't manipulate any ramdisks for compatibility reasons, but it works with the GKI boot scheme and partition layout.

Requirements

The flasher script, flash.sh, must be installed as the init script in an Alpine Linux ramdisk with the following changes made:

• sgdisk package installed
• magiskboot tool from Magisk placed in PATH
• reboot_with_cmd tool (source code available in this repo) placed in PATH

For the flasher to show output rather than appearing to freeze and crash at the bootloader splash, the kernel console needs to be configured to display output to the user. The easiest way to do this is to enable and use the default fbcon console and make it render to simplefb, backed by the continuous splash framebuffer that the bootloader sets up before starting Linux.

If a console is present, adding loglevel=2 to the kernel command-line is recommended to reduce spammy output and speed up boot significantly.

Payload

The kernel payload should be placed in the /payload directory of the ramdisk, consisting of:

• Image.lz4: LZ4-compressed kernel image without appended DTBs
• dtb: Concatenated DTBs for supported devices
• banner: Optional banner to show to the user when flashing

DTBO flashing is not currently supported.

Kernel changes

The flashed kernel payload should not be changed in any way. However, the flasher itself uses a kernel because it is essentially a custom bootable recovery. No changes to the kernel are strictly necessary, but they improve the user experience significantly:

• For easier debugging on newer kernels (4.14+): add printk.devkmsg=on to cmdline (example)
• Minimize kernel size in order to reduce the total flasher size: example
• Framebuffer console for live feedback, otherwise it just looks like the flasher crashed even if it succeeded: example framebuffer and console

If using a console:

• Silence kernel logs: add quiet to cmdline (example) and set loglevel (example)
• Larger font for legibility: Terminus 16x32 (example)

See the changes made to the Pixel 5 kernel for more information.