update simple guide and add Debug.md

Author: sunflower2333

.vitepress/en.ts

@@ -58,7 +58,8 @@ function sidebarDocs(): DefaultTheme.SidebarItem[] {
       items: [
         { text: 'UEFI Porting Guide', link: '/PortingGuides/SimpleGuide'},
         { text: 'Definitions', link: '/PortingGuides/DefinesGuidance'},
-        { text: '[Deprecated]Find Protocol Addresses For Kailua', link: '/PortingGuides/FindProtocolAddressesForKailua'},
+        { text: 'Debugging', link: '/PortingGuides/Debug'},
+        { text: '[Deprecated]Find Protocol Addresses', link: '/PortingGuides/FindProtocolAddresses'},
       ]
     },
     {

.vitepress/zh.ts

@@ -46,7 +46,7 @@ function sidebarDocs(): DefaultTheme.SidebarItem[] {
       items: [
         { text: 'Project-Aloha', link: '/Introduction/organization'},
         { text: 'mu_aloha_platforms', link: '/Introduction/mu_aloha_platforms'},
-        { text: 'CrDK', link: '/Introduction/CrDK'},
+        { text: 'Crane开发套件', link: '/Introduction/CrDK'},
         { text: '移植状态', link: '/PortingStatus/PortingStatus'}
       ]
     },
@@ -62,7 +62,8 @@ function sidebarDocs(): DefaultTheme.SidebarItem[] {
     {
       text: 'UEFI移植',
       items: [
-        { text: '简易移植教程', link: '/PortingGuides/SimpleGuide'}
+        { text: '设备移植简述', link: '/PortingGuides/SimpleGuide'},
+        { text: '调试', link: '/PortingGuides/Debug'}
       ]
     },
     {

PortingGuides/Debug.md

@@ -0,0 +1,31 @@
+# Debugging Skills
+
+## Enable log output
+Our UEFI provides 4 ways currently for getting UEFI logs.
+```
+  USE_SCREEN_FOR_SERIAL_OUTPUT    = 0
+  USE_UART_GENI_FOR_SERIAL_OUTPUT = 0
+  USE_UART_DM_FOR_SERIAL_OUTPUT   = 0
+  USE_MEMORY_FOR_SERIAL_OUTPUT    = 0
+```
+Only one of them can be enabled at the same time.
+
+### USE_SCREEN_FOR_SERIAL_OUTPUT
+Set to **1** to enable serial output via screen. Logs will be printed to screen
+directly. This way is very **useful** for devices without a UART.
+
+### USE_UART_GENI_FOR_SERIAL_OUTPUT
+Set to **1** to enable serial output via a real serial port. Logs will be printed
+to the geni uart address at `gAndromedaPkgTokenSpaceGuid.PcdUartSerialBase` which is defined in
+*Silicon/QC/XXX/QcomPkg/QcomPkg.dsc.inc*.
+
+### USE_UART_DM_FOR_SERIAL_OUTPUT
+Similar to **USE_UART_GENI_FOR_SERIAL_OUTPUT**. It's used for older Qualcomm platforms like msm8996.
+
+### USE_MEMORY_FOR_SERIAL_OUTPUT
+Set to **1** to print logs to pstore memory. It's useful when you have JTAG or EUD enabled on your
+device. The log output region is defined in your device's *Library/PlatformMemoryMapLib/PlatformMemoryMapLib.c*.  
+The region must be named *PStore* like this:
+```
+{"PStore", <StartAddress>, <Size>, AddMem, MEM_RES, SYS_MEM_CAP, Reserv, WRITE_THROUGH_XN},
+```

PortingGuides/DefinesGuidance.md

@@ -11,27 +11,7 @@
     - If `HAS_MLVM = TRUE`, the MLVM regions will be reserved, so HLOS will not use this region.
     - Total RAM size will decrease about 400MB.
   * Where used it ?
-    - `HAS_MLVM` is used in `Platforms/SurfaceDuoFamilyPkg/Driver/RamPartitionDxe/ExtendedMemoryMap.h`.
-
-## **CUST_PLATFORM_PRE_PI_LIB**  
-  :::warning Deprecated
-  This definition and codes are removed.  
-  Please use DualBoot Patcher build dual boot kernel.
-  :::
-  * Type
-    - Boolean
-  * Why define it ?
-    - Some device may want to customized `IsLinuxBootRequested()` function in Library/PlatformPrePiLib/PlatformUtils.c 
-    - The `IsLinuxBootRequested()` function is used to judge the direction where to boot.
-      + return `TRUE`
-        * boot to Android
-      + return `FALSE`
-        * boot to UEFI
-  * What happened when **1**?
-    - The build-system will try to find PlatformPrePiLib under `Device/$(brand-codename)/Library/PlatformPrePiLib/`
-  * Where used it ?
-    - `CUST_PLATFORM_PRE_PI_LIB`  is used in `Platforms/SurfaceDuoFamilyPkg/SurfaceDuoFamily.dsc.inc`
-    - Line: 395
+    - `HAS_MLVM` is used in `Platforms/AndromedaPkg/Driver/RamPartitionDxe/ExtendedMemoryMap.h`.
 
 ## **CUST_LOGO**  
   * Type
@@ -41,4 +21,4 @@
   * What happened when **1**?
     - The Boot Logo will be replaced with the one under `Device/$(brand-codename)/Include/Resources/CustBootLogo.bmp`
   * Where used it ?
-    - `CUST_LOGO` is used in `Platforms/SurfaceDuoFamilyPkg/Frontpage.fdf.inc`
+    - `CUST_LOGO` is used in `Platforms/AndromedaPkg/Frontpage.fdf.inc`

…Guides/FindProtocolAddressesForKailua.md PortingGuides/FindProtocolAddresses.mdPortingGuides/FindProtocolAddressesForKailua.md renamed to PortingGuides/FindProtocolAddresses.md PortingGuides/FindProtocolAddressesForKailua.md renamed to PortingGuides/FindProtocolAddresses.md

@@ -1,9 +1,10 @@
-# Find Protocol Addresses For Kailua
+# Find Protocol Addresses
 :::warning WARNING
-This page is deprecated now, new uefi supports find address at run time.
+This page is deprecated now, new uefi supports find address at runtime.
+You only need to read this page when the online locator in uefi does not work.
 :::
 
-On Sm8550, many uefi drivers need ***scheduler*** protocol and ***xbldt*** protocol.  
+On Sm8550 and newer platforms, many uefi drivers need ***scheduler*** protocol and ***xbldt*** protocol.  
 Our solution is to reserve the original *UEFI FD* region in XBL's memory map, find the addresses in decompile tool, then provide these protocols again.
 ___
 
@@ -37,20 +38,20 @@ ___
         - Waiting Decompile finish.
         - Press `Alt+B`.
         - Type `E8 E1 06 3A F6 61 EB 11 BB ED 4B 47 6E 2F F6 A7`, Click **OK**.
-            <img src="/PortingGuides/Resources/FindProtocolAddressesForKailua/IDABinarySearch.png" width=80%/>
+            <img src="/PortingGuides/Resources/FindProtocolAddresses/IDABinarySearch.png" width=80%/>
         - Double Click the only result, the tool will jump to IDA `View-A`.
         - Click the label (e.g. *unk_A703B290*), then press `x`, Click **OK**.
-            <img src="/PortingGuides/Resources/FindProtocolAddressesForKailua/IDAXrefs.png" width=80%/>
+            <img src="/PortingGuides/Resources/FindProtocolAddresses/IDAXrefs.png" width=80%/>
         - Select the instruction that 2 instractions before *ADRL X0,unk_A703B290*(it is *ADRL X8, unk_A703B0C8* here.).
-            <img src="/PortingGuides/Resources/FindProtocolAddressesForKailua/IDAViewASecDTB.png" width=80%/>
+            <img src="/PortingGuides/Resources/FindProtocolAddresses/IDAViewASecDTB.png" width=80%/>
         - Copy *A703B0C8* to your note book. This is XBL DTB Protocol Address.
         - Press `Alt+B`.
         - Type `8D BD C2 8E D7 56 EF 49 87 96 63 17 78 F8 EB F8` and Click **OK**.
         - Use the same way you just done, then you'll find the address for Schedule Protocol.
 
   4. Fill address in your device's PcdsFixedAtBuild.dsc.inc.
       - Here gives an example.  
-        <img src="/PortingGuides/Resources/FindProtocolAddressesForKailua/PcdsFixedAtBuildSample.png" width=80%/>
+        <img src="/PortingGuides/Resources/FindProtocolAddresses/PcdsFixedAtBuildSample.png" width=80%/>
 
 ## Notice & Issues
   - Fix address here may cause some issues.