Merge pull request #119 from aisuneko/main

licheervnano: Add/Update Alpine/BuildRoot/Fedora
ruyisdk · Dec 20, 2024 · fb613a4 · fb613a4
2 parents 0ed73cc + 63efaea
commit fb613a4
Show file tree

Hide file tree

Showing 8 changed files with 1,225 additions and 33 deletions.
diff --git a/LicheeRV_Nano/Alpine/README.md b/LicheeRV_Nano/Alpine/README.md
@@ -0,0 +1,193 @@
+---
+sys: alpine
+sys_ver: null
+sys_var: null
+
+status: basic
+last_update: 2024-12-14
+---
+
+# Alpine Linux LicheeRV Nano Test Report
+
+## Test Environment
+
+### Operating System Information
+
+- System Version: 3.20.3 riscv64
+- Download Link: 
+  - Alpine minirootfs: [https://alpinelinux.org/downloads/](https://dl-cdn.alpinelinux.org/alpine/v3.20/releases/riscv64/alpine-minirootfs-3.20.3-riscv64.tar.gz)
+  - Official Buildroot image: [https://github.com/sipeed/LicheeRV-Nano-Build/releases/](https://github.com/sipeed/LicheeRV-Nano-Build/releases/download/20241129/2024-11-29-11-46-540e94.img.xz)
+- Reference Installation Document: 
+  - [Alpine Wiki (Installation)](https://wiki.alpinelinux.org/wiki/Installation)
+  - [Alpine Wiki (How to make a cross architecture chroot)](https://wiki.alpinelinux.org/wiki/How_to_make_a_cross_architecture_chroot)
+
+### Hardware Information
+
+- LicheeRV Nano
+- A USB-A to C or USB-C to C cable
+- A microSD card
+- A microSD card reader
+- A USB to UART debugger (e.g., CH340, CH341, FT2232, etc.)
+
+## Installation Steps
+
+### Download Alpine minirootfs and Buildroot image
+
+```bash
+wget https://dl-cdn.alpinelinux.org/alpine/v3.20/releases/riscv64/alpine-minirootfs-3.20.3-riscv64.tar.gz
+tar -xvf alpine-minirootfs-3.20.3-riscv64.tar.gz --one-top-level
+wget https://github.com/sipeed/LicheeRV-Nano-Build/releases/download/20241129/2024-11-29-11-46-540e94.img.xz
+xz -d 2024-11-29-11-46-540e94.img.xz
+```
+
+### Prepare rootfs
+Note that the obtained Alpine system is only a "minirootfs" without system packages such as OpenRC. We need to install Alpine's base packages using `apk` inside the rootfs in order to make it bootable.
+
+#### Install Alpine's package manager `apk`
+Skip this step if using Alpine-based distributions on host. Otherwise install `apk-tools` on your distribution (e.g. on Arch Linux: `sudo pacman -S apk-tools`).
+
+run `apk --help` to verify installation.
+
+#### Install Alpine's base package `alpine-base` inside minirootfs
+
+(`chroot` is NOT required)
+
+```bash
+cd alpine-minirootfs-3.20.3-riscv64
+sudo apk add -p . --initdb -U --arch riscv64 --allow-untrusted alpine-base
+```
+
+#### Extra setups
+
+1. Edit `./etc/inittab` and add the following line (or uncomment) to enable serial access on `/dev/ttyS0`:
+    ```
+    ttyS0::respawn:/sbin/getty -L 115200 ttyS0 vt100
+    ```
+    And comment out the six lines starting with `tty1` - `tty6`.
+
+2. Edit `./etc/passwd`:
+
+    Remove the `x` in `root:x:0:0:root:/root:/bin/sh`.
+
+    (Alternatively, edit `/etc/shadow` and remove the `*` in `root:*::0:::::`). 
+
+3. Enable the OpenRC hostname service (for setting up the hostname correctly)：
+   
+   ```bash
+   ln -s ./etc/init.d/hostname ./etc/runlevels/boot
+   ```
+   You may enable other OpenRC system services of interest likewise.
+
+### Flash Buildroot image
+
+```bash
+cd ..
+sudo dd if=2024-11-29-11-46-540e94.img of=/dev/your/device bs=4M status=progress
+```
+
+Your device should now be able to detect the `rootfs` and `boot` partitions on the SD card. Mount only the `rootfs` partition.
+
+### Replace root on SD card with Alpine rootfs
+```bash
+rm -rf /path/to/your/mnt/root/*
+cp -r /path/to/your/alpine-minirootfs-3.20.3-riscv64/* /path/to/your/mnt/root/
+```
+
+### Booting and Logging into the System
+
+Insert SD card onto the board and boot.
+Login into the system via serial port at `/dev/ttyUSB0`, baudrate 115200.
+
+Default username: `root`
+Default password: none
+
+#### Optional post-installation setups
+Setup the password and hostname with `passwd` and `hostname` after login. 
+
+Setup the system time with `date -s`, then install `cronyd`:
+```bash
+apk add cronyd
+rc-update add chronyd default
+```
+
+It is recommended to enable the following system OpenRC services (though test results show that the system will still be able to boot nevertheless):
+
+```bash
+rc-update add bootmisc boot
+rc-update add networking boot # make sure /etc/network/interfaces is present
+rc-update add devfs sysinit
+rc-update add mdev sysinit
+rc-update add acpid default
+rc-update add killprocs shutdown
+rc-update add mount-ro shutdown
+rc-update add savecache shutdown
+```
+
+## Expected Results
+
+The system should boot normally and allow login through the onboard serial port.
+
+## Actual Results
+
+The system booted successfully, and login through the onboard serial port was also successful.
+
+### Boot Log
+
+```log
+   OpenRC 0.54 is starting up Linux 5.10.4-tag- (riscv64)
+
+ * /proc is already mounted
+ * Mounting /run ... [ ok ]
+ * /run/openrc: creating directory
+ * /run/lock: creating directory
+ * /run/lock: correcting owner
+ * Caching service dependencies ... [ ok ]
+ * Clock skew detected with `/etc/init.d'
+ * Adjusting mtime of `/run/openrc/deptree' to Fri Dec 13 15:13:15 2024
+
+ * WARNING: clock skew detected!
+ * WARNING: clock skew detected!
+ * Setting hostname ... [ ok ]
+ * WARNING: clock skew detected!
+
+Welcome to Alpine Linux 3.20
+Kernel 5.10.4-tag- on an riscv64 (/dev/ttyS0)
+
+localhost login: root
+Welcome to Alpine!
+
+The Alpine Wiki contains a large amount of how-to guides and general
+information about administrating Alpine systems.
+See <https://wiki.alpinelinux.org/>.
+
+You can setup the system with the command: setup-alpine
+
+You may change this message by editing /etc/motd.
+
+login[287]: root login on 'ttyS0'
+localhost:~# uname -a
+Linux localhost 5.10.4-tag- #14 PREEMPT Fri Nov 29 11:40:35 CST 2024 riscv64 Linux
+localhost:~# cat /etc/os-release
+NAME="Alpine Linux"
+ID=alpine
+VERSION_ID=3.20.3
+PRETTY_NAME="Alpine Linux v3.20"
+HOME_URL="https://alpinelinux.org/"
+BUG_REPORT_URL="https://gitlab.alpinelinux.org/alpine/aports/-/issues"
+localhost:~# free -h
+              total        used        free      shared  buff/cache   available
+Mem:         128.0M       10.2M      112.4M       32.0K        5.3M      113.0M
+Swap:             0           0           0
+localhost:~#
+
+```
+
+## Test Criteria
+
+Successful: The actual result matches the expected result.
+
+Failed: The actual result does not match the expected result.
+
+## Test Conclusion
+
+Test successful.
diff --git a/LicheeRV_Nano/Alpine/README_zh.md b/LicheeRV_Nano/Alpine/README_zh.md
@@ -0,0 +1,184 @@
+# Alpine Linux LicheeRV Nano 测试报告
+
+## 测试环境
+
+### 操作系统信息
+
+- 系统版本：3.20.3 riscv64
+- 下载链接：
+  - Alpine minirootfs: [https://alpinelinux.org/downloads/](https://dl-cdn.alpinelinux.org/alpine/v3.20/releases/riscv64/alpine-minirootfs-3.20.3-riscv64.tar.gz)
+  - 官方 Buildroot 镜像: [https://github.com/sipeed/LicheeRV-Nano-Build/releases/](https://github.com/sipeed/LicheeRV-Nano-Build/releases/download/20241129/2024-11-29-11-46-540e94.img.xz)
+- 参考安装文档：
+  - [Alpine Wiki (Installation)](https://wiki.alpinelinux.org/wiki/Installation)
+  - [Alpine Wiki (How to make a cross architecture chroot)](https://wiki.alpinelinux.org/wiki/How_to_make_a_cross_architecture_chroot)
+
+### 硬件信息
+
+- LicheeRV Nano
+- Type-C 电源线一根
+- UART 转 USB 调试器一个
+- microSD 卡一张
+- microSD 读卡器一个
+
+## 安装步骤
+
+### 下载 Alpine minirootfs 和 Buildroot 镜像
+
+```bash
+wget https://dl-cdn.alpinelinux.org/alpine/v3.20/releases/riscv64/alpine-minirootfs-3.20.3-riscv64.tar.gz
+tar -xvf alpine-minirootfs-3.20.3-riscv64.tar.gz --one-top-level
+wget https://github.com/sipeed/LicheeRV-Nano-Build/releases/download/20241129/2024-11-29-11-46-540e94.img.xz
+xz -d 2024-11-29-11-46-540e94.img.xz
+```
+
+### 准备 rootfs
+Alpine 官方提供的 riscv64 发行仅是一个 "minirootfs", 缺少 OpenRC 等必要的系统组件。要在实体硬件上启动，我们需要使用 `apk` 在该 minirootfs 中安装 Alpine 基础包。 
+
+#### 安装 Alpine 包管理器 `apk`
+（如果宿主机已经在使用 Alpine 系发行版则跳过此步）
+安装 `apk-tools` （如在 Arch Linux 上： `sudo pacman -S apk-tools`），并运行 `apk --help` 确认安装。
+
+#### 在 minirootfs 中安装 Alpine 基础包 `alpine-base`
+
+(注：无需 `chroot`)
+
+```bash
+cd alpine-minirootfs-3.20.3-riscv64
+sudo apk add -p . --initdb -U --arch riscv64 --allow-untrusted alpine-base
+```
+
+#### 额外设置
+
+1. 编辑 `./etc/inittab`，加入或取消注释下面一行以启用 `/dev/ttyS0` 上的串口访问：
+    ```
+    ttyS0::respawn:/sbin/getty -L 115200 ttyS0 vt100
+    ```
+    并注释掉以 `tty1` - `tty6` 开头的六行。
+
+2. 编辑 `./etc/passwd`:
+
+    去掉 `root:x:0:0:root:/root:/bin/sh` 一行中的 `x`。
+
+    （也可以编辑  `/etc/shadow` 并去掉 `root:*::0:::::` 一行中的 `*`）。
+
+3. 启用 OpenRC hostname 服务 （否则主机名无法正确设置）：
+   
+   ```bash
+   ln -s ./etc/init.d/hostname ./etc/runlevels/boot
+   ```
+   可仿照此步按需启用其他的 OpenRC 系统服务。
+
+### 刷入 Buildroot 镜像
+
+```bash
+cd ..
+sudo dd if=2024-11-29-11-46-540e94.img of=/dev/your/device bs=4M status=progress
+```
+
+你的设备应该能识别到 SD 卡上的 `rootfs` 和 `boot` 两个分区。挂载 `rootfs` 分区。
+
+### 替换 SD 卡上根目录为 Alpine rootfs
+```bash
+rm -rf /path/to/your/mnt/root/*
+cp -r /path/to/your/alpine-minirootfs-3.20.3-riscv64/* /path/to/your/mnt/root/
+```
+
+### 启动并登录系统
+
+将 SD 卡插入开发板并启动。
+通过 `/dev/ttyUSB0` 上的串口登录系统 （baudrate 115200）。
+
+用户名: `root`
+密码: 无
+
+#### 安装后设置
+登录后分别使用 `passwd` 和 `hostname` 设置密码和主机名。
+
+使用 `date -s` 设置系统时间，再安装 `cronyd`:
+
+```bash
+apk add cronyd
+rc-update add chronyd default
+```
+
+建议同时启用如下的 OpenRC 服务（虽然测试中发现如跳过此步，系统仍然可以正常启动）：
+
+```bash
+rc-update add bootmisc boot
+rc-update add networking boot # 需要先编辑好 /etc/network/interfaces
+rc-update add devfs sysinit
+rc-update add mdev sysinit
+rc-update add acpid default
+rc-update add killprocs shutdown
+rc-update add mount-ro shutdown
+rc-update add savecache shutdown
+```
+
+## 预期结果
+
+系统正常启动，能够通过串口登录。
+
+## 实际结果
+
+系统正常启动，成功通过串口登录。
+
+### 启动信息
+
+```log
+   OpenRC 0.54 is starting up Linux 5.10.4-tag- (riscv64)
+
+ * /proc is already mounted
+ * Mounting /run ... [ ok ]
+ * /run/openrc: creating directory
+ * /run/lock: creating directory
+ * /run/lock: correcting owner
+ * Caching service dependencies ... [ ok ]
+ * Clock skew detected with `/etc/init.d'
+ * Adjusting mtime of `/run/openrc/deptree' to Fri Dec 13 15:13:15 2024
+
+ * WARNING: clock skew detected!
+ * WARNING: clock skew detected!
+ * Setting hostname ... [ ok ]
+ * WARNING: clock skew detected!
+
+Welcome to Alpine Linux 3.20
+Kernel 5.10.4-tag- on an riscv64 (/dev/ttyS0)
+
+localhost login: root
+Welcome to Alpine!
+
+The Alpine Wiki contains a large amount of how-to guides and general
+information about administrating Alpine systems.
+See <https://wiki.alpinelinux.org/>.
+
+You can setup the system with the command: setup-alpine
+
+You may change this message by editing /etc/motd.
+
+login[287]: root login on 'ttyS0'
+localhost:~# uname -a
+Linux localhost 5.10.4-tag- #14 PREEMPT Fri Nov 29 11:40:35 CST 2024 riscv64 Linux
+localhost:~# cat /etc/os-release
+NAME="Alpine Linux"
+ID=alpine
+VERSION_ID=3.20.3
+PRETTY_NAME="Alpine Linux v3.20"
+HOME_URL="https://alpinelinux.org/"
+BUG_REPORT_URL="https://gitlab.alpinelinux.org/alpine/aports/-/issues"
+localhost:~# free -h
+              total        used        free      shared  buff/cache   available
+Mem:         128.0M       10.2M      112.4M       32.0K        5.3M      113.0M
+Swap:             0           0           0
+localhost:~#
+
+```
+
+## 测试判定标准
+
+测试成功：实际结果与预期结果相符。
+
+测试失败：实际结果与预期结果不符。
+
+## 测试结论
+
+测试成功。