From nobody Thu Nov 13 23:40:49 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=gmail.com ARC-Seal: i=1; a=rsa-sha256; t=1583100200; cv=none; d=zohomail.com; s=zohoarc; b=RkekgZNFVjilakzkYYFfugIf4Bwk0O711umKNW1KuCSI7QB+SvT9nyV1GKQwbUyYgK+FKm2CMd1RdqpVKnowb/ctbGmEP3QRC9pQulsDGzLEZdD0M1Pc6etNfUwMGrzl2+P/HQck9NhEZSbVYSOjPlpkIKwtFfaSQNQNCUAN2LU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1583100200; h=Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:Message-ID:References:Sender:Subject:To; bh=ZcDH5zaXlnVesehM+A/XdcvhwS1VBGfED/LsFvtDTeM=; b=KKKy3BRIAYf95IMcJrHV9013UwEW4K1FxGtFT3LoFet1peoDfbUkAqgGuOdN0EgpnNYD3f8VfrsAjHGRxA8pMFHZ0plgvYb95e3eLHQgSHVNcHuOnDNHDPr+4GRM90oCTXaL57lypLAVRjVzMVrLQtOLXlRe+HAE1B2t1XJgpVk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1583100200782563.1865593560668; Sun, 1 Mar 2020 14:03:20 -0800 (PST) Received: from localhost ([::1]:52398 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j8WgB-0004OU-Es for importer@patchew.org; Sun, 01 Mar 2020 17:03:19 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:57954) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j8WUC-0001Sd-68 for qemu-devel@nongnu.org; Sun, 01 Mar 2020 16:50:58 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j8WU9-0006YK-8D for qemu-devel@nongnu.org; Sun, 01 Mar 2020 16:50:56 -0500 Received: from mail-wr1-x443.google.com ([2a00:1450:4864:20::443]:36270) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j8WU9-0006X8-04; Sun, 01 Mar 2020 16:50:53 -0500 Received: by mail-wr1-x443.google.com with SMTP id j16so10113605wrt.3; Sun, 01 Mar 2020 13:50:52 -0800 (PST) Received: from pavilion.home ([2a02:a456:6be8:1:8edc:d4ff:fe8b:18b7]) by smtp.gmail.com with ESMTPSA id e8sm25033124wrr.69.2020.03.01.13.50.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 01 Mar 2020 13:50:50 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=ZcDH5zaXlnVesehM+A/XdcvhwS1VBGfED/LsFvtDTeM=; b=OmtKAFULGS/ORIbSyo6s3lwEbNncO1hy2FKum5RuKObhXhwDN6TRpjA/lgkgFkLCy0 WhmIpR39Xe5/nRlg6mkiYwnH8w9VyFjMM3PyiH29gvNvMx+UfstUXO9UBsCYtUmjJlL2 j+42RvaKgnhOznPbMqlIlZ1/7ocZAjglY3jmldlVMCMkXJqYJG5vzOwzFgcXjcHDcXgu 9S5oNpOY81gCcHBbJqR4c7dhzD9yXFlkw1Wo0Na3gFJc9hNvRyGwHLhoz45NZyeVoMPw yfWFryrablKDeui8tBH07j9mG541x2cDyGRXBJMsCD6f8GU3LrT0CLozQmzaeb9rB4NI f6Lg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=ZcDH5zaXlnVesehM+A/XdcvhwS1VBGfED/LsFvtDTeM=; b=cxFV7LKke8n4zOtGF1TcZSp0fj/Fla3e8SWfWFRkZhQJZSSaJszmQg7lSMox54Y1gO K/cPGw0N/dlAOaeHsqrglOgTOK+1jwShCcVmB7wG1u/BqOHm//dy5Q7gBIAw2ybAgwqF 8JmdjCjNU0eRett1w8OC+2cqsth5JNF9W9bmZMmbrL7ruGm8kbNxABkH2n/QPHTnqQxm UvrWvBaSPnkxCGqK2zAgDWCN3wMIAD2uGe4tTjSGmh5FCRje/lI3mk1XVA8yUVEnoF2e 3QN/cXRm5dh0YxZJkOlKPJ/MdJApZ0QD/QWzwk/z/EjkxLQ5oTeUbtD2/aSTE05pfuwN YbiA== X-Gm-Message-State: APjAAAUSqM4hKrTY6VKoEsO87AvaUCEWT3yr+eMPZYJdSG7PJUQbKPUJ JqV84VZQE5PS4fivgepqc2OTfP4m X-Google-Smtp-Source: APXvYqw9vXU3KR9OzORtFH9XIKqdzZhd9HNZTiBXxBtxbRwrJX0TLb08DR6XUnjpXUJ+n4TbcZdRfQ== X-Received: by 2002:adf:fa4a:: with SMTP id y10mr17747639wrr.322.1583099451451; Sun, 01 Mar 2020 13:50:51 -0800 (PST) From: Niek Linnenbank To: qemu-devel@nongnu.org Subject: [PATCH v6 18/18] docs: add Orange Pi PC document Date: Sun, 1 Mar 2020 22:50:29 +0100 Message-Id: <20200301215029.15196-19-nieklinnenbank@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200301215029.15196-1-nieklinnenbank@gmail.com> References: <20200301215029.15196-1-nieklinnenbank@gmail.com> X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::443 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: peter.maydell@linaro.org, alex.bennee@linaro.org, jasowang@redhat.com, b.galvani@gmail.com, Niek Linnenbank , qemu-arm@nongnu.org, imammedo@redhat.com, philmd@redhat.com Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" The Xunlong Orange Pi PC machine is a functional ARM machine based on the Allwinner H3 System-on-Chip. It supports mainline Linux, U-Boot, NetBSD and is covered by acceptance tests. This commit adds a documentation text file with a description of the machine and instructions for the user. Signed-off-by: Niek Linnenbank --- docs/orangepi.rst | 226 ++++++++++++++++++++++++++++++++++++++++++++++ MAINTAINERS | 1 + 2 files changed, 227 insertions(+) create mode 100644 docs/orangepi.rst diff --git a/docs/orangepi.rst b/docs/orangepi.rst new file mode 100644 index 0000000000..a9b46f553c --- /dev/null +++ b/docs/orangepi.rst @@ -0,0 +1,226 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D +Orange Pi PC Machine Type +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D + +The Xunlong Orange Pi PC is an Allwinner H3 System on Chip +based embedded computer with mainline support in both U-Boot +and Linux. The board comes with a Quad Core Cortex A7 @ 1.3GHz, +1GiB RAM, 100Mbit ethernet, USB, SD/MMC, USB, HDMI and +various other I/O. + +Supported devices +----------------- + +The Orange Pi PC machine supports the following devices: + + * SMP (Quad Core Cortex A7) + * Generic Interrupt Controller configuration + * SRAM mappings + * SDRAM controller + * Real Time Clock + * Timer device (re-used from Allwinner A10) + * UART + * SD/MMC storage controller + * EMAC ethernet + * USB 2.0 interfaces + * Clock Control Unit + * System Control module + * Security Identifier device + +Limitations +----------- + +Currently, Orange Pi PC does *not* support the following features: + +- Graphical output via HDMI, GPU and/or the Display Engine +- Audio output +- Hardware Watchdog + +Also see the 'unimplemented' array in the Allwinner H3 SoC module +for a complete list of unimplemented I/O devices: + ./hw/arm/allwinner-h3.c + +Using the Orange Pi PC machine type +----------------------------------- + +Boot options +~~~~~~~~~~~~ + +The Orange Pi PC machine can start using the standard -kernel functionality +for loading a Linux kernel or ELF executable. Additionally, the Orange Pi = PC +machine can also emulate the BootROM which is present on an actual Allwinn= er H3 +based SoC, which loads the bootloader from a SD card, specified via the -s= d argument +to qemu-system-arm. + +Machine-specific options +~~~~~~~~~~~~~~~~~~~~~~~~ + +The following machine-specific options are supported: + +- allwinner-rtc.base-year=3DYYYY + + The Allwinner RTC device is automatically created by the Orange Pi PC ma= chine + and uses a default base year value which can be overridden using the 'ba= se-year' property. + The base year is the actual represented year when the RTC year value is = zero. + This option can be used in case the target operating system driver uses = a different + base year value. The minimum value for the base year is 1900. + +- allwinner-sid.identifier=3Dabcd1122-a000-b000-c000-12345678ffff + + The Security Identifier value can be read by the guest. + For example, U-Boot uses it to determine a unique MAC address. + +The above machine-specific options can be specified in qemu-system-arm +via the '-global' argument, for example: + + $ qemu-system-arm -M orangepi-pc -sd mycard.img \ + -global allwinner-rtc.base-year=3D2000 + +Running mainline Linux +~~~~~~~~~~~~~~~~~~~~~~ + +Mainline Linux kernels from 4.19 up to latest master are known to work. +To build a Linux mainline kernel that can be booted by the Orange Pi PC ma= chine, +simply configure the kernel using the sunxi_defconfig configuration: + + $ ARCH=3Darm CROSS_COMPILE=3Darm-linux-gnueabi- make mrproper + $ ARCH=3Darm CROSS_COMPILE=3Darm-linux-gnueabi- make sunxi_defconfig + +To be able to use USB storage, you need to manually enable the correspondi= ng +configuration item. Start the kconfig configuration tool: + + $ ARCH=3Darm CROSS_COMPILE=3Darm-linux-gnueabi- make menuconfig + +Navigate to the following item, enable it and save your configuration: + + Device Drivers > USB support > USB Mass Storage support + +Build the Linux kernel with: + + $ ARCH=3Darm CROSS_COMPILE=3Darm-linux-gnueabi- make + +To boot the newly build linux kernel in QEMU with the Orange Pi PC machine= , use: + + $ qemu-system-arm -M orangepi-pc -nic user -nographic \ + -kernel /path/to/linux/arch/arm/boot/zImage \ + -append 'console=3DttyS0,115200' \ + -dtb /path/to/linux/arch/arm/boot/dts/sun8i-h3-orangepi-pc.dtb + +Orange Pi PC images +~~~~~~~~~~~~~~~~~~~ + +Note that the mainline kernel does not have a root filesystem. You may pro= vide it +with an official Orange Pi PC image from the official website: + + http://www.orangepi.org/downloadresources/ + +Another possibility is to run an Armbian image for Orange Pi PC which +can be downloaded from: + + https://www.armbian.com/orange-pi-pc/ + +Alternatively, you can also choose to build you own image with buildroot +using the orangepi_pc_defconfig. Also see https://buildroot.org for more i= nformation. + +You can choose to attach the selected image either as an SD card or as USB= mass storage. +For example, to boot using the Orange Pi PC Debian image on SD card, simpl= y add the -sd +argument and provide the proper root=3D kernel parameter: + + $ qemu-system-arm -M orangepi-pc -nic user -nographic \ + -kernel /path/to/linux/arch/arm/boot/zImage \ + -append 'console=3DttyS0,115200 root=3D/dev/mmcblk0p2' \ + -dtb /path/to/linux/arch/arm/boot/dts/sun8i-h3-orangepi-pc.dtb \ + -sd OrangePi_pc_debian_stretch_server_linux5.3.5_v1.0.img + +To attach the image as an USB mass storage device to the machine, +simply append to the command: + + -drive if=3Dnone,id=3Dstick,file=3Dmyimage.img \ + -device usb-storage,bus=3Dusb-bus.0,drive=3Dstick + +Instead of providing a custom Linux kernel via the -kernel command you may= also +choose to let the Orange Pi PC machine load the bootloader from SD card, j= ust like +a real board would do using the BootROM. Simply pass the selected image vi= a the -sd +argument and remove the -kernel, -append, -dbt and -initrd arguments: + + $ qemu-system-arm -M orangepi-pc -nic user -nographic \ + -sd Armbian_19.11.3_Orangepipc_buster_current_5.3.9.img + +Note that both the official Orange Pi PC images and Armbian images start +a lot of userland programs via systemd. Depending on the host hardware and= OS, +they may be slow to emulate, especially due to emulating the 4 cores. +To help reduce the performance slow down due to emulating the 4 cores, you= can +give the following kernel parameters (or via -append): + + =3D> setenv extraargs 'systemd.default_timeout_start_sec=3D9000 loglevel= =3D7 nosmp console=3DttyS0,115200' + +Running U-Boot +~~~~~~~~~~~~~~ + +U-Boot mainline can be build and configured using the orangepi_pc_defconfig +using similar commands as describe above for Linux. Note that it is recomm= ended +for development/testing to select the following configuration setting in U= -Boot: + + Device Tree Control > Provider for DTB for DT Control > Embedded DTB + +To start U-Boot using the Orange Pi PC machine, provide the +u-boot binary to the -kernel argument: + + $ qemu-system-arm -M orangepi-pc -nic user -nographic \ + -kernel /path/to/uboot/u-boot -sd disk.img + +Use the following U-boot commands to load and boot a Linux kernel from SD = card: + + -> setenv bootargs console=3DttyS0,115200 + -> ext2load mmc 0 0x42000000 zImage + -> ext2load mmc 0 0x43000000 sun8i-h3-orangepi-pc.dtb + -> bootz 0x42000000 - 0x43000000 + +Running NetBSD +~~~~~~~~~~~~~~ + +The NetBSD operating system also includes support for Allwinner H3 based b= oards, +including the Orange Pi PC. NetBSD 9.0 is known to work best for the Orang= e Pi PC +board and provides a fully working system with serial console, networking = and storage. +For the Orange Pi PC machine, get the 'evbarm-earmv7hf' based image from: + + https://cdn.netbsd.org/pub/NetBSD/NetBSD-9.0/evbarm-earmv7hf/binary/gzim= g/armv7.img.gz + +The image requires manually installing U-Boot in the image. Build U-Boot w= ith +the orangepi_pc_defconfig configuration as described in the previous secti= on. +Next, unzip the NetBSD image and write the U-Boot binary including SPL usi= ng: + + $ gunzip armv7.img.gz + $ dd if=3D/path/to/u-boot-sunxi-with-spl.bin of=3Darmv7.img bs=3D1024 se= ek=3D8 conv=3Dnotrunc + +Finally, before starting the machine the SD image must be extended such +that the NetBSD kernel will not conclude the NetBSD partition is larger th= an +the emulated SD card: + + $ dd if=3D/dev/zero bs=3D1M count=3D64 >> armv7.img + +Start the machine using the following command: + + $ qemu-system-arm -M orangepi-pc -nic user -nographic \ + -sd armv7.img -global allwinner-rtc.base-year=3D2000 + +At the U-Boot stage, interrupt the automatic boot process by pressing a key +and set the following environment variables before booting: + + =3D> setenv bootargs root=3Dld0a + =3D> setenv kernel netbsd-GENERIC.ub + =3D> setenv fdtfile dtb/sun8i-h3-orangepi-pc.dtb + =3D> setenv bootcmd 'fatload mmc 0:1 ${kernel_addr_r} ${kernel}; fatload= mmc 0:1 ${fdt_addr_r} ${fdtfile}; fdt addr ${fdt_addr_r}; bootm ${kernel_a= ddr_r} - ${fdt_addr_r}' + +Optionally you may save the environment variables to SD card with 'saveenv= '. +To continue booting simply give the 'boot' command and NetBSD boots. + +Orange Pi PC acceptance tests +----------------------------- + +The Orange Pi PC machine has several acceptance tests included. +To run the whole set of tests, build QEMU from source and simply +provide the following command: + + $ AVOCADO_ALLOW_LARGE_STORAGE=3Dyes avocado --show=3Dapp,console run \ + -t machine:orangepi-pc tests/acceptance/boot_linux_console.py diff --git a/MAINTAINERS b/MAINTAINERS index 02ecba8d9c..643906bd18 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -497,6 +497,7 @@ S: Maintained F: hw/*/allwinner-h3* F: include/hw/*/allwinner-h3* F: hw/arm/orangepi.c +F: docs/orangepi.rst =20 ARM PrimeCell and CMSDK devices M: Peter Maydell --=20 2.17.1