Difference between revisions of "Template:BurnLinuxToEMMC-RK3588"

From FriendlyELEC WiKi
Jump to: navigation, search
(updated by API)
(updated by API)
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
====Install OS to eMMC====
 
====Install OS to eMMC====
 
=====Option 1: Install OS on Web Page=====
 
=====Option 1: Install OS on Web Page=====
Get a TF card which has been installed with FriendlyWrt, log in FriendlyWrt on the web page, click on “System” ->”eMMC Tools”. Click on “Select file” to select your wanted image file, either an official image (the name might start with “rk3588-sd”) or a third party image. The file should be a “.gz” or “.img” file.<br/>
+
Get a TF card which has been installed with FriendlyWrt, log in FriendlyWrt on the web page, click on “System” ->”eMMC Tools”. Click on “Select file” to select your wanted image file, either an official image (filename containing '-sd-') or a third party image. The file should be a “.gz” or “.img” file.<br/>
 
After a file is selected, click on “Upload and Write” to start installing an OS.<br/>
 
After a file is selected, click on “Upload and Write” to start installing an OS.<br/>
 
[[File:Friendlywrt-emmctools2-en.png|frameless|600px]]<br/>
 
[[File:Friendlywrt-emmctools2-en.png|frameless|600px]]<br/>
 
After installation is done, eject the SD card, the system will automatically reboot and load the OS from eMMC. After the OS begins to load, if the system LED is flashing and the network LED is on, it means the the OS has loaded successfully. If the OS is FriendlyWrt, you can click on “Go to Homepage” to enter the homepage. <br/>
 
After installation is done, eject the SD card, the system will automatically reboot and load the OS from eMMC. After the OS begins to load, if the system LED is flashing and the network LED is on, it means the the OS has loaded successfully. If the OS is FriendlyWrt, you can click on “Go to Homepage” to enter the homepage. <br/>
Note that if you are burning the FriendlyElec firmware, you need to use an image file with the "-sd-" file name, similar to the one below:
+
For official OS, you need select the file with the filename containing '-sd-', for example: rk3NNN-sd-friendlywrt-21.02-YYYYMMDD.img.gz, the compression file only supports the .gz format. If the file is too large, you can compress it into .gz format before uploading.
{| class="wikitable"
+
|-
+
  | rk3588-sd-friendlywrt-21.02-YYYYMMDD.img.gz
+
|-
+
  | rk3588-sd-friendlywrt-21.02-docker-YYYYMMDD.img.gz
+
|-
+
  | rk3588-sd-friendlywrt-22.03-YYYYMMDD.img.gz
+
|-
+
  | rk3588-sd-friendlywrt-22.03-docker-YYYYMMDD.img.gz
+
|}
+
If the file is in 7z, zip or rar format, you will need to extract it first. If the file is too large to write, you can compress it into .gz format and try again.
+
 
=====Option 2: Install OS via TF Card=====
 
=====Option 2: Install OS via TF Card=====
======Install OS to eMMC======
+
This method firstly boots a mini Linux from a TF card and then automatically runs an EFlasher utility to install the OS to eMMC. You can connect your system to an HDMI monitor and watch its progress. <br />
* This method firstly boots a mini Linux from a TF card and then automatically runs an EFlasher utility to install the OS to eMMC.<br />
+
This is optional. You can watch its progress by observing its LEDs as well:
* You can connect your system to an HDMI monitor and watch its progress. This is optional. You can watch its progress by observing its LEDs as well.<br />
+
Visit [http://download.friendlyelec.com/{{#replace:{{#replace:{{BASEPAGENAME}}| |}}|/zh|}} download link] to download the needed utilities and image file:<br />
+
{| class="wikitable"
+
|-
+
  | colspan=2 | '''Image File'''
+
|-
+
  | rk3588-eflasher-friendlywrt-21.02-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Based on OpenWrt 21.02<br />Kernel version 5.10.y
+
|-
+
  | rk3588-eflasher-friendlywrt-21.02-docker-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Pre-installed Docker<br />Based on OpenWrt 21.02<br />Kernel version 5.10.y
+
|-
+
  | rk3588-eflasher-friendlywrt-22.03-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Based on OpenWrt 22.03<br />Kernel version 5.10.y
+
|-
+
  | rk3588-eflasher-friendlywrt-22.03-docker-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Pre-installed Docker<br />Based on OpenWrt 22.03<br />Kernel version 5.10.y
+
|-
+
  | rk3588-eflasher-debian-bullseye-core-5.10-arm64-YYYYMMDD.img.gz
+
  | '''Debian 11(Bullseye) Core'''<br />No desktop environment, command line only<br />Kernel version 5.10.y
+
|-
+
  | rk3588-eflasher-debian-bullseye-minimal-5.10-arm64-YYYYMMDD.img.gz
+
  | '''Debian 11(Bullseye) Desktop'''<br />Uses Xfce as default desktop<br />No pre-installed recommended software<br />Supports hardware acceleration<br >Kernel version 5.10.y
+
|-
+
  | rk3588-eflasher-debian-bullseye-desktop-5.10-arm64-YYYYMMDD.img.gz
+
  | '''Debian 11(Bullseye) Desktop'''<br />Uses Xfce as default desktop<br />Pre-installed mpv, smplayer and chromium brower<br />Supports hardware acceleration<br >Kernel version 5.10.y
+
<!--
+
|-
+
  | rk3588-eflasher-debian-buster-desktop-arm64-YYYYMMDD.img.gz
+
  | '''Debian 10(buster) Desktop'''<br />Uses LXDE as default desktop<br />Pre-installed mpv, smplayer and chromium brower<br />Supports hardware acceleration<br >Kernel version 5.10.y
+
-->
+
|-
+
  | rk3588-eflasher-androidtv-YYYYMMDD.img.zip
+
  | '''Android TV'''
+
|-
+
  | rk3588-eflasher-android12-YYYYMMDD.img.zip
+
  | '''Android 12 (Tablet)'''
+
|-
+
  | rk3588-eflasher-ubuntu-jammy-desktop-arm64-YYYYMMDD.img.gz
+
  | Ubuntu 22.04 with GNOME and Wayland<br />Pre-installed web browser and other recommended software<br />kernel version 5.10.y
+
|-
+
  | rk3588-eflasher-ubuntu-jammy-minimal-arm64-YYYYMMDD.img.gz
+
  | Lightweight Ubuntu 22.04 with GNOME and Wayland<br />Recommended software is not included<br />kernel version 5.10.y
+
|-
+
  | rk3588-eflasher-friendlycore-focal-5.10-arm64-YYYYMMDD.img.gz
+
  | 64-bit FriendlyCore Lite image file based on Ubuntu core 20.04 64bit, kernel version 5.10.y
+
|-
+
  | colspan=2 | '''Flash Utility:'''
+
|-
+
  | win32diskimager.rar
+
  | Windows utility. Under Linux users can use "dd"
+
|}
+
Here are the steps:<br />
+
* Get an SDHC card with a minimum capacity of 8G
+
* Download a rk3588-eflasher-OSNAME-YYYYMMDD.img.gz image file and a win32diskimager;
+
* Under Windows, run win32diskimager as administrator, select your SD card and extracted [[EFlasher/zh|EFlasher]] image file, and click on “Write” to write image file on the SD card; or under Linux, you use the dd command to write the rk3588-eflasher-OSNAME-YYYYMMDD.img file to the SD card. 
+
* Eject your SD card and insert it to {{{1}}}’s microSD card slot.
+
* Turn on {{{1}}}, it will boot from the SD card and automatically run [[EFlasher/zh|EFlasher]] to install the OS to the board’s eMMC. You connect your board to an HDMI monitor or observer the board’s LEDs to watch its installation progress 
+
 
{{#switch: {{{1}}}
 
{{#switch: {{{1}}}
 
  | NanoPi-R6S
 
  | NanoPi-R6S
Line 138: Line 69:
 
  | #default =
 
  | #default =
 
}}
 
}}
* After installation is done, power off the board, eject the SD card from {{{1}}}, power on the board again, {{{1}}} will load the OS from its eMMC
+
By default, flashing starts automatically upon power-up, so be sure to back up the data in eMMC. If you don't want it to start automatically, you can use image file with a filename containing the words 'multiple-os' and manually select the OS you want to flash on the interface.
======Install Flash Image File to eMMC======
+
======Flash Official OS to eMMC======
 +
Follow the steps below:<br />
 +
* Get an SDHC card with a minimum capacity of 8G
 +
* Visit [http://download.friendlyelec.com/{{#replace:{{#replace:{{BASEPAGENAME}}| |}}|/zh|}} download link]to download image files (in the "01_Official images/02_SD-to-eMMC images" directory) and win32diskimager tool (in the "05_Tools" directory);
 +
* Extract the .gz format compressed file to get the .img format image file;
 +
* Run the win32diskimager utility under Windows as administrator. On the utility's main window select your SD card's drive, the wanted image file and click on "write" to start flashing the SD card.
 +
* Eject your SD card and insert it to {{{1}}}’s microSD card slot.
 +
* Turn on {{{1}}}, it will boot from the SD card and automatically run [[EFlasher/zh|EFlasher]] to install the OS to the board’s eMMC.
 +
* After flashing is complete, eject the SD card from {{{1}}}, {{{1}}} will automatically reboot and boot from eMMC.
 +
======Flash third party OS (Image file) to eMMC======
 
* Auto Install (Default Behavior)
 
* Auto Install (Default Behavior)
1) Download an “eflasher” firmware from [http://download.friendlyelec.com/{{#replace:{{#replace:{{BASEPAGENAME}}| |}}|/zh|}} network drive], extract it and install it to a TF card ;<br />
+
1) Download an “eflasher” firmware from [http://download.friendlyelec.com/{{#replace:{{#replace:{{BASEPAGENAME}}| |}}|/zh|}} network drive](in the "01_Official images/02_SD-to-eMMC images" directory), extract it and install it to a TF card ;<br />
 
2) Eject and insert the TF card to your PC, after a “FriendlyARM” device shows up(Under Linux, it is a “FriendlyARM” directory), copy an .img or .gz file to the TF card.<br />
 
2) Eject and insert the TF card to your PC, after a “FriendlyARM” device shows up(Under Linux, it is a “FriendlyARM” directory), copy an .img or .gz file to the TF card.<br />
 
3) Open the eflasher.conf file on the TF card, set “autoStart=” to the name of your image file, such as:<br />
 
3) Open the eflasher.conf file on the TF card, set “autoStart=” to the name of your image file, such as:<br />
Line 147: Line 87:
 
autoStart=openwrt-rockchip-armv8_nanopi-ext4-sysupgrade.img.gz
 
autoStart=openwrt-rockchip-armv8_nanopi-ext4-sysupgrade.img.gz
 
</syntaxhighlight>
 
</syntaxhighlight>
Anyone of the files that contain “-sd-” will work. Here is a list:
+
Anyone of the files that contain “-sd-” will work. for example: rk3NNN-sd-friendlywrt-21.02-YYYYMMDD.img.gz<br />
{| class="wikitable"
+
|-
+
  | rk3588-sd-friendlywrt-22.03-YYYYMMDD.img.gz
+
|-
+
  | rk3588-sd-friendlywrt-22.03-docker-YYYYMMDD.img.gz
+
|-
+
  | rk3588-sd-friendlywrt-21.02-YYYYMMDD.img.gz
+
|-
+
  | rk3588-sd-friendlywrt-21.02-docker-YYYYMMDD.img.gz
+
|-
+
  | rk3588-sd-ubuntu-jammy-desktop-5.10-arm64-20221029.img.gz
+
|}
+
 
4) Eject the TF card, insert the TF card to {{{1}}}, power it on it will automatically install your firmware. You can watch the installation progress by observing the LEDs’ status.<br />
 
4) Eject the TF card, insert the TF card to {{{1}}}, power it on it will automatically install your firmware. You can watch the installation progress by observing the LEDs’ status.<br />
* Disable Auto Installation
 
If you want to disable auto installation, please open the eflasher.conf file, set “autoStart=” to empty:<br />
 
<syntaxhighlight lang="bash">
 
autoStart=
 
</syntaxhighlight>
 
In this case, after the system boots, it will stay at the step where you are expected to select an image file. You need to connect an HDMI monitor and a USB mouse to your board and install a firmware on its UI;
 
 
=====Option 3: Install OS via USB=====
 
=====Option 3: Install OS via USB=====
 
======Step 1: Install USB Driver and Tools/Utilities======
 
======Step 1: Install USB Driver and Tools/Utilities======
Line 196: Line 118:
 
Go to “Upgrade Firmware(升级固件)”, click on “Firmware(固件)”, select your wanted image file, and click on “Upgrade(升级)” to install. After installation is done, your board will reboot automatically and load the system from eMMC;<br />
 
Go to “Upgrade Firmware(升级固件)”, click on “Firmware(固件)”, select your wanted image file, and click on “Upgrade(升级)” to install. After installation is done, your board will reboot automatically and load the system from eMMC;<br />
 
* Option 2: Install OS that is packaged & placed in multiple partition images<br />
 
* Option 2: Install OS that is packaged & placed in multiple partition images<br />
Go to [http://download.friendlyelec.com/{{#replace:{{#replace:{{BASEPAGENAME}}| |}}|/zh|}} network drive] to download your needed package and extract it.
+
Go to [http://download.friendlyelec.com/{{#replace:{{#replace:{{BASEPAGENAME}}| |}}|/zh|}} network drive] to download your needed package and extract it (in the "01_Official images/03_USB upgrade images).
{| class="wikitable"
+
|-
+
  | colspan=2 | '''Image File'''
+
|-
+
  | rk3588-usb-friendlywrt-21.02-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Based on OpenWrt 21.02<br />Kernel version 5.10.y
+
|-
+
  | rk3588-usb-friendlywrt-21.02-docker-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Pre-installed Docker<br />Based on OpenWrt 21.02<br />Kernel version 5.10.y
+
|-
+
  | rk3588-usb-friendlywrt-22.03-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Based on OpenWrt 22.03<br />Kernel version 5.10.y
+
|-
+
  | rk3588-usb-friendlywrt-22.03-docker-YYYYMMDD.img.gz
+
  | '''[[How to Build FriendlyWrt|FriendlyWrt]]'''<br/>Pre-installed Docker<br />Based on OpenWrt 22.03<br />Kernel version 5.10.y
+
|-
+
  | rk3588-usb-debian-bullseye-core-arm64-YYYYMMDD.img.gz
+
  | '''Debian 11(Bullseye) Core'''<br />No desktop environment, command line only<br />Kernel version 5.10.y
+
|-
+
  | rk3588-usb-debian-bullseye-minimal-arm64-YYYYMMDD.img.gz
+
  | '''Debian 11(Bullseye) Desktop'''<br />Uses Xfce as default desktop<br />No pre-installed recommended software<br />Supports hardware acceleration<br >Kernel version 5.10.y
+
|-
+
  | rk3588-usb-debian-bullseye-desktop-arm64-YYYYMMDD.img.gz
+
  | '''Debian 11(Bullseye) Desktop'''<br />Uses Xfce as default desktop<br />Pre-installed mpv, smplayer and chromium brower<br />Supports hardware acceleration<br >Kernel version 5.10.y
+
<!--
+
|-
+
  | rk3588-usb-debian-buster-desktop-arm64-YYYYMMDD.img.gz
+
  | '''Debian 10(buster) Desktop'''<br />Uses LXDE as default desktop<br />Pre-installed mpv, smplayer and chromium brower<br />Supports hardware acceleration<br >Kernel version 5.10.y
+
-->
+
|-
+
  | rk3588-usb-androidtv-YYYYMMDD.img.zip
+
  | '''Android TV'''
+
|-
+
  | rk3588-usb-android12-YYYYMMDD.img.zip
+
  | '''Android 12 (Tablet)'''
+
|-
+
  | rk3588-usb-ubuntu-jammy-desktop-arm64-YYYYMMDD.img.gz
+
  | Ubuntu 22.04 with GNOME and Wayland<br />Pre-installed web browser and other recommended software<br />kernel version 5.10.y
+
|-
+
  | rk3588-usb-ubuntu-jammy-minimal-arm64-YYYYMMDD.img.gz
+
  | Lightweight Ubuntu 22.04 with GNOME and Wayland<br />Recommended software is not included<br />kernel version 5.10.y
+
|-
+
  | rk3588-usb-friendlycore-focal-5.10-arm64-YYYYMMDD.img.gz
+
  | 64-bit FriendlyCore Lite image file based on Ubuntu core 20.04 64bit, kernel version 5.10.y
+
|}
+
 
After it is extracted, you will see some utilities and a configuration file under the directory. double click on RKDevTool.exe, you will see a “Found a new Maskrom device” message on the utility. Click on the “Execute”, wait a moment and it will be installed. After installation is done your system will automatically reboot and load the system from eMMC.<br />
 
After it is extracted, you will see some utilities and a configuration file under the directory. double click on RKDevTool.exe, you will see a “Found a new Maskrom device” message on the utility. Click on the “Execute”, wait a moment and it will be installed. After installation is done your system will automatically reboot and load the system from eMMC.<br />

Latest revision as of 10:29, 2 August 2023

1 Install OS to eMMC

1.1 Option 1: Install OS on Web Page

Get a TF card which has been installed with FriendlyWrt, log in FriendlyWrt on the web page, click on “System” ->”eMMC Tools”. Click on “Select file” to select your wanted image file, either an official image (filename containing '-sd-') or a third party image. The file should be a “.gz” or “.img” file.
After a file is selected, click on “Upload and Write” to start installing an OS.
Friendlywrt-emmctools2-en.png
After installation is done, eject the SD card, the system will automatically reboot and load the OS from eMMC. After the OS begins to load, if the system LED is flashing and the network LED is on, it means the the OS has loaded successfully. If the OS is FriendlyWrt, you can click on “Go to Homepage” to enter the homepage.
For official OS, you need select the file with the filename containing '-sd-', for example: rk3NNN-sd-friendlywrt-21.02-YYYYMMDD.img.gz, the compression file only supports the .gz format. If the file is too large, you can compress it into .gz format before uploading.

1.2 Option 2: Install OS via TF Card

This method firstly boots a mini Linux from a TF card and then automatically runs an EFlasher utility to install the OS to eMMC. You can connect your system to an HDMI monitor and watch its progress.
This is optional. You can watch its progress by observing its LEDs as well:

By default, flashing starts automatically upon power-up, so be sure to back up the data in eMMC. If you don't want it to start automatically, you can use image file with a filename containing the words 'multiple-os' and manually select the OS you want to flash on the interface.

1.2.1 Flash Official OS to eMMC

Follow the steps below:

  • Get an SDHC card with a minimum capacity of 8G
  • Visit download linkto download image files (in the "01_Official images/02_SD-to-eMMC images" directory) and win32diskimager tool (in the "05_Tools" directory);
  • Extract the .gz format compressed file to get the .img format image file;
  • Run the win32diskimager utility under Windows as administrator. On the utility's main window select your SD card's drive, the wanted image file and click on "write" to start flashing the SD card.
  • Eject your SD card and insert it to {{{1}}}’s microSD card slot.
  • Turn on {{{1}}}, it will boot from the SD card and automatically run EFlasher to install the OS to the board’s eMMC.
  • After flashing is complete, eject the SD card from {{{1}}}, {{{1}}} will automatically reboot and boot from eMMC.
1.2.2 Flash third party OS (Image file) to eMMC
  • Auto Install (Default Behavior)

1) Download an “eflasher” firmware from network drive(in the "01_Official images/02_SD-to-eMMC images" directory), extract it and install it to a TF card ;
2) Eject and insert the TF card to your PC, after a “FriendlyARM” device shows up(Under Linux, it is a “FriendlyARM” directory), copy an .img or .gz file to the TF card.
3) Open the eflasher.conf file on the TF card, set “autoStart=” to the name of your image file, such as:

autoStart=openwrt-rockchip-armv8_nanopi-ext4-sysupgrade.img.gz

Anyone of the files that contain “-sd-” will work. for example: rk3NNN-sd-friendlywrt-21.02-YYYYMMDD.img.gz
4) Eject the TF card, insert the TF card to {{{1}}}, power it on it will automatically install your firmware. You can watch the installation progress by observing the LEDs’ status.

1.3 Option 3: Install OS via USB
1.3.1 Step 1: Install USB Driver and Tools/Utilities

Download a driver file DriverAssitant_v5.1.1.zip under the “tools” directory from network drive, extract and install it.
Under the same directory, download a utility RKDevTool_Release_v2.84.zip and extract it.

1.3.2 Step 2: Connect {{{1}}} to PC and Enter Installation Mode

1) Disconnect the connected USB cable and the power cord from {{{1}}}, eject the TF card;
2) Press and hold the “Mask” key, power on the board. After the status LED has been on for at least 3 seconds, release the Mask key.


1.3.3 Step 3: Install image to eMMC

A firmware in general is packaged in either of the two options: the first is an whole image (ie, update.img) which is often offered by third party developers, the second is that an image is packaged and placed in multiple partition images. FriendlyElec offers an image in the latter option.

  • Option 1: Install whole image (ie, update.img)

On a PC which has the extracted RKDevTool_Release_v2.84 utility, go to the RKDevTool_Release_v2.84 directory, run the RKDevTool.exe file. If everything works, you will see a “Found a new Maskrom device” message on the utility;
Go to “Upgrade Firmware(升级固件)”, click on “Firmware(固件)”, select your wanted image file, and click on “Upgrade(升级)” to install. After installation is done, your board will reboot automatically and load the system from eMMC;

  • Option 2: Install OS that is packaged & placed in multiple partition images

Go to network drive to download your needed package and extract it (in the "01_Official images/03_USB upgrade images). After it is extracted, you will see some utilities and a configuration file under the directory. double click on RKDevTool.exe, you will see a “Found a new Maskrom device” message on the utility. Click on the “Execute”, wait a moment and it will be installed. After installation is done your system will automatically reboot and load the system from eMMC.