OpenWrt for Amlogic s9xxx tv box

View Chinese description | 查看中文说明

The OpenWrt Project is a Linux router operating system targeting embedded devices. Instead of trying to create a single, static firmware, OpenWrt provides a fully writable filesystem with package management. Allows you to freely choose the software package you need to customize your router system. For developers, OpenWrt is the framework to build an application without having to build a complete firmware around it; for users this means the ability for full customization, to use the device in ways never envisioned. It has more than 3000+ standardized application packages and a very rich third-party plug-in support, so you can easily replicate the same setup on any supported device.

Now you can replace the Android TV system of the TV box with the Amlogic chip with the OpenWrt system, making it a powerful router. This project supports github.com One-stop compilation, Use GitHub Action to packaging, Use github.com Releases rootfs file to packaging, Local packaging. including OpenWrt firmware install to EMMC and update related functions. Support Amlogic s9xxx tv box are a311d, s922x, s905x3, s905x2, s905l3a, s912, s905d, s905x, s905w, s905, etc. such as Belink GT-King, Belink GT-King Pro, UGOOS AM6 Plus, X96-Max+, HK1-Box, H96-Max-X3, Phicomm-N1, Octopus-Planet, Fiberhome HG680P, ZTE B860H, etc.

The latest version of the OpenWrt firmware can be downloaded in Releases. Welcome to use Fork for personalized OpenWrt firmware configuration. If you like it, Please click the Star.

OpenWrt Firmware instructions

SoC	Device	Optional kernel	OpenWrt Firmware
a311d	Khadas-VIM3	All	openwrt_a311d_k*.img
s922x	Beelink-GT-King, Beelink-GT-King-Pro, Ugoos-AM6-Plus, ODROID-N2	All	openwrt_s922x_k*.img
s905x3	X96-Max+, HK1-Box, H96-Max-X3, Ugoos-X3, X96-Air, A95XF3-Air	All	openwrt_s905x3_k*.img
s905x2	X96Max-4G, X96Max-2G, MECOOL-KM3-4G	All	openwrt_s905x2_k*.img
s905l3a	E900V22C/D	All	openwrt_s905l3a_k*.img
s912	H96-Pro-Plus, Tanix-TX92, VORKE-Z6-Plus, T95Z-Plus, Octopus-Planet	All	openwrt_s912_k*.img
s905d	MECOOL-KI-Pro, Phicomm-N1	All	openwrt_s905d_k*.img
s905x	HG680P, B860H	All	openwrt_s905x_k*.img
s905w	X96-Mini, TX3-Mini	5.4.*	openwrt_s905w_k*.img
s905	Beelink-Mini-MX-2G, MXQ-PRO+4K	All	openwrt_s905_k*.img

💡Tip: The current box of s905 can only be used in TF/SD/USB, and other types of boxes can also be used in EMMC at the same time. The s905w boxs currently only support 5.4 kernels, Cannot use kernel version 5.10 and above, Other devices can be freely selected. Please refer to the instructions for dtb and u-boot of each device.

Install to EMMC and update instructions

Choose the corresponding firmware according to your box. Then write the IMG file to the USB hard disk through software such as Rufus or balenaEtcher. Insert the USB hard disk into the box. Common for all Amlogic s9xxx tv box.

• Install OpenWrt

Log in to the default IP: 192.168.1.1 → Login in to openwrt → system menu → Amlogic Service → Install OpenWrt, Select your box in the Supported Devices drop-down list and click the Install OpenWrt button to install it.

• Update OpenWrt

Log in to the default IP: 192.168.1.1 → Login in to openwrt → system menu → Amlogic Service → Upload updates manually / Download updates online

If you choose Upload Updates Manually OpenWrt firmware, You can upload the corresponding OpenWrt firmware package, such as openwrt_s9xxx_k5.15.25_xxx.img.gz (It is recommended to upload the compressed package, and the system will automatically decompress it. If you upload the decompressed xxx.img file, the upload may fail because the file is too large), After the upload is complete, the interface will display the Update firmware operation button, click to update.

If you choose Manually upload updates OpenWrt kernel, You can upload the three kernel files boot-xxx.tar.gz, dtb-amlogic-xxx.tar.gz, modules-xxx.tar.gz (Other kernel files are not required. If uploading at the same time does not affect the update, the system can accurately identify the required kernel files.)，After the upload is complete, the interface will display the Update Kernel operation button, click to update.

If you choose Online Download Update OpenWrt firmware or kernel, it will be downloaded according to Firmware download address and Kernel download address in Plugin Settings, you can customize and modify the download source, For details, please refer to the compilation and usage instructions of luci-app-amlogic.

Tip: Functions such as install/update are provided by luci-app-amlogic to provide visual operation support. Also supports command operations.

• Use OpenWrt in TF/SD/USB

Log in to the default IP: 192.168.1.1 → Login in to openwrt → system menu → TTYD terminal → input command

openwrt-tf

After activating the remaining space, the kernel and OpenWrt system can be upgraded in TF/SD/USB.

• Create swap for openwrt system

If you feel that the memory of the current box is not enough when you are using applications with a large memory footprint such as docker, you can create a swap virtual memory partition, Change the disk space of /mnt/*4 A certain capacity is virtualized into memory for use. The unit of the input parameter of the following command is GB, and the default is 1.

Log in to the default IP: 192.168.1.1 → Login in to openwrt → system menu → TTYD terminal → input command

openwrt-swap 1

• Backup/restore the original EMMC system

Supports backup/restore of the box's EMMC partition in TF/SD/USB. It is recommended that you back up the Android TV system that comes with the current box before installing the OpenWrt system in a brand new box, so that you can use it in the future when restoring the TV system.

Please start the OpenWrt system from TF/SD/USB, Log in to the default IP: 192.168.1.1 → Login in to openwrt → system menu → TTYD terminal → input command

openwrt-ddbr

According to the prompt, enter b to perform system backup, and enter r to perform system recovery.

💡Tip: You must use the /mnt/*4/ space to store the BACKUP-arm-64-emmc.img.gz backup file, Users who have not created the TF/SD/USB extended partition must first use the openwrt-tf command to create the extended partition.

Detailed make compile command

Parameter	Meaning	Description
-d	Defaults	Compile all cores and all firmware types.
-b	BuildSoC	Specify the Build firmware type. Write the build firmware name individually, such as -b s905x3 . Multiple firmware use _ connect such as -b s905x3_s905d . You can use these codes: a311d, s905x3, s905x2, s905l3a, s905x, s905w, s905d, s905d-ki, s905, s922x, s922x-n2, s912, s912-t95z . Note: s922x-reva is s922x-gtking-pro-rev_a, s922x-n2 is s922x-odroid-n2, s912-t95z is s912-t95z-plus, s905d-ki is s912-mecool-ki-pro, s905x2-km3 is s905x2-mecool-km3.
-v	VersionBranch	Specify the name of the kernel version branch, Such as -v stable. The specified name must be the same as the branch directory name. The stable branch version is used by default.
-k	Kernel	Specify the kernel name. Write the kernel name individually such as -k 5.4.180 . Multiple kernel use _ connection such as -k 5.15.25_5.4.180
-a	AutoKernel	Set whether to automatically adopt the latest version of the kernel of the same series. When it is true, it will automatically find in the kernel library whether there is an updated version of the kernel specified in -k such as 5.4.180 version. If there is the latest version of 5.4 same series, it will automatically Replace with the latest version. When set to false, the specified version of the kernel will be compiled. Default value: true
-s	Size	Specify the size of the ROOTFS partition in MB. The default is 1024, and the specified size must be greater than 256. Such as -s 1024

• sudo ./make -d: Compile latest kernel versions of openwrt for all SoC with the default configuration.
• sudo ./make -d -b s905x3 -k 5.4.180: recommend. Use the default configuration, specify a kernel and a firmware for compilation.
• sudo ./make -d -b s905x3_s905d -k 5.15.25_5.4.180: Use the default configuration, specify multiple cores, and multiple firmware for compilation. use _ to connect.
• sudo ./make -d -b s905x3 -k 5.4.180 -s 1024: Use the default configuration, specify a kernel, a firmware, and set the partition size for compilation.
• sudo ./make -d -b s905x3 -v dev -k 5.7.19: Use the default configuration, specify the model, specify the version branch, and specify the kernel for packaging.
• sudo ./make -d -b s905x3_s905d: Use the default configuration, specify multiple firmware, use _ to connect. compile all kernels.
• sudo ./make -d -k 5.15.25_5.4.180: Use the default configuration. Specify multiple cores, use _ to connect.
• sudo ./make -d -k 5.15.25_5.4.180 -a true: Use the default configuration. Specify multiple cores, use _ to connect. Auto update to the latest kernel of the same series.
• sudo ./make -d -s 1024 -k 5.4.180: Use the default configuration and set the partition size to 1024m, and only compile the openwrt firmware with the kernel version 5.4.180.

Compilation and packaging method

Provide multiple ways to generate the OpenWrt firmware you need. Please choose one method you like. Each method can be used independently.

• Local packaging instructions

1. Install the necessary packages (E.g Ubuntu 20.04 LTS user)

sudo apt-get update -y
sudo apt-get full-upgrade -y
sudo apt-get install -y $(curl -fsSL git.io/ubuntu-2004-openwrt)

2. Clone the repository to the local. git clone --depth 1 https://github.com/ophub/amlogic-s9xxx-openwrt.git
3. Create a openwrt-armvirt folder, and upload the OpenWrt firmware of the ARM kernel ( Eg: openwrt-armvirt-64-default-rootfs.tar.gz ) to this ~/amlogic-s9xxx-openwrt/openwrt-armvirt directory.
4. Enter the ~/amlogic-s9xxx-openwrt root directory. And run Eg: sudo ./make -d -b s905x3 -k 5.4.180. The generated OpenWrt firmware is in the out directory under the root directory.

• Github.com One-stop compilation instructions

You can modify the configuration file in the router-config directory and .yml file, customize the OpenWrt firmware, and complete the packaging online through Actions, and complete all the compilation of OpenWrt firmware in github.com One-stop.

1. Personalized plug-in configuration in router-config directory. Workflows configuration in .yml file.
2. Select Build OpenWrt on the Action page. Click the Run workflow button.

- name: Build OpenWrt firmware
  id: build
  run: |
    [ -d openwrt-armvirt ] || mkdir -p openwrt-armvirt
    cp -f openwrt/bin/targets/*/*/*.tar.gz openwrt-armvirt/ && sync
    sudo chmod +x make
    sudo ./make -d -b s905x3_s905x2_s905x_s905w_s905d_s922x_s912 -k 5.15.25_5.4.180
    echo "PACKAGED_OUTPUTPATH=${PWD}/out" >> $GITHUB_ENV
    echo "PACKAGED_OUTPUTDATE=$(date +"%Y.%m.%d.%H%M")" >> $GITHUB_ENV
    echo "::set-output name=status::success"

The output variable ${{ env.PACKAGED_OUTPUTPATH }} is the path where the packaged file is located.

• Use github.com Releases rootfs file to packaging

If there is an openwrt-armvirt-64-default-rootfs.tar.gz file in a Releases in your repository, you can use this file to directly package the required firmware.

• openwrt_s9xxx_.* is Prefix the tag_name in the Release.
• openwrt-armvirt-64-default-rootfs.tar.gz is the firmware you are going to package, please refer to router-config for compilation method.

For more instructions please see: use-releases-file-to-packaging.yml

- name: Build OpenWrt firmware
  id: build
  run: |
    [ -d openwrt-armvirt ] || mkdir -p openwrt-armvirt
    curl -s "https://api.github.com/repos/${GITHUB_REPOSITORY}/releases" | grep -o "openwrt_s9xxx_.*/openwrt-armvirt-.*\.tar.gz" | head -n 1 > DOWNLOAD_URL
    [ -s DOWNLOAD_URL ] && wget -q -P openwrt-armvirt https://github.com/${GITHUB_REPOSITORY}/releases/download/$(cat DOWNLOAD_URL)
    sudo chmod +x make
    sudo ./make -d -b s905x3_s905x2_s905x_s905w_s905d_s922x_s912 -k 5.15.25_5.4.180
    echo "PACKAGED_OUTPUTPATH=${PWD}/out" >> $GITHUB_ENV
    echo "PACKAGED_OUTPUTDATE=$(date +"%Y.%m.%d.%H%M")" >> $GITHUB_ENV
    echo "::set-output name=status::success"

This function is generally used to replace the kernel for quick packaging. If you have the openwrt-armvirt-64-default-rootfs.tar.gz file in your repository, when you want to use other kernel versions of OpenWrt, you can directly specify the relevant kernel for Quickly packaged, no longer waiting for a long firmware compilation.

• Use GitHub Action to packaging instructions

For more instructions please see: .yml example

In your .github/workflows/.yml file, after completing the compilation of Subtarget is ARMv8, add the following online packaging code:

- name: Package Armvirt as OpenWrt
  uses: ophub/amlogic-s9xxx-openwrt@main
  with:
    armvirt64_path: openwrt/bin/targets/*/*/*.tar.gz
    amlogic_openwrt: s905x3_s905x2_s905x_s905w_s905d_s922x_s912
    amlogic_kernel: 5.15.25_5.4.180

• GitHub Action Input parameter description

The relevant parameters correspond to the local packaging command, please refer to the above description.

Parameter	Defaults	Description
armvirt64_path	no	Set the file path of openwrt-armvirt-64-default-rootfs.tar.gz , Use the path of the file in the current workflow such as openwrt/bin/targets/*/*/*.tar.gz .
amlogic_openwrt	s905d_s905x3	Set the SoC of the packaging box, function reference -b
version_branch	stable	Specify the name of the kernel version branch, function reference -v
amlogic_kernel	5.15.25_5.4.180	Set the kernel version，function reference -k
auto_kernel	true	Set whether to automatically adopt the latest version of the kernel of the same series. function reference -a
amlogic_size	1024	Set the size of the firmware ROOTFS partition, function reference -s

• GitHub Action Output variable description

Parameter	For example	Description
${{ env.PACKAGED_OUTPUTPATH }}	${PWD}/out	OpenWrt firmware storage path
${{ env.PACKAGED_OUTPUTDATE }}	2021.04.13.1058	Packing date
${{ env.PACKAGED_STATUS }}	success / failure	Package status

• Uploads OpenWrt Firmware to Release:

- name: Upload OpenWrt Firmware to Release
  uses: ncipollo/release-action@v1
  with:
    tag: openwrt_s9xxx
    artifacts: ${{ env.PACKAGED_OUTPUTPATH }}/*
    allowUpdates: true
    token: ${{ secrets.GITHUB_TOKEN }}
    body: |
      This is OpenWrt firmware for Amlogic s9xxx tv box.
      More information ...

Compile a custom kernel

For the compilation method of the custom kernel, see compile-kernel

- name: Compile the kernel for Amlogic s9xxx
  uses: ophub/amlogic-s9xxx-armbian@main
  with:
    build_target: kernel
    kernel_version: 5.15.25_5.4.180
    kernel_auto: true
    kernel_sign: -meson64-dev

~/openwrt-armvirt/*-rootfs.tar.gz Firmware compilation parameters

Option	Value
Target System	QEMU ARM Virtual Machine
Subtarget	QEMU ARMv8 Virtual Machine(cortex-a53)
Target Profile	Default
Target Images	tar.gz

For more instructions please see: router-config

Firmware information

Name	Value
Default IP	192.168.1.1
Default username	root
Default password	password
Default WIFI name	OpenWrt
Default WIFI password	none

Resource Description

When making an OpenWrt system, the kernel and u-boot files used are the same files used to make an Armbian system. In order to avoid repeated maintenance, the relevant content is classified and placed in the corresponding resource repository, and it will be automatically downloaded from the relevant repository when it is used.

The kernel / u-boot and other resources used by this system are mainly copied from the project of unifreq/openwrt_packit, Some files are shared by users in Pull and Issues of amlogic-s9xxx-openwrt / amlogic-s9xxx-armbian / luci-app-amlogic / kernel / script and other projects. To thank these pioneers and sharers, I have recorded them in CONTRIBUTOR.md. Thanks again everyone for giving new life and meaning to the box.

Acknowledgments

• OpenWrt
• coolsnowwolf/lede
• Lienol/openwrt
• unifreq/openwrt_packit

License

The amlogic-s9xxx-openwrt © OPHUB is licensed under GPL-2.0