Skip to content

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

doc: improve grandmaster and standalone section

parent 360b2779
Hide whitespace changes
Inline Side-by-side
Showing with 34 additions and 13 deletions
doc/wr-starting-kit.md
View file @ 613e9854
...@@ -1405,43 +1405,62 @@ The requirement for the applied signals are: ...@@ -1405,43 +1405,62 @@ The requirement for the applied signals are:
[^aroundval]: These values are given on an indicative basis because they depend on the source and [^aroundval]: These values are given on an indicative basis because they depend on the source and
connection you are using. connection you are using.
An example of typical signal generated for GM mode is displayed below: ### Example from GPS
* Green signal is PPS. The common way to use grandmaster mode is with a GPS source where the
* Pink signal is 10MHz. input 10MHz signal can be square or sinusoidal.
![Grandmaster signals](ssk_gm_signals.png) ![Grandmaster signals from GPS (PPS=>Yellow, 10MHz=> Blue)](img/ssk_gm_GPS.jpg)
Then in the wrc console just execute the following commands: ### Example from a FMC fine-delay
If you have a [FMC fine-delay] board you can generated the PPS/10MHz by
executing the following commands (using release 2014.04):
~~~~~~{.sh} ~~~~~~{.sh}
wrc# mode grandmaster >:$ sudo tools/fmc-fdelay-pulse -o 1 -p ## PPS on #1
>:$ sudo tools/fmc-fdelay-pulse -o 2 -1 ## 10MhZ on #2
~~~~~~~~~~~~~
![Grandmaster signals from a FMC fine-delay (PPS=>Yellow, 10MHz=> Blue)](img/ssk_gm_fdelay.jpg)
### Locking
Then in the wrc console of the [SPEC+FMCDIO] just execute the following commands:
~~~~~~{.sh}
wrc# ptp stop
wrc# mode gm
wrc# ptp start wrc# ptp start
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
And you should obtained: And you should obtained:
~~~~~~{.sh} ~~~~~~{.sh}
SPLL_Init: running as GrandMaster, 1 ref channels, 2 out channels
PLL locking .................. LOCKED PLL locking .................. LOCKED
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
For more information about grandmaster mode you can take a look at: [wr_external_reference.pdf]. For more information about grandmaster mode you can take a look at: [wr_external_reference.pdf].
This document has been written for the WR switch, but timing/accuracy/stability requirements are This document has been written for the WR switch, but timing/accuracy/stability requirements are
similar for the SPECs. similar for the [SPEC+FMCDIO].
By default the [SPEC+FMCDIO] should be configured to be run in GM setup, but if you are not sure please
By default the SPEC+DIO should be configured to be run in GM setup, but if you are not sure please reset the default value. See [Default Mode](#default-mode) Section. If you
reset the default value. See [Default Mode](#default-mode) Section. want to run the [SPEC+FMCDIO] in standalone mode as grandmaster we also
recommand you to modify the startup script as explained in the [section below](#run-in-standalone)
Run in standalone modes Run in standalone
---------------------------- ----------------------------
> **Note**: You need to have the Xilinx JTAG USB platform cable or similar
to perform the next step.
You can also run GM in a full standalone mode in order to transmit WR clock without the need of a PC. 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: 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 <http://www.sevensols.com/dl/wr-nic/bin/latest_stable.tar.gz>
To do so you need to generate a MSC file as follow: To do so you need to generate a MSC file as follow:
...@@ -1458,6 +1477,8 @@ correctly configured for GM by default at power up. ...@@ -1458,6 +1477,8 @@ correctly configured for GM by default at power up.
* (Optional) Finally, if you need to keep this configuration at power up, you can write a small script * (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. on the EEPROM to boot in grandmaster mode.
### EEPROM boot script
~~~~~~{.sh} ~~~~~~{.sh}
wrc# init erase wrc# init erase
wrc# init add ptp stop wrc# init add ptp stop
......
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