Skip to content

Commit

Permalink
update group link
Browse files Browse the repository at this point in the history
  • Loading branch information
FIFCC committed Oct 28, 2024
1 parent 9335372 commit 3232575
Show file tree
Hide file tree
Showing 51 changed files with 3,053 additions and 32 deletions.
Binary file added docs/en/Installation/image for flash/lpi4a1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/Installation/image for flash/lpi4a2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/Installation/image for flash/lpi4a3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/Installation/image for flash/lpi4a4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/Installation/image for flash/lpi4a5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
Empty file.
123 changes: 123 additions & 0 deletions docs/en/Installation/licheepi4a.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# LicheePi 4A Image Flashing Guide

The LicheePi 4A board supports booting from both SD card and eMMC. Below are instructions for flashing RevyOS images for each method.

**Environment**: Ubuntu 22.04

---

## Booting from SD Card

> **Note:** Ensure the dip switch is set for eMMC boot, even when booting from an SD card.
### Preparation

#### Hardware

- A MicroSD card reader
- A MicroSD card

#### Required Tools

Download the [BalenaEtcher tool](https://etcher.balena.io/) for flashing.
Install `zstd` for decompressing the image:

```bash
apt install zstd
```

#### Downloading the Image

Download the system image for LicheePi4A from the [RevyOS mirror site](https://mirror.iscas.ac.cn/revyos/extra/images/lpi4a/20240720/).

Decompress the downloaded image file:

```bash
unzstd sdcard-lpi4a-20240720_171951.img.zst
```

### Writing the Image to the MicroSD Card

1. Insert the SD card into the reader and connect it to the computer.
2. Open BalenaEtcher, click "Flash from file," and select the `.img` file.
![Select image file](./image%20for%20flash/lpi4a1.png)
3. In the second field, select the target SD card.
![Select target device](./image%20for%20flash/lpi4a2.png)
4. Click "Flash" to begin the write process.
![Flash process](./image%20for%20flash/lpi4a3.png)
5. Wait for the flashing to complete. A success message will appear.
![Flash complete](./image%20for%20flash/lpi4a4.png)

### System Boot

After flashing, insert the SD card into the slot on the board, as shown below.
![SD card slot](./image%20for%20flash/lpi4a5.png)

Connect the HDMI and power cables to start the system.

---

## Booting from eMMC

When booting from eMMC, RevyOS images are flashed to the eMMC storage using `fastboot`. There are two options: connecting with or without a serial interface. This guide provides instructions for both methods.

### Preparation

Flashing the image to eMMC requires U-Boot, boot, and root files to be flashed via `fastboot`. Ensure `fastboot` is installed:

```bash
apt install fastboot
```

If using a serial connection, install `minicom` to monitor the console:

```bash
apt install minicom
```

#### Downloading the Image

Download the necessary image files for LicheePi4A from the [RevyOS mirror site](https://mirror.iscas.ac.cn/revyos/extra/images/lpi4a/20240720/).

Make sure to choose the U-Boot file that matches your board model (8GB or 16GB).

### Flashing the Image to eMMC (Without Serial Connection)

1. Hold down the reset button on the board and connect it to the computer via USB. The board will enter flashing mode.

### Flashing the Image to eMMC (With Serial Connection)

1. Open `minicom` in a terminal to access the serial console:

```bash
sudo minicom
```

2. Connect the USB end to the computer, and connect the Type-C interface on the board to the computer with a USB-Type-C cable.

3. In the serial console, press any key to interrupt the boot process. Then, enter the following command:

```bash
fastboot usb 0
```

4. In a new terminal window, navigate to the folder where the image files are stored, and execute the following flash commands:

```bash
fastboot flash uboot u-boot-with-spl-lpi4a-16g.bin
fastboot flash boot boot-lpi4a-20240720_171951.ext4
fastboot flash root root-lpi4a-20240720_171951.ext4
```

5. Monitor the flashing progress in the serial console.

6. After flashing is complete, disconnect the USB-Type-C cable, connect the power cable, and boot into the system.

---

### User Login

Default credentials for RevyOS:

- **Username**: debian
- **Password**: debian
Empty file.
121 changes: 121 additions & 0 deletions docs/en/Installation/milkv-pioneer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# Installing RevyOS on the Milk-V Pioneer

## 1. Preparation

### Required Tools

- MicroSD card
- MicroSD card reader
- NVMe SSD reader

### Downloading the Image

RevyOS image directory: [Download Link](https://mirror.iscas.ac.cn/revyos/extra/images/sg2042/)

Latest image version: [20240819](https://mirror.iscas.ac.cn/revyos/extra/images/sg2042/20240819/)

Example directory for the 20240819 image:

![Image Directory](image%20for%20flash/pioneer-image-dir.png)

RevyOS requires flashing both firmware and system files, as listed below:

- **Firmware files**:
- `firmware_single_sg2042-v6.6-lts-v0p7.bin` (for SPI Flash)
- `firmware_single_sg2042-v6.6-lts-v0p7.img` (for SD card)

- **System file**:
- `revyos-pioneer-20240819-154656.img.zst`

---

## 2. Flashing the Firmware

### Flashing Options

Firmware files can be stored on either the SPI Flash or an SD card, so the method will vary accordingly.

### Flashing Firmware to SD Card

**Operating System**: Ubuntu 22.04

#### Using BalenaEtcher

1. Select the file `firmware_single_sg2042-v6.6-lts-v0p7.img`.
2. Choose the target SD card.
3. Click "Flash" to start the process.

#### Using Command Line

Insert the SD card into a reader connected to your computer, then verify the device path.

Navigate to the directory with `firmware_single_sg2042-v6.6-lts-v0p7.img` and flash it with the following command:

```bash
sudo dd if=firmware_single_sg2042-v6.6-lts-v0p7.img of=/dev/sda bs=4M status=progress
```

Replace `of=/dev/sda` with your specific device path if different.

After flashing, use `sync` to ensure data is fully written to the SD card.

### Flashing Firmware to SPI Flash

**Operating System**: RevyOS0819

> **Note**: For first-time installation, using an SD card to store the firmware is recommended.
#### Using Command Line

Flashing to the SPI Flash requires installing utilities and loading the `mtd` module.

1. Install necessary packages:

```bash
sudo apt install mtd-utils
sudo modprobe mtdblock
```

2. Download the firmware file:

```bash
wget https://mirror.iscas.ac.cn/revyos/extra/images/sg2042/20240819/firmware_single_sg2042-v6.6-lts-v0p7.bin
```

3. Navigate to the directory where `firmware_single_sg2042-v6.6-lts-v0p7.bin` was downloaded and run:

```bash
sudo flashcp -v firmware_single_sg2042-v6.6-lts-v0p7.bin /dev/mtd1
```

Flashing to SPI Flash is now complete.

---

## 3. Flashing the RevyOS Image

**Operating System**: Ubuntu 22.04

### Using Command Line

1. Decompress the `revyos-pioneer-20240819-154656.img.zst` file:

```bash
unzstd revyos-pioneer-20240819-154656.img.zst
```

This produces the `revyos-pioneer-20240819-154656.img` file.

2. Insert the NVMe SSD into the reader and connect it to your computer, then confirm the device path.

3. In the directory containing `revyos-pioneer-20240819-154656.img`, flash the image to the NVMe SSD:

```bash
sudo dd if=revyos-pioneer-20240819-154656.img of=/dev/nvme0n1 bs=4M status=progress
```

Replace `of=/dev/nvme0n1` with the correct device path if different.

4. After flashing, use `sync` to ensure the data is fully written to the NVMe SSD.


69 changes: 69 additions & 0 deletions docs/en/Installation/在 macOS 上刷写 RevyOS 镜像到 lpi4a.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Flashing RevyOS Image onto LPI4A from macOS

## Step 1: Preparation

1. Install `android-platform-tools` using `brew` or an alternative method.
2. Download the correct U-Boot and RevyOS image files for your hardware model.
3. Connect your LPI4A development board to your Mac using both serial and USB connections.
4. Ensure your board is powered by a 12V power source.

### Download U-Boot and RevyOS Image

Visit the [RevyOS mirror site](https://mirror.iscas.ac.cn/revyos/extra/images/lpi4a/) and navigate to the latest dated folder (e.g., `20240720`). Download the following files:

> **Note:** Ensure the files match your LPI4A hardware configuration, as the 8GB and 16GB models require different U-Boot files.
### Install Android Platform Tools

Use `brew` to install the tools:

```bash
brew install android-platform-tools
```

Verify `fastboot` is available by running:

```bash
yuiyuuhayashi@MacBook-Air ~ % fastboot usb 0
< waiting for any device >
```

## Step 2: Start Installation

1. Boot your LPI4A into the fastboot mode by entering `fastboot usb 0`. Ensure the board is properly connected via USB Type-C and powered by 12V.
2. On your Mac, execute the following command to flash U-Boot:

```bash
fastboot flash uboot <filename>
```

3. After flashing, reboot with:

```bash
fastboot reboot
```

> If the board doesn’t reboot, perform a manual power cycle.
4. Re-enter fastboot mode on the development board and, on macOS, execute:

```bash
fastboot flash root <filename>
```

5. Reboot again using:

```bash
fastboot reboot
```

## Step 3: Log in to RevyOS

Once booted, log in with the following credentials:

```plaintext
Username: debian
Password: debian
```

After login, you can use `neofetch` or similar tools to verify the system version and other information.
Loading

0 comments on commit 3232575

Please sign in to comment.