Skip to content

W
White Rabbit Starting Kit
Commit 2c7cd1b3 authored by manuel's avatar manuel
Browse files
Options

doc: Put correctly the names, White Rabbit and WR Stating Kit

parent 06e19eb4
Hide whitespace changes
Inline Side-by-side
Showing with 15 additions and 15 deletions
doc/wr-starting-kit.md
View file @ 2c7cd1b3
...@@ -157,10 +157,10 @@ Distance Range ...@@ -157,10 +157,10 @@ Distance Range
: Taking into account the size and ranges of the majority of industrial and scientific facilities, the [WR] network specifications have been chosen to support distance ranges of 10 km between [WR] network elements(nodes or switches) using fiber cables. : Taking into account the size and ranges of the majority of industrial and scientific facilities, the [WR] network specifications have been chosen to support distance ranges of 10 km between [WR] network elements(nodes or switches) using fiber cables.
The **Starting Kit** has been designed to test and check if the White The **WR Starting Kit** has been designed to test and check if the White
Rabbit technology meets your requirements. It shall also facilitate the Rabbit technology meets your requirements. It shall also facilitate the
understanding on the technology capabilities and possibilities. understanding on the technology capabilities and possibilities.
WR starting kit can also be used to evaluate what can be done with it WR Starting kit can also be used to evaluate what can be done with it
and how to integrate it on your own project. and how to integrate it on your own project.
You can find more information on other components and use cases on: You can find more information on other components and use cases on:
...@@ -172,7 +172,7 @@ You can find more information on other components and use cases on: ...@@ -172,7 +172,7 @@ You can find more information on other components and use cases on:
About the WR Starting Kit About the WR Starting Kit
---------------------------------- ----------------------------------
This starting kit uses two nodes, each one composed of a [SPEC] and one This WR Starting Kit uses two nodes, each one composed of a [SPEC] and one
[FMC-DIO] card. [FMC-DIO] card.
A node makes basic operations such as input time-stamping or programmable output pulse generation. A node makes basic operations such as input time-stamping or programmable output pulse generation.
...@@ -265,7 +265,7 @@ System Setup ...@@ -265,7 +265,7 @@ System Setup
=========== ===========
This section describes the main elements required to start with the White-Rabbit based This section describes the main elements required to start with the White-Rabbit based
on the *"White Rabbit (SPEC-based) starting kit"*. The different on the *"White Rabbit (SPEC-based) Starting Kit"*. The different
hardware elements and theirs connections are described in this section. hardware elements and theirs connections are described in this section.
What do you need? What do you need?
...@@ -288,10 +288,10 @@ However, the `spec-sw` driver should work with other releases, distributions and ...@@ -288,10 +288,10 @@ However, the `spec-sw` driver should work with other releases, distributions and
![Configuration with one two PCs](img/ssk_configs.png) ![Configuration with one two PCs](img/ssk_configs.png)
Starting kit components WR Starting Kit components
----------------- -----------------
The starting kit is composed of various elements that you should find The WR Starting Kit is composed of various elements that you should find
in the package[^standardssk] : in the package[^standardssk] :
* 2x [SPEC]s boards * 2x [SPEC]s boards
...@@ -304,9 +304,9 @@ in the package[^standardssk] : ...@@ -304,9 +304,9 @@ in the package[^standardssk] :
* 3x LEMO cable (2m) * 3x LEMO cable (2m)
* 3x LEMO-BNC Adaptor * 3x LEMO-BNC Adaptor
![The components of the starting kit](img/ssk_components.jpg) ![The components of the WR Starting Kit](img/ssk_components.jpg)
[^standardssk]: Only with the standard version of starting kit. [^standardssk]: Only with the standard version of WR Starting Kit.
Physical setup Physical setup
...@@ -1181,7 +1181,7 @@ distributed instrumentation facility); another typical application is ...@@ -1181,7 +1181,7 @@ distributed instrumentation facility); another typical application is
time stamping input events. time stamping input events.
Thus in these experiments we are going to transmit an external frequency in Thus in these experiments we are going to transmit an external frequency in
the 100Hz range using the starting kit: the 100Hz range using the WR Starting Kit:
* The user supplies a ~100Hz square wave on the channel 0 of the master card. * The user supplies a ~100Hz square wave on the channel 0 of the master card.
* The **dio-ruler** on master host reads the UTC time of the rising edge of the external pulse upon IRQ. * The **dio-ruler** on master host reads the UTC time of the rising edge of the external pulse upon IRQ.
...@@ -1400,7 +1400,7 @@ The result of this experiment is illustrated by the next figure where ...@@ -1400,7 +1400,7 @@ The result of this experiment is illustrated by the next figure where
you can see the 3 PPS signals: yellow for [WRS], blue and violet for you can see the 3 PPS signals: yellow for [WRS], blue and violet for
[SPEC+FMCDIO]. [SPEC+FMCDIO].
![WRS PPS (yellow) vs Starting Kit PPS (blue & violet)](img/ssk_wrspps.jpg) ![WRS PPS (yellow) vs WR Starting Kit PPS (blue & violet)](img/ssk_wrspps.jpg)
The distance between each PPS might be reduced by the improving the The distance between each PPS might be reduced by the improving the
calibration which is the subject of the next section. calibration which is the subject of the next section.
...@@ -1428,7 +1428,7 @@ captured by the oscilloscope. ...@@ -1428,7 +1428,7 @@ captured by the oscilloscope.
> ***Notes:***: Please check that you are using the values that correspond > ***Notes:***: Please check that you are using the values that correspond
to your gateware release. When this document was generated we refer as to your gateware release. When this document was generated we refer as
wr-starting-kit-v3.0 (starting kit). You can also check using the `ver` command wr-starting-kit-v3.0 (WR Starting Kit). You can also check using the `ver` command
if the corresponding embedded LM32 corresponds to your gateware version. if the corresponding embedded LM32 corresponds to your gateware version.
~~~~~{.sh} ~~~~~{.sh}
...@@ -1442,7 +1442,7 @@ wrc# sfp show ...@@ -1442,7 +1442,7 @@ wrc# sfp show
## Erase the actual database if it was corrupted ## Erase the actual database if it was corrupted
wrc# sfp erase wrc# sfp erase
## Add the parameters for the SFP provided in the starting kit ## Add the parameters for the SFP provided in the WR Starting Kit
wrc# sfp add AXGE-1254-0531 121751 95827 64481496 wrc# sfp add AXGE-1254-0531 121751 95827 64481496
wrc# sfp add AXGE-3454-0531 121751 95827 -66584558 wrc# sfp add AXGE-3454-0531 121751 95827 -66584558
~~~~~~~~~~~ ~~~~~~~~~~~
...@@ -1601,13 +1601,13 @@ If you need a more complete guide on how to create your own HDL for the [SPEC], ...@@ -1601,13 +1601,13 @@ If you need a more complete guide on how to create your own HDL for the [SPEC],
or you want to improve the structure of a project using the [OHWR] platform we recommend you or you want to improve the structure of a project using the [OHWR] platform we recommend you
to look at the [spec-getting-started.pdf] guide. to look at the [spec-getting-started.pdf] guide.
The starting kit is based on various project: The WR Starting Kit is based on various project:
* [spec-sw], The project that contains the PCIe driver and tools to access to the SPEC FPGA * [spec-sw], The project that contains the PCIe driver and tools to access to the SPEC FPGA
* [spec-golden], A simple gateware in order to access to the EEPROM of the [FMC] (WB-I2C) * [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 capabilities and its corresponding kernel drivers * [wr-nic], gateware (FPGA HDL) that includes the NIC capabilities and its corresponding kernel drivers
* [fmc-dio-5chttla], gateware (FPGA HDL) that includes the DIO capabilities (with NIC) and its corresponding kernel drivers * [fmc-dio-5chttla], gateware (FPGA HDL) that includes the DIO capabilities (with NIC) and its corresponding kernel drivers
* [wrpc-sw], LM32 software in the white rabbit PTP core for the synchronization * [wrpc-sw], LM32 software in the White Rabbit PTP core for the synchronization
* [coht-vic], Kernel driver to handles interruption from FPGA such as the one from SPEC * [coht-vic], Kernel driver to handles interruption from FPGA such as the one from SPEC
...@@ -1879,7 +1879,7 @@ References ...@@ -1879,7 +1879,7 @@ References
* [spec-sw] Sub-project with that contains the PCIe driver and tools to access to the SPEC FPGA * [spec-sw] Sub-project with that contains the PCIe driver and tools to access to the SPEC FPGA
* [wr-nic] Sub-project with gateware (FPGA HDL) that includes the NIC capabilities and its corresponding kernel drivers * [wr-nic] Sub-project with gateware (FPGA HDL) that includes the NIC capabilities and its corresponding kernel drivers
* [fmc-dio-5chttla] Sub-project with gateware (FPGA HDL) that includes the DIO capabilities (with NIC) and its corresponding kernel drivers * [fmc-dio-5chttla] Sub-project with gateware (FPGA HDL) that includes the DIO capabilities (with NIC) and its corresponding kernel drivers
* [wrpc-sw] Sub-project with the LM32 software in the white rabbit PTP core for the synchronization * [wrpc-sw] Sub-project with the LM32 software in the White Rabbit PTP core for the synchronization
......
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