Skip to content

W
White Rabbit Starting Kit
Commit 0bb438ae authored by manuel's avatar manuel
Browse files
Options

doc:Update starting kit document 

-Update links
-Update some repositories
-Remove information not necesary
-Update links to sections of the document
parent 907a0a0e
Hide whitespace changes
Inline Side-by-side
Showing with 34 additions and 50 deletions
doc/wr-starting-kit.md
View file @ 0bb438ae
......@@ -224,7 +224,7 @@ experiments you will need:
This tutorial has been tested and verified with Ubuntu LTS 16.04.6 (kernel v.4.15.9) and Ubuntu LTS 18.04.2 (kernel v.4.18.0-17), this mean that standard support will only be given for these releases.
However, the `spec-sw` driver should work with other releases, distributions and architectures.
![Configuration with one or two PCs](img/ssk_configs.png)
![Configuration with one two PCs](img/ssk_configs.png)
Starting kit components
-----------------
......@@ -295,9 +295,9 @@ You should obtain something similar as:
01:00.0 Non-VGA unclassified device: CERN/ECP/EDU Device 018d (rev 03)
~~~~~~~~~~
Where `01` and `0b` represent the ID of the PCIe slot given by your motherboard.
Where `01` represent the ID of the PCIe slot given by your motherboard.
> **Note**: The PCIe slot numbering are normally ordered from top to bottom on the motherboard,
this mean that the board with ID `01` will be above the one with index `0b`.
this mean that the board with ID `01` will be above.
Tools
......@@ -549,7 +549,7 @@ The White Rabbit Core Shell
Once you are in the UART you should obtain the White Rabit Core console (`wrc#`).
A complete reference of the shell commands is included in the [wrpc.pdf] manual or
you can read them in the [Wiki](http://www.ohwr.org/projects/wr-cores/wiki/Wrpc_shell)
you can read them in the [Wiki](https://www.ohwr.org/project/wr-cores/wikis/home)
The most useful commands are repeated here for your convenience
......@@ -561,8 +561,8 @@ The most useful commands are repeated here for your convenience
For the tutorial we will use the following names:
* `wrc1#` for `wrc#` console of the main board (wri1/busID=0x0100) on the PC1
* `wrc2#` for `wrc#` console of the main board (wri1/busID=0x0100) on the PC2
* `wrc1#` for `wrc#` console of the main board (wri1/busID=0x0100) on the PC01
* `wrc2#` for `wrc#` console of the main board (wri1/busID=0x0100) on the PC02
Configure in slave & master mode
......@@ -795,7 +795,7 @@ ch 4, 542.500000000
~~~~~~~~
> ***Notes:*** If you see other timestampings messages coming from channel 2 this mean you don't
have disabled the PPS mode. Check [Disabling PPS](#disabling-pps-on-channel-2) section.
have disabled the PPS mode.
### Time stamping input & output.
......@@ -847,7 +847,7 @@ However with the next experiment you will find out that the synchronization is b
Synchronization of PPS
----------------------------------------------------------------------------------------
This corresponds to the experiment from [spec-sw.pdf:6.8][spec-sw.pdf] document.
This corresponds to the experiment from TODO:[spec-sw.pdf:6.8][spec-sw.pdf] document.
Here we want to synchronize the PPS of the master and slave boards using WR protocol on a fiber.
### Setup
......@@ -1049,7 +1049,7 @@ The *ruler* waits for timestamps to appear on a specific input channel;
when a positive-going edge occurs the *ruler* notifies it or replicates the edge on one or more outputs.
Each output can be local or remote, and can use a different delay from the input pulse.
For further details (deeper studies) the user is recommended to read the [spec-sw.pdf:6.8][spec-sw.pdf] document
For further details (deeper studies) the user is recommended to read the TODO:[spec-sw.pdf:6.8][spec-sw.pdf] document
and to also take a look at the source code of `wr-dio-agent` and `wr-dio-ruler`
......@@ -1224,7 +1224,7 @@ wrc# ptp start
~~~~~~~
Then you should run the [WRS] in master or grandmaster mode as explained
in [wr-switch-guide.pdf].
in (Resources) [wr-switch-guide.pdf].
Finally you need to connect the slave SFPs (blue) to the [SPEC]s and the
master SFP (violet) to the switch.
......@@ -1371,7 +1371,7 @@ Run in standalone
You can also run GM in a full standalone mode in order to transmit WR clock without the need of a PC.
First you need to flash the SPEC with the latest bitstream you can find the package:
TODO:First you need to flash the SPEC with the latest bitstream you can find the package:
<http://www.sevensols.com/dl/wr-nic/bin/latest_stable.tar.gz>
To do so you need to generate a MSC file as follows:
......@@ -1423,7 +1423,7 @@ The starting kit is based on various project:
[spec-sw]
: The project that contains the software (application + driver) which you have already compiled above.
[spec-golden]
TODO:[spec-golden]
: A simple gateware in order to access to the EEPROM of the [FMC] (WB-I2C)
[wr-nic]
: gateware (FPGA HDL) that includes the NIC & DIO capabilities.
......@@ -1485,7 +1485,6 @@ However we provide here a simple resume of the steps required to compile the fir
You should also look at the [wrpc.pdf] to understand how to use it and
how to compile new firmware for other configurations.
You can download it from [wr-nic-v2.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], and then you need to compile it using the specific configuration as bellow:
......@@ -1495,10 +1494,11 @@ You first need to install the **lm32** compiler as suggested in
export CROSS_COMPILE="<your_path_to_lm32>/lm32/bin/lm32-elf-";
## Clone the repository
git clone git://ohwr.org/hdl-core-lib/wr-cores/wrpc-sw.git
git clone https://ohwr.org/project/wrpc-sw.git
cd wrpc-sw
## Checkout the stable release
TODO:## Checkout the stable release
git checkout -b wrpc-v2.1-for-wrnic wrpc-v2.1-for-wrnic
~~~~~~~~~~
......@@ -1506,7 +1506,7 @@ git checkout -b wrpc-v2.1-for-wrnic wrpc-v2.1-for-wrnic
And finally configure and compile it
~~~~~~{.sh}
## Configuring the project for SPEC
TODO:## Configuring the project for SPEC
make wrnic_defconfig
## Compile
......@@ -1518,7 +1518,7 @@ 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.
~~~~~{.sh}
## Override the default embeded wrpc-sw
TODO:## Override the default embeded wrpc-sw
cp wrc.ram <wr_root_folder>/wr-nic/syn/spec
~~~~~~~~~~~
......@@ -1533,9 +1533,9 @@ the wrpc-sw (`wrc.ram` file) embedded inside.
~~~~~~{.bash}
## Checkout the code
git clone git://ohwr.org/white-rabbit/wr-nic.git
git https://ohwr.org/project/wr-nic.git
cd wr-nic
git checkout -b wr-nic-v2.0 wr-nic-v2.0
TODO:git checkout -b wr-nic-v2.0 wr-nic-v2.0
## Create and update the submodules
git submodule init
......@@ -1544,18 +1544,13 @@ git submodule update
## Go to the main directory
cd syn/specdio/
## Synthetize using hdlmake
TODO:## Synthetize using hdlmake
hdlmake --make-ise --ise-proj
make
~~~~~~~~~~~
You should finally obtain the bitstream to import in your [FMC] driver folder.
> **Notes**: You must have the proper version of hdlmake installed, please
check the manual [wr-nic.pdf] for more information on how to synthesize the
gateware.
Frequently Added Questions
===========================
......@@ -1570,7 +1565,7 @@ we strongly recommand you to visit the webpage:
and you might also find information there:
* <http://www.ohwr.org/projects/spec/wiki/FAQ>
* <http://www.ohwr.org/projects/wr-cores/wiki/Wrpc_faq>
* <https://www.ohwr.org/project/wr-cores/wikis/home>
Resume
......@@ -1583,30 +1578,17 @@ However, you will find a resume of the most asked questions below:
In all of those cases the PLL has to be locked. That means your card has to be either in Master Mode, Grand Master or Slave Mode.
When you have only one card (or some but unconnected) it should be working as Free Running Master. If you have two of them (or more), one of them has to work as master, the others as Slaves and all of them have to be synced via PTP as explained en section [4.3](#configure-in-slave-master-mode). To say that is running Grand Master Mode is to make sure the PLL has already been locked to the external reference (see [Appendix](#appendix)).
When you have only one card (or some but unconnected) it should be working as Free Running Master. If you have two of them (or more), one of them has to work as master, the others as Slaves and all of them have to be synced via PTP as explained en section [4.3](#configure-in-slave-master-mode). To say that is running Grand Master Mode is to make sure the PLL has already been locked to the external reference.
### I don't see the interface using ifconfig
Please check if you see them using `ifconfig -a`, if you see them by using the `-a` option you just need
to bring them up. This is explained in the [Bring up the network interface](#bring-up-the-network-interface) section.
### Compilation of spec-sw is impossible
To compile you must have at least the 2.6.36 kernel (errors occurs with
2.6.32, 2.6.34). We recommend you to use the latest version of your distribution.
If you think you have the correct setup you can also use our automatic build
script that also generate a report with your system information.
sudo scripts/wr-ssk-get --report
After a few minutes your project should have been installed correctly, if you
still have problems send us the generated `report.log` files in the main folder.
to bring them up. This is explained in the [Check the network interface](#Check-the-network-interface) section.
### The starting kit is based on Ubuntu. How can I use it with Scientific Linux?
The commands to execute in order to update the kernel using scientific linux (you need at least the 2.6.36 to compile the starting kit) are:
The commands to execute in order to update the kernel using scientific linux (you need at least the 4.15.9 to compile the starting kit) are:
~~~~~{.bash}
rpm --import http://elrepo.org/RPM-GPG-KEY-elrepo.org
......@@ -1615,7 +1597,7 @@ sudo yum --enablerepo=elrepo-kernel --skip-broken install kernel-lt kernel-lt-de
~~~~~~~~~~
You can have more information on how to do this by browsing the (http://elrepo.org/tiki/tiki-index.php "ELRepo Project")
After this you should reboot your PC with the new kernel source and start from [section compile & install](#compile-install)
After this you should reboot your PC with the new kernel source and start from [Compile & Install the project](#Compile-&-Install-the-project)
### I can't detect any level on my inputs.
......@@ -1670,8 +1652,10 @@ following commands:
~~~~~~~{.sh}
>:$ sudo insmod kernel/fmc.ko
>:$ sudo insmod kernel/htvic.ko
>:$ sudo insmod kernel/spec.ko
>:$ sudo insmod kernel/wr-nic.ko
>:$ sudo insmod kernel/wr-dio.ko
~~~~~~~~~~~~~
### The system hangs-up
......@@ -1725,25 +1709,25 @@ WRC / WRPC
: White Rabbit Switch
[WR]:http://www.sevensols.com/whiterabbitsolution
[WRS]: http://www.sevensols.com/en/products/wr-switch.html
[WR]:https://www.ohwr.org/project/white-rabbit/wikis/home
[WRS]: https://sevensols.com/index.php/products/white-rabbit-switch/
[WRSSK]: http://www.sevensols.com/en/products/wr-starting-kit.html
[SPEC+FMCDIO]: http://sevensols.com/index.php/kit-spec/
[SPEC]: http://sevensols.com/index.php/products/spec/
[FMC]: http://www.ohwr.org/projects/fmc-projects
[FMC-DIO]: http://sevensols.com/index.php/fmc-dio/
[FMCDIO]: http://sevensols.com/index.php/fmc-dio/
[FMC fine-delay]: http://www.sevensols.com/en/products/fmc-del.html
[FMC fine-delay]: https://sevensols.com/index.php/fmc-del/
[OHWR]: http://www.ohwr.org/projects/white-rabbit
[fmc-dio-5chttla]: https://ohwr.org/project/fmc-dio-5chttla/
References
============
* [spec-sw.pdf] main documentation of the spec-sw
* TODO:[spec-sw.pdf] main documentation of the spec-sw
* [wrpc.pdf] White Rabbit Core documentation
* [fmc-bus.pdf] How the FMC bus driver works and how to write one for your own FMC board.
* SFPs information <http://www.ohwr.org/projects/white-rabbit/wiki/SFP>
* White Rabbit Calibration: <http://www.ohwr.org/documents/213>
* [spec-2-spec]: SPEC-2-SPEC demo
......@@ -1754,7 +1738,7 @@ References
[wr-switch-guide.pdf]: http://www.sevensols.com/dl/wr-switch-sw/startupguide/latest_stable.pdf
[wr-switch-guide.pdf]: https://sevensols.com/index.php/products/white-rabbit-switch/
[wr-nic]: http://www.ohwr.org/projects/wr-nic/
[wr-starting-kit]: http://www.ohwr.org/projects/wr-starting-kit/
[spec-sw]: http://www.ohwr.org/projects/spec-sw/
......@@ -1768,4 +1752,4 @@ References
[wr_external_reference.pdf]: http://www.ohwr.org/attachments/1647/wr_external_reference.pdf
[wrpc.pdf]: http://www.ohwr.org/attachments/2559/wrpc-v2.1.pdf
[wrpc-v2.1.pdf]: http://www.ohwr.org/attachments/2559/wrpc-v2.1.pdf
[Seven Solutions]: http://www.sevensols.com
[Seven Solutions]: http://www.sevensols.com
\ No newline at end of file
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