devices: aml*: Rework install instructions

npjohnson · npjohnson · commit ebcb9e063fdb · 2026-01-08T19:17:33.000Z
Wiki-Wide:
  * Unconditionally `fastboot reboot bootloader` on devices utilizing
    before_recovery_install_boot_stack, as some devices load DTB/DTBO into memory
    during bootloader, and we want to ensure the newly installed ones are utilized.
  * Introduce `burn_boot` to allow maintainers to detail non-fastboot/ODIN
    boot modes that exist alongside fastboot. It will only show if a device sets it.

AML-Specific:
  * Convert `download_boot` instructions to `burn_boot` where applicable, or drop it.
    * (deadpool/sabrina): Remove `download_boot` entry (`adb reboot recovery`???)
    * (m5*): Set `download_boot` to `SW3` key.
    * (odroidc4*/radxa0*): Remove `download_boot`, as there is no way to boot
      to fastboot from a cold boot w/o UART.
    * (odroidc4*): Make `burn_boot` instructions more detailed.
    * (wade/dopinder): Set `burn_boot` to holding button, and `download_boot` to
      doing that, but then using `update` to get to fastboot.
    * (sabrina): There is no easy way to do _anything_, just let them learn from
      the before_install_sabrina instructions that detail the unlock procedure
      and exploit tool-kit.
  * Instruct users who have IR remotes (just wade really) how to navigate in recovery.
  * Instruct dev-kit users how to interact with recovery via their USB keyboard.
  * Align before_install{g12-locked,sabrina} with one another.
  * Update maintainers for m5* while here.

Change-Id: I6b81ce55b1421fadd1e2daeaae86b110befba15e
diff --git a/_data/devices/deadpool.yml b/_data/devices/deadpool.yml
@@ -11,7 +11,6 @@ cpu_freq: 1.8 GHz
 current_branch: 22.2
 custom_unlock_cmd: 'fastboot flashing unlock'
 dimensions: {depth: 15, height: 69, width: 69}
-download_boot: 'adb reboot recovery'
 gpu: ARM Mali-G31 MP2
 image: deadpool.png
 install_method: fastboot_nexus
diff --git a/_data/devices/dopinder.yml b/_data/devices/dopinder.yml
@@ -3,6 +3,7 @@ battery: None
 before_install: {instructions: 'g12-locked'}
 before_recovery_install: g12
 bluetooth: {spec: '4.2'}
+burn_boot: With the device unplugged, plug in the device while holding the <kbd>Side Button</kbd> until you see a logo on screen. At this point you can communicate with the device by utilizing Amlogic's [update](https://github.com/khadas/utils/blob/master/aml-flash-tool/tools/linux-x86/update) tool.
 cameras: []
 codename: dopinder
 cpu: Cortex-A53
@@ -11,7 +12,7 @@ cpu_freq: 1.8 GHz
 current_branch: 22.2
 custom_unlock_cmd: "fastboot oem 'setenv lock 10100000;saveenv;save'\nfastboot reboot bootloader\nfastboot flashing unlock"
 dimensions: {depth: 15, height: 69, width: 69}
-download_boot: Run `adb reboot bootloader`.
+download_boot: With the device unplugged, plug in the device while holding the <kbd>Side Button</kbd> until you see a logo on screen. At this point you can communicate with the device by utilizing Amlogic's [update](https://github.com/khadas/utils/blob/master/aml-flash-tool/tools/linux-x86/update) tool, and run 'sudo ./update bulkcmd fastboot' to enter fastboot mode.
 gpu: ARM Mali-G31 MP2
 image: dopinder.png
 install_method: fastboot_nexus
diff --git a/_data/devices/m5.yml b/_data/devices/m5.yml
@@ -1,6 +1,7 @@
 architecture: {cpu: 'arm64', userspace: 'arm'}
 battery: None
 bluetooth: {spec: '4.2'}
+burn_boot: With the device unplugged, plug in the device while holding the <kbd>SW4 Button</kbd> on the board until you see a logo on screen. At this point you can communicate with the device by utilizing Amlogic's [update](https://github.com/khadas/utils/blob/master/aml-flash-tool/tools/linux-x86/update) tool.
 cameras: []
 codename: m5
 cpu: Cortex-A53
@@ -9,12 +10,12 @@ cpu_freq: 1.8 GHz
 current_branch: 22.2
 custom_unlock_cmd: 'fastboot flashing unlock'
 dimensions: {depth: 17, height: 56, width: 85}
-download_boot: Press and hold the `SW4` button on the board, and plug into your PC.
+download_boot: With the device unplugged, plug in the device while holding the <kbd>SW3 Button</kbd> on the board until you see a logo on screen. At this point you can communicate with the device by utilizing Amlogic's [update](https://github.com/khadas/utils/blob/master/aml-flash-tool/tools/linux-x86/update) tool, and run 'sudo ./update bulkcmd fastboot' to enter fastboot mode.
 gpu: ARM Mali-G31 MP2
 image: m5.png
 install_method: amlogic_update
 kernel: {repo: android_kernel_amlogic_linux-4.9, version: '4.9'}
-maintainers: [stricted]
+maintainers: [bumerc, npjohnson, stricted]
 name: M5 (Android TV)
 network: None
 peripherals: [3.5mm jack]
diff --git a/_data/devices/m5_tab.yml b/_data/devices/m5_tab.yml
@@ -1,6 +1,7 @@
 architecture: {cpu: 'arm64', userspace: 'arm'}
 battery: None
 bluetooth: {spec: '4.2'}
+burn_boot: With the device unplugged, plug in the device while holding the <kbd>SW4 Button</kbd> on the board until you see a logo on screen. At this point you can communicate with the device by utilizing Amlogic's [update](https://github.com/khadas/utils/blob/master/aml-flash-tool/tools/linux-x86/update) tool.
 cameras: []
 codename: m5_tab
 cpu: Cortex-A53
@@ -9,12 +10,12 @@ cpu_freq: 1.8 GHz
 current_branch: 22.2
 custom_unlock_cmd: 'fastboot flashing unlock'
 dimensions: {depth: 17, height: 56, width: 85}
-download_boot: Press and hold the `SW4` button on the board, and plug into your PC.
+download_boot: With the device unplugged, plug in the device while holding the <kbd>SW3 Button</kbd> on the board until you see a logo on screen. At this point you can communicate with the device by utilizing Amlogic's [update](https://github.com/khadas/utils/blob/master/aml-flash-tool/tools/linux-x86/update) tool, and run 'sudo ./update bulkcmd fastboot' to enter fastboot mode.
 gpu: ARM Mali-G31 MP2
 image: m5.png
 install_method: amlogic_update
 kernel: {repo: android_kernel_amlogic_linux-4.9, version: '4.9'}
-maintainers: [npjohnson, stricted]
+maintainers: [bumerc, npjohnson, stricted]
 name: M5 (Tablet)
 network: None
 peripherals: [3.5mm jack]
diff --git a/_data/devices/odroidc4.yml b/_data/devices/odroidc4.yml
@@ -1,6 +1,7 @@
 architecture: {cpu: 'arm64', userspace: 'arm'}
 battery: None
 bluetooth: {spec: None}
+burn_boot: Attach a blank eMMC module to the device, plug into your PC via the Micro-USB port, and connect the device to power.
 cameras: []
 codename: odroidc4
 cpu: Cortex-A55
@@ -9,7 +10,6 @@ cpu_freq: 2.016 GHz
 current_branch: 22.2
 custom_unlock_cmd: 'fastboot flashing unlock'
 dimensions: {depth: 10, height: 56, width: 85}
-download_boot: Attach a blank eMMC module to the device, and plug into your PC.
 gpu: ARM Mali-G31 MP2
 image: odroidc4.png
 install_method: amlogic_update
diff --git a/_data/devices/odroidc4_tab.yml b/_data/devices/odroidc4_tab.yml
@@ -1,6 +1,7 @@
 architecture: {cpu: 'arm64', userspace: 'arm'}
 battery: None
 bluetooth: {spec: None}
+burn_boot: Attach a blank eMMC module to the device, plug into your PC via the Micro-USB port, and connect the device to power.
 cameras: []
 codename: odroidc4_tab
 cpu: Cortex-A55
@@ -9,7 +10,6 @@ cpu_freq: 2.016 GHz
 current_branch: 22.2
 custom_unlock_cmd: 'fastboot flashing unlock'
 dimensions: {depth: 10, height: 56, width: 85}
-download_boot: Attach a blank eMMC module to the device, and plug into your PC.
 gpu: ARM Mali-G31 MP2
 image: odroidc4.png
 install_method: amlogic_update
diff --git a/_data/devices/radxa0.yml b/_data/devices/radxa0.yml
@@ -1,6 +1,7 @@
 architecture: {cpu: 'arm64', userspace: 'arm'}
 battery: None
 bluetooth: {spec: '4.2'}
+burn_boot: Press and hold the `USB BOOT` button on the board, and plug into your PC.
 cameras: []
 codename: radxa0
 cpu: Cortex-A53
@@ -9,7 +10,6 @@ cpu_freq: 1.8 GHz
 current_branch: 22.2
 custom_unlock_cmd: 'fastboot flashing unlock'
 dimensions: {depth: 5, height: 30, width: 65}
-download_boot: Press and hold the `USB BOOT` button on the board, and plug into your PC.
 gpu: ARM Mali-G31 MP2
 image: radxa0.png
 install_method: amlogic_update
diff --git a/_data/devices/radxa02.yml b/_data/devices/radxa02.yml
@@ -1,6 +1,7 @@
 architecture: {cpu: 'arm64', userspace: 'arm'}
 battery: None
 bluetooth: {spec: '4.2'}
+burn_boot: Press and hold the `USB BOOT` button on the board, and plug into your PC.
 cameras: []
 codename: radxa02
 cpu: Cortex-A53
@@ -9,7 +10,6 @@ cpu_freq: 1.8 GHz
 current_branch: 22.2
 custom_unlock_cmd: 'fastboot flashing unlock'
 dimensions: {depth: 5.15, height: 36.25, width: 65.33}
-download_boot: Press and hold the `USB BOOT` button on the board, and plug into your PC.
 gpu: ARM Mali-G31 MP2
 image: radxa02.png
 install_method: amlogic_update
diff --git a/_data/devices/radxa02_tab.yml b/_data/devices/radxa02_tab.yml
@@ -1,6 +1,7 @@
 architecture: {cpu: 'arm64', userspace: 'arm'}
 battery: None
 bluetooth: {spec: '4.2'}
+burn_boot: Press and hold the `USB BOOT` button on the board, and plug into your PC.
 cameras: []
 codename: radxa02_tab
 cpu: Cortex-A53
@@ -9,7 +10,6 @@ cpu_freq: 1.8 GHz
 current_branch: 22.2
 custom_unlock_cmd: 'fastboot flashing unlock'
 dimensions: {depth: 5.15, height: 36.25, width: 65.33}
-download_boot: Press and hold the `USB BOOT` button on the board, and plug into your PC.
 gpu: ARM Mali-G31 MP2
 image: radxa02.png
 install_method: amlogic_update
diff --git a/_data/devices/radxa0_tab.yml b/_data/devices/radxa0_tab.yml
@@ -1,6 +1,7 @@
 architecture: {cpu: 'arm64', userspace: 'arm'}
 battery: None
 bluetooth: {spec: '4.2'}
+burn_boot: Press and hold the `USB BOOT` button on the board, and plug into your PC.
 cameras: []
 codename: radxa0_tab
 cpu: Cortex-A53
@@ -9,7 +10,6 @@ cpu_freq: 1.8 GHz
 current_branch: 22.2
 custom_unlock_cmd: 'fastboot flashing unlock'
 dimensions: {depth: 5, height: 30, width: 65}
-download_boot: Press and hold the `USB BOOT` button on the board, and plug into your PC.
 gpu: ARM Mali-G31 MP2
 image: radxa0.png
 install_method: amlogic_update
diff --git a/_data/devices/sabrina.yml b/_data/devices/sabrina.yml
@@ -10,7 +10,6 @@ cpu_freq: 1.8 GHz
 current_branch: 22.2
 custom_unlock_cmd: 'fastboot flashing unlock'
 dimensions: {depth: 12.5, height: 61, width: 161}
-download_boot: Run `adb reboot bootloader`.
 gpu: ARM Mali-G31 MP2
 image: sabrina.png
 install_method: fastboot_nexus
diff --git a/_data/devices/wade.yml b/_data/devices/wade.yml
@@ -3,6 +3,7 @@ battery: None
 before_install: {instructions: 'needs_specific_android_fw', lineage_version: 20, ships_fw: true, version: '12'}
 before_recovery_install: g12
 bluetooth: {spec: '4.2'}
+burn_boot: With the device unplugged, plug in the device while holding the <kbd>Side Button</kbd> until you see a logo on screen. At this point you can communicate with the device by utilizing Amlogic's [update](https://github.com/khadas/utils/blob/master/aml-flash-tool/tools/linux-x86/update) tool.
 cameras: []
 codename: wade
 cpu: Cortex-A53
@@ -11,7 +12,7 @@ cpu_freq: 1.8 GHz
 current_branch: 22.2
 custom_unlock_cmd: "fastboot oem 'setenv lock 10100000;saveenv;save'\nfastboot reboot bootloader\nfastboot flashing unlock"
 dimensions: {depth: 15, height: 69, width: 69}
-download_boot: Run `adb reboot bootloader`.
+download_boot: With the device unplugged, plug in the device while holding the <kbd>Side Button</kbd> until you see a logo on screen. At this point you can communicate with the device by utilizing Amlogic's [update](https://github.com/khadas/utils/blob/master/aml-flash-tool/tools/linux-x86/update) tool, and run 'sudo ./update bulkcmd fastboot' to enter fastboot mode.
 gpu: ARM Mali-G31 MP2
 image: wade.png
 install_method: fastboot_nexus
diff --git a/_includes/templates/device_info.md b/_includes/templates/device_info.md
@@ -58,7 +58,7 @@ There are multiple variants of this device. [Make sure you're viewing the right
 {% include templates/device_info_note.md %}
 {% endif %}
 
-{% if device.recovery_boot or device.download_boot %}
+{% if device.recovery_boot or device.download_boot or device.burn_boot %}
 ## Special boot modes
 
 {% if device.recovery_boot %}
@@ -70,6 +70,9 @@ There are multiple variants of this device. [Make sure you're viewing the right
 {%- if device.download_boot %}
 * **Bootloader/Fastboot/Download**: {{ device.download_boot }}
 {%- endif %}
+{%- if device.burn_boot %}
+* **Burn Mode**: {{ device.burn_boot }}
+{%- endif %}
 {%- endif %}
 
 ## Known quirks
diff --git a/_includes/templates/device_specific/before_install_g12-locked.md b/_includes/templates/device_specific/before_install_g12-locked.md
@@ -4,12 +4,12 @@
 
 These instructions will only work on devices that have not yet been updated past the April 2024 Security Patch Level to the August 2024 OTA or later.
 
+You can check this in the Settings application under the "System", "About" tab, labeled "Security Patch Level".
+
 If your device was updated past this build, it is not able to be bootloader unlocked, and you cannot run LineageOS on that device.
 
 Downgrading to older builds is not a viable option.
 
-You can check this in the Settings application under the "System", "About" tab, labeled "Security Patch Level".
-
 If you have not yet setup your device, **do not** set it up to check the version, or to toggle the OEM Unlock just proceed with the installation instructions, as the setup process forcibly updates the device. Instead proceed past this page and the next and proceed directly to [Forcibly unlocking the bootloader](https://wiki.lineageos.org/devices/{{ device.codename }}/install/#forcibly-unlocking-the-bootloader) and proceed from there.
 
 If your device is already past the setup screen, and on the April 2024 OTA or a build that preceeds it, you can proceed using the "Next Step" button below.
diff --git a/_includes/templates/device_specific/before_install_sabrina.md b/_includes/templates/device_specific/before_install_sabrina.md
@@ -1,6 +1,6 @@
 ## Unlocking the bootloader
 
-These instructions will only work on devices that have not yet been updated past the February 2021 OTA.
+These instructions will only work on devices that have not yet been updated past the February 2021 Security Patch Level.
 
 You can check this in the Settings application under the "System", "About" tab, labeled "Security Patch Level".
 
diff --git a/_includes/templates/device_specific/before_recovery_install_boot_stack.md b/_includes/templates/device_specific/before_recovery_install_boot_stack.md
@@ -19,3 +19,7 @@ fastboot flash {{ partition }} {{ partition }}.img
   {%- endfor %}
   ```
     {% include snippets/fastboot_path.md %}
+4. Reboot to bootloader mode:
+```
+fastboot reboot bootloader
+```
diff --git a/_includes/templates/device_specific/before_recovery_install_g12.md b/_includes/templates/device_specific/before_recovery_install_g12.md
@@ -1,5 +1,10 @@
 ## Forcibly unlocking the bootloader
 
+This generation of Amlogic device includes a unique boot mode called "Burn Mode", which we will be utilizing to forcibly unlock the device's bootloader.
+`aml-flash-tool` is Radxa's wrapper script for Amlogic's official `update` tool, which allows interfacing with burn mode. It's only available for Linux, though a VM will suffice.
+
+{% include alerts/warning.html content="Please note that both `aml-flash-tool` and `update` are known to be somewhat finicky on specific host platforms (e.g. AMD machines). If you encounter any failures while flashing, return to step 2 and try again." %}
+
  1. Run the following command to ascertain the device's current bootloader lock state:
  ```
  fastboot getvar unlocked
@@ -45,3 +50,8 @@
  fastboot flash dtb dtb.img
  fastboot flash dtbo dtbo.img
  ```
+4. Reboot to bootloader mode:
+```
+fastboot reboot bootloader
+```
+{% include alerts/note.html content="Please note that most devices will be able to navigate in recovery mode by pressing the <kbd>Side Button</kbd> to cycle through the on-screen options, and long-pressing the <kbd>Side Button</kbd> to select an option. However, if your device has a remote that communicates via Infrared (IR), the on-device button may not function correctly to change selection/select items in the recovery menu. If you hit this, please try utilizing your IR remote's <kbd>DPAD Keys</kbd> to change selection, and the <kbd>Power Button</kbd> to select an item." %}
diff --git a/_includes/templates/recovery_install_amlogic_update.md b/_includes/templates/recovery_install_amlogic_update.md
@@ -11,7 +11,7 @@ This generation of Amlogic devices include a unique boot mode called "Burn Mode"
 
 1. Download `aml_install_package.img` file from [here](https://download.lineageos.org/devices/{{ device.codename }}).
 2. Power off the device, and boot it into burn mode:
-    * {{ device.download_boot }}
+    * {{ device.burn_boot }}
 3. Download and install `aml-flash-tool`:
 ```
 git clone https://github.com/radxa/aml-flash-tool.git
@@ -26,10 +26,11 @@ sudo ./aml-flash-tool.sh <aml_install_package.img>
     {% include alerts/note.html content="These flash packages were built by LineageOS maintainers from officially supported LineageOS repositories, by using `lunch` to select the device, then run `m aml_install`." %}
     {% include alerts/warning.html content="Please note that both `aml-flash-tool` and `update` are known to be somewhat finicky on specific host platforms (e.g. AMD machines). If you see any failures in flashing, return to step 2 and try again." %}
 5. The script will flash the firmware, and after you see `Resetting board [OK]`, plug in a USB keyboard and cycle power to the board, at which point you will see LineageOS Recovery boot. You may now proceed with the following installation instructions.
-6. Using your keyboard's <kbd>arrow keys</kbd> to navigate, and <kbd>enter key</kbd> to select the "Advanced" option, then "Enter fastboot".
+6. Using your keyboard's <kbd>Arrow Keys</kbd> to navigate, and <kbd>Enter Key</kbd> to select the "Advanced" option, then "Enter fastboot".
 7. Download `super_empty.img` from [here](https://download.lineageos.org/devices/{{ device.codename }}).
 8. Now, prepare the super image for dynamic partitions by running the following (replace `<super_empty.img>` with the actual filename!):
 ```
 fastboot -w wipe-super <super_empty.img>
 ```
-9. Now, using your keyboard, select "Enter recovery".
+9. Now, use your keyboard's <kbd>Arrow Keys</kbd> to highlight "Enter Recovery", and the <kbd>Enter Key</kbd> to select it.
+    {% include alerts/note.html content="Please note that once booted into recovery, you can utilize the attached USB keyboard's <kbd>Arrow Keys</kbd> to change selection, and the <kbd>Enter Key</kbd> to select an item." %}
diff --git a/device_sample/sample.yml b/device_sample/sample.yml
@@ -3,6 +3,7 @@ battery:
   - A0001: {capacity: 2800, removable: true, tech: 'Li-Ion'}
   - SM-6900F: {capacity: 3000, removable: true, tech: 'Li-Po'}
 bluetooth: {spec: 4.0 + LE}
+burn_boot: With the device unplugged, plug in the device while holding the <kbd>Side Button</kbd> until you see a logo on screen.
 cameras:
   - {flash: 'LED', info: '16 MP'}
   - {flash: None, info: '2 MP'}
diff --git a/pages/internal/adding_device.md b/pages/internal/adding_device.md
@@ -96,6 +96,7 @@ The following list will mention Model-Value pairs where applicable.
   For the optional profiles:
   {{ properties.bluetooth.properties.profiles.items.enum | join: ', ' }}
   ```
+* `burn_boot`: Instructions for booting the device into the mode used for flashing low-level images to prepare the NAND/eMMC/UFS to boot Android. Most devices will not need to set this.
 
 * `camera`: One entry for each camera in the format
 
diff --git a/test/schema-06.yml b/test/schema-06.yml
@@ -651,6 +651,9 @@ properties:
     required:
       - spec
     type: object
+  burn_boot:
+    "$id": "/properties/burn_boot"
+    type: string
   cameras:
     "$id": "/properties/cameras"
     items:
