UniXNU provides shared build tools, ARM64 support, OS profiles and reusable components for ports across SoCs and devices. SoC repositories supply common platform support, and device repositories supply board configuration and hardware integration.

🎉 News: Adreno740 and AdrenoMetal provide GPU acceleration on sheng. The render server composites the system UI through the Adreno 740, and listed processes get their own Metal devices. These components are shared GPU implementations; each device port supplies the required firmware, power, memory and display integration. See the Adreno 740 driver documentation.

Firmware requirement

Build the device firmware with ./unixnu build firmware --uefi ../uefi-<device> before ./unixnu bootimg. Include UniXNU, UniXNUDxe, DarwinBoot and the shared UniXNURamDiskDxe payload driver in the firmware. Follow the required firmware integration.

Save paths and boot arguments in unixnu.local.toml to run ./unixnu kernel, ./unixnu firmware, ./unixnu payload, and ./unixnu bootimg. After changing boot arguments, rebuild the payload and boot image. See boot arguments and green-bar diagnosis.

Documentation

Linux setup supports apt, dnf, pacman and zypper, plus environments with dependencies installed separately. See Linux requirements.

The documentation is at unixnu.com. Its sources, navigation, translations, assets, configuration, and deployment workflow are maintained in this repository. It covers the boot chain, the build driver, device porting, driver development, the 4 KiB XNU page patches, boot arguments and per-device notes.

Repositories

Repository	Contents
UniXNU	Build tools, component catalog, ARM64 support, OS profiles, templates, UEFI package and documentation site
UniXNU-sm8550-common	Shared SM8550 configuration, DTSI, platform operations and patch series
UniXNU-sheng	Device repository for the Xiaomi Pad 6S Pro
uefi-sheng	UEFI firmware port for the Xiaomi Pad 6S Pro

The main checkout contains shared drivers and kits. Device repositories own their board driver submodules; sheng supplies ShengUfs and ShengHidInput alongside its touch and preflight components. The catalog describes available components, and the build tools assemble the selected device sources. Clone repositories with --recurse-submodules.

Device repositories select pinned SoC sources, OS profiles, and components. The build tools merge the profiles, resolve dependencies, compile the board DTS, and generate the ADT. Start with AGENTS.md, the device template, and the migration guide.

Official device development

Every official device maintains porting.toml with hardware inputs, configuration, procedures, findings, evidence and completion criteria for each subsystem. Maintainers and agents use this record. The site renders it from the device revision pinned in devices.toml.

The required CI check covers the record structure, component dependencies and updates to findings or evidence for changed code. Start with the record guide, UFS porting guide and device template.

Contributing

Read CONTRIBUTING.md for the repository scope, the development workflow, the commit format and the documentation rules.

Private blobs

Do not add Apple IPSW files, kernelcaches, disk images, trust caches, Data seeds or vendor firmware to this repository. Keep them in a local cache or external storage.

License

BSD-2-Clause-Patent. See LICENSE.