Skip to content

Latest commit

 

History

History
156 lines (109 loc) · 17 KB

README.md

File metadata and controls

156 lines (109 loc) · 17 KB

Kernel Compilation and Usage Instructions

View Chinese description | 查看中文说明

This kernel can be used for Armbian and OpenWrt systems. For example, it can be used in the amlogic-s9xxx-armbian, amlogic-s9xxx-openwrt, flippy-openwrt-actions, and unifreq/openwrt_packit projects. It can be integrated when compiling firmware or installed to use in an existing system.

You can adjust the kernel's configuration as needed, such as adding drivers and patches. You can also compile personalized signature kernels with special significance according to your mood, such as 5.10.95-happy-new-year, 5.10.96-beijing-winter-olympics, 5.10.99-valentines-day, and so on.

Kernel Repository

Pre-compiled kernels are available in the Releases of ophub/kernel.

Local Compilation

  • Running on Ubuntu system

  1. Clone the repository to local git clone --depth 1 https://github.com/ophub/amlogic-s9xxx-armbian.git

  2. Install necessary software packages (for Ubuntu 24.04):

sudo apt-get update -y
sudo apt-get full-upgrade -y
# For Ubuntu-24.04
sudo apt-get install -y $(cat compile-kernel/tools/script/ubuntu2404-build-armbian-depends)
  1. Go to the ~/amlogic-s9xxx-armbian root directory, and then run sudo ./recompile -k 5.15.100 or other specified parameter commands to compile the kernel. The script will automatically download and install the compilation environment and kernel source code, and make all settings. The compiled kernel files are saved in the compile-kernel/output directory of the current source tree, or in the directory specified using the -h option.

  • Running on the Armbian system

You can compile the kernel in the Armbian system, or run the Armbian system in a Docker container on Ubuntu/Debian system to compile the kernel. The method of making the Armbian system Docker image can refer to the armbian_docker production script.

  1. Update local compilation environment and configuration files: armbian-kernel -u

  2. Compile the kernel: Run armbian-kernel -k 5.15.100 or other specified parameter commands to compile the kernel. The script will automatically download, install the compilation environment and the kernel source code, and make all settings. The packaged kernel files are saved in the /opt/kernel/compile-kernel/output directory.

  • Local Compilation Parameter Explanation

Parameter Meaning Description
-r Repository Specifies the source code repository for compiling the kernel. You can choose the kernel source code repository from github.com, such as -r unifreq. The parameter format can be a combination of three items owner/repo@branch. The owner's name owner is a mandatory parameter, the kernel source code repository name /repo and the branch name of the repository @branch are optional parameters. When only specifying the owner's name owner, it will automatically match the kernel source code repository with the name format linux-5.x.y and the branch main of the owner. If the repository name or branch name is different, please specify it in combination, such as owner@branch or owner/repo or owner/repo@branch. Default value: unifreq
-k Kernel Specifies the kernel name, such as -k 5.15.100. Multiple kernels are connected with _, such as -k 5.15.100_5.15.50. Using -k all means compiling all mainline kernels, which is currently equivalent to -k 5.10.y_5.15.y_6.1.y_6.6.y_6.12.y_6.18.y. The kernel list is dynamically adjusted based on the maintenance status of the upstream kernel source repository unifreq.
-a AutoKernel Sets whether to automatically adopt the latest version of the same series of kernels. When it is true, it will automatically search whether there is a newer version of the same series of kernels specified in -k, such as 5.15.100. If there is a latest version after 5.15.100, it will automatically switch to the latest version. When set to false, it will compile the specified version of the kernel. Default value: true
-m MakePackage Sets the package list for making the kernel. When set to all, it will make all the files of Image, modules, dtbs. When the setting value is dtbs, only 3 dtbs files will be produced. Default value: all
-f configFlavor Set up downloading the specified configuration file config-* from the kernel repository ophub/kernel to the local tools/config directory. When a configuration file corresponding to the kernel version already exists locally and this parameter is not set to specify downloading a configuration file, the download will be skipped. The available options are the directory names that exist in the kernel repository release, for example: stable / rk3588 / rk35xx / h6. The default value is stable.
-p AutoPatch Sets whether to use custom kernel patches. When set to true, it will use the kernel patches in the tools/patch directory. For detailed instructions, refer to how to add kernel patches. Default value: false
-n CustomName Sets the custom signature of the kernel. When set to -ophub, the generated kernel name is 5.15.100-ophub. Please do not include spaces when setting custom signatures. Default value: -ophub
-t Toolchain Sets the toolchain for compiling the kernel. Options: clang / gcc / gcc-<version>. Default value: gcc
-z CompressFormat Set the compression format used for initrd in the kernel. Options: xz / gzip / zstd / lzma. Default value: xz
-d DeleteSource Set whether to delete the kernel source code after the kernel compilation is completed. Options: true / false. Default value: false
-s SilentLog Set whether to use silent mode to reduce log output when compiling the kernel. Options: true / false. Default value: false
-l EnableLog Set whether to log the kernel compilation process to a log file: /var/log/kernel_compile_*.log. Options: true / false. Default value: false
-c CcacheClear Set whether to clear the cache before compiling the kernel. Options: true / false. Default value: false
-h DockerHostpath Set the host mount path for kernel compilation. Default is the current directory.
-i DockerImage Set the Docker container image for kernel compilation. Default: ophub/armbian-trixie:arm64
  • sudo ./recompile: Compile the kernel using the default configuration.
  • sudo ./recompile -k 5.15.100: Use the default configuration and specify the kernel version to be compiled through -k. Multiple versions are connected using _ for simultaneous compilation.
  • sudo ./recompile -k 5.15.100 -f stable : Use the default configuration and specify the kernel version to be compiled through -k 5.15.100, and specify the configuration files to be downloaded from the stable directory of the kernel repository through -f stable.
  • sudo ./recompile -k 5.15.100 -a true: Use the default configuration and set whether to automatically upgrade to the latest kernel of the same series during kernel compilation through the -a parameter.
  • sudo ./recompile -k 5.15.100 -n -ophub: Use the default configuration and set the kernel custom signature through the -n parameter.
  • sudo ./recompile -k 5.15.100 -m dtbs: Use the default configuration and specify only the creation of dtbs files through the -m parameter.
  • sudo ./recompile -k 5.15.100_6.1.10 -a true -n -ophub: Use the default configuration and set multiple parameters.

💡 Tip: We recommend using the kernel source code from repositories such as linux-6.1.y, linux-5.15.y, linux-5.10.y of unifreq for compilation, who added drivers and patches for related boxes. It is recommended to use the template in ophub/kernel, which has been pre-configured according to the related boxes and can be customized based on this.

Compile Kernel Using GitHub Actions

  1. In the Action page, select Compile the kernel and click the Run workflow button to compile.

  2. See the use of the template compile-kernel-via-docker.yml. The code is as follows:

- name: Compile the kernel
  uses: ophub/amlogic-s9xxx-armbian@main
  with:
    build_target: kernel
    kernel_version: 6.12.y_6.18.y
    kernel_auto: true
    kernel_sign: -yourname

💡 Note: If you fork the repository and made modifications, you need to change the Actions username to your own repository when using it, for example:

uses: YOUR-REPO/amlogic-s9xxx-armbian@main

  • GitHub Action Input Parameters

These parameters correspond to the local compilation commands. Please refer to the above explanation.

Parameter Default Value Description
build_target kernel Fixed parameter kernel, set the compilation target to the kernel.
kernel_source unifreq Specifies the source code repository for compiling the kernel. Default value is unifreq. Refer to -r for functionality.
kernel_version 6.12.y_6.18.y Specifies the kernel name, such as 5.15.100. Refer to -k for functionality.
kernel_auto true Sets whether to automatically adopt the latest version of the same series kernel. Default value is true. Refer to -a for functionality.
kernel_package all Sets the package list for making the kernel. Default value is all. Refer to -m for functionality.
kernel_sign -ophub Sets the kernel custom signature. Default value is -ophub. Refer to -n for functionality.
kernel_toolchain gcc Sets the toolchain for compiling the kernel. Default value is gcc. Refer to -t for functionality.
config_flavor stable Set up downloading the specified configuration file config-* from the kernel repository ophub/kernel to the local tools/config directory. When a configuration file corresponding to the kernel version already exists locally and this parameter is not set to specify downloading a configuration file, the download will be skipped. The available options are the directory names that exist in the kernel repository release, for example: stable / rk3588 / rk35xx / h6. The default value is stable. If the kernel_config parameter is set at the same time, the configuration file specified by config_flavor will be used as the final choice. These two parameters are mutually exclusive: you can use them to select either the kernel configuration files provided by ophub/kernel or the configuration files from your own repository. Refer to -f for functionality.
kernel_config false By default, uses the configuration templates in the tools/config directory. You can set the directory in your repository where the kernel configuration files are stored, such as kernel/config_path. The configuration templates in this directory must be named according to the main kernel version, such as config-5.10, config-5.15, etc.
kernel_patch false Set the directory for custom kernel patch files in your repository. If this parameter is set, the kernel patch files will be automatically downloaded from the specified directory in your repository before compilation. If it is not set, this step will be skipped.
auto_patch false Sets whether to use custom kernel patches. Default value is false. Refer to -p for functionality.
compress_format xz Set the compression format used for initrd in the kernel. Default value is xz. Refer to -z for functionality.
delete_source false Set whether to delete the kernel source code after the kernel compilation is completed. Default value is false. Refer to -d for functionality.
silent_log false Set whether to use silent mode to reduce log output when compiling the kernel. Default value is false. Refer to -s for functionality.
enable_log false Set whether to log the kernel compilation process to a log file: /var/log/kernel_compile_*.log. Default value: false. Refer to -l for functionality.
ccache_clear false Set whether to clear the cache before compiling the kernel. Default value is false. Refer to -c for functionality.
docker_hostpath . Set the host mount path for kernel compilation. Defaults to the current working directory. Refer to -h for functionality.
docker_image ophub/armbian-trixie:arm64 Set the Docker container image for kernel compilation. Refer to -i for functionality.

  • GitHub Action Output Variables

To upload to Releases, you need to set Workflow read/write permissions for repository. For more details, see Usage Instructions.

Parameter Default Value Description
${{ env.PACKAGED_OUTPUTTAGS }} 6.12.y_6.18.y The name of the compiled kernel.
${{ env.PACKAGED_OUTPUTPATH }} compile-kernel/output The path of the directory where the compiled kernel is stored.
${{ env.PACKAGED_OUTPUTDATE }} 04.13.1058 The compilation date (month.day.hourminute).
${{ env.PACKAGED_STATUS }} success Compilation status: success / failure.

Kernel Usage Instructions

This kernel can be used for Armbian and OpenWrt systems. For example, the project of ophub.

Use in Armbian System

The following describes separately how to integrate it when compiling Armbian firmware, and how to install it for use in an existing system.

  • Using the Kernel to Compile Armbian Firmware

Compiling Armbian firmware supports localization operations, and it also supports online compilation using Actions on github.com. The method of use when localizing compilation can be found in: Local Packaging, and the method of use when using Actions for online compilation can be found in: Using GitHub Actions for Compilation.

  • Installing the Kernel in an Existing Armbian System

You can use the armbian-update command to install the compiled kernel into an existing Armbian system. For specific operation methods, please refer to: Update Armbian Kernel.

  • Custom Compile Driver Module

In the Linux mainline kernel, some drivers are not yet supported, so you can customize and compile driver modules. For specific instructions, please refer to: Compile Driver Module

Use in OpenWrt System

The following describes separately how to integrate it when compiling firmware in the OpenWrt system and how to install it for use in an existing system.

  • Using the Kernel to Compile OpenWrt Firmware

Compiling OpenWrt firmware supports localization operations, and it also supports online compilation using Actions on github.com. The method of use when localizing compilation can be found in: Local Packaging, and the method of use when using Actions for online compilation can be found in: Use GitHub Actions for Compilation.

  • Installing the Kernel in an Existing OpenWrt System

You can use the luci-app-amlogic plugin to install the compiled kernel into an existing OpenWrt system. For specific operation methods, please refer to: Update OpenWrt.