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

Documentation: the repositories are their own now; sync after the clone

shimoku5b4e0d29388b
diff --git a/README.md b/README.md
index a121ca9..74e1263 100644
--- a/README.md
+++ b/README.md
@@ -57,21 +57,28 @@ make kernel # the kernel with the drivers that configuration builds
make phone SECS=600 # a 10-minute session on the phone, in RAM
```
-## Repositories: common, SoC, device
+## Repositories: common, SoC, device, UEFI
-| Where | What |
+| Repository | What |
|---|---|
-| this repository | **common**: the kernel port (`xnu/`), every common driver (`drivers/`), the loader (`xnuloader/`), user space (`userland/`), the tools, the documentation |
-| `socs/sc7280/` | the Qualcomm SC7280 family (Snapdragon 778G): its fragment, its drivers' choice |
-| `devices/redwood/` | POCO X5 Pro 5G: its defconfig, status, UEFI port, firmware script |
-| `devices/qemu/` | QEMU's `virt` machine, as a device: none of a phone's drivers built in |
-| `devices/manifest.conf` | every SoC and device repository, in this tree or a repository of its own at a revision |
-
-A device is a repository of its own over the common one: `tools/hakios-device.py new` makes it from the phone's own device tree,
-with every phone driver left out until it is ported; `split` makes it a git repository; `sync` fetches the ones that live
-elsewhere. Each driver is an option of the kernel's own configuration (`CONFIG_HAKIOS_*`, XNU's `options` and `conf/files`), so a
-device's defconfig builds exactly the drivers it has. [How the repositories fit](docs/porting/repositories.md),
-[Drivers in the configuration](docs/drivers-config.md).
+| [hakios](https://github.com/shimoku74/hakios) | **common**: the kernel port, every common driver, the loader, user space, the tools, this documentation, and `devices/qemu` |
+| [hakios-sc7280-common](https://github.com/shimoku74/hakios-sc7280-common) | the Qualcomm SC7280 family (Snapdragon 778G): its configuration fragment and the drivers it builds |
+| [hakios-redwood](https://github.com/shimoku74/hakios-redwood) | POCO X5 Pro 5G: its defconfig, status, UEFI platform, firmware script |
+| [hakios-uefi](https://github.com/shimoku74/hakios-uefi) | HakiOS's UEFI: Mu-Silicium with HakiOS's boot path, banner and name |
+| [hakios-web](https://github.com/shimoku74/hakios-web) | the website, with this documentation and the FAQ |
+
+`devices/manifest.conf` in the common repository names each one and the revision it is at; `tools/hakios-device.py sync` clones them
+into `socs/`, `devices/` and `uefi/`. [How the repositories fit](docs/porting/repositories.md).
+
+```sh
+git clone https://github.com/shimoku74/hakios.git && cd hakios
+tools/hakios-device.py sync # the SoC, device and UEFI repositories, at the revisions the manifest names
+```
+
+A device of your own is a repository over the common one: `tools/hakios-device.py new` makes it from the phone's own device tree,
+with every phone driver left out until it is ported. Each driver is an option of the kernel's own configuration (`CONFIG_HAKIOS_*`,
+XNU's `options` and `conf/files`), so a device's defconfig builds exactly the drivers it has.
+[Port a device](docs/porting/index.md), [Drivers in the configuration](docs/drivers-config.md).
## What is in the repository, and what never is
diff --git a/docs/getting-started/phone.md b/docs/getting-started/phone.md
index 4e22726..2b7b2dd 100644
--- a/docs/getting-started/phone.md
+++ b/docs/getting-started/phone.md
@@ -20,6 +20,7 @@ that you create yourself, and nowhere else. [What is written, exactly](../concep
## Step by step
```sh
+tools/hakios-device.py sync # hakios-redwood, hakios-sc7280-common, hakios-uefi into devices/, socs/, uefi/
devices/redwood/pull-firmware.sh # Android running, on adb: GPU, Wi-Fi, audio, haptics, modem, cameras -> fw-*/
make redwood_defconfig # the phone's configuration: the common kernel, the SC7280's, the phone's own
make config # what it is: the drivers built in, the kernel's arguments, the firmware it wants
diff --git a/docs/getting-started/qemu.md b/docs/getting-started/qemu.md
index d6e24b7..ead5cf5 100644
--- a/docs/getting-started/qemu.md
+++ b/docs/getting-started/qemu.md
@@ -7,6 +7,7 @@ The kernel, a placeholder loader and a tiny raw-syscall user space: **nothing of
```sh
git clone https://github.com/shimoku74/hakios.git hakios
cd hakios
+tools/hakios-device.py sync # the SoC, device and UEFI repositories (the open kernel needs none of them; the rest does)
make doctor # what this machine lacks, and what to do
make qemu-open # builds what is missing, then boots
```
diff --git a/docs/index.md b/docs/index.md
index de0f0dc..486bb19 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -44,10 +44,11 @@ Android. What is and is not written to a phone: [Architecture](concepts/architec
| Repository | What |
|---|---|
-| [hakios](https://github.com/shimoku74/hakios) | **common**: the kernel port, the drivers, the loader, user space, the tools, this documentation |
-| `socs/sc7280` | the Qualcomm SC7280 family (Snapdragon 778G): its configuration fragment and drivers |
-| `devices/redwood` | POCO X5 Pro 5G: its defconfig, UEFI port, firmware script, status |
-| `devices/qemu` | QEMU's `virt` machine, as a device |
-
-SoC and device repositories are kept in the common tree until they are split into their own; `devices/manifest.conf` lists them
-all, and `tools/hakios-device.py sync` fetches the ones that live elsewhere. [How the repositories fit](porting/repositories.md).
+| [hakios](https://github.com/shimoku74/hakios) | **common**: the kernel port, every common driver, the loader, user space, the tools, this documentation, and `devices/qemu` |
+| [hakios-sc7280-common](https://github.com/shimoku74/hakios-sc7280-common) | the Qualcomm SC7280 family (Snapdragon 778G): its configuration fragment and the drivers it builds |
+| [hakios-redwood](https://github.com/shimoku74/hakios-redwood) | POCO X5 Pro 5G: its defconfig, status, UEFI platform, firmware script |
+| [hakios-uefi](https://github.com/shimoku74/hakios-uefi) | HakiOS's UEFI: Mu-Silicium with HakiOS's boot path, banner and name |
+| [hakios-web](https://github.com/shimoku74/hakios-web) | the website, with this documentation and the FAQ |
+
+`devices/manifest.conf` in the common repository names each one and the revision it is at; `tools/hakios-device.py sync` clones them
+into `socs/`, `devices/` and `uefi/`. [How the repositories fit](porting/repositories.md).
diff --git a/docs/porting/repositories.md b/docs/porting/repositories.md
index 3e1342c..1f19cd5 100644
--- a/docs/porting/repositories.md
+++ b/docs/porting/repositories.md
@@ -10,8 +10,9 @@ hakios/ common: the kernel port, every common driver, the loader, u
└── devices/manifest.conf every SoC and device repository: kept in this tree, or a repository of its own at a revision
```
-A SoC or device directory is the same whether it is kept in this tree or is a git repository of its own cloned into place: the
-tools look for `socs/*/soc.conf` and `devices/*/device.conf`, whatever put them there.
+A SoC or device directory is the same whether it is kept in the common tree (`devices/qemu` is) or is a git repository of its own
+that `tools/hakios-device.py sync` cloned into place (the others are): the tools look for `socs/*/soc.conf` and
+`devices/*/device.conf`, whatever put them there. The common repository ignores what `sync` clones.
## A device repository
@@ -73,7 +74,11 @@ its own.
```
soc sc7280
- path socs/sc7280 kept in this tree
+ repository https://github.com/shimoku74/hakios-sc7280-common.git
+ revision 977fc7181fc1eb984c4ebd4bb64c65a4d65f549a
+
+device qemu
+ path devices/qemu kept in the common tree
device sheng
repository https://github.com/<you>/hakios-device-sheng.git