Skip to content

W
White Rabbit Starting Kit
Commit 814cc3f4 authored by Benoit Rat's avatar Benoit Rat
Browse files
Options

doc: update the documentation with relase of wr-nic, wrpc-sw and spec-sw

parent bd6eeb4c
Hide whitespace changes
Inline Side-by-side
Showing with 46 additions and 47 deletions
doc/ssk_components.jpg
View replaced file @ bd6eeb4c View file @ 814cc3f4
doc/ssk_components.jpg

478 KB | W: | H:

doc/ssk_components.jpg

202 KB | W: | H:

doc/ssk_components.jpg
doc/ssk_components.jpg
doc/ssk_components.jpg
doc/ssk_components.jpg
  • 2-up
  • Swipe
  • Onion skin
doc/wr-starting-kit.md
View file @ 814cc3f4
...@@ -90,13 +90,12 @@ The starting kit is composed of various elements that you should find in the box ...@@ -90,13 +90,12 @@ The starting kit is composed of various elements that you should find in the box
* AXGE-3454-0531 (violet) * AXGE-3454-0531 (violet)
* 1x LC-LC cable (2m) * 1x LC-LC cable (2m)
* 2x LEMO cable (2m) * 2x LEMO cable (2m)
* 2x LEMO-BNC Adaptor (Not in the next picture) * 2x LEMO-BNC Adaptor
![The components of the starting kit](ssk_components.jpg) ![The components of the starting kit](ssk_components.jpg)
[^standardssk]: Only with the standard version of starting kit. [^standardssk]: Only with the standard version of starting kit.
<!--TODO: take a new picture with rodrigo box-->
Physical configurations Physical configurations
------------------- -------------------
...@@ -174,14 +173,22 @@ rm spec-sw.tar.gz ...@@ -174,14 +173,22 @@ rm spec-sw.tar.gz
cd spec-sw cd spec-sw
~~~~~~~~~~~~ ~~~~~~~~~~~~
* Or get the latest release : **spec-sw-2.1**[^commitgit] <!-- TODO: change these -->
* Or get the latest release : **spec-sw-2.2**[^commitgit]
~~~~{.bash} ~~~~{.bash}
# Create the "root" directory
mkdir -p ~/wr/ mkdir -p ~/wr/
cd ~/wr/ cd ~/wr/
git clone -b spec-sw-2.1 git://ohwr.org/fmc-projects/spec/spec-sw.git
# Clone the repository
git clone git://ohwr.org/fmc-projects/spec/spec-sw.git
cd spec-sw cd spec-sw
# Checkout the stable release
git checkout -b wr-nic-v1.0 wr-nic-v1.0
~~~~~~~~~~~~ ~~~~~~~~~~~~
[^commitgit]: You should only use our package or proper release (tagged commit). [^commitgit]: You should only use our package or proper release (tagged commit).
...@@ -208,10 +215,8 @@ Each of the following folder contains: ...@@ -208,10 +215,8 @@ Each of the following folder contains:
* **gateware**: downloaded HDL binaries also called gateware.\ * **gateware**: downloaded HDL binaries also called gateware.\
(This folder is created while downloading gateware) (This folder is created while downloading gateware)
* **kernel**: Kernel modules (drivers) to connect the SPEC to the PC through PCIe. * **kernel**: Kernel modules (drivers) to connect the SPEC to the PC through PCIe.
* **test-lm32**: Will be removed in next version
* **tools**: Set of tools use for the experiments in the starter Kit * **tools**: Set of tools use for the experiments in the starter Kit
<!-- TODO: When next release remove the test-lm32 folder -->
### Structure of the driver and HDL ### Structure of the driver and HDL
...@@ -241,14 +246,13 @@ Otherwise you need to download it ...@@ -241,14 +246,13 @@ Otherwise you need to download it
~~~~{.bash} ~~~~{.bash}
#Create the gateware folder #Create the gateware folder
$ mkdir gateware $ mkdir gateware
$ cd gateware
#Download all the files (from OHWR website). #Download all the files (from OHWR website).
$ wget -nv http://www.ohwr.org/attachments/download/1454/spec-init.bin-2012-07-24 $ wget -nv http://www.ohwr.org/attachments/download/1761/wr-nic-v1.0.tar.gz
-O gateware/spec-init.bin -O gateware/spec-init.bin
$ wget -nv http://www.ohwr.org/attachments/download/1633/wr_nic_dio.bin-2012-10-02 $ wget -nv http://www.ohwr.org/attachments/download/1757/wr_nic_dio.bin-2012-12-14
-O gateware/wr_nic_dio.bin -O gateware/wr_nic_dio.bin
$ wget -nv http://www.ohwr.org/attachments/download/1611/wr_nic_dio-wrc.bin-2012-09-26
-O gateware/wr_nic_dio-wrc.bin
~~~~~~~~~~~ ~~~~~~~~~~~
<!-- TODO: Put the source and tag of the binaries --> <!-- TODO: Put the source and tag of the binaries -->
...@@ -1040,7 +1044,7 @@ The starting kit is base on various project: ...@@ -1040,7 +1044,7 @@ The starting kit is base on various project:
[spec-sw] [spec-sw]
: The project that contains the software (application + driver) which you have already compiled above. : The project that contains the software (application + driver) which you have already compiled above.
spec-golden [spec-golden]
: A simple gateware in order to access to the EEPROM of the FMC (WB-I2C) : A simple gateware in order to access to the EEPROM of the FMC (WB-I2C)
[wr-nic] [wr-nic]
: gateware (FPGA HDL) that includes the NIC & DIO capabilities. : gateware (FPGA HDL) that includes the NIC & DIO capabilities.
...@@ -1048,10 +1052,6 @@ spec-golden ...@@ -1048,10 +1052,6 @@ spec-golden
: LM32 sofwtare in the white rabbit PTP core for the synchronization. : LM32 sofwtare in the white rabbit PTP core for the synchronization.
<!-- TODO: Update with release -->
Tools Tools
---------------- ----------------
...@@ -1098,15 +1098,16 @@ make ...@@ -1098,15 +1098,16 @@ make
You will therefore obtain your golden firmware called as `spec-init.bin` You will therefore obtain your golden firmware called as `spec-init.bin`
WRPC Firmware WRPC-SW (LM32 firmware)
-------------- -----------------------
> *Dep*: lm32 compiler, autoconf
If you have the **lm32** compiler installed, you might download the code > ***Notes***: The steps in this section are not needed as we already provide the `wrc.ram` in the [wr-nic] repository.
from [wrpc-sw] project and compile it by simply using: However we provide here a simple resume of the steps to follow to compile the firmware specifically for the wr-nic.
You should also look at the [wrpc.pdf] to understand how to use it and how to compile for other configurations.
You can download it from [wr-nic-v1.0.tar.gz](http://www.ohwr.org/projects/wr-nic/files) file or you can try to compile it following the instructions below:
You first need to install the **lm32** compiler as suggested in [wrpc.pdf], then you need to compile using the specific configuration as bellow:
~~~~~~{.bash} ~~~~~~{.bash}
#Set up CROSS_COMPILE variable for this terminal #Set up CROSS_COMPILE variable for this terminal
...@@ -1115,14 +1116,17 @@ export CROSS_COMPILE="<your_path_to_lm32>/lm32/bin/lm32-elf-"; ...@@ -1115,14 +1116,17 @@ export CROSS_COMPILE="<your_path_to_lm32>/lm32/bin/lm32-elf-";
#Clone the repository #Clone the repository
$ git clone git://ohwr.org/hdl-core-lib/wr-cores/wrpc-sw.git $ git clone git://ohwr.org/hdl-core-lib/wr-cores/wrpc-sw.git
$ cd wrpc-sw $ cd wrpc-sw
~~~~~~~~~~
#Checkout the stable release
$ git checkout -b wr-nic-v1.0 wr-nic-v1.0
~~~~~~~~~~
And finally configure & compile it And finally configure & compile it
~~~~~~{.bash} ~~~~~~{.bash}
# Configuring the project for SPEC # Configuring the project for SPEC
$ make spec_defconfig $ make wrnic_defconfig
# Compile # Compile
$ make $ make
...@@ -1130,24 +1134,28 @@ $ make ...@@ -1130,24 +1134,28 @@ $ make
You should obtain various files named wrc.bin, wrc.elf, wrc.vhd, wrc.ram You should obtain various files named wrc.bin, wrc.elf, wrc.vhd, wrc.ram
You can therefore use them to override the one in [wr-nic](#wr-nic-hdl-gateware) project.
> ***Notes***: These steps are a simple resume on how to compile the ~~~~~{.bash}
firware, you should also look at the [wrpc-sw.pdf]. # Override the default embeded wrpc-sw
cp wrc.ram <wr_root_folder>/wr-nic/syn/spec
~~~~~~~~~~~
WR-NIC WR-NIC (HDL-gateware)
------- ----------------------
The final step is to prepare the WR-NIC bitstream (SPEC+FMC DIO) with This step show us how to prepare the WR-NIC bitstream (SPEC+FMC DIO) with
the wrpc-sw embeded inside. the wrpc-sw (`wrc.ram` file) embeded inside.
~~~~~~{.bash} ~~~~~~{.bash}
## Checkout the code ## Checkout the code
git clone git://ohwr.org/white-rabbit/wr-nic.git git clone git://ohwr.org/white-rabbit/wr-nic.git
cd wr-nic
## Import the wrc.ram from wrpc-sw to the wr-nic project #Checkout the stable release
cp wrpc-sw/wrc.ram wr-nic/syn/spec/ git checkout -b wr-nic-v1.0 wr-nic-v1.0
## Go to the main directory ## Go to the main directory
cd wr-nic/syn/spec/ cd wr-nic/syn/spec/
...@@ -1157,11 +1165,8 @@ hdlmake --fetch ...@@ -1157,11 +1165,8 @@ hdlmake --fetch
hdlmake --fetch hdlmake --fetch
hdlmake -l hdlmake -l
~~~~~~~~~~~ ~~~~~~~~~~~
you should finally obtain the bitstream to import in your fmc driver folder.
Appendix Appendix
...@@ -1193,17 +1198,9 @@ FAQS & Bugs ...@@ -1193,17 +1198,9 @@ FAQS & Bugs
Known Bugs Known Bugs
---------- ----------
### Setting time
On the current release the time can not be setup up manually in wrpc, this is already fix in the master branch
and will be included in the next release.
The following operation should set up at 01/01/2000 but it does not.
time set 946684801 00
### Virtual UART ### Virtual UART
sfp
The following command: `sudo tools/spec-vuart -b <dev_id>` does not show anything? The following command: `sudo tools/spec-vuart -b <dev_id>` does not show anything?
Virtual UART is not enable on the current release but will be available on the next one. Virtual UART is not enable on the current release but will be available on the next one.
...@@ -1342,7 +1339,9 @@ References ...@@ -1342,7 +1339,9 @@ References
[wr-nic]: http://www.ohwr.org/projects/wr-nic/ [wr-nic]: http://www.ohwr.org/projects/wr-nic/
[spec-sw]: http://www.ohwr.org/projects/spec-sw/ [spec-sw]: http://www.ohwr.org/projects/spec-sw/
[wrpc-sw]: http://www.ohwr.org/projects/wrpc-sw/ [wrpc-sw]: http://www.ohwr.org/projects/wrpc-sw/
[spec-golden]: http://www.ohwr.org/projects/spec/repository/show/trunk/hdl/golden
[spec-2-spec]: http://www.ohwr.org/projects/wr-cores/wiki/spec-to-spec [spec-2-spec]: http://www.ohwr.org/projects/wr-cores/wiki/spec-to-spec
[wrpc.pdf]: http://www.ohwr.org/attachments/download/1586/wrpc-v2.0.pdf [wrpc.pdf]: http://www.ohwr.org/attachments/download/1762/wr-nic-v1.0.pdf
[spec-sw.pdf]: http://www.ohwr.org/attachments/download/1634/spec-sw-2012-10-02-v2.1.pdf [wr-nic.pdf]: http://www.ohwr.org/attachments/download/1761/wr-nic-v1.0.tar.gz
[fmc-bus.pdf]: <http://www.ohwr.org/attachments/download/1589/fmc-bus-2012-09-16.pdf> [spec-sw.pdf]: http://www.ohwr.org/attachments/download/1760/spec-sw-2012-12-14-v2.2.pdf
[fmc-bus.pdf]: http://www.ohwr.org/attachments/download/1656/fmc-bus-2012-10-12-v1.0.pdf
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment