OpenWrt for Amlogic S9xxx STB

View Chinese description | 查看中文说明

Support 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 STB are s922x, s905x3, s905x2, s912, s905d, s905x, s905w, 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.

This OpenWrt firmware is packaged using Flippy's Amlogic S9xxx Kernel for OpenWrt, and the Install and update scripts, etc. Welcome to use Fork for personalized OpenWrt firmware configuration. If you like it, Please click the Star.

OpenWrt Firmware instructions

Model	STB	Optional kernel	OpenWrt Firmware
s922x	Belink, Belink-Pro, Ugoos-AM6-Plus	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	All	openwrt_s905x2_k*.img
s912	H96-Pro-Plus, Octopus-Planet	All	openwrt_s912_k*.img
s905d	Phicomm-N1	All	openwrt_s905d_k*.img
s905x	HG680P, B860H	5.4.*	openwrt_s905x_k*.img
s905w	X96-Mini, TX3-Mini	5.4.*	openwrt_s905w_k*.img

Install to EMMC and update instructions

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

• Install OpenWrt

Log in to the default IP: 192.168.1.1 → Login in to openwrt → system menu → Amlogic Service → Install OpenWrt

• Update OpenWrt

Log in to the default IP: 192.168.1.1 → Login in to openwrt → system menu → Amlogic Service → Update OpenWrt

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

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.

• 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.10.70_5.4.150
    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 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.10.70_5.4.150
    auto_kernel: true
    amlogic_size: 1024

• GitHub Action Input parameter 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, the default all packs all boxes, you can specify a single box such as s905x3, you can choose multiple boxes to use _ connection such as s905x3_s905d . SOC code of each box is: s905x3, s905x2, s905x, s905w, s905d, s922x, s912
amlogic_kernel	5.10.70_5.4.150	Set the kernel version，Ophub's kernel library contains many original kernels of Flippy, you can view and choose to specify.
auto_kernel	true	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 amlogic_kernel. such as 5.4.150 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
amlogic_size	1024	Set the size of the firmware ROOT partition

• GitHub Action Output variable description

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

• Uploads OpenWrt Firmware to Actions:

- name: Upload artifact to Actions
  uses: kittaakos/upload-artifact-as-is@master
  with:
    path: ${{ env.PACKAGED_OUTPUTPATH }}/

• 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 STB.
      More information ...

• 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.10.70_5.4.150
    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 suitable for the needs of replacing the kernel packaging and packaging the OpenWrt firmware of the specified amlogic-dtb separately. As long as you have the openwrt-armvirt-64-default-rootfs.tar.gz file in the Releases of your repository, you can package the OpenWrt firmware you want at any time, which is efficient and convenient.

• 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. Name the kernel package according to the corresponding version number, such as 5.4.150 version, and put it into the ~/amlogic-s9xxx-openwrt/amlogic-s9xxx/amlogic-kernel directory.
5. Enter the ~/amlogic-s9xxx-openwrt root directory. And run Eg: sudo ./make to make selection settings. The generated OpenWrt firmware is in the out directory under the root directory.

Detailed make compile command

• sudo ./make -d -b s905x3 -k 5.4.150: recommend. Use the default configuration, specify a kernel and a firmware for compilation.
• sudo ./make -d -b s905x3_s905d -k 5.10.70_5.4.150: Use the default configuration, specify multiple cores, and multiple firmware for compilation. use _ to connect.
• sudo ./make -d: Compile latest kernel versions of openwrt for all SoC with the default configuration.
• sudo ./make -d -b s905x3 -k 5.4.150 -s 1024: Use the default configuration, specify a kernel, a firmware, and set the partition size for compilation.
• sudo ./make -d -b s905x3_s905d: Use the default configuration, specify multiple firmware, use _ to connect. compile all kernels.
• sudo ./make -d -k 5.10.70_5.4.150: Use the default configuration. Specify multiple cores, use _ to connect.
• sudo ./make -d -k 5.10.70_5.4.150 -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 -k latest: Use the default configuration to compile the latest kernel version of the openwrt firmware.
• sudo ./make -d -s 1024 -k 5.4.150: Use the default configuration and set the partition size to 1024m, and only compile the openwrt firmware with the kernel version 5.4.150.
• sudo ./make -h: Display help information and view detailed description of each parameter.
• sudo ./make: If you are familiar with the relevant setting requirements of the s905x3 firmware, you can follow the prompts, such as selecting the firmware you want to make, the kernel version, setting the ROOTFS partition size, etc. If you don’t know these settings, just press Enter.

Parameter	Types	Description
-d	Defaults	Compile all cores and all firmware types.
-b	Build	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: s905x3, s905x2, s905x, s905w, s905d, s922x, s912
-k	Kernel	Specify the kernel type. Write the kernel name individually such as -k 5.4.150 . Multiple cores use _ connection such as -k 5.10.70_5.4.150 kernel.
-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.150 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 root partition in MB. The default is 1024, and the specified size must be greater than 256. Such as -s 1024
-h	help	View full documentation.

~/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

Bypass gateway settings

If used as a bypass gateway, you can add custom firewall rules as needed (Network → Firewall → Custom Rules):

iptables -t nat -I POSTROUTING -o eth0 -j MASQUERADE        #If the interface is eth0.
iptables -t nat -I POSTROUTING -o br-lan -j MASQUERADE      #If the interface is br-lan bridged.

Acknowledgments

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

License

LICENSE © OPHUB