Skip to content

Latest commit

 

History

History
158 lines (110 loc) · 14.4 KB

README.cn.md

File metadata and controls

158 lines (110 loc) · 14.4 KB

内核编译与使用指南

查看英文说明 | View English description

本项目编译的内核兼容 Armbian 和 OpenWrt 系统，可用于 amlogic-s9xxx-armbian、amlogic-s9xxx-openwrt、flippy-openwrt-actions 和 unifreq/openwrt_packit 等项目。既可在编译固件时集成，也可安装到已有系统中使用。

你可以根据需要调整内核配置，例如添加驱动和补丁。也可以编译带有个性化签名的内核，如 5.10.95-happy-new-year、5.10.96-beijing-winter-olympics、5.10.99-valentines-day 等。

内核仓库

在 ophub/kernel 的 Releases 中提供了预编译的内核文件。

本地编译

  • 在 Ubuntu 系统下运行

  1. 克隆仓库到本地：git clone --depth 1 https://github.com/ophub/amlogic-s9xxx-armbian.git

  2. 安装必要的软件包（以 Ubuntu 24.04 为例）：

进入 ~/amlogic-s9xxx-armbian 根目录，然后执行安装命令：

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. 进入 ~/amlogic-s9xxx-armbian 根目录，执行 sudo ./recompile -k 5.15.100 等指定参数命令即可编译内核。脚本将自动下载并安装编译环境和内核源代码，并完成全部配置。编译完成的内核文件保存在当前源码树的 compile-kernel/output 目录中，或通过 -h 参数指定的目录中。

  • 在 Armbian 系统下运行

可以直接在 Armbian 系统中编译内核，也可以在 Ubuntu/Debian 等系统上通过 Docker 容器运行 Armbian 系统来编译内核。Armbian 系统 Docker 镜像的制作方法可参考 armbian_docker 构建脚本。

  1. 更新本地编译环境和配置文件：armbian-kernel -u

  2. 编译内核：执行 armbian-kernel -k 5.15.100 等指定参数命令即可编译内核。脚本将自动下载并安装编译环境和内核源代码，并完成全部配置。编译完成的内核文件保存在 /opt/kernel/compile-kernel/output 目录中。

  • 本地编译参数说明

参数 含义 说明
-r Repository 指定编译内核的源代码仓库。可选择 github.com 上的内核源代码仓库，例如 -r unifreq。参数格式支持 owner/repo@branch 三部分组合，其中所有者名称 owner 为必选参数，仓库名称 /repo 和分支名称 @branch 为可选参数。当仅指定所有者名称时，将自动匹配该所有者下名称符合 linux-5.x.y 格式且分支为 main 的内核源代码仓库。若仓库名称或分支名称不同，请使用组合方式指定，如 owner@branch、owner/repo 或 owner/repo@branch。默认值：unifreq
-k Kernel 指定内核版本，如 -k 5.15.100。多个内核以 _ 分隔，如 -k 5.15.100_5.15.50。使用 -k all 表示编译全部主线内核，当前等价于 -k 5.10.y_5.15.y_6.1.y_6.6.y_6.12.y_6.18.y，内核列表会随上游内核源码仓库 unifreq 的维护状态动态调整。
-a AutoKernel 设置是否自动采用同系列最新版本内核。设为 true 时，将自动检查 -k 指定的内核（如 5.15.100）同系列是否存在更新版本，若存在则自动切换为最新版。设为 false 时则编译指定版本。默认值：true
-m MakePackage 设置内核构建的包列表。设为 all 时生成 Image、modules、dtbs 全部文件；设为 dtbs 时仅生成 3 个 DTB 文件。默认值：all
-f configFlavor 指定从内核仓库 ophub/kernel 下载的配置文件 config-* 到本地 tools/config 目录。若本地已存在对应内核版本的配置文件且未设置此参数，则跳过下载。可选项为内核仓库中存在的目录名，例如：stable / rk3588 / rk35xx / h6。默认值：stable
-p AutoPatch 设置是否应用自定义内核补丁。设为 true 时将使用 tools/patch 目录下的内核补丁，详细说明参考内核补丁添加方法。默认值：false
-n CustomName 设置内核自定义签名。例如设为 -ophub 时，生成的内核名称为 5.15.100-ophub。签名中请勿包含空格。默认值：-ophub
-t Toolchain 设置编译内核的工具链。可选项：clang / gcc / gcc-<version>。默认值：gcc
-z CompressFormat 设置内核中 initrd 使用的压缩格式。可选项：xz / gzip / zstd / lzma。默认值：xz
-d DeleteSource 设置内核编译完成后是否删除源代码。可选项：true / false。默认值：false
-s SilentLog 设置编译时是否启用静默模式以减少日志输出。可选项：true / false。默认值：false
-l EnableLog 设置是否将编译过程记录到日志文件：/var/log/kernel_compile_*.log。可选项：true / false。默认值：false
-c CcacheClear 设置编译前是否清除 ccache 缓存。可选项：true / false。默认值：false
-h DockerHostpath 设置内核编译时 Docker 容器在宿主机的挂载路径。默认使用当前目录。
-i DockerImage 设置编译内核的 Docker 容器镜像。默认值：ophub/armbian-trixie:arm64
  • sudo ./recompile : 使用默认配置编译内核。
  • sudo ./recompile -k 5.15.100 : 使用默认配置，并通过 -k 进行指定需要编译的内核版本，多个版本同时编译时使用 _ 进行连接。
  • sudo ./recompile -k 5.15.100 -f stable : 使用默认配置，并通过 -k 5.15.100 参数指定需要编译的内核版本，通过 -f stable 参数指定从内核仓库下载 stable 目录下的配置文件。
  • sudo ./recompile -k 5.15.100 -a true : 使用默认配置，并通过 -a 参数设置编译内核时，是否自动升级到同系列最新内核。
  • sudo ./recompile -k 5.15.100 -n -ophub : 使用默认配置，并通过 -n 参数设置内核自定义签名。
  • sudo ./recompile -k 5.15.100 -m dtbs : 使用默认配置，并通过 -m 参数指定仅制作 dtbs 文件。
  • sudo ./recompile -k 5.15.100_6.1.10 -a true -n -ophub : 使用默认配置，并通过多个参数进行设置。

’ 提示：推荐使用 unifreq 的 linux-6.1.y、linux-5.15.y、linux-5.10.y 等仓库的内核源代码进行编译，其中已针对相关设备添加了驱动和补丁。配置文件推荐使用 ophub/kernel 中的模板，已针对支持的设备进行了预配置，可在此基础上进行个性化定制。

使用 GitHub Actions 编译内核

  1. 在 Action 页面选择 Compile the kernel，点击 Run workflow 按钮即可开始编译。

  2. 详见模板 compile-kernel-via-docker.yml。代码如下：

- 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

’ 注意：若你 fork 仓库并进行了修改，使用时须将 Actions 的用户名改为你自己的仓库，例如：

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

  • GitHub Action 输入参数说明

相关参数与本地编译命令相对应，请参考上述说明。

参数 默认值 说明
build_target kernel 固定参数 kernel，设置编译目标为内核。
kernel_source unifreq 指定编译内核的源代码仓库。默认值：unifreq。功能参考 -r
kernel_version 6.12.y_6.18.y 指定内核版本，如 5.15.100。功能参考 -k
kernel_auto true 设置是否自动采用同系列最新版本内核。默认值：true。功能参考 -a
kernel_package all 设置内核构建的包列表。默认值：all。功能参考 -m
kernel_sign -ophub 设置内核自定义签名。默认值：-ophub。功能参考 -n
kernel_toolchain gcc 设置编译内核的工具链。默认值：gcc。功能参考 -t
config_flavor stable 指定从内核仓库 ophub/kernel 下载的配置文件 config-* 到本地 tools/config 目录。若本地已存在对应内核版本的配置文件且未设置此参数，则跳过下载。可选项为内核仓库中存在的目录名，例如：stable / rk3588 / rk35xx / h6。默认值：stable。若同时设置了 kernel_config 参数，最终优先采用 config_flavor 指定的配置文件。这两个参数互斥，可任选其一：通过前者使用 ophub/kernel 的内核配置文件，或通过后者使用你自己仓库的配置文件。功能参考 -f
kernel_config false 默认使用 tools/config 目录下的配置模板。可指定你仓库中存放内核配置文件的目录，如 kernel/config_path。该目录下的配置模板须以内核主版本命名，如 config-5.10、config-5.15 等。
kernel_patch false 指定你仓库中自定义内核补丁文件的目录。若设置此参数，编译前将自动从指定目录下载补丁文件；未设置则跳过。
auto_patch false 设置是否应用自定义内核补丁。默认值：false。功能参考 -p
compress_format xz 设置内核中 initrd 使用的压缩格式。默认值：xz。功能参考 -z
delete_source false 设置编译完成后是否删除内核源代码。默认值：false。功能参考 -d
silent_log false 设置编译时是否启用静默模式以减少日志输出。默认值：false。功能参考 -s
enable_log false 设置是否将编译过程记录到日志文件：/var/log/kernel_compile_*.log。默认值：false。功能参考 -l
ccache_clear false 设置编译前是否清除 ccache 缓存。默认值：false。功能参考 -c
docker_hostpath . 设置内核编译时 Docker 容器在宿主机的挂载路径。默认使用当前目录。功能参考 -h
docker_image ophub/armbian-trixie:arm64 设置编译内核的 Docker 容器镜像。功能参考 -i

  • GitHub Action 输出变量说明

上传到 Releases 需要给仓库设置 Workflow 读写权限，详见使用说明。

参数 默认值 说明
${{ env.PACKAGED_OUTPUTTAGS }} 6.12.y_6.18.y 编译完成的内核名称
${{ env.PACKAGED_OUTPUTPATH }} compile-kernel/output 编译完成的内核文件所在目录
${{ env.PACKAGED_OUTPUTDATE }} 04.13.1058 编译日期（月.日.时分）
${{ env.PACKAGED_STATUS }} success 编译状态：success / failure

内核使用指南

本项目编译的内核兼容 Armbian 和 OpenWrt 系统。以下以 ophub 的项目为例进行说明。

在 Armbian 系统中使用

以下分别介绍如何在编译 Armbian 固件时集成内核，以及如何将内核安装到已有系统中。

  • 使用内核编译 Armbian 固件

Armbian 固件编译支持本地操作，也支持通过 github.com 的 Actions 在线编译。本地编译方法详见：本地化打包，使用 Actions 在线编译的方法详见：使用 GitHub Actions 进行编译

  • 将内核安装到已有的 Armbian 系统

使用 armbian-update 命令可将编译好的内核安装到已有的 Armbian 系统中，具体操作方法详见：更新 Armbian 内核

  • 自定义编译驱动模块

在 Linux 主线内核中，部分驱动尚未被支持，可自行编译所需的驱动模块。具体操作方法详见：编译驱动模块

在 OpenWrt 系统中使用

以下分别介绍如何在 OpenWrt 系统编译固件时集成内核，以及如何将内核安装到已有系统中。

  • 使用内核编译 OpenWrt 固件

OpenWrt 固件编译支持本地操作，也支持通过 github.com 的 Actions 在线编译。本地编译方法详见：本地化打包，使用 Actions 在线编译的方法详见：使用 Github Actions 进行编译

  • 将内核安装到已有的 OpenWrt 系统

使用 luci-app-amlogic 插件可将编译好的内核安装到已有的 OpenWrt 系统中，具体操作方法详见：升级 OpenWrt