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: in my own voice, portable by design rather than one phone's, and plain about what is and is not in the repository

shimoku74f4b994daf123
diff --git a/README.md b/README.md
index 3e33365..4131e47 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,25 @@
# HakiOS
-**HakiOS** — открытое ядро XNU (xnu-8796.121.2, ядро iOS 16.5), собственный загрузчик и собственные
-драйверы для Android-телефона **POCO X5 Pro 5G (redwood, Snapdragon 778G)**, под которыми работает
-пользовательское окружение iOS 16.5: launchd → backboardd → SpringBoard → приложения. То же самое
-запускается в QEMU (`virt`, aarch64) на обычном Linux-компьютере.
+**HakiOS** — мой проект по запуску Darwin на Android-телефонах: открытое ядро XNU (xnu-8796.121.2 — то
+же ядро, что в iOS 16.5), собственный загрузчик и собственные драйверы для железа Qualcomm, под
+которыми работает пользовательское окружение iOS: launchd → backboardd → SpringBoard → приложения.
+То же самое запускается в QEMU (`virt`, aarch64) на обычном Linux-компьютере.
+
+Первый и пока единственный телефон, на котором всё это отлажено, — **POCO X5 Pro 5G (redwood,
+Snapdragon 778G)**, но проект с самого начала делается переносимым: ядро ничего не знает о телефоне
+заранее, все адреса, прерывания, рельсы питания и прошивки берутся из дерева устройств и из Android
+конкретного аппарата, и каждый драйвер написан так, чтобы перенос на другой телефон на Qualcomm был
+вопросом данных, а не переписывания. Если у вас другой аппарат и желание — порт делается по тем же
+шагам, что описаны в `docs/notes.md` и `docs/cellular.md`.
Ничего в телефон не прошивается: загрузчик уходит в ОЗУ через `fastboot boot`, система живёт в ОЗУ до
-конца сеанса, после перезагрузки телефон снова в своём Android. Это исследовательский стенд, а не
-прошивка.
+конца сеанса, после перезагрузки телефон снова в своём Android. Это исследовательский стенд для
+изучения того, как устроены XNU и железо телефона, а не прошивка и не замена Android.
## Что в репозитории, а чего нет
-В репозитории **только наш код и наши данные**:
+Я слежу за тем, чтобы в репозитории были **только мой код и мои данные** — ничего, что принадлежит
+Apple или производителю телефона:
- ядро — патч к открытым исходникам XNU Apple (`xnu/redwood.patch`, лицензия APSL) и наши файлы
драйверов (`xnu/files/`), которые `xnu/apply.sh` накладывает на свежий клон xnu;
@@ -21,13 +29,18 @@
Чего **нет и не будет**:
-- файлов iOS: ни одного бинарника, образа, кеша или ресурса Apple. Образ системы собирается на вашей
- машине из IPSW iOS 16.5, который `ios165/fetch.sh` скачивает с серверов Apple сам;
+- файлов iOS: ни одного бинарника, образа, кеша, шрифта, картинки или иного ресурса Apple, и ни одного
+ снимка экрана iOS. Образ системы собирается на вашей машине из IPSW iOS 16.5, который вы скачиваете
+ сами (`ios165/fetch.sh` берёт его с публичных серверов Apple, ничего не расшифровывая и не обходя);
- прошивок телефона (GPU, Wi-Fi, звукового процессора, модема, вибромотора, камер): они вендорские и
снимаются с того самого аппарата из его Android (`adb pull`) в каталоги `fw-*/`, которые в git
не попадают;
-- ключей, идентификаторов и чего-либо, что позволяло бы выдавать это устройство за iPhone перед
- службами Apple.
+- ключей, сертификатов, обхода защиты, активации и чего-либо, что позволяло бы выдавать устройство за
+ iPhone перед службами Apple или пользоваться платными службами. Вход в учётную запись Apple здесь
+ невозможен и не является целью.
+
+Пользоваться iOS на не-Apple устройстве вы можете только в рамках вашего собственного права на
+копию iOS и её лицензионного соглашения; этот репозиторий — инструменты и ядро, а не iOS.
## Что работает
@@ -63,8 +76,8 @@ qemu/run-ios.sh 1200 -display gtk > logs/qemu.log # сеанс на 20 ми
## На телефоне
-Нужны POCO X5 Pro 5G с разблокированным загрузчиком, `adb` и `fastboot`, образы из предыдущего
-раздела и прошивки телефона из его Android:
+Нужен телефон, для которого есть порт (сейчас — POCO X5 Pro 5G), с разблокированным загрузчиком,
+`adb` и `fastboot`, образы из предыдущего раздела и прошивки телефона из его Android:
```sh
adb pull /vendor/firmware/a660_{gmu.bin,sqe.fw,zap.mdt,zap.b00,zap.b01,zap.b02} fw-gpu/ # GPU
@@ -138,8 +151,12 @@ QMI; файловые системы модема отдаются с UFS (то
с модемом проходит. SIM-карта привязывается к подписке, NAS читает сигнал. Текущее состояние и история —
в `docs/cellular.md`.
-## Лицензии
+## Лицензии и юридическая сторона
-Наш код — под той же лицензией, что и файлы, которые он изменяет: патч к XNU — APSL, остальное — см.
-заголовки файлов. iOS, её образы и прошивки телефона принадлежат их владельцам и в репозиторий не
-входят; каждый получает их сам со своего телефона и из своего IPSW.
+Мой код — под той же лицензией, что и файлы, которые он изменяет: патч к XNU — Apple Public Source
+License 2.0 (исходники XNU открыты Apple именно под ней, и условия я соблюдаю: изменения публикуются
+в виде исходников, уведомления сохранены), остальное — см. заголовки файлов. iOS, её образы,
+товарные знаки Apple и прошивки телефона принадлежат их владельцам, в репозиторий не входят и мною
+не распространяются; каждый получает их сам со своего телефона и из своего IPSW. Названия «iOS»,
+«iPhone», «Apple» упоминаются только для описания того, с чем работает код. Если какой-то файл
+здесь, по вашему мнению, нарушает чьи-то права — напишите в issue, я уберу его.