EDK2 UEFI firmware for Rockchip RK3588 platforms

This repository contains an UEFI firmware implementation based on EDK2 for various RK3588 boards.

Supported platforms

• Radxa ROCK 5B
• Radxa ROCK 5A
• Orange Pi 5
• Orange Pi 5 Plus
• ameriDroid Indiedroid Nova
• Firefly ROC-RK3588S-PC
• StationPC Station M3
• Mekotronics R58X
• Mekotronics R58 Mini
• Khadas Edge2
• FriendlyELEC NanoPC T6

Supported peripherals

Applicable to all platforms unless otherwise noted.

Supported OSes

Installation & usage

Check out the latest release at: https://github.com/edk2-porting/edk2-rk35xx/releases, including install instructions.

Configuration settings

The UEFI configuration settings can be viewed and changed using both the UI configuration menu (under Device Manager -> Rockchip Platform Configuration), as well as the UEFI Shell. To configure using the UEFI Shell, use setvar command to read/write the UEFI variables with GUID = 10f41c33-a468-42cd-85ee-7043213f73a3.

The syntax to read a setting is:

setvar <NAME> -guid 10f41c33-a468-42cd-85ee-7043213f73a3

The syntax to write a setting is:

setvar <NAME> -guid 10f41c33-a468-42cd-85ee-7043213f73a3 -bs -rt -nv =<VALUE>

VALUE must be in hexadecimal.

For string-type settings, the syntax to write is:

setvar <NAME> -guid 10f41c33-a468-42cd-85ee-7043213f73a3 -bs -rt -nv =L"<VALUE>" =0x0000

CPU Performance

Cluster clocks / voltages

x can be :

• L for LITTLE cluster
• B01 for big cluster #0
• B23 for big cluster #1

CpuPerf_CPUxClusterClockCustom can have one of the following values:

• All clusters: 408000000, 600000000, 816000000, 1008000000, 1200000000, 1416000000, 1608000000, 1800000000
• Big cluster additional clocks: 2016000000, 2208000000, 2256000000, 2304000000, 2352000000, 2400000000

CpuPerf_CPUxClusterVoltageCustom is the cluster voltage in microvolts. Min: 500000, Max: 1500000. Default value depends on cluster type.

PCIe/SATA/USB Combo PIPE PHY

Default values and supported options depend on the platform. Check documentation and schematics for more details on PHY wiring.

Examples:

• To read the 'CPUL Clock Preset' setting :

setvar CpuPerf_CPULClusterClockPreset -guid 10f41c33-a468-42cd-85ee-7043213f73a3

• To change the 'CPUL Clock Preset' setting to 'Maximum' :

setvar CpuPerf_CPULClusterClockPreset -guid 10f41c33-a468-42cd-85ee-7043213f73a3 -bs -rt -nv =0x00000002

Building

The firmware can only be built on Linux currently. For Windows use WSL.

1. Install required packages:

   For Ubuntu/Debian:

   sudo apt install git gcc g++ build-essential gcc-aarch64-linux-gnu iasl python3-pyelftools

   For Arch Linux:

   sudo pacman -Syu
   sudo pacman -S git base-devel gcc dtc aarch64-linux-gnu-binutils aarch64-linux-gnu-gcc aarch64-linux-gnu-glibc python python-pyelftools iasl --needed

2. Clone the repository:

   git clone https://github.com/edk2-porting/edk2-rk35xx.git --recursive
   cd edk2-rk35xx

3. Build UEFI (ROCK 5B for example, check list of platform configs):

   ./build.sh --device rock-5b --release Release # (or Debug)

Notes

ACPI

ACPI support is limited, with only boot critical devices being currently exposed. It has been tested with Windows, NetBSD and VMware ESXi.

Flash layout

Memory Map

Licenses

The UEFI code and produced FD binary are licensed under the current EDK2 license, which is BSD-2-Clause-Patent.

The license of the blobs in the misc/rkbin/ directory is to be determined. Most of them are built from open-source projects such as U-Boot, Arm Trusted Firmware and OP-TEE.

Community

• Radxa forum: https://forum.radxa.com/t/windows-uefi-on-rock-5-mega-thread/12924
• Hack w/ Rockchip Telegram: https://t.me/UEFIonRockchip
• Windows on R Discord: https://discord.gg/vjHwptUCa3

Credits & alternatives

This firmware is based on Rockchip's initial efforts at https://gitlab.com/rk3588_linux/rk/uefi-monorepo.

There's also minimal support for RK356X (likely broken in our repo with no plans of reviving), but there's a much better implementation made by @jaredmcneill at https://github.com/jaredmcneill/quartz64_uefi, from which we also reused some code.