#How the repositories fit

HakiOS is put together from layers, the way an Android device's source is (device/<vendor>/<name>, a <soc>-common, a manifest that names them):

hakios/                          common: the kernel port, every common driver, the loader, user space, the tools, the docs
├── devices/<name>/              a device, one repository: device.conf, configs/, drivers/, its UEFI platform, scripts
│   └── soc/                     ... and its SoC family's layer: soc.conf, configs/<soc>.config, the SoC's drivers
├── uefi/                        HakiOS's UEFI (Mu-Silicium with HakiOS's changes), one for every device
└── devices/manifest.conf        every device and the UEFI: 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 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

#device.conf

device redwood
	title       POCO X5 Pro 5G
	vendor      Xiaomi
	soc         sc7280
	defconfig   redwood_defconfig
	firmware    pull-firmware.sh
	maintainer  the HakiOS developers (README.md)
	status      touch       works     Goodix GT9916 / FocalTech FT3680 on SPI, multitouch (touchscreen=1)
	status      cellular    partial   the modem boots, sees the network; no registration yet
	status      bluetooth   missing   step one only

The device's page in this documentation (redwood) and the table of all devices are made from it by tools/docs-gen.py: the status is written once, next to the code it describes.

#The SoC's layer

A device carries its SoC family's layer with it, in soc/, so that one repository is all a device needs:

soc sc7280
	title       Qualcomm SC7280 family (SM7325 "Snapdragon 778G", QCM6490; "yupik", "kodiak")
	vendor      Qualcomm
	cores       8, the biggest is core 7
	gpu         Adreno 642L
	maintainer  the HakiOS developers (README.md)

and soc/configs/<soc>.config, the SoC's facts: CONFIG_SOC, its cores, and the drivers of the SoC family (CONFIG_HAKIOS_CPUFREQ=y, CONFIG_HAKIOS_THERMAL=y, ...), so that the device has them whatever it leaves out of its own.

Two devices with the same SoC each carry a copy. The copies must be the same: the tools take the SoC once, and refuse two copies that differ, naming both, because a build would otherwise depend on which device was checked out. tools/hakios-device.py new --soc sc7280 copies the layer from a device that has it; a SoC nobody has yet gets a new layer to fill in. A SoC many devices share can also be a repository of its own in socs/<soc>/ (a soc block in the manifest); the tools read both.

#The manifest

devices/manifest.conf names every SoC and device:

device redwood
	repository  https://github.com/oosexgang/hakios-sm7325.git
	revision    

device qemu
	path        devices/qemu                       kept in the common tree

device sheng
	repository  https://github.com/<you>/hakios-device-sheng.git
	revision    0123456789abcdef0123456789abcdef01234567

#How a device's own driver reaches the kernel

A driver in devices/<name>/drivers/<subsystem>/conf is a CONFIG_HAKIOS_<NAME> symbol like the common ones. make kernel copies its files into the kernel tree (xnu/sync-drivers.sh, through tools/hakios-config.py external-files) and writes it into XNU's conf/files as optional; xnu/export.sh leaves it out of the common patch, because it is the device's. A device repository cannot declare standard files: what every kernel has is the common repository's to decide.

#Publishing a device

1. tools/hakios-device.py check NAME passes.
2. tools/hakios-device.py split NAME ../hakios-device-NAME makes it a repository of its own.
3. Push it to a repository named hakios-device-NAME (or hakios-soc-SOC for a SoC).
4. In a pull request to the common repository: its block in devices/manifest.conf with repository and revision (tools/hakios-device.py lock NAME writes it), and nothing else.

#Compared with others