目录


BiscuitOS 硬件准备

开发者首先准备一台主机或电脑,CPU 最好是 Intel CPU。可以选择安装 Ubuntu 系统,或者采用 Windows+VirtualBox 虚拟机方案。由于项目构建基于 Ubuntu,因此需要准备一台运行 Ubuntu 14.04/16.04/18.04/20.04/22.04 的主机(推荐使用 Ubuntu20.04)。由于第一次部署需要下载相关的源码包,因此主机需要保持网络的连通.

BiscuitOS 软件准备

开发者准好硬件设备之后,首先在 Ubuntu 上安装相应的开发工具,这些工具是编译源码的前提,如果不安装可能会导致部署失败,反而影响进度,因此推荐开发者参考下面文档进行安装,其他 Linux 发行版与之类似:

基础环境搭建完毕之后,开发者从 GitHub/Gitee 上获取 BiscuitOS 项目源码(国内开发者建议从 Gitee 上获得源码),使用如下命令:

# From Github
git clone https://github.com/BiscuitOS/BiscuitOS.git --depth=1
# From Gitee
git clone https://gitee.com/BiscuitOS_team/BiscuitOS.git --depth=1
cd BiscuitOS

BiscuitOS 源码下载完毕后,使用 BiscuitOS 自动部署功能,部署一个 Linux 6.0 x86_64 的开发部署,使用自动部署功能之后,BiscuitOS 项目会自动下载并部署 Linux 6.0 x86_64 所需的源码和编译工具等,可能需要一些时间,请保持网络的通畅. 开发者参考下面命令进行部署:

cd BiscuitOS
make linux-6.0-x86_64_defconfig
make
cd BiscuitOS/output/linux-6.0-x86_64

成功执行之后,BiscuitOS 输出 Linux 6.0 x86_64 项目目录,以及对应内核的目录,并且自动生成 BiscuitOS Linux 6.0 x86_64 用户手册 (README),开发者应该重点参考该 README.md.


Linux 内核配置

对于内核配置,根据 README.md 的提示(实际情况以 README.md 为准),配置内核可以参考如下命令:

cd BiscuitOS/output/linux-6.0-x86_64/linux/linux
make ARCH=x86_64 clean
make ARCH=x86_64 x86_64_defconfig
make ARCH=x86_64 menuconfig

  Device Drivers --->
        [*] Virtio drivers --->
            <*> PCI driver for virtio devices
        [*] Block devices --->
            <*> Virtio block driver
Linux 内核编译

内核配置完毕之后,接下来就是编译内核,根据 README.md 里提供的命令进行编译,具体命令如下:

cd BiscuitOS/output/linux-6.0-x86_64/linux/linux
make ARCH=x86_64 bzImage -j4
make ARCH=x86_64 modules -j4
Busybox/Rootfs 制作

为了使 BiscuitOS 能够运行,开发者需要为 BiscuitOS 准备运行必备的工具,BiscuitOS 默认使用 busybox 进行系统 rootfs 的构建,开发者可以参考如下命令进行构建:

cd BiscuitOS/output/linux-6.0-x86_64/busybox/busybox
make clean
make menuconfig
   Busybox Settings --->
     Build Options --->
       [*] Build Busybox as a static binary (no shared libs)

# 编译 Busybox
make -j4
# 安装 Busybox
make install

编译完上面的工具和 Linux 之后,运行前的最后一步就是制作一个可运行的 Rootfs。开发者可以使用 README 中提供的命令进行制作,如下:

cd BiscuitOS/output/linux-6.0-x86_64
./RunBiscuitOS.sh pack
BiscuitOS 基础使用

在准备完各个模块之后,开发者完成本节的内容之后,就可以运行一个完整的 BiscuitOS 系统. BiscuitOS 的运行很简单,通过提供 RunBiscuitOS.sh 脚本将涉及的启动命令全部整理包含成精简的命令,开发者可以通过查看 RunBiscuitOS.sh 脚本逻辑来研究 BiscuitOS 运行机理. BiscuitOS 的运行很简单,开发者执行使用如下命令即可:

cd BiscuitOS/output/linux-6.0-x86_64
./RunBiscuitOS.sh


BiscuitOS 驱动部署

BiscuitOS 支持 “BiscuitOS 驱动框架部署” 和 “内核驱动部署” 两种方式进行 Linux 驱动开发。”BiscuitOS 驱动框架部署” 是 BiscuitOS 提供的一套快速驱动开发框架. “内核驱动部署” 是标准 Linux 源码树下内核驱动开发框架。开发者可以根据需求选择驱动开发方式.


BiscuitOS 驱动框架部署

BiscuitOS 以及完整支持驱动开发体系,并基于 Kbuild 编译系统,制作了一套便捷的驱动开发环境,开发者可以参考如下步骤进行快速开发,本次以一个 MISC 驱动为例进行讲解。


MISC 源码获取

首先开发者应该准备基于 Linux 6.0 x86_64 开发环境,然后使用如下命令获得 Platform 所需的开发环境:

cd BiscuitOS
make linux-6.0-x86_64_defconfig
make menuconfig

    [*] Package --->
        [*] BiscuitOS Demo Code -->
            [*] MISC-DD Demo Code on BiscuitOS -->

# 编译生效
cd BiscuitOS
make
# 源码目录
BiscuitOS/output/linux-6.0-x86_64/package/BiscuitOS-MISC-default


MISC 源码编译运行

MISC 的编译很简单,只需执行如下命令就可以快速编译:

cd BiscuitOS/output/linux-6.0-x86_64/package/BiscuitOS-MISC-default
make prepare
make download
make
make install
make pack
make run

运行 BiscuitOS 之后,在 BiscuitOS 上使用如下命令:

# 安装模块
insmod lib/modules/$(uname -r)/extra/BiscuitOS-MISC-default.ko
# 运行应用程序
APP


通用驱动开发

通用驱动开发模式就是按标准的内核驱动开发方式,将驱动放到内核 源码树内或者源码树之外进行开发,这里以内核源码树内开发为例:


驱动源码

开发者首先准备一份驱动源码,可以操作如下源码,本节中使用一份 misc 驱动,并命名为 BiscuitOS_drv.c,具体源码如下:


驱动安置

开发者准备好源码之后,接着将源码添加到内核源码树。开发者在内核源码树目录下,找到 drivers 目录,然后在 drivers 目录下创建一个名为 BiscuitOS 的目录,然后将源码 BiscuitOS_drv.c 放入到 BiscuitOS 目录下。接着添加 Kconfig 和 Makefile 文件,具体内容如下:

mkdir -p BiscuitOS/output/linux-6.0-x86_64/linux/linux/drivers/BiscuitOS
Kconfig

Makefile

接着修改内核源码树 drivers 目录下的 Kconfig,在文件的适当位置加上如下代码:

source "drivers/BiscuitOS/Kconfig"

然后修改内核源码树 drivers 目录下的 Makefile,在文件的末尾上加上如下代码:

obj-$(CONFIG_BISCUITOS_DRV)  += BiscuitOS/


驱动配置

准备好所需的文件之后,接下来进行驱动在内核源码树中的配置,使用如下命令:

cd BiscuitOS/output/linux-6.0-x86_64/linux/linux
make ARCH=x86_64 menuconfig

  Device Drivers --->
     <M> BiscuitOS Driver --->
         <M> BiscuitOS misc driver


驱动编译

配置完驱动之后,接下来将编译驱动。开发者使用如下命令编译驱动:

make ARCH=x86_64 modules -j4
make ARCH=x86_64 INSTALL_MOD_PATH=BiscuitOS/output/linux-6.0-x86_64/rootfs/rootfs/ modules_install

从编译的 log 可以看出 BiscuitOS_drv.c 已经被编译进内核。


驱动安装

驱动安装制作很简单,请参考如下命令:

cd BiscuitOS/output/linux-6.0-x86_64
./RunBiscuitOS.sh pack

驱动使用

模块的使用也很简单,使用如下命令:

cd BiscuitOS/output/linux-6.0-x86_64/
./RunBiscuitOS.sh

运行 BiscuitOS 之后,在 BiscuitOS 上使用如下命令:

cd lib/modules/6.0.0/kernel/driver/BiscuitOS/
insmod misc.ko


BiscuitOS 应用程序部署

BiscuitOS 目前提供了一套便捷的应用程序开发框架,开发者可以使用这套框架快速实践应用程序,开发者可以参考如下步骤进行应用程序实践, 本次以一个 Application Demo 为例进行讲解。


应用程序源码获取

首先开发者应该准备基于 Linux 6.0 x86_64 开发环境,然后使用如下命令获得应用程序所需的开发环境:

cd BiscuitOS
make linux-6.0-x86_64_defconfig
make menuconfig

    [*] Package --->
        [*] BiscuitOS Demo Code -->
            [*] MISC-DD Demo Code on BiscuitOS -->

# 编译生效
cd BiscuitOS
make
# 源码目录
BiscuitOS/output/linux-6.0-x86_64/package/BiscuitOS-Application-default


应用程序源码编译和运行

应用程序的编译很简单,只需执行如下命令就可以快速编译:

cd BiscuitOS/output/linux-6.0-x86_64/package/BiscuitOS-Application-default
make prepare
make download
make
make install
make pack
make run

BiscuitOS 运行之后执行 BiscuitOS-Application-default 命令即可运行程序.


BiscuitOS 调试部署

BiscuitOS 的 Linux 内核也支持多种调试,其中比较重要的方式就是 GDB 调试,开发者可以使用 GDB 对内核进行单步调试,具体步骤如下:

首先使用 QEMU 的调试工具,将内核挂起等待调试,使用如下命令:

cd BiscuitOS/output/linux-6.0-x86_64
./RunBiscuitOS.sh debug

接着在另外一个终端中输入如下命令,作为 gdb server

gdb BiscuitOS/output/linux-6.0-x86_64/linux/linux/vmlinux

输入以上命令之后,在第二个终端中,会进入 gdb 模式,此时以此输入一下命名进行 gdb 挂载:

(gdb) target remote :1234

然后开发者可以根据自己的需求进行内核调试,比如在 start_kernel 出添加 一个断点调试,如下:

(gdb) b start_kernel
(gdb) c
(gdb) list
(gdb) info reg

更多内核调试,请查考文档:


附录

BiscuitOS Home

BiscuitOS Catalogue

Linux Kernel

Bootlin: Elixir Cross Referencer

捐赠一下吧 🙂

MMU