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

README (en, uk, zh): the three layers, what is written to the phone by default, links to the new documents

shimoku9e1fe95d4aef
diff --git a/.gitignore b/.gitignore
index 3fe78fe..d4fcabb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -16,6 +16,7 @@
!/LICENSE.APSL
!/NOTICE
!/LEGAL.md
+!/COMMUNITY.md
!/COMPLIANCE.md
!/THIRD_PARTY_LICENSES.md
!/devices/
diff --git a/README.md b/README.md
index a4775cd..b33289d 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,28 @@
English · [中文](README.zh.md) · [Українська](README.uk.md)
-HakiOS runs the open-source XNU kernel (xnu-8796.121.2) with my own boot loader and my own drivers
-on an Android phone with a Qualcomm SoC, and boots the stock iOS 16.5 user space on top of it:
-launchd, backboardd, SpringBoard, the apps. The same thing runs in QEMU (`virt`, aarch64) on a
-Linux PC.
+HakiOS is an adaptation of the Darwin kernel (Apple's open-source XNU, xnu-8796.121.2) to Android phones with a
+Qualcomm SoC, in the way Android is an adaptation of Linux to phones: my own boot loader, my own drivers, a
+configuration system (`configs/`) and a kernel version of its own (`VERSION`). The same thing runs in QEMU
+(`virt`, aarch64) on a Linux PC, with nothing of Apple's and nothing of any phone's (`make qemu-open`).
-Nothing is flashed. The loader goes into RAM through `fastboot boot`, the system lives in RAM for
-the length of a session, and a reboot brings the phone back to its own Android. This is a research
-bench, not a ROM.
+It has three layers, and the project says which one it stands behind (`LEGAL.md`):
+
+1. **The open core**: the kernel port, the loader, the drivers, the tools. All source, in this repository.
+2. **What you put on top**: the kernel can start a user space that you supply. The project was built so that it can
+ start the iOS 16.5 user space, which you lay out yourself from files you download from Apple; it ships none of it
+ and circumvents nothing to get it. Whether you may do that, and whether you want to, is your decision.
+3. **Apple's services** (activation, Apple ID, iCloud, the App Store): not supported and not a goal.
+
+By default the loader goes into RAM through `fastboot boot`, the system lives in RAM for the length of a session,
+and a reboot brings the phone back to its own Android. The one thing it writes by default is its own log (a few KB)
+to the phone's `logdump` partition; with `ufs_write=1` the kernel writes only to a partition `darwin` that you
+create yourself. This is a research bench, not a ROM.
+
+More: [`COMMUNITY.md`](COMMUNITY.md) (the community and the token, and what they are not), [`docs/configs.md`](docs/configs.md)
+(defconfigs and fragments), [`docs/versioning.md`](docs/versioning.md) (`kernel.ver`), [`docs/boot-args.md`](docs/boot-args.md)
+(every boot argument), [`docs/uefi-boot.md`](docs/uefi-boot.md), [`docs/install.md`](docs/install.md) (the design of an install,
+not an installer), [`docs/comparison.md`](docs/comparison.md) (the other projects), [`drivers/README.md`](drivers/README.md).
The first phone is the **POCO X5 Pro 5G** (`redwood`, Snapdragon 778G). The kernel knows nothing
about it in advance: every address, interrupt, power rail and firmware comes from the phone's own
@@ -39,6 +53,8 @@ Not in the repository, never:
## Status
+The rows about the lock screen, the apps and so on describe what happens when you add layer 2 yourself.
+
| Works | Not yet |
|---|---|
| Lock screen, home screen, Control Center, gestures, the stock apps | Cellular: the modem boots, sees the network, the SIM is bound, the IPA data path and `en1` are in place; registration, the data session and the status bar bars are in progress (`docs/cellular.md`) |
diff --git a/README.uk.md b/README.uk.md
index 1c4b030..ad4bc74 100644
--- a/README.uk.md
+++ b/README.uk.md
@@ -2,14 +2,28 @@
[English](README.md) · [中文](README.zh.md) · Українська
-HakiOS запускає відкрите ядро XNU (xnu-8796.121.2) з власним завантажувачем і власними драйверами
-на Android-телефоні з процесором Qualcomm, а поверх нього — стандартний користувацький простір
-iOS 16.5: launchd, backboardd, SpringBoard, застосунки. Те саме працює в QEMU (`virt`, aarch64)
-на звичайному комп'ютері з Linux.
+HakiOS — це адаптація ядра Darwin (відкритий XNU від Apple, xnu-8796.121.2) до Android-телефонів із Qualcomm, так
+само як Android — адаптація Linux до телефонів: власний завантажувач, власні драйвери, система конфігурацій
+(`configs/`) і власна версія ядра (`VERSION`). Те саме працює в QEMU (`virt`, aarch64) на комп'ютері з Linux, без
+нічого від Apple і без нічого з будь-якого телефона (`make qemu-open`).
-Нічого не прошивається. Завантажувач іде в ОЗП через `fastboot boot`, система живе в ОЗП до кінця
-сеансу, а перезавантаження повертає телефон у його власний Android. Це дослідницький стенд, а не
-прошивка.
+Тут три шари, і проєкт каже, за який із них він відповідає (`LEGAL.md`):
+
+1. **Відкрите ядро**: порт ядра, завантажувач, драйвери, інструменти. Увесь код у цьому репозиторії.
+2. **Те, що ви кладете зверху**: ядро може запустити користувацький простір, який ви надаєте самі. Проєкт збудовано
+ так, що воно вміє запускати користувацький простір iOS 16.5, який ви самі збираєте з файлів, завантажених у
+ Apple; проєкт нічого з цього не поширює і нічого не обходить, щоб це отримати. Чи можна вам це робити і чи
+ хочете ви — ваше рішення.
+3. **Сервіси Apple** (активація, Apple ID, iCloud, App Store): не підтримуються і не є метою.
+
+За замовчуванням завантажувач іде в ОЗП через `fastboot boot`, система живе в ОЗП до кінця сеансу, а
+перезавантаження повертає телефон у його власний Android. Єдине, що він пише за замовчуванням, — власний журнал
+(кілька КБ) у розділ `logdump` телефона; з `ufs_write=1` ядро пише лише в розділ `darwin`, який ви створюєте самі.
+Це дослідницький стенд, а не прошивка.
+
+Докладніше: [`COMMUNITY.md`](COMMUNITY.md), [`docs/configs.md`](docs/configs.md), [`docs/versioning.md`](docs/versioning.md),
+[`docs/boot-args.md`](docs/boot-args.md), [`docs/uefi-boot.md`](docs/uefi-boot.md), [`docs/install.md`](docs/install.md),
+[`docs/comparison.md`](docs/comparison.md), [`drivers/README.md`](drivers/README.md).
Перший телефон — **POCO X5 Pro 5G** (`redwood`, Snapdragon 778G). Ядро нічого не знає про нього
наперед: кожна адреса, переривання, лінія живлення і прошивка беруться з дерева пристроїв самого
@@ -39,6 +53,8 @@ iOS 16.5: launchd, backboardd, SpringBoard, застосунки. Те саме
## Стан
+Рядки про екран блокування, застосунки тощо описують те, що відбувається, коли ви самі додаєте шар 2.
+
| Працює | Ще ні |
|---|---|
| Екран блокування, домашній екран, Пункт керування, жести, стандартні застосунки | Стільниковий зв'язок: модем стартує, бачить мережу, SIM прив'язана; реєстрація та палички в статус-барі — у роботі (`docs/cellular.md`) |
diff --git a/README.zh.md b/README.zh.md
index c26f374..26bfb35 100644
--- a/README.zh.md
+++ b/README.zh.md
@@ -2,12 +2,23 @@
[English](README.md) · 中文 · [Українська](README.uk.md)
-HakiOS 在搭载高通 SoC 的 Android 手机上运行开源的 XNU 内核(xnu-8796.121.2),配上我自己写的引导
-程序和驱动,并在其上启动原版 iOS 16.5 用户空间:launchd、backboardd、SpringBoard 和各个应用。同样
-的东西也能在 Linux 电脑上的 QEMU(`virt`,aarch64)里运行。
+HakiOS 是把 Darwin 内核(Apple 开源的 XNU,xnu-8796.121.2)适配到搭载高通 SoC 的 Android 手机上,就像 Android 是
+Linux 在手机上的适配:我自己的引导程序、驱动、配置系统(`configs/`)和独立的内核版本号(`VERSION`)。同样的东西也能在
+Linux 电脑上的 QEMU(`virt`,aarch64)里运行,不需要任何 Apple 的东西,也不需要任何手机的东西(`make qemu-open`)。
-不刷写任何东西。引导程序通过 `fastboot boot` 进入内存,系统在内存里运行一个会话,重启后手机回到
-它自己的 Android。这是一个研究用的试验台,不是 ROM。
+它分三层,项目说明自己对哪一层负责(`LEGAL.md`):
+
+1. **开放核心**:内核移植、引导程序、驱动、工具。全部是本仓库里的源码。
+2. **你自己放在上面的东西**:内核可以启动你自己提供的用户空间。项目的构建方式使它能够启动 iOS 16.5 用户空间,但那是你自己用
+ 从 Apple 下载的文件在本机整理出来的;项目不提供其中任何内容,也不绕过任何限制去获取它。你是否可以这样做、是否愿意这样做,由你自己决定。
+3. **Apple 的服务**(激活、Apple ID、iCloud、App Store):不支持,也不是目标。
+
+默认情况下,引导程序通过 `fastboot boot` 进入内存,系统在内存里运行一个会话,重启后手机回到它自己的 Android。它默认只写一样东西:
+自己的日志(几 KB),写入手机的 `logdump` 分区;开启 `ufs_write=1` 时,内核只会写入你自己创建的 `darwin` 分区。这是一个研究用的试验台,不是 ROM。
+
+更多:[`COMMUNITY.md`](COMMUNITY.md)、[`docs/configs.md`](docs/configs.md)、[`docs/versioning.md`](docs/versioning.md)、
+[`docs/boot-args.md`](docs/boot-args.md)、[`docs/uefi-boot.md`](docs/uefi-boot.md)、[`docs/install.md`](docs/install.md)、
+[`docs/comparison.md`](docs/comparison.md)、[`drivers/README.md`](drivers/README.md)。
第一台手机是 **POCO X5 Pro 5G**(`redwood`,骁龙 778G)。内核事先对它一无所知:每个地址、中断、
电源轨和固件都来自手机自己的设备树和它的 Android,所以移植到另一台高通手机意味着在 `devices/`
@@ -34,6 +45,8 @@ HakiOS 在搭载高通 SoC 的 Android 手机上运行开源的 XNU 内核(xnu
## 现状
+关于锁屏、应用等的各行,描述的是你自己加上第 2 层之后的情况。
+
| 可用 | 尚未 |
|---|---|
| 锁屏、主屏、控制中心、手势、系统自带应用 | 蜂窝网络:调制解调器已启动、能看到网络、SIM 已绑定;注册和状态栏信号格正在进行(`docs/cellular.md`) |