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
The whitelist lets the Makefile, the licenses, NOTICE and the device layer in
shimoku74ea3fadaabc50
diff --git a/.gitignore b/.gitignoreindex 875ea0a..50e0864 100644--- a/.gitignore+++ b/.gitignore@@ -4,6 +4,11 @@/*!/.gitignore!/README.md+!/Makefile+!/LICENSE+!/LICENSE.APSL+!/NOTICE+!/devices/!/docs/!/xl!/mkxnuimg.py@@ -16,7 +21,6 @@!/sysimage/!/xnu/!/xnu-deps/-!/uefi/!/prebuilt/!/wifi/diff --git a/LICENSE b/LICENSEnew file mode 100644index 0000000..212f57a--- /dev/null+++ b/LICENSE@@ -0,0 +1,40 @@+HakiOS++Two licenses apply, by directory:++1. The kernel: xnu/redwood.patch and everything under xnu/files/ are a derivative work of+ Apple's XNU and are licensed under the Apple Public Source License, Version 2.0, whose full+ text is in LICENSE.APSL. Per its terms the modifications are published here as source and+ Apple's notices are kept in the files they belong to.++2. Everything else that is ours (the boot loader in xnuloader/, the user-space code in+ userland/src/, the tools, the scripts, the documentation, the device layer under devices/)+ is licensed under the MIT License below.++Third-party components and their licenses are listed in NOTICE. iOS, the iOS 16.5 IPSW, Apple's+trademarks and the phone's own firmware are not part of this repository and are not licensed by+it; every user obtains them from their own device and their own copy of the firmware.++----------------------------------------------------------------------------------------------++MIT License++Copyright (c) 2025-2026 the HakiOS authors++Permission is hereby granted, free of charge, to any person obtaining a copy+of this software and associated documentation files (the "Software"), to deal+in the Software without restriction, including without limitation the rights+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell+copies of the Software, and to permit persons to whom the Software is+furnished to do so, subject to the following conditions:++The above copyright notice and this permission notice shall be included in all+copies or substantial portions of the Software.++THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE+SOFTWARE.diff --git a/LICENSE.APSL b/LICENSE.APSLnew file mode 100644index 0000000..fe81a60--- /dev/null+++ b/LICENSE.APSL@@ -0,0 +1,367 @@+APPLE PUBLIC SOURCE LICENSE+Version 2.0 - August 6, 2003++Please read this License carefully before downloading this software.+By downloading or using this software, you are agreeing to be bound by+the terms of this License. If you do not or cannot agree to the terms+of this License, please do not download or use the software.++1. General; Definitions. This License applies to any program or other+work which Apple Computer, Inc. ("Apple") makes publicly available and+which contains a notice placed by Apple identifying such program or+work as "Original Code" and stating that it is subject to the terms of+this Apple Public Source License version 2.0 ("License"). As used in+this License:++1.1 "Applicable Patent Rights" mean: (a) in the case where Apple is+the grantor of rights, (i) claims of patents that are now or hereafter+acquired, owned by or assigned to Apple and (ii) that cover subject+matter contained in the Original Code, but only to the extent+necessary to use, reproduce and/or distribute the Original Code+without infringement; and (b) in the case where You are the grantor of+rights, (i) claims of patents that are now or hereafter acquired,+owned by or assigned to You and (ii) that cover subject matter in Your+Modifications, taken alone or in combination with Original Code.++1.2 "Contributor" means any person or entity that creates or+contributes to the creation of Modifications.++1.3 "Covered Code" means the Original Code, Modifications, the+combination of Original Code and any Modifications, and/or any+respective portions thereof.++1.4 "Externally Deploy" means: (a) to sublicense, distribute or+otherwise make Covered Code available, directly or indirectly, to+anyone other than You; and/or (b) to use Covered Code, alone or as+part of a Larger Work, in any way to provide a service, including but+not limited to delivery of content, through electronic communication+with a client other than You.++1.5 "Larger Work" means a work which combines Covered Code or portions+thereof with code not governed by the terms of this License.++1.6 "Modifications" mean any addition to, deletion from, and/or change+to, the substance and/or structure of the Original Code, any previous+Modifications, the combination of Original Code and any previous+Modifications, and/or any respective portions thereof. When code is+released as a series of files, a Modification is: (a) any addition to+or deletion from the contents of a file containing Covered Code;+and/or (b) any new file or other representation of computer program+statements that contains any part of Covered Code.++1.7 "Original Code" means (a) the Source Code of a program or other+work as originally made available by Apple under this License,+including the Source Code of any updates or upgrades to such programs+or works made available by Apple under this License, and that has been+expressly identified by Apple as such in the header file(s) of such+work; and (b) the object code compiled from such Source Code and+originally made available by Apple under this License.++1.8 "Source Code" means the human readable form of a program or other+work that is suitable for making modifications to it, including all+modules it contains, plus any associated interface definition files,+scripts used to control compilation and installation of an executable+(object code).++1.9 "You" or "Your" means an individual or a legal entity exercising+rights under this License. For legal entities, "You" or "Your"+includes any entity which controls, is controlled by, or is under+common control with, You, where "control" means (a) the power, direct+or indirect, to cause the direction or management of such entity,+whether by contract or otherwise, or (b) ownership of fifty percent+(50%) or more of the outstanding shares or beneficial ownership of+such entity.++2. Permitted Uses; Conditions & Restrictions. Subject to the terms+and conditions of this License, Apple hereby grants You, effective on+the date You accept this License and download the Original Code, a+world-wide, royalty-free, non-exclusive license, to the extent of+Apple's Applicable Patent Rights and copyrights covering the Original+Code, to do the following:++2.1 Unmodified Code. You may use, reproduce, display, perform,+internally distribute within Your organization, and Externally Deploy+verbatim, unmodified copies of the Original Code, for commercial or+non-commercial purposes, provided that in each instance:++(a) You must retain and reproduce in all copies of Original Code the+copyright and other proprietary notices and disclaimers of Apple as+they appear in the Original Code, and keep intact all notices in the+Original Code that refer to this License; and++(b) You must include a copy of this License with every copy of Source+Code of Covered Code and documentation You distribute or Externally+Deploy, and You may not offer or impose any terms on such Source Code+that alter or restrict this License or the recipients' rights+hereunder, except as permitted under Section 6.++2.2 Modified Code. You may modify Covered Code and use, reproduce,+display, perform, internally distribute within Your organization, and+Externally Deploy Your Modifications and Covered Code, for commercial+or non-commercial purposes, provided that in each instance You also+meet all of these conditions:++(a) You must satisfy all the conditions of Section 2.1 with respect to+the Source Code of the Covered Code;++(b) You must duplicate, to the extent it does not already exist, the+notice in Exhibit A in each file of the Source Code of all Your+Modifications, and cause the modified files to carry prominent notices+stating that You changed the files and the date of any change; and++(c) If You Externally Deploy Your Modifications, You must make+Source Code of all Your Externally Deployed Modifications either+available to those to whom You have Externally Deployed Your+Modifications, or publicly available. Source Code of Your Externally+Deployed Modifications must be released under the terms set forth in+this License, including the license grants set forth in Section 3+below, for as long as you Externally Deploy the Covered Code or twelve+(12) months from the date of initial External Deployment, whichever is+longer. You should preferably distribute the Source Code of Your+Externally Deployed Modifications electronically (e.g. download from a+web site).++2.3 Distribution of Executable Versions. In addition, if You+Externally Deploy Covered Code (Original Code and/or Modifications) in+object code, executable form only, You must include a prominent+notice, in the code itself as well as in related documentation,+stating that Source Code of the Covered Code is available under the+terms of this License with information on how and where to obtain such+Source Code.++2.4 Third Party Rights. You expressly acknowledge and agree that+although Apple and each Contributor grants the licenses to their+respective portions of the Covered Code set forth herein, no+assurances are provided by Apple or any Contributor that the Covered+Code does not infringe the patent or other intellectual property+rights of any other entity. Apple and each Contributor disclaim any+liability to You for claims brought by any other entity based on+infringement of intellectual property rights or otherwise. As a+condition to exercising the rights and licenses granted hereunder, You+hereby assume sole responsibility to secure any other intellectual+property rights needed, if any. For example, if a third party patent+license is required to allow You to distribute the Covered Code, it is+Your responsibility to acquire that license before distributing the+Covered Code.++3. Your Grants. In consideration of, and as a condition to, the+licenses granted to You under this License, You hereby grant to any+person or entity receiving or distributing Covered Code under this+License a non-exclusive, royalty-free, perpetual, irrevocable license,+under Your Applicable Patent Rights and other intellectual property+rights (other than patent) owned or controlled by You, to use,+reproduce, display, perform, modify, sublicense, distribute and+Externally Deploy Your Modifications of the same scope and extent as+Apple's licenses under Sections 2.1 and 2.2 above.++4. Larger Works. You may create a Larger Work by combining Covered+Code with other code not governed by the terms of this License and+distribute the Larger Work as a single product. In each such instance,+You must make sure the requirements of this License are fulfilled for+the Covered Code or any portion thereof.++5. Limitations on Patent License. Except as expressly stated in+Section 2, no other patent rights, express or implied, are granted by+Apple herein. Modifications and/or Larger Works may require additional+patent licenses from Apple which Apple may grant in its sole+discretion.++6. Additional Terms. You may choose to offer, and to charge a fee for,+warranty, support, indemnity or liability obligations and/or other+rights consistent with the scope of the license granted herein+("Additional Terms") to one or more recipients of Covered Code.+However, You may do so only on Your own behalf and as Your sole+responsibility, and not on behalf of Apple or any Contributor. You+must obtain the recipient's agreement that any such Additional Terms+are offered by You alone, and You hereby agree to indemnify, defend+and hold Apple and every Contributor harmless for any liability+incurred by or claims asserted against Apple or such Contributor by+reason of any such Additional Terms.++7. Versions of the License. Apple may publish revised and/or new+versions of this License from time to time. Each version will be given+a distinguishing version number. Once Original Code has been published+under a particular version of this License, You may continue to use it+under the terms of that version. You may also choose to use such+Original Code under the terms of any subsequent version of this+License published by Apple. No one other than Apple has the right to+modify the terms applicable to Covered Code created under this+License.++8. NO WARRANTY OR SUPPORT. The Covered Code may contain in whole or in+part pre-release, untested, or not fully tested works. The Covered+Code may contain errors that could cause failures or loss of data, and+may be incomplete or contain inaccuracies. You expressly acknowledge+and agree that use of the Covered Code, or any portion thereof, is at+Your sole and entire risk. THE COVERED CODE IS PROVIDED "AS IS" AND+WITHOUT WARRANTY, UPGRADES OR SUPPORT OF ANY KIND AND APPLE AND+APPLE'S LICENSOR(S) (COLLECTIVELY REFERRED TO AS "APPLE" FOR THE+PURPOSES OF SECTIONS 8 AND 9) AND ALL CONTRIBUTORS EXPRESSLY DISCLAIM+ALL WARRANTIES AND/OR CONDITIONS, EXPRESS OR IMPLIED, INCLUDING, BUT+NOT LIMITED TO, THE IMPLIED WARRANTIES AND/OR CONDITIONS OF+MERCHANTABILITY, OF SATISFACTORY QUALITY, OF FITNESS FOR A PARTICULAR+PURPOSE, OF ACCURACY, OF QUIET ENJOYMENT, AND NONINFRINGEMENT OF THIRD+PARTY RIGHTS. APPLE AND EACH CONTRIBUTOR DOES NOT WARRANT AGAINST+INTERFERENCE WITH YOUR ENJOYMENT OF THE COVERED CODE, THAT THE+FUNCTIONS CONTAINED IN THE COVERED CODE WILL MEET YOUR REQUIREMENTS,+THAT THE OPERATION OF THE COVERED CODE WILL BE UNINTERRUPTED OR+ERROR-FREE, OR THAT DEFECTS IN THE COVERED CODE WILL BE CORRECTED. NO+ORAL OR WRITTEN INFORMATION OR ADVICE GIVEN BY APPLE, AN APPLE+AUTHORIZED REPRESENTATIVE OR ANY CONTRIBUTOR SHALL CREATE A WARRANTY.+You acknowledge that the Covered Code is not intended for use in the+operation of nuclear facilities, aircraft navigation, communication+systems, or air traffic control machines in which case the failure of+the Covered Code could lead to death, personal injury, or severe+physical or environmental damage.++9. LIMITATION OF LIABILITY. TO THE EXTENT NOT PROHIBITED BY LAW, IN NO+EVENT SHALL APPLE OR ANY CONTRIBUTOR BE LIABLE FOR ANY INCIDENTAL,+SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES ARISING OUT OF OR RELATING+TO THIS LICENSE OR YOUR USE OR INABILITY TO USE THE COVERED CODE, OR+ANY PORTION THEREOF, WHETHER UNDER A THEORY OF CONTRACT, WARRANTY,+TORT (INCLUDING NEGLIGENCE), PRODUCTS LIABILITY OR OTHERWISE, EVEN IF+APPLE OR SUCH CONTRIBUTOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH+DAMAGES AND NOTWITHSTANDING THE FAILURE OF ESSENTIAL PURPOSE OF ANY+REMEDY. SOME JURISDICTIONS DO NOT ALLOW THE LIMITATION OF LIABILITY OF+INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS LIMITATION MAY NOT APPLY+TO YOU. In no event shall Apple's total liability to You for all+damages (other than as may be required by applicable law) under this+License exceed the amount of fifty dollars ($50.00).++10. Trademarks. This License does not grant any rights to use the+trademarks or trade names "Apple", "Apple Computer", "Mac", "Mac OS",+"QuickTime", "QuickTime Streaming Server" or any other trademarks,+service marks, logos or trade names belonging to Apple (collectively+"Apple Marks") or to any trademark, service mark, logo or trade name+belonging to any Contributor. You agree not to use any Apple Marks in+or as part of the name of products derived from the Original Code or+to endorse or promote products derived from the Original Code other+than as expressly permitted by and in strict compliance at all times+with Apple's third party trademark usage guidelines which are posted+at http://www.apple.com/legal/guidelinesfor3rdparties.html.++11. Ownership. Subject to the licenses granted under this License,+each Contributor retains all rights, title and interest in and to any+Modifications made by such Contributor. Apple retains all rights,+title and interest in and to the Original Code and any Modifications+made by or on behalf of Apple ("Apple Modifications"), and such Apple+Modifications will not be automatically subject to this License. Apple+may, at its sole discretion, choose to license such Apple+Modifications under this License, or on different terms from those+contained in this License or may choose not to license them at all.++12. Termination.++12.1 Termination. This License and the rights granted hereunder will+terminate:++(a) automatically without notice from Apple if You fail to comply with+any term(s) of this License and fail to cure such breach within 30+days of becoming aware of such breach;++(b) immediately in the event of the circumstances described in Section+13.5(b); or++(c) automatically without notice from Apple if You, at any time during+the term of this License, commence an action for patent infringement+against Apple; provided that Apple did not first commence+an action for patent infringement against You in that instance.++12.2 Effect of Termination. Upon termination, You agree to immediately+stop any further use, reproduction, modification, sublicensing and+distribution of the Covered Code. All sublicenses to the Covered Code+which have been properly granted prior to termination shall survive+any termination of this License. Provisions which, by their nature,+should remain in effect beyond the termination of this License shall+survive, including but not limited to Sections 3, 5, 8, 9, 10, 11,+12.2 and 13. No party will be liable to any other for compensation,+indemnity or damages of any sort solely as a result of terminating+this License in accordance with its terms, and termination of this+License will be without prejudice to any other right or remedy of+any party.++13. Miscellaneous.++13.1 Government End Users. The Covered Code is a "commercial item" as+defined in FAR 2.101. Government software and technical data rights in+the Covered Code include only those rights customarily provided to the+public as defined in this License. This customary commercial license+in technical data and software is provided in accordance with FAR+12.211 (Technical Data) and 12.212 (Computer Software) and, for+Department of Defense purchases, DFAR 252.227-7015 (Technical Data --+Commercial Items) and 227.7202-3 (Rights in Commercial Computer+Software or Computer Software Documentation). Accordingly, all U.S.+Government End Users acquire Covered Code with only those rights set+forth herein.++13.2 Relationship of Parties. This License will not be construed as+creating an agency, partnership, joint venture or any other form of+legal association between or among You, Apple or any Contributor, and+You will not represent to the contrary, whether expressly, by+implication, appearance or otherwise.++13.3 Independent Development. Nothing in this License will impair+Apple's right to acquire, license, develop, have others develop for+it, market and/or distribute technology or products that perform the+same or similar functions as, or otherwise compete with,+Modifications, Larger Works, technology or products that You may+develop, produce, market or distribute.++13.4 Waiver; Construction. Failure by Apple or any Contributor to+enforce any provision of this License will not be deemed a waiver of+future enforcement of that or any other provision. Any law or+regulation which provides that the language of a contract shall be+construed against the drafter will not apply to this License.++13.5 Severability. (a) If for any reason a court of competent+jurisdiction finds any provision of this License, or portion thereof,+to be unenforceable, that provision of the License will be enforced to+the maximum extent permissible so as to effect the economic benefits+and intent of the parties, and the remainder of this License will+continue in full force and effect. (b) Notwithstanding the foregoing,+if applicable law prohibits or restricts You from fully and/or+specifically complying with Sections 2 and/or 3 or prevents the+enforceability of either of those Sections, this License will+immediately terminate and You must immediately discontinue any use of+the Covered Code and destroy all copies of it that are in your+possession or control.++13.6 Dispute Resolution. Any litigation or other dispute resolution+between You and Apple relating to this License shall take place in the+Northern District of California, and You and Apple hereby consent to+the personal jurisdiction of, and venue in, the state and federal+courts within that District with respect to this License. The+application of the United Nations Convention on Contracts for the+International Sale of Goods is expressly excluded.++13.7 Entire Agreement; Governing Law. This License constitutes the+entire agreement between the parties with respect to the subject+matter hereof. This License shall be governed by the laws of the+United States and the State of California, except that body of+California law concerning conflicts of law.++Where You are located in the province of Quebec, Canada, the following+clause applies: The parties hereby confirm that they have requested+that this License and all related documents be drafted in English. Les+parties ont exige que le present contrat et tous les documents+connexes soient rediges en anglais.++EXHIBIT A.++"Portions Copyright (c) 1999-2003 Apple Computer, Inc. All Rights+Reserved.++This file contains Original Code and/or Modifications of Original Code+as defined in and that are subject to the Apple Public Source License+Version 2.0 (the 'License'). You may not use this file except in+compliance with the License. Please obtain a copy of the License at+http://www.opensource.apple.com/apsl/ and read it before using this+file.++The Original Code and all software distributed under the License are+distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER+EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,+INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,+FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.+Please see the License for the specific language governing rights and+limitations under the License."diff --git a/Makefile b/Makefilenew file mode 100644index 0000000..dc81bd9--- /dev/null+++ b/Makefile@@ -0,0 +1,61 @@+# HakiOS: one Makefile at the top, the way an Android tree has one. Every target is a script+# below it; run the script itself for its options.+#+# make help+# make fetch the OS files from the iOS 16.5 IPSW into sysimage/ (sysimage/fetch.sh)+# make images userland/root.apfs and userland/system.apfs (userland/build.sh)+# make kernel the kernel from source (xnu/apply.sh, xnu-deps/setup.sh, xnu-build.sh)+# make loader the boot loader, with identity.h made from your IPSW (xnuloader/build.sh)+# make firmware the phone's firmware off the phone over adb (devices/$(DEVICE)/pull-firmware.sh)+# make qemu a 20-minute session in QEMU+# make phone a session on the phone, then back to Android (tools/modem-cycle.sh)+# make prebuilt refresh prebuilt/ from what was built (tools/update-prebuilt.sh)+# make clean build output of the kernel, loader and images+#+# DEVICE=redwood the device directory under devices/ (default redwood)+# ARGS="..." kernel arguments for make phone (default: everything the phone has)+# SECS=600 the session's length for make phone / make qemu+# JOBS=8 parallel jobs for the kernel build++DEVICE ?= redwood+JOBS ?= 8+SECS ?= 600+ARGS ?= touchscreen=1 gpu=1 adsp=1 sound=4 wifi=1 haptic=5 modem=1 modem_again=1 modem_buffer=0xa8000000+IMAGE_OPTS ?= REST=1++.PHONY: help fetch images kernel loader firmware qemu phone prebuilt clean all++help:+ @sed -n '2,20p' Makefile | sed 's/^# \{0,1\}//'++all: kernel loader images++fetch:+ sysimage/fetch.sh++images:+ $(IMAGE_OPTS) userland/build.sh++kernel:+ [ -d xnu-src/xnu-8796.121.2 ] || xnu/apply.sh+ [ -x xnu-deps/host/bin/xnu-clang ] || xnu-deps/setup.sh+ ./xnu-build.sh -j$(JOBS) -k++loader:+ xnuloader/build.sh++firmware:+ devices/$(DEVICE)/pull-firmware.sh++qemu:+ mkdir -p logs+ qemu/run-ios.sh $(SECS) -display gtk | tee logs/qemu.log++phone:+ XL_SB_DELAY=8 tools/modem-cycle.sh "$(ARGS)" $(SECS)++prebuilt:+ tools/update-prebuilt.sh++clean:+ rm -rf xnu-src/xnu-8796.121.2/BUILD xnuloader/loader.obj xnuloader/loader.efi userland/root.apfs userland/system.apfs userland/objdiff --git a/NOTICE b/NOTICEnew file mode 100644index 0000000..b061008--- /dev/null+++ b/NOTICE@@ -0,0 +1,25 @@+Third-party components in or used by HakiOS++In the repository:++- XNU (Apple): the kernel sources are fetched by xnu/apply.sh from github.com/apple-oss-distributions/xnu;+ our patch and files are a derivative work under the Apple Public Source License 2.0 (LICENSE.APSL).+- libdeflate (Eric Biggers), xnu/files/bsd/miscfs/apfs/libdeflate/: MIT, see its COPYING.+- mkbootimg.py (Android Open Source Project), devices/redwood/prebuilt/mkbootimg.py: Apache License 2.0.+- Mu-Silicium / Project Mu (Project Silicium, Microsoft and contributors): devices/redwood/uefi/ holds a+ patch and files against it; their license applies to the derived parts (BSD-2-Clause-Patent).+- UEFI driver binaries of the phone's own firmware, devices/redwood/uefi/files/Binaries/redwood/: the+ vendor's (Qualcomm/Xiaomi), extracted from the phone's xbl.img the way Project Silicium redistributes+ such drivers for other phones. They are needed only to rebuild the UEFI image; they can be removed and+ extracted by each user from their own phone's firmware with UEFIReader.++Fetched at build time, never committed:++- the iOS 16.5 IPSW (Apple): the user space of the system image; sysimage/fetch.sh downloads it from+ Apple's public servers; its license is Apple's.+- the iPhoneOS 16.5 SDK from github.com/theos/sdks, and theos's cctools (Apple's open-source cctools): the+ kernel's and user space's build tools.+- the phone's firmware (GPU, Wi-Fi, audio DSP, modem, haptics, cameras): the vendor's, pulled from the+ user's own phone (devices/redwood/pull-firmware.sh).+- lzfse (Apple, BSD-3-Clause), built by xnuloader/mkidentity.sh when no LZFSE decoder is installed.+- Mesa (for GL=1 images), Procursus and Sileo packages (tools/mk-jb.sh): their own licenses.diff --git a/devices/redwood/README.md b/devices/redwood/README.mdnew file mode 100644index 0000000..5b0f361--- /dev/null+++ b/devices/redwood/README.md@@ -0,0 +1,33 @@+# Device: POCO X5 Pro 5G (redwood)++Everything in HakiOS that belongs to one phone is here. The kernel, loader and user space above+know nothing about the phone: addresses, interrupts, power rails and firmware come from its device+tree and its Android. A port to another Qualcomm phone is another directory like this one.++| What | Where |+|---|---|+| SoC | Qualcomm Snapdragon 778G (SM7325, "yupik" in the device tree) |+| UEFI for the phone | `uefi/`: a port of Mu-Silicium (a patch and files; `apply.sh` clones and applies, `export.sh` saves) |+| Prebuilt UEFI images | `prebuilt/`: `SILICIUM_UEFI.fd`, `BootShim.bin`, the device tree `redwood.dtb` (the phone's Android kernel's), `ramdisk`, `mkbootimg.py` |+| The phone's firmware | **not in the repository**: `pull-firmware.sh` pulls it off your phone over `adb` into `fw-*/` at the top |+| Tools | `tools/modem_firmware.py` (the modem image by the device tree), `tools/cellular_probe.py` (the modem's nodes in the device tree) |++What the kernel does for this phone in particular is the drivers `xnu/files/bsd/dev/redwood_*.c`+(display, Goodix touch, UFS, Adreno 642L, WCN6750 Wi-Fi, the audio DSP, the modem, the Awinic+haptics, the cameras); the head of each file says where its numbers come from. That is the map of+what to rewrite for another phone.++## Firmware++```sh+devices/redwood/pull-firmware.sh # the phone in Android, on adb+```++Pulls the GPU (`fw-gpu/`), Wi-Fi (`fw-wifi/`), the audio DSP (`fw-audio/`, battery and charging+come through it), the vibration motor (`fw-haptic/`), the modem (`fw-modem/`, with `image/` for its+TFTP) and the cameras (`fw-camera/`). All of it is the vendor's and stays out of git.++## Running++From the top of the repository, see the main README: `./xl enter`, `./xl ramdisk`, `./xl run`,+or everything in one command: `tools/modem-cycle.sh "ARGS" SECS`, or `make phone`.diff --git a/devices/redwood/pull-firmware.sh b/devices/redwood/pull-firmware.shnew file mode 100755index 0000000..7b6ea26--- /dev/null+++ b/devices/redwood/pull-firmware.sh@@ -0,0 +1,20 @@+#!/bin/bash+# Pull the phone's own firmware out of its Android into the fw-*/ directories at the top of the+# repository (never committed: it is the vendor's). The phone is on adb, in Android.+set -e+cd "$(dirname "$0")/../.."+pull() { # DIR SOURCE... (missing files are told, not fatal)+ local dir=$1; shift+ mkdir -p "$dir"+ for f in "$@"; do adb pull "$f" "$dir/" >/dev/null 2>&1 || echo "pull-firmware.sh: $f: not on the phone"; done+ echo "pull-firmware.sh: $dir: $(ls -1 "$dir" | wc -l | tr -d ' ') files"+}+adb get-state >/dev/null+pull fw-gpu /vendor/firmware/a660_gmu.bin /vendor/firmware/a660_sqe.fw /vendor/firmware/a660_zap.mdt /vendor/firmware/a660_zap.b00 /vendor/firmware/a660_zap.b01 /vendor/firmware/a660_zap.b02+pull fw-wifi $(for i in mdt b02 b03 b04 b05 b06 b07; do echo /vendor/firmware_mnt/image/wpss.$i; done)+pull fw-audio /vendor/firmware_mnt/image/adsp.mdt $(for i in $(seq -w 2 36); do echo /vendor/firmware_mnt/image/adsp.b$i; done)+pull fw-haptic /vendor/firmware/aw8697_haptic.bin+pull fw-modem /vendor/firmware_mnt/image/modem.mdt $(for i in $(seq -w 0 28); do echo /vendor/firmware_mnt/image/modem.b$i; done)+mkdir -p fw-modem/image && adb pull /vendor/firmware_mnt/image fw-modem/ >/dev/null 2>&1 && echo "pull-firmware.sh: fw-modem/image: the modem's own files (TFTP)"+pull fw-camera $(adb shell ls /vendor/lib64/camera/com.qti.sensormodule.redwood_*.bin /vendor/lib64/camera/com.qti.tuned.redwood_*.bin 2>/dev/null | tr -d '\r')+echo "pull-firmware.sh: done; Wi-Fi also wants fw-wifi/mac (the radio's address) and fw-wifi/network (the network's name and passphrase)"