# raspberrypi
**Repository Path**: alanmars/raspberrypi
## Basic Information
- **Project Name**: raspberrypi
- **Description**: It provides scripts for building openEuler image on Raspberry Pi and documents
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 45
- **Created**: 2022-03-28
- **Last Updated**: 2022-03-28
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# raspberrypi
English | [简体中文](./README.md)
This repository is main repository of openEuler RaspberryPi SIG, and provides scripts for building openEuler image for Raspberry Pi and related documents.
In addition, RaspberryPi SIG also aims to migrate openEuler to other SoCs, such as [Rockchip](https://gitee.com/openeuler/rockchip).
- [raspberrypi](#raspberrypi)
- [How to collaborate](#how-to-collaborate)
- [File description](#file-description)
- [How to download latest image](#how-to-download-latest-image)
- [How to Use image](#how-to-use-image)
- [How to build image locally](#how-to-build-image-locally)
- [Prepare the environment](#prepare-the-environment)
- [Run the scripts to build image](#run-the-scripts-to-build-image)
- [Quickly Build without kernel compilation(Recommended)](#quickly-build-without-kernel-compilationrecommended)
- [Build with kernel compilation](#build-with-kernel-compilation)
- [Build on host](#build-on-host)
- [Build in a Docker container](#build-in-a-docker-container)
## How to collaborate
You can get introduction of openEuler RaspberryPi SIG from [sig-RaspberryPi](https://gitee.com/openeuler/community/tree/master/sig/sig-RaspberryPi).
- Issues: welcome to collaborate with us by creating new issues or reply opened issues. You can get repository list from [sig-RaspberryPi](https://gitee.com/openeuler/community/tree/master/sig/sig-RaspberryPi).
- Join Slack workspace: [openeuler-raspberrypi](https://openeuler-raspberrypi.slack.com)
- [Invite link](https://join.slack.com/t/openeuler-raspberrypi/shared_invite/zt-uh95ug4n-yX7a~c7VrTEU64tZlX3Djw)
- Weekly meeting schedule
- Meeting Time: The 1st and 3rd Wednesday of each month, 17:00 - 17:30 UTC+8.
- Meeting Link: There are two methods to get the meeting link which will be updated before each meeting.
- Log in to the [openEuler Community](https://openeuler.org/) website, then view the booking information of `sig-RaspberryPi例会` in the meeting calendar.
- Search `openEuler` in mini programs of WeChat, add `openEuler mini program`. Then click `会议` and view the booking information of `sig-RaspberryPi例会`.
- [Meeting Agenda](https://etherpad.openeuler.org/p/sig-RaspberryPi-meetings)
- [Meeting Minutes](https://gitee.com/openeuler/raspberrypi/issues/I1EYZ6)
- Warmly welcome to submit Pull Requests.
## File description
> **NOTE: **
>- Recommendation: use the openEuler-RaspberryPi images provided in the chapter [How to download latest image](#how-to-download-latest-image) of this documentation.
>- If you need to customize the image, please refer to [Building openEuler image for Raspberry Pi](documents/openEuler镜像的构建.md) and [Cross-compile the kernel](documents/交叉编译内核.md).
- [documents](./documents/):
- [Install openEuler on an SD card](documents/刷写镜像.md)
- [How to use Raspberry Pi](documents/树莓派使用.md)
- [Building openEuler image for Raspberry Pi](documents/openEuler镜像的构建.md)
- [Cross-compile the kernel](documents/交叉编译内核.md)
- [Emulate Raspberry Pi with QEMU](documents/QEMU启动树莓派.md)
- [openEuler 20.03 LTS SP2 alpha version ChangeLog](documents/changelog/changelog-20.03-LTS-SP2.en.md)
- [openEuler 20.03 LTS SP2 alpha version (UKUI desktop environment and Chinese input method) ChangeLog](documents/changelog/changelog-20.03-LTS-SP2-UKUI.en.md)
- [openEuler 20.03 LTS SP2 alpha version (DDE desktop environment and Chinese input method) ChangeLog](documents/changelog/changelog-20.03-LTS-SP2-DDE.en.md)
- [openEuler 20.03 LTS SP2 alpha version (Xfce desktop environment and Chinese input method) ChangeLog](documents/changelog/changelog-20.03-LTS-SP2-Xfce.en.md)
- [openEuler 21.09 alpha version ChangeLog](documents/changelog/changelog-21.09.en.md)
- [openEuler 21.09 alpha version (UKUI desktop and Chinese input method) ChangeLog](documents/changelog/changelog-21.09-UKUI.en.md)
- [openEuler 21.09 alpha version (DDE desktop and Chinese input method) ChangeLog](documents/changelog/changelog-21.09-DDE.en.md)
- [openEuler 21.09 alpha version (Xfce desktop and Chinese input method) ChangeLog](documents/changelog/changelog-21.09-Xfce.en.md)
- [openEuler 21.09 alpha version (LXDE desktop and Chinese input method) ChangeLog](documents/changelog/changelog-21.09-LXDE.en.md)
- [scripts](./scripts): Script for building openEuler image for Raspberry Pi
- [Quickly Build (without kernel compilation)](scripts/build-image.sh)
- [Build on host (with kernel compilation)](scripts/build-image-common.sh)
- [Build in a Docker container (with kernel compilation)](scripts/build-image-docker.sh)
## How to download latest image
Basic information of the image is as follows. [more images](documents/images.en.md)
Other information:
- Firmware source: [firmware](https://github.com/raspberrypi/firmware), [bluez-firmware](https://github.com/RPi-Distro/bluez-firmware), [firmware-nonfree](https://github.com/RPi-Distro/firmware-nonfree)
## How to Use image
Refer to [Install openEuler on an SD card](documents/刷写镜像.md) and [How to use Raspberry Pi](documents/树莓派使用.md) for details about how to use the image on Raspberry Pi.
## How to build image locally
### Prepare the environment
To build openEuler AArch64 image for Raspberry Pi, the requirements of running scripts of this repository are as follows:
- OS: openEuler or CentOS 7/8
- Hardware: AArch64 hardware, such as Raspberry Pi
For other architecture hardware, you can use [QEMU](https://www.qemu.org/) to build AArch64 system emulation.
### Run the scripts to build image
Refer to [Script for building openEuler image for Raspberry Pi](documents/openEuler镜像的构建.md) for details.
#### Quickly Build without kernel compilation(Recommended)
> **NOTICE:**
>Two openEuler versions are currently supported, i.e., 20.09, 20.03 LTS SP1, 21.03, 20.03 LTS SP2, 21.09 and 20.03 LTS SP3.
>When building an image with Xfce/UKUI/DDE desktop environment, you need to pay attention to three issues:
>1. For building an image with Xfce desktop environment, note that only openEuler 21.03, 20.03 LTS SP2, 21.09 and 20.03 LTS SP3 are currently supported.
>2. For building an image with DDE desktop environment, note that only openEuler 20.03 LTS SP1, 21.03, 20.03 LTS SP2, 21.09 and 20.03 LTS SP3 are currently supported.
>3. Need to set the parameter `-s/--spec`. Please refer to the description of this parameter for details.
Build images with packages of raspberrypi-kernel, raspberrypi-firmware, and raspberrypi-bluetooth.
Run the following command to build an image:
`sudo bash build-image.sh -d DIR -r REPO -n IMAGE_NAME -s SPEC`
The meaning of each parameter:
1. -d, --dir DIR
The directory for storing the image and other temporary files, which defaults to be the directory in which the script resides. If the `DIR` does not exist, it will be created automatically.
After building the image, you can find the image in `DIR/raspi_output/img/` as shown in the script output.
2. -r, --repo REPO_INFO
The URL/path of target repo file, or the list of repositories' baseurls. Note that, the baseurls should be separated by space and enclosed in double quotes.
Examples are as follows:
- The URL of target repo file: `https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-21.03/generic.repo`.
- The path of target repo file:
- `./openEuler-21.03.repo`: for building openEuler 21.03 image, refer to for details.
- List of repo's baseurls: `"http://repo.openeuler.org/openEuler-21.03/OS/aarch64/ http://repo.openeuler.org/openEuler-21.03/EPOL/aarch64/"`.
3. -n, --name IMAGE_NAME
The image name to be built.
For example, `openEuler-21.03.img`. The default is `openEuler-raspi-aarch64.img`, or it is automatically generated based on parameter: `-n, --name IMAGE_NAME`.
4. -s, --spec SPEC
Specify the image version:
- `headless`, image without desktop environments.
- `xfce`, image with Xfce desktop environment and related software including CJK fonts and IME.
- `ukui`, image with UKUI desktop environment and fundamental software without CJK fonts and IME.
- `dde`, image with DDE desktop environment and fundamental software without CJK fonts and IME.
- The file path of rpmlist, the file contains a list of the software to be installed in the image, refer to [rpmlist](./scripts/config/rpmlist) for details.
The default is `headless`.
5. -h, --help
Display help information.
#### Build with kernel compilation
Here, we provide two approaches to build an image, which both include compiling kernel and downloading firmware files of Raspberry Pi. These approaches will take considerably longer.
> **NOTICE:**
>Three openEuler versions are currently supported, i.e., 20.03 LTS, 20.09, 20.03 LTS SP1, 21.03, 20.03 LTS SP2, 21.09 and 20.03 LTS SP3.
>When building an image with Xfce/UKUI/DDE desktop environment, you need to pay attention to four issues:
>1. For building an image with Xfce desktop environment, note that only openEuler 21.03, 20.03 LTS SP2, 21.09 and 20.03 LTS SP3 are currently supported.
> - openEuler 21.03: You need to select the branch [openEuler-21.03](https://gitee.com/openeuler/kernel/tree/openEuler-21.03/) of the [openEuler kernel](https://gitee.com/openeuler/kernel), i.e., set the parameter `-k/--kernel` to `git@gitee.com:openeuler/kernel.git` and set the parameter `-b/--branch` to `openEuler-21.03`.
> - openEuler 20.03 LTS SP2/20.03 LTS SP3: You need to select the branch [openEuler-20.03-LTS](https://gitee.com/openeuler/raspberrypi-kernel/tree/openEuler-20.09/) of the [openEuler-RaspberryPi kernel](https://gitee.com/openeuler/raspberrypi-kernel), i.e., set the parameter `-k/--kernel` to `git@gitee.com:openeuler/raspberrypi-kernel.git` and set the parameter `-b/--branch` to `openEuler-20.03-LTS`.
> - openEuler 21.09: You need to select the branch [openEuler-21.09](https://gitee.com/openeuler/raspberrypi-kernel/tree/openEuler-21.09/) of the [openEuler-RaspberryPi kernel](https://gitee.com/openeuler/raspberrypi-kernel), i.e., set the parameter `-k/--kernel` to `git@gitee.com:openeuler/raspberrypi-kernel.git` and set the parameter `-b/--branch` to `openEuler-21.09`.
>2. For building an image with UKUI desktop environment, note that only openEuler 20.09, 20.03 LTS SP1, 21.03, 20.03 LTS SP2, 21.09 and 20.03 LTS SP3 are currently supported.
> - openEuler 20.09: You need to select the branch [openEuler-20.09](https://gitee.com/openeuler/raspberrypi-kernel/tree/openEuler-20.09/) of the [openEuler-RaspberryPi kernel](https://gitee.com/openeuler/raspberrypi-kernel), i.e., set the parameter `-k/--kernel` to `git@gitee.com:openeuler/raspberrypi-kernel.git` and set the parameter `-b/--branch` to `openEuler-20.09`.
> - openEuler 20.03 LTS SP1/20.03 LTS SP2/20.03 LTS SP3: You need to select the branch [openEuler-20.03-LTS](https://gitee.com/openeuler/raspberrypi-kernel/tree/openEuler-20.09/) of the [openEuler-RaspberryPi kernel](https://gitee.com/openeuler/raspberrypi-kernel), i.e., set the parameter `-k/--kernel` to `git@gitee.com:openeuler/raspberrypi-kernel.git` and set the parameter `-b/--branch` to `openEuler-20.03-LTS`.
> - openEuler 21.03: You need to select the branch [openEuler-21.03](https://gitee.com/openeuler/kernel/tree/openEuler-21.03/) of the [openEuler kernel](https://gitee.com/openeuler/kernel), i.e., set the parameter `-k/--kernel` to `git@gitee.com:openeuler/kernel.git` and set the parameter `-b/--branch` to `openEuler-21.03`.
> - openEuler 21.09: You need to select the branch [openEuler-21.09](https://gitee.com/openeuler/raspberrypi-kernel/tree/openEuler-21.09/) of the [openEuler-RaspberryPi kernel](https://gitee.com/openeuler/raspberrypi-kernel), i.e., set the parameter `-k/--kernel` to `git@gitee.com:openeuler/raspberrypi-kernel.git` and set the parameter `-b/--branch` to `openEuler-21.09`.
>3. For building an image with DDE desktop environment, note that only openEuler 20.03 LTS SP1, 21.03, 20.03 LTS SP2, 21.09 and 20.03 LTS SP3 are currently supported.
> - openEuler 20.03 LTS SP1/20.03 LTS SP2/20.03 LTS SP3: You need to select the branch [openEuler-20.03-LTS](https://gitee.com/openeuler/raspberrypi-kernel/tree/openEuler-20.09/) of the [openEuler-RaspberryPi kernel](https://gitee.com/openeuler/raspberrypi-kernel), i.e., set the parameter `-k/--kernel` to `git@gitee.com:openeuler/raspberrypi-kernel.git` and set the parameter `-b/--branch` to `openEuler-20.03-LTS`.
> - openEuler 21.03: You need to select the branch [openEuler-21.03](https://gitee.com/openeuler/kernel/tree/openEuler-21.03/) of the [openEuler kernel](https://gitee.com/openeuler/kernel), i.e., set the parameter `-k/--kernel` to `git@gitee.com:openeuler/kernel.git` and set the parameter `-b/--branch` to `openEuler-21.03`.
> - openEuler 21.09: You need to select the branch [openEuler-21.09](https://gitee.com/openeuler/raspberrypi-kernel/tree/openEuler-21.09/) of the [openEuler-RaspberryPi kernel](https://gitee.com/openeuler/raspberrypi-kernel), i.e., set the parameter `-k/--kernel` to `git@gitee.com:openeuler/raspberrypi-kernel.git` and set the parameter `-b/--branch` to `openEuler-21.09`.
>4. Need to set the parameter `-s/--spec`. Please refer to the description of this parameter for details.
##### Build on host
Run the following command to build an image:
`sudo bash build-image-common.sh -n IMAGE_NAME -k KERNEL_URL -b KERNEL_BRANCH -c KERNEL_DEFCONFIG -r REPO -s SPEC --cores N`
After building the image, you can find the image in `raspi_output_common/img/` of the directory in which the script resides as shown in the script output.
The meaning of each parameter:
1. -n, --name IMAGE_NAME
The image name to be built.
For example, `openEuler-20.03-LTS-SP1.img`. The default is `openEuler-raspi-aarch64.img`, or it is automatically generated based on parameter: `-n, --name IMAGE_NAME`.
2. -k, --kernel KERNEL_URL
The URL of kernel source repository, which defaults to `https://gitee.com/openeuler/raspberrypi-kernel.git`. You can set the parameter as `git@gitee.com:openeuler/raspberrypi-kernel.git` or `git@gitee.com:openeuler/kernel.git` according to the requirement.
3. -b, --branch KERNEL_BRANCH
The branch name of kernel source repository, which defaults to `openEuler-20.03-LTS`. `openEuler-21.09`, `openEuler-20.03-LTS` or `openEuler-20.09` is recommended.
4. -c, --config KERNEL_DEFCONFIG
The filename/path of configuration for compiling kernel, which defaults to `openeuler-raspi_defconfig`. If this parameter is the filename of configuration, please make sure the configuration file in arch/arm64/configs of the kernel source.
5. -r, --repo REPO_INFO
The URL/path of target repo file, or the list of repositories' baseurls. Note that, the baseurls should be separated by space and enclosed in double quotes.
Examples are as follows:
- The URL of target repo file: `https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-20.03-LTS-SP1/generic.repo`
- The path of target repo file:
- `./openEuler-20.03-LTS-SP1.repo`: for building openEuler 20.03 LTS SP1 image, refer to for details.
- List of repo's baseurls: `"http://repo.openeuler.org/openEuler-20.03-LTS-SP1/OS/aarch64/ http://repo.openeuler.org/openEuler-20.03-LTS-SP1/EPOL/aarch64/"`.
6. -s, --spec SPEC
Specify the image version:
- `headless`, image without desktop environments.
- `xfce`, image with Xfce desktop environment and related software including CJK fonts and IME.
- `ukui`, image with UKUI desktop environment and fundamental software without CJK fonts and IME.
- `dde`, image with DDE desktop environment and fundamental software without CJK fonts and IME.
- The file path of rpmlist, the file contains a list of the software to be installed in the image, refer to [rpmlist](./scripts/config-common/rpmlist) for details.
The default is `headless`.
7. --cores N
The number of parallel compilations, according to the actual number of CPU of the host running the script. The default is the number of processing units available.
##### Build in a Docker container
Run the following command to build an image:
`sudo bash build-image-docker.sh -d DOCKER_FILE -n IMAGE_NAME -k KERNEL_URL -b KERNEL_BRANCH -c KERNEL_DEFCONFIG -r REPO --cores N`
After building the image, you can find the image in `raspi_output_common/img/` of the directory in which the script resides.
Caution, before running the script, you need to install Docker. The script will automatically import the Docker image into the local system according to the script's parameter: DOCKER_FILE.
In addition to the parameter DOCKER_FILE, the other parameters are the same as the corresponding parameters in [Build on host](#Build-on-host):
1. -d, --docker DOCKER_FILE
The URL/path of the Docker image, which defaults to `https://repo.openeuler.org/openEuler-20.03-LTS-SP1/docker_img/aarch64/openEuler-docker.aarch64.tar.xz`. With the default parameter, the script will automatically download the Docker image of openEuler 20.03 LTS SP1 and import it into the local system.