From: TAOcroatia <34100820+TAOcroatia@users.noreply.github.com>
Date: 星期六, 30 Jan 2021 22:01:56 +0000 (+0100)
Subject: Added port guide (#6)
X-Git-Tag: v0.4~98
X-Git-Url: https://git.renegade-project.org/?a=commitdiff_plain;h=bbd475782a643ad4d4357d0f7e69db2d471b1654;p=edk2-sdm845.git

Added port guide (#6)

Added a port guide and removed sony device from the list of supported devices.
---

diff --git a/README.md b/README.md
index 8c8507c..74d1ee1 100644
--- a/README.md
+++ b/README.md
@@ -1,87 +1,115 @@
-# EDK2 UEFI Firmware For Snapdragon 845 (sdm845)
-
-Attempt to create a normal EDK2 for Snapdragon 845 platform.
-
-Pull requests for new devices and device tree or ACPI fixes are welcomed!
-
-![Github](https://img.shields.io/github/downloads/edk2-porting/edk2-sdm845/total)
-![Github](https://img.shields.io/github/v/release/edk2-porting/edk2-sdm845?include_prereleases)
-
-## Resources
-
-[Telegram group (recommended)](https://t.me/joinchat/MNjTmBqHIokjweeN0SpoyA)
-
-[Discord group](https://discord.gg/XXBWfag)
-
-QQ group: 697666196
-
-## License
-This project is released under the [WTFPL LICENSE](http://www.wtfpl.net/ "WTFPL LICENSE").
-
-## WARNING
-
-**DO NOT EVER TRY TO PORT IT TO *SONY* DEVICES**
-
-**YOUR UFS WILL BE WIPED CLEAN!!!**
-
-
-**This repo only supports Snapdragon 845 (sdm845) and does not support others such as Snapdragon 855 (sm8150)**
-
-**Do not try to run on other non sdm845 devices such as Xiaomi MIX3 5G**
-
-## Dependencies
-
-Ubuntu 18.04:
-
-```bash
-sudo apt update
-sudo apt install build-essential uuid-dev iasl git nasm gcc-aarch64-linux-gnu abootimg python3-distutils python3-pil python3-git
-```
-Ubuntu 20.04 is also proved to be fine.
-
-## Supported devices
-
-1. Xiaomi MIX 2S       (polaris)
-2. Xiaomi MIX 3        (perseus)
-3. Xiaomi MI 8         (dipper)
-4. Xiaomi PocoPhone F1 (beryllium)
-5. OnePlus 6           (enchilada)
-6. OnePlus 6T          (fajita)
-7. Sony Xperia XZ2     (akari)     (Removed)
-
-## Building
-
-1.Clone this project
-
-```bash
-git clone https://github.com/edk2-porting/edk2-sdm845.git --recursive --depth=1
-```
-
-2.Build this project
-
-```bash
-bash build.sh --device DEVICE
-```
-
-3.Boot the image
-
-```bash
-fastboot boot boot_DEVICE.img
-```
-
-(DEVICE is the codename of your phone.)
-
-## Credits
-
-Special thanks to [fxsheep](https://github.com/fxsheep)
-
-MemoryMap thanks to [Lemon1Ice](https://github.com/Lemon1Ice).
-
-ACPI tables thanks to [sunshuyu](https://github.com/sunshuyu) and many other people related.
-
-SimpleFbDxe driver is from imbushuo's [Lumia950XLPkg](https://github.com/WOA-Project/Lumia950XLPkg).
-
-Also thanks to [edk2 website](https://github.com/tianocore/tianocore.github.io/wiki/Using-EDK-II-with-Native-GCC#Install_required_software_from_apt).
-
-## Simple Porting Guide
- WIP
+# EDK2 UEFI Firmware For Snapdragon 845 (sdm845)
+
+Attempt to create a normal EDK2 for Snapdragon 845 platform.
+
+Pull requests for new devices and device tree or ACPI fixes are welcomed!
+
+![Github](https://img.shields.io/github/downloads/edk2-porting/edk2-sdm845/total)
+![Github](https://img.shields.io/github/v/release/edk2-porting/edk2-sdm845?include_prereleases)
+
+## Resources
+
+[Telegram group (recommended)](https://t.me/joinchat/MNjTmBqHIokjweeN0SpoyA)
+
+[Discord group](https://discord.gg/XXBWfag)
+
+QQ group: 697666196
+
+## License
+This project is released under the [WTFPL LICENSE](http://www.wtfpl.net/ "WTFPL LICENSE").
+
+## WARNING
+
+**DO NOT EVER TRY TO PORT IT TO *SONY* DEVICES**
+
+**YOUR UFS WILL BE WIPED CLEAN!!!**
+
+
+**This repo only supports Snapdragon 845 (sdm845) and does not support others such as Snapdragon 855 (sm8150)**
+
+**Do not try to run on other non sdm845 devices such as Xiaomi MIX3 5G**
+
+## Dependencies
+
+Ubuntu 18.04:
+
+```bash
+sudo apt update
+sudo apt install build-essential uuid-dev iasl git nasm gcc-aarch64-linux-gnu abootimg python3-distutils python3-pil python3-git
+```
+Ubuntu 20.04 is also proved to be fine.
+
+## Supported devices
+
+1. Xiaomi MIX 2S       (polaris)
+2. Xiaomi MIX 3        (perseus)
+3. Xiaomi MI 8         (dipper)
+4. Xiaomi PocoPhone F1 (beryllium)
+5. OnePlus 6           (enchilada)
+6. OnePlus 6T          (fajita)
+
+## Building
+
+1.Clone this project
+
+```bash
+git clone https://github.com/edk2-porting/edk2-sdm845.git --recursive --depth=1
+```
+
+2.Build this project
+
+```bash
+bash build.sh --device DEVICE
+```
+
+3.Boot the image
+
+```bash
+fastboot boot boot_DEVICE.img
+```
+
+(DEVICE is the codename of your phone.)
+
+## Credits
+
+Special thanks to [fxsheep](https://github.com/fxsheep)
+
+MemoryMap thanks to [Lemon1Ice](https://github.com/Lemon1Ice).
+
+ACPI tables thanks to [sunshuyu](https://github.com/sunshuyu) and many other people related.
+
+SimpleFbDxe driver is from imbushuo's [Lumia950XLPkg](https://github.com/WOA-Project/Lumia950XLPkg).
+
+Also thanks to [edk2 website](https://github.com/tianocore/tianocore.github.io/wiki/Using-EDK-II-with-Native-GCC#Install_required_software_from_apt).
+
+## Porting Guide
+ 
+ 1. Install Python protobuf and uefi_firmware-parser by executing `pip install --upgrade google-api-python-client uefi_firmware` in terminal
+ 2. Download [extract_android_ota_payload](https://github.com/cyxx/extract_android_ota_payload/archive/master.zip) and extract the folder inside the archive anywhere
+ 3. Download any OTA update for your phone
+ 4. Extract payload.bin to `extract_android_ota_payload-master` folder
+ 5. Open terminal in the same folder and execute `python3 extract_android_ota_payload.py payload.bin`
+ 6. Execute `uefi-firmware-parser -b -e xbl.img`
+ 7. Change directory to `volume-******/file-9e21fd93-9c72-4c15-8c4b-e77f1db2d792`
+ 8. Execute `7z x -oextracted section0.guid`
+ 9. Open UEFITool and open the file `section0` in folder `extracted`
+ 10. In a file manager, open `edk2-sdm845/sdm845Pkg/Binary`, duplicate `dipper` folder and rename it to your device's codename
+ 11. In UEFITool, expand `UEFI image` and the volume underneath
+ 12. For each file in your device's folder replace it with UEFITool by:
+	 - expanding the DXE Driver in UEFITool with the same name as the file you are replacing
+	 - in case of file that ends with `.depex` right clicking on DXE dependency
+	 - in case of file that ends with `.efi` right clicking on PE32 Image
+	 - clicking `Extract body`
+	 - deleting the original file
+	 - saving the one you are extracting and naming it same as the deleted one
+- In case a part (ex. DXE Dependency) is missing in UEFITool, just delete that file
+ 13. Open `edk2-sdm845/sdm845Pkg` in a file manager
+ 14. Duplicate `dipper.dsc` and `dipper.fdf` and rename both to your device's codename
+ 15. Open the `.dsc` file, replace values 1080 and 2248 with your device's display width and height and save
+ 16. Open the `.fdf` file, replace every word "dipper" with your device's codename and save
+ 17. Open `edk2-sdm845` and edit `build.sh` with a text editor
+ 18. Locate device list at the top, add your device's codename and save
+
+ You can now build as usual.
+ 
+ Make sure to message the Discord or Telegram group in case you are stuck somewhere and if your port is successful, send `edk2-sdm845/sdm845Pkg/Binary/devicename` folder and `.dsc` and `.fdf` files.