Skip to content

Commit

Permalink
Add tutorial video for Windows users
Browse files Browse the repository at this point in the history
  • Loading branch information
yhzhang0128 committed May 22, 2022
1 parent 9d5b0e1 commit 4e3457c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 11 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,10 @@ The definitions of `struct earth` and `struct grass` in [**egos.h**](library/ego
* a microUSB cable (e.g., [microUSB-to-USB](https://www.amazon.com/CableCreation-Charging-Shielded-Charger-Compatible/dp/B07CKXQ9NB?ref_=ast_sto_dp&th=1&psc=1) or [microUSB-to-USB-C](https://www.amazon.com/dp/B0744BKDRD?psc=1&ref=ppx_yo2_dt_b_product_details))
* [optional] a [microSD Pmod](https://digilent.com/reference/pmod/pmodmicrosd/start?redirect=1), a [microSD reader](https://www.amazon.com/dp/B07G5JV2B5?psc=1&ref=ppx_yo2_dt_b_product_details) and a microSD card (e.g., [Sandisk](https://www.amazon.com/dp/B073K14CVB?ref=ppx_yo2_dt_b_product_details&th=1), [Samsung](https://www.amazon.com/dp/B09B1F9L52?ref=ppx_yo2_dt_b_product_details&th=1) or [PNY](https://www.amazon.com/dp/B08RG87JN5?ref=ppx_yo2_dt_b_product_details&th=1))
### Software Requirements
* To compile egos-2000: [SiFive freedom riscv-gcc compiler](https://github.com/sifive/freedom-tools/releases/tag/v2020.04.0-Toolchain.Only)
* To program the on-board ROM: [OpenOCD](https://github.com/xpack-dev-tools/openocd-xpack/releases/tag/v0.11.0-1) for Linux/MacOS or [Vivado](https://www.xilinx.com/support/download.html) for Windows
* To connect with the serial tty: [screen](https://linux.die.net/man/1/screen) for Linux/MacOS or [PuTTY](https://www.putty.org/) for Windows
* [optional] To program a disk image file to the microSD card: [dd](https://linux.die.net/man/1/dd) or [balena Etcher](https://www.balena.io/etcher/)
### Usages and Documentation
For compiling and running egos-2000, please watch the [tutorial video](https://youtu.be/JDApdvnnz4A) and read [USAGES.md](references/USAGES.md).
[This document](references/README.md) further introduces the teaching plans, architecture and development history of egos-2000.
For compiling and running egos-2000, please read [USAGES.md](references/USAGES.md) or watch the tutorial videos ([Linux/MacOS user](https://youtu.be/JDApdvnnz4A), [Windows user](https://youtu.be/VTTynr9MZRg)).
[This document](references/README.md) further introduces the teaching plans, architecture and development history.
The [RISC-V instruction set manual](references/riscv-privileged-v1.10.pdf) introduces the privileged registers used by egos-2000.
The [SiFive FE310 manual](references/sifive-fe310-v19p04.pdf) introduces the processor used by egos-2000, especially the GPIO, UART and SPI bus controllers.
Expand Down
5 changes: 2 additions & 3 deletions references/USAGES.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Compile and run egos-2000

You can use Windows, Linux or MacOS. For Windows users, use WSL (Windows Subsystem for Linux) for step1 and step2.
There is a [tutorial video](https://youtu.be/JDApdvnnz4A) following the steps described below.
There are also two tutorial videos for [Linux/MacOS](https://youtu.be/JDApdvnnz4A) and [Windows](https://youtu.be/VTTynr9MZRg).

## Step1: Setup the compiler and compile egos-2000

Expand Down Expand Up @@ -112,11 +112,10 @@ You may need to register a Xilinx account, but the software is free.
In **4**, new versions of Arty may use "s25fl128sxxxxxx0" as memory device.
If you choose the wrong one, **6** will tell you.

In **2**, if the Arty board doesn't appear, try to reinstall the USB cable drivers following [these instructions](https://support.xilinx.com/s/article/59128?language=en_US). If it still doesn't work, it may be an issue with Vivado and please [contact Xilinx](https://support.xilinx.com/s/topic/0TO2E000000YKXgWAO/programmable-logic-io-bootconfiguration?language=en_US) or try the openocd method described above.
In **2**, if the Arty board doesn't appear, try to install [Digilent Adept](https://digilent.com/reference/software/adept/start) or reinstall the USB cable drivers following [these instructions](https://support.xilinx.com/s/article/59128?language=en_US). If it still doesn't work, it may be an issue with Vivado and please [contact Xilinx](https://support.xilinx.com/s/topic/0TO2E000000YKXgWAO/programmable-logic-io-bootconfiguration?language=en_US).

![This is an image](screenshots/vivado.png)


## Step4: Connect with egos-2000

1. Press the `program` red button on the left-top corner of the Arty board
Expand Down

0 comments on commit 4e3457c

Please sign in to comment.