This Repo Is Based On SurfaceDuoPkg

Thanks for Gustave's instructions!

Project Mu UEFI Implementation for Devices on Snapdragon™ Platforms.

Build

Minimum System Requirements

• At least 2 cores x86_64 processor running at 2Ghz or higher implementing the X86 ISA with 64 bit AMD extensions (AMD64) (Currently, building on any other ISA is not supported. In other words, do. not. build. this. on. a. phone. running. android. please.)
• SSD
• A linux environment capable of running below tool stack:
  • Bash
  • Python 3.10 or higher (python3.10, python3.10-venv, python3.10-pip)
  • mono-devel
  • git-core, git
  • build-essential
  • clang38 (or higher), llvm, ggc-aarch64-linux-gnu
• Exported CLANG38_BIN environment variable pointing to LLVM 10 binary folder
• Exported CLANG38_AARCH64_PREFIX variable equalling to aarch64-linux-gnu-

Build Instructions

• Clone this repository to a reasonable location on your disk (There is absolutely no need to initialize submodules, stuart will do it for you later on)
• Run the following commands in order, with 0 typo, and without copy pasting all of them blindly all at once:

1. Setup Base environment

./setup_env.sh
pip install --upgrade -r pip-requirements.txt

Alternatively, use docker if you don't have Ubuntu 22.04 environment

docker build -t mu:v1 .
docker run -it mu:v1 -v ./:/build/

Then finish the following process in docker environment

You can also use docker-compose if you know how to use

docker-compose up

2. Build UEFI & Generate Android Boot Image

Usage: build_uefi.py -d <target-device>

• Exmaple:

  ./build_uefi.py -d <target-name>
  

• Tips:

  • use -s all to build all devices.
  • use -d all -s <target-silicon> to build all devices in one silicon.

• You will find Build/xxxxPkg/<target-device>.img after successfully building.

Target list

SDM845

Device	Target name	DSDT Support	Maintainers
HDK 845	qcom-hdk845	✅	NONE
Xiaomi Mix 2s	xiaomi-polaris	❌	NONE

SM8150

Device	Target name	DSDT Support	Maintainers
ASUS ROG2	asus-I001DC	✅	Ww
Axon Stage 5G	kakao-pine	❌	AKA
BlackShark 2	blackshark-skywalker	❌	NONE
BlackShark 2 Pro	blackshark-darklighter	❌	NONE
HTC 5G Hub	htc-rtx	❌	NONE
LG G8	lg-alphaplus	✅	Yanhua
LG G8S	lg-betalm	✅	J0SH1X
LG G8X	lg-mh2lm	✅	Molly Sophia
LG V50	lg-flashlmdd	✅	AKA
LG V50S	lg-mh2lm5g	✅	AKA
Meizu 16T	meizu-m928q	❌	NONE
Meizu 16s	meizu-m971q	❌	NONE
Nubia RedMagic 3	nubia-nx629j	❌	NONE
Nubia RedMagic 3S	nubia-nx629jv1s	❌	NONE
Nubia Mini 5G	nubia-tp1803	✅	Alula
OnePlus 7	oneplus-guacamoleb	❌	NONE
OnePlus 7 Pro	oneplus-guacamole	✅	Waseem Alkurdi
OnePlus 7T Pro	oneplus-hotdog	✅	Morc
OnePlus 7T Pro 5G	oneplus-hotdogg	✅	NONE
OPPO Reno 10X	oppo-op46c3	❌	NONE
OPPO Reno ACE	oppo-pclm10	✅	sunflower2333
QTI QRD 855	qcom-msmnile	✅	sunflower2333
Realme X3	realme-rmx2086	❌	NONE
Samsung Galaxy S10	samsung-beyond1qlte	✅	Ww
Smartisan Pro 3	smartisan-aries	❌	NONE
Xiaomi 9	xiaomi-cepheus	✅	qaz6750
Xiaomi Hercules	xiaomi-hercules	✅	Ww
Xiaomi K20 Pro	xiaomi-raphael	✅	sunflower2333
Xiaomi Mix3 5G	xiaomi-andromeda	✅	sunflower2333
Xiaomi Mix Alpha u2	xiaomi-avenger	❌	NONE
Xiaomi Pad 5	xiaomi-nabu	✅	Map220v
Xiaomi Poco X3 Pro	xiaomi-vayu	✅	Degdag

SM7125

Device	Target name	DSDT Support	Maintainers
QTI QRD 720	qcom-atoll	✅	sunflower2333
Xiaomi Note 9S	xiaomi-miatoll	❌	Icesito
Xiaomi Note 10 Pro	xiaomi-sweet	❌	dopaemon

SM7325

Device	Target name	DSDT Support	Maintainers
QTI QRD 778	qcom-kodiak	✅	Ayu&sunflower2333

SM8350

Comming soon...

Device	Target name	DSDT Support	Maintainers
QTI QRD 888	qcom-lahaina	❌	None

SM8550

Device	Target name	DSDT Support	Maintainers
QTI QRD 8550	qcom-kailua	❌	Sunflower2333
Nubia RedMagic 8 Pro	nubia-nx729j	❌	BigfootACA
Xiaomi 13	xiaomi-fuxi	❌	None
Xiaomi 13 Pro	xiaomi-nuwa	❌	None

Acknowledgements

• Gustave Monce and his SurfaceDuoPkg
• Andrei Warkentin and his RaspberryPiPkg
• Sarah Purohit
• Googulator
• Ben (Bingxing) Wang
• Samuel Tulach and his Rainbow Patcher
• BigfootACA and his SimpleInit
• Renegade Project
• Lemon ICE

License

All code except drivers in GPLDriver directory are licensed under BSD 2-Clause.
GPL Drivers are licensed under GPLv2 license.

Boot Chain

flowchart TD
  subgraph fake_kernel[Fake Kernel]

    subgraph bootshim[Boot Shim]
      kernel_header[ARM64 Magic]
      copy_fd[Copy UefiFD to stack base]
      save_args[Save needed arguments to registers]
      jump[jump to uefi fd base]
    end

    subgraph uefi[Uefi]
      subgraph platform_prepi_lib[PlatformPrePiLib]
        is_linux_boot_requested{IsLinuxBootRequested}
      end
      continue_uefi[Continue Booting Uefi]
    end
    subgraph kernel[Linux Kernel]
      linux_kernel[Kernel]
    end
  end
  
  subgraph hlos[HLOS]
    android[Android]
    linux[Linux]
    windows[Windows]
    etc[...]
  end

  kernel_header --> copy_fd --> save_args --> jump --> platform_prepi_lib
  platform_prepi_lib --> is_linux_boot_requested
  is_linux_boot_requested -- True --> linux_kernel
  is_linux_boot_requested -- False --> continue_uefi
  continue_uefi --> linux
  linux_kernel --> linux
  linux_kernel --> android
  continue_uefi --> windows
  fake_kernel ==> hlos