pingu_98/fomu-workshop
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: Add required hardware section

Browse source 
Add a section describing required hardware.
This commit is contained in:
Sean Cross 2019-08-21 09:47:53 +02:00 committed by GitHub
parent 65ccad81b5
commit 5ef37b5018
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -21,9 +21,26 @@ Fomu requires specialized software. Namely, you must have the following softwar
| **wishbone-tool** | Interact with Fomu over USB |
| **serial console** | Interact with Python over a virtual console |
This software is provided on a USB drive for Linux x86/64, macOS, and Windows. Debian packages are also available for Raspberry Pi. For other platforms, please see the people running the workshop.
This software is provided for Linux x86/64, macOS, and Windows, via [Fomu Toolchain] (github.com/im-tomu/fomu-toolchain/releases/latest). If you're taking this workshop as a class, the toolchain are provided on the USB disk. Debian packages are also [available for Raspberry Pi](https://github.com/im-tomu/fomu-raspbian-packages). For other platforms, please see the people running the workshop.
This software is also available from the [Fomu Toolchain repository](https://github.com/im-tomu/fomu-toolchain/releases/latest).
To install the software, extract it somewhere on your computer, then open up a terminal window and add that directory to your PATH:
* MacOS: `export PATH=[path-to-bin]:$PATH`
* Linux: `export PATH=[path-to-bin]:$PATH`
* Windows Powershell: `$ENV:PATH = "[path-to-bin];" + $ENV:PATH`
* Windows cmd.exe: `PATH=[path-to-bin];%PATH`
To confirm installation, run a command such as `nextpnr-ice40` or `yosys`.
## Required Hardware
For this workshop, you will need a Fomu board. This workshop may be competed with any model of Fomu, though there are some parts that require you to identify which model you have:
1. **Fomu EVT3**: This model of Fomu is about the size of a credit card. It should have the text "Fomu EVT3" written across it in white silkscreen. If you have a different EVT board such as EVT2 or EVT1, they should work also.
1. **Fomu PVT1**: If you ordered a Fomu from Crowd Supply, this is the model you'll receive. It is small, and fits in a USB port. There is no silkscreen on it. This model of Fomu has a large silver crystal oscillator that is the tallest component on the board.
1. **Fomu Hacker**: These are the original design and are easiest to manufacture. If you received one directly from Tim, you probably have one of these. Hacker boards have white silkscreen on the back.
Aside from that, you need a computer with a USB port that can run the toolchain software. You should need any special drivers, though on Linux you may need sudo access, or special udev rules to grant permission to use the USB device from a non-privileged account.
## About FPGAs
@ -671,4 +688,4 @@ Now, when we rebuild this design and check `test/csr.csv` we can see our new reg
csr_register,rgb_output,0xe0006800,1,rw
```
We can use `wishbone-tool` to write values to `0xe0006800` and see them take effect immediately.
We can use `wishbone-tool` to write values to `0xe0006800` and see them take effect immediately.