[^debian]:This sample command is for debian's like distributions.
However similar packages exist for other distributions.
Compile & Install the project
Compile & Install the project {#wrsk-comp-inst}
-------------------
The first step is to install the driver to communicate with the card using
...
...
@@ -891,7 +894,7 @@ The available modes are:
*`D/d`: DIO core output
*`P/p` (Channel 0): Output PPS (Pulse Per Second) Generator from PTP core.
*`C/c` (Channel 4): Clock Input to PTP core: allow to input a high frequency signal without interruption throwing
*`-` : This operator is used to Keep the current configuration on the channel
*`-` : This operator is used to keep the current configuration on the channel
>> ***Note:*** If the Letter is capitalized the I/O channel is connected to 50-ohm termination resistor, otherwise it is not. e.g. The `I` is input with 50-ohm termination resistor and `i` is without it.
...
...
@@ -1256,7 +1259,7 @@ delay of 50 microseconds).
### The setup
Let's start by running the "dump" agent on the slave board in charge of forwarding *ioctl* packet to the *DIO* core:
Let's start by running the "dumb" agent on the slave board in charge of forwarding *ioctl* packet to the *DIO* core:
~~~~~~{.sh}
## Set remote1 as DIO output (and disable remote2)
...
...
@@ -1486,8 +1489,11 @@ SPEC+DIO as grandmaster
In basic configuration your Master [SPEC] can use its internal
free-running oscillator as a time reference. However, you can also
discipline your Master [SPEC] with external 10 MHz(to the channel 4) and 1-PPS(to the channel 3) signal by
connecting them to the appropriate LEMO connectors of [FMC-DIO] board:
discipline your Master [SPEC] with external 10 MHz and 1-PPS signal by
connecting them to appropiate LEMO connectors of [FMC-DIO] board (note: channel
0 is the first one):
- connected 10 MHz to channel 4.
- connected 1-PPS to channel 3.
...
...
@@ -1568,8 +1574,6 @@ following `promgen` (ISE Tool) parameters should be used:
To do so you need to generate a MSC file as follows:
Finally:
* The setup of the cable is exactly the same as above, and you do not need to update the configuration of DIOFMC inputs because it is correctly configured for GM by default at power up.
...
...
@@ -1577,7 +1581,7 @@ Finally:
* (Optional) Finally, if you need to keep this configuration at power up, you can write a small script
on the EEPROM to boot in grandmaster mode.
> **Note**: In the case when you want to run on the the SPEC a reference bitstream provided with a stable
> **Note**: In the case when you want to run on the SPEC a reference bitstream provided with a stable
WRPC release, you can simply program your Flash with \textit{spec\_top.mcs}
provided with the release binaries using for example Xilinx ISE Impact tool.
...
...
@@ -1626,7 +1630,7 @@ 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
to look at the [spec-getting-started.pdf] guide.
The WR Starting Kit is based on various project:
The [WR Starting Kit][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-golden], A simple gateware in order to access to the EEPROM of the [FMC](WB-I2C)
...
...
@@ -1635,6 +1639,11 @@ The WR Starting Kit is based on various project:
*[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
> ***Note:*** Next sections describe manual procedures to generate software and
> FPGA firmware binary files. All relative path in their code listings are refered
> to main folder of the WR Starting Kit project. WR Starting Kit repository
> installation guidelines can be found in [Compile & Install the
> project](#wrsk-comp-inst) section.
In the following figure you can understand better how the different subproject are connected and included in the WR-starting-kit project.
...
...
@@ -1708,12 +1717,18 @@ $ hdlmake -v
hdlmake 3.2
~~~~~~
If it is not the case you should visit [hdlmake] project, and follows the instruction to install by doing a checkout to commit `#43d55c3`
If it is not the case you should visit [hdlmake] project, and follows the
instruction to install by doing a checkout to version 3.2 (tag `3.2` or commit `#c4b5fce`)
