From 9bc3d32cb67e1dcf8d0ab77bb370fa83a48ef8ab Mon Sep 17 00:00:00 2001 From: tabidachinokaze Date: Fri, 2 Sep 2022 20:27:58 +0800 Subject: [PATCH] Update the VIM3 setup guide --- development/hardware/khadas-vim3.md | 455 +++++++++++++++++++--------- 1 file changed, 309 insertions(+), 146 deletions(-) diff --git a/development/hardware/khadas-vim3.md b/development/hardware/khadas-vim3.md index 758ff5a7..2e4a5219 100644 --- a/development/hardware/khadas-vim3.md +++ b/development/hardware/khadas-vim3.md @@ -1,214 +1,377 @@ # Install Fuchsia on a Khadas VIM3 board -This document describes running Fuchsia on a Khadas VIM3 board. +This guide shows you how to install Fuchsia on a +[Khadas VIM3](https://www.khadas.com/vim3). The installation +process will probably take between 1 to 3 hours. -The Khadas VIM3 board is the successor to the VIM2. For more information, -check out the [Khadas Docs](http://docs.khadas.com/){:.external} site. +Running Fuchsia on VIM3 is useful if you want to explore how Fuchsia works on +relatively low-cost real hardware that supports many kinds of peripheral devices. +See [Appendix: Feature support](#features) for details on which VIM3 features +Fuchsia supports. -## Feature support +If you just want to explore Fuchsia with the lowest friction possible, check out +[Get started with the Fuchsia SDK](/docs/get-started/sdk/index.md) instead. -Fuchsia currently supports these features of the VIM3: +See [Appendix: Support](#support) if you have any trouble completing +this guide. -* UART Serial Debugger -* Paving over ethernet and USB -* Storage (eMMC) -* HDMI Display and Framebuffer -* GPU (Mali) and Vulkan graphics -* Ethernet -* SDIO -* I2C -* GPIO -* Temperature Sensors and DVFS -* RTC -* Clock -* Fan -* NNA -* USB C in peripheral mode +## Audience {#audience} -These features are under development and may not be supported: +If you've never tinkered with electronics you might find this +guide difficult to complete. For example, this guide assumes that you know +how to hook up serial cable wires to GPIOs to read logs and send commands +over a serial communication program like `minicom`. -* Video decoder -* SPI -* Audio +This guide also assumes that you're comfortable +with CLI workflows such as building Fuchsia from source. -The following features are not supported, but might be added by future -contributions: +## Prerequisites {#prerequisites} -* SPI Flash -* USB C in host mode -* USB A -* Power management and PMIC -* Wake on LAN -* UART BT +You'll need all of the following hardware and software to complete this guide: -These features are not supported and are unlikely to be added: +* A [Khadas VIM3](https://www.khadas.com/vim3) single-board computer. -* Video encoding (due to non-public firmware) -* Trusted Execution Environment / secure boot + Caution: It's unknown whether Fuchsia will run on the Basic model VIM3. + This guide was validated with the Pro model VIM3. + +* A desktop or laptop computer that's running Linux and has 2 USB ports + available. + + Key Term: This desktop or laptop is called the **host** + throughout the rest of this guide. + + Caution: A macOS host may work but these instructions have not been validated + with macOS. Building Fuchsia on a remote Linux computer and then attempting to flash + Fuchsia onto the VIM3 with a local macOS host is known to not work. + + + + Note: This guide assumes that your Linux distribution has Debian commands + like `apt`. + +* A power supply of at least 24W to your host. The VIM3 can draw that much power when + [DVFS](https://en.wikipedia.org/wiki/Dynamic_frequency_scaling) is enabled. + +* A working Fuchsia development environment on your host. In other words you + should be able to build Fuchsia from its source code on your host. See + [Build Fuchsia](#build). + +* A [USB to TTL serial cable](https://www.adafruit.com/product/954). + +* A USB-C to USB-\* cable that supports both data and power delivery. + The USB-C side is for the VIM3. The other side can be whatever USB + type your host supports. + +The following is optional: + +* A [heatsink](https://www.khadas.com/product-page/new-vim-heatsink). + This enables running 2 CPU cores on the VIM3 at full speed without + reaching 80°C, the critical temperature beyond which cores are throttled + down. + +See the [VIM3 collection](https://www.khadas.com/shop?Collection=VIM3&sort=price_descending) +in the Khadas shop for examples of compatible accessories. + +Note: All the links in this section are only for your convenience. You +don't need to buy from these exact stores or these exact parts. + +## Build Fuchsia {#build} + +If you don't already have an [in-tree][glossary.in-tree] environment +set up, you should start the process now because it can take a while to +complete: + +1. [Download the Fuchsia source code](/docs/get-started/get_fuchsia_source.md). + +1. [Configure and build Fuchsia](/docs/get-started/build_fuchsia.md). + + * When building Fuchsia, use `fx set core.vim3` instead. + +Note: The rest of this guide assumes that your Fuchsia source code directory +is located at `~/fuchsia`. + +You'll use the Fuchsia development environment to build the Fuchsia image +for VIM3 and run an in-tree CLI tool for flashing the Fuchsia image onto +the VIM3. + +## Set up the hardware {#hardware} + +Set up the VIM3 to communicate with your host: + +1. Connect the VIM3 and your host to each other with the USB-C to USB-\* cable. + The white LED on the VIM3 should turn on. + + Caution: Don't put a [USB hub](https://en.wikipedia.org/wiki/USB_hub) + between the VIM3 and your host. The hub may make it harder for your + VIM3 and host to detect and communicate with each other. + + This connection is used to power and flash the VIM3 with + [`fastboot`](https://en.wikipedia.org/wiki/Fastboot). + +1. Connect the serial cable wires to the VIM3's GPIOs: -When setting up your board, make sure you have at least a 24W power supply, as the VIM3 -can draw that much power when DVFS is enabled. + * GND to pin 17. -## Board orientation + * RX (in to VIM3) to pin 18. -When describing the location of buttons, pins and other items on the board, -we will refer to the side with the USB, ethernet and HDMI connectors as the **front** of the board -and the opposite side the **back** of the board, as illustrated by this photo. + * TX (out from VIM3) to pin 19. -![VIM3 board photo](images/VIM3-photo.jpg "A photo of a VIM3 board demonstrating the front and back orientation.") + * Don't connect the power wire of your serial cable to any VIM3 GPIO. + The VIM3 is getting power through the USB cable. -## Heat Sink + Tip: Pins 1, 20, 21, and 40 are labeled on the circuit board. -A heat sink is strongly recommended. A passive chip heat sink will allow you -to run 2 cores out of 8 at full speed before reaching 80C, the critical -temperature at which cores have to be throttled down. + Caution: In general the colors for TX and RX wires are not standardized. + For example your RX wire may be blue or green. -## Setup + See [Serial Debugging Tool](https://docs.khadas.com/linux/vim3/SetupSerialTool.html) + for an example image of how your serial wires should be connected to the VIM3. -- USB C port: Connect to host. Provides power and `fastboot`. -- Ethernet: Connect cable directly to board (do not use a USB ethernet adapter). -- HDMI: Optional. Connects to display. -- Serial Console: Required for flashing the device. See next section. +### Verify the serial connection {#serial} -## Serial Console +Make sure that you can view the logs being sent over the serial cable: -The debug UART for the serial console is exposed on the 40 pin header at the back of the board. -You may use a 3.3v USB to serial cable to access the serial console. Depending on your cable, -the colors will vary, so be sure you have a reference for which color maps to which pin. +1. Open a terminal in your host and run `ls /dev/ttyUSB*` before connecting the + serial cable to a USB port on your host. -The relevant pins on the front row of the header are: +1. Connect the serial cable to your host and run `ls /dev/ttyUSB*` again. + There should be 1 more result than the first time you ran the command, + such as `/dev/ttyUSB0`. That is the USB connection between your VIM3 + and your host. You'll provide this result for the `Serial Device` + value in the next step. -- 2nd from left, pin 19: TX out from VIM3 -- 3rd from left, pin 18: RX in to VIM3 -- 4th from left, pin 17: Ground + If you see no difference when running `ls /dev/ttyUSB*` before and after + connecting the serial cable, try `ls /dev/tty*` or `ls /dev/*` instead. -Connect the TX out from your cable to the RX in on the VIM3, and the RX in on your cable -to the TX out from the VIM3. If your cable has a VCC pin, you do not need to connect it, -but you do need the ground connection. +1. Install, set up, and launch `minicom` on your host as explained in [Set Up Serial Communication + Program](https://docs.khadas.com/linux/vim3/SetupSerialTool.html#Setup-Serial-Communication-Program). -You can see these pins on the "GPIO Pinout" tab of [this page](https://docs.khadas.com/linux/vim3/Hardware.html#VIM3-Hardware-Info). + Key Term: In the rest of this guide the terminal window running `minicom` is called + the **serial console**. -When connecting to the serial port, use (115200,8,N,1) as the settings. + Note: This guide assumes that you're using `minicom` for your serial communication + program but you can use whatever program you prefer. -## Buttons +1. Press the reset button on the VIM3. The reset button is the one with the **R** + printed next to it on the circuit board. + See [VIM3/3L Hardware](https://docs.khadas.com/linux/vim3/Hardware.html) for + a diagram. In your serial console you should see human-readable logs. -When viewed from the front, the VIM3 has 3 buttons on the left side of the board. On the board schematic, SW1 (switch closest to the USB plug) is the reset switch. SW3 (farthest away from the USB plug on the schematic) can be used for entering flashing mode. If SW3 is held down while the board is reset or power cycled , the bootloader will enter flashing mode instead of booting the kernel normally. +## Erase the eMMC {#emmc} -## VIM3 Bootloader +In later sections of this guide you'll update the bootloader and +OS on the VIM3. These updates don't work unless you +completely erase the eMMC first: -Booting Fuchsia on the VIM3 requires a custom bootloader found at -`//prebuilt/third_party/firmware/vim3`. It can also be built from source at -https://third-party-mirror.googlesource.com/u-boot/, in the `vim3` branch. +1. Press the reset button on your VIM3. -To find out what version of the bootloader you have, grep for "zircon-bootloader" -in the kernel boot log. You should see something like: "cmdline: zircon-bootloader=0.12" +1. Right after you press the reset button, start repeatedly pressing the + Space key as your VIM3 boots up. Make sure that your cursor + is focused on your serial console. The bootloader process should pause + and your serial console should show a `kvim3#` prompt. Your serial + console is now providing you access to the **U-Boot shell**. -## First time steps +1. Run the following command in the U-Boot shell: -The first time flashing the device, you will need to unlock the flashing capability. Boot the device by pressing the reset switch and you'll see logs in the serial console and hold. Repeatedly press the space bar to get to the U-boot console prompt. -If you are already in Fuchsia, you can enter the u-boot console by repeatedly pressing "f". + ```posix-terminal + store init 3 + ``` -Once you see the U-boot prompt (`kvim#`), type `fastboot` to launch fastboot. You should then see: + Your serial console logs should verify that the eMMC was correctly erased. -``` -USB RESET -SPEED ENUM +See [Erase eMMC](https://docs.khadas.com/linux/vim3/EraseEmmc.html) +for more details. -USB RESET -SPEED ENUM -``` +## Update the Android image on the VIM3 {#android} -This indicates that fastboot is running. + -To unlock flashing, type the following fastboot commands on the host: +The Android image that ships by default on the VIM3 does +not support Fuchsia installation. If you just received your VIM3 +from Khadas you must update your Android image: -``` -fastboot flashing unlock -fastboot flashing unlock_critical -``` +1. Click the following URL to download the updated Android image: + -Now you can flash the Fuchsia bootloader. Assuming you named the bootloader -file `u-boot.bin.unsigned`, type the following commands: +1. Extract the compressed archive file (`VIM3_Pie_V210527.7z`). + After the extraction you should have a `VIM3_Pie_V210527` directory + with an `update.img` file in it. -``` -fastboot flash bootloader u-boot.bin.unsigned -fastboot reboot -``` +1. Follow the instructions in [Install OS into + eMMC](https://docs.khadas.com/linux/vim3/InstallOsIntoEmmc.html). + When running `aml-burn-tool` the value for the `-i` flag should be the + path to your `update.img` file. Your command should look similar to this: -Now your board will reboot and use the new version of U-boot you just flashed. You only need to do this step once. + ```posix-terminal + aml-burn-tool -b VIM3 -i ~/Downloads/VIM3_Pie_V210527/update.img + ``` -## Building Fuchsia + Caution: Make sure that you're following the instructions for Ubuntu + and VIM3 by clicking the **Install on Ubuntu** and **VIM3/VIM3L** tabs. + These instructions are not shown by default. -Set your build configuration to the core vim3 product and build it: + Tip: The `TST Mode` workflow is probably the easiest and fastest way to get + your VIM3 into Upgrade Mode. -``` -fx set core.vim3 -fx build -``` +1. If the white and red LEDs on your VIM3 are off and the blue LED is on, + it means that your VIM3 is in sleep mode. Try putting your VIM3 + back into [Upgrade Mode](https://docs.khadas.com/linux/vim3/BootIntoUpgradeMode.html) + and then pressing the reset button again. -When the build is complete, you can flash the device (below). +At this point the white LED on your VIM3 should be on and you should see +logs in your serial console after you press the reset button on your VIM3. -## Flashing & Paving Fuchsia +## Update the bootloader {#bootloader} -First enter fastboot mode by holding down SW3 (leftmost button), pressing SW1 (rightmost button) quickly and keeping pressing SW3 for a few seconds. When the following shows up, the device is in fastboot mode: +Flash Fuchsia's custom bootloader onto the VIM3: -``` -USB RESET -SPEED ENUM +1. Install the [Android SDK Platform + Tools](https://developer.android.com/studio/releases/platform-tools). -USB RESET -SPEED ENUM -``` + Installing these tools gives you access to `adb`. -Now you can flash & pave: +1. Verify that you can now run `adb`: -``` -fx flash --pave -``` + ```posix-terminal + adb --version + ``` -This flashes all of the zircon, zedboot, vbmeta and fvm images to your vim3 and provisions ssh key files on the device. -It is now ready to use and does not need to go through zedboot or paving. (If you don't know what those are, don't worry!) +1. Access the U-Boot shell again by pressing the reset button and + then repeatedly pressing the Space key in your serial + console. When your serial console shows the `kvim3#` prompt, you're + in the U-Boot shell. -If `fx flash` asks for serial, you can find it with `fastboot devices`. +1. In your U-Boot shell run the following command: -In order to get into zedboot you can reboot into the recovery: + ```posix-terminal + fastboot + ``` -``` -dm reboot-recovery -``` + You should see the following logs in your serial console: -### Paving + ``` + g_dnl_register: g_dnl_driver.name = usb_dnl_fastboot -Paving is available from the "core" product and above. Run the following under the fuchsia directory: + USB RESET + SPEED ENUM -``` -fx set core.vim3 && fx build && fx pave -1 -``` + USB RESET + SPEED ENUM + ``` -### Fuchsia logo + If you see the first line (`g_dnl_register: g_dnl_driver.name = usb_dnl_fastboot`) + but not the lines after that, try using a different USB-C to USB-\* cable and make + sure that it supports both data and power delivery. -To update the boot splash screen to be the Fuchsia logo, do this in fastboot mode: +1. Open a new terminal window in your host and run the following commands: -``` -fastboot flash logo zircon/kernel/target/arm64/board/vim3/firmware/logo.img -``` + ```posix-terminal + cd ~/fuchsia/prebuilt/third_party/fastboot -## Troubleshooting + ./fastboot flashing unlock -**Bootserver can't seem to talk to my zedboot instance on the Vim3.** + ./fastboot flashing unlock_critical + + ./fastboot flash bootloader ~/fuchsia/prebuilt/third_party/firmware/vim3/u-boot.bin.unsigned + + ./fastboot reboot + ``` + + Caution: Installing the Android SDK Platform Tools probably installed another + instance of `fastboot` on your host. When working with Fuchsia, remember to use + the [in-tree][glossary.in-tree] version of `fastboot` at + `~/fuchsia/prebuild/third_party/fastboot/fastboot`. The `fastboot` protocol allows arbitrary + vendor protocol extensions and Fuchsia may rely on this functionality in the future. + +Note: You can also build the custom bootloader (`u-boot.bin.unsigned`) from source: + + +## Flash Fuchsia into the eMMC {#fuchsia} + +Install Fuchsia onto your VIM3: + +1. Put your VIM3 into `fastboot` mode by pressing the reset button + and then immediately pressing the F key. + +1. From a separate terminal on your host run the following command: + + ```posix-terminal + cd ~/fuchsia + + fx flash --pave + ``` + +Your VIM3 is now running Fuchsia! + +Repeat the steps in this section whenever you want to flash a new Fuchsia +image onto your VIM3. + +## Appendix: Fix a bricked VIM3 {#bricks} + +Do these steps if you've [bricked](https://en.wikipedia.org/wiki/Brick_(electronics)) +your VIM3 and need to "factory reset" it: + +1. [Erase the eMMC](#emmc). +1. [Update the Android image](#android). +1. [Update the bootloader](#bootloader). +1. [Flash Fuchsia into the eMMC](#fuchsia). + +## Appendix: Support {#support} + +* For issues that seem related to VIM3 hardware or firmware, try the + [VIM3 official docs](https://docs.khadas.com/linux/vim3/index.html) and + [Khadas VIM3 official forum](https://forum.khadas.com/c/khadas-vim3/30). +* For issues that seem related to Fuchsia, try the + [Fuchsia mailing lists and chat rooms](/docs/contribute/community/mailing-lists.md). + +## Appendix: Feature support {#features} + +Fuchsia currently supports these features of the VIM3: + +* UART Serial Debugger +* Paving over ethernet and USB +* Storage (eMMC) +* HDMI Display and Framebuffer +* GPU (Mali) and Vulkan graphics +* Ethernet +* SDIO +* I2C +* GPIO +* Temperature Sensors and DVFS +* RTC +* Clock +* Fan +* NNA +* USB-C in peripheral mode +* USB-A + +These features are under development and may not be supported: + +* Video decoder +* SPI +* Audio + +The following features are not supported, but might be added by future +contributions: + +* SPI Flash +* USB-C in host mode +* Power management and PMIC +* Wake on LAN +* UART BT + +These features are not supported and are unlikely to be added: + +* Video encoding (due to non-public firmware) +* Trusted Execution Environment / secure boot -If you are using ethernet, make sure you have a DHCP server running on the other end. -If you are using USB CDC, comment out this line in the -[kernel command line build file](https://cs.opensource.google/fuchsia/fuchsia/+/main:boards/kernel_cmdline/BUILD.gn): +## Appendix: Update the boot splash screen {#splash} -``` -kernel_cmdline("vim3") { - deps = [ ":pmm-checker-from-board" ] - args = [ - # Prefer using the built-in NIC to the CDC-ether interface. - {{''}}"netsvc.interface=/dev/dwmac/dwmac/Designware-MAC/ethernet",{{''}} - ] -} -``` +To update the boot splash screen to be the Fuchsia logo, run the following command +from a host terminal while the VIM3 is in `fastboot` mode: -The `"netsvc.interface=/dev/dwmac/dwmac/Designware-MAC/ethernet"` command line argument causes the board to prefer using the built-in NIC, which is the default configuration for devices running in Fuchsia's build infrastructure. +```posix-terminal +fastboot flash logo ~/fuchsia/zircon/kernel/target/arm64/board/vim3/firmware/logo.img +``` \ No newline at end of file