Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
W
White Rabbit Starting Kit
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Wiki
Wiki
image/svg+xml
Discourse
Discourse
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Projects
White Rabbit Starting Kit
Commits
88d3ff67
Commit
88d3ff67
authored
Oct 08, 2019
by
manuel
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
doc:remove visible "TODO:" of document
parent
0bb438ae
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
25 additions
and
10 deletions
+25
-10
wr-starting-kit.md
doc/wr-starting-kit.md
+25
-10
No files found.
doc/wr-starting-kit.md
View file @
88d3ff67
...
...
@@ -846,8 +846,9 @@ However with the next experiment you will find out that the synchronization is b
Synchronization of PPS
----------------------------------------------------------------------------------------
<!--TODO: spec-sw.pdf does not exist -->
This corresponds to the experiment from
TODO:
[
spec-sw.pdf:6.8
][
spec-sw.pdf
]
document.
This corresponds to the experiment from
[
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 +1050,9 @@ 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 TODO:
[
spec-sw.pdf:6.8
][
spec-sw.pdf
]
document
<!--TODO: spec-sw.pdf does not exist -->
For further details (deeper studies) the user is recommended to read the
[
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`
...
...
@@ -1371,7 +1374,9 @@ 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.
TODO:First you need to flash the SPEC with the latest bitstream you can find the package:
<!--TODO: The package does not exist -->
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 +1428,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.
TODO:
[
spec-golden
]
[
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.
...
...
@@ -1489,6 +1494,8 @@ how to compile new firmware for other configurations.
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:
<!--TODO: update checkout and configure -->
~~~
~~~{.sh}
## Set up CROSS_COMPILE variable for this terminal
export CROSS_COMPILE="<your_path_to_lm32>/lm32/bin/lm32-elf-";
...
...
@@ -1498,7 +1505,7 @@ git clone https://ohwr.org/project/wrpc-sw.git
cd wrpc-sw
TODO:
## Checkout the stable release
## Checkout the stable release
git checkout -b wrpc-v2.1-for-wrnic wrpc-v2.1-for-wrnic
~~~
~~~~~~~
...
...
@@ -1506,7 +1513,7 @@ git checkout -b wrpc-v2.1-for-wrnic wrpc-v2.1-for-wrnic
And finally configure and compile it
~~~
~~~{.sh}
TODO:
## Configuring the project for SPEC
## Configuring the project for SPEC
make wrnic_defconfig
## Compile
...
...
@@ -1518,7 +1525,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}
TODO:
## Override the default embeded wrpc-sw
## Override the default embeded wrpc-sw
cp wrc.ram <wr_root_folder>/wr-nic/syn/spec
~~~
~~~~~~~~
...
...
@@ -1531,11 +1538,14 @@ WR-NIC (HDL-gateware)
This step shows us how to prepare the WR-NIC bitstream (
[
SPEC+FMCDIO
]
) with
the wrpc-sw (
`wrc.ram`
file) embedded inside.
<!--TODO: update checkout -->
~~~
~~~{.bash}
## Checkout the code
git https://ohwr.org/project/wr-nic.git
cd wr-nic
TODO:git checkout -b wr-nic-v2.0 wr-nic-v2.0
git checkout -b wr-nic-v2.0 wr-nic-v2.0
## Create and update the submodules
git submodule init
...
...
@@ -1544,7 +1554,7 @@ git submodule update
## Go to the main directory
cd syn/specdio/
TODO:
## Synthetize using hdlmake
## Synthetize using hdlmake
hdlmake --make-ise --ise-proj
make
~~~
~~~~~~~~
...
...
@@ -1726,7 +1736,9 @@ WRC / WRPC
References
============
*
TODO:
[
spec-sw.pdf
]
main documentation of the spec-sw
<!--TODO: spec-sw.pdf link does not exist -->
*
[
spec-sw.pdf
]
main documentation of the spec-sw
*
[
wrpc.pdf
]
White Rabbit Core documentation
*
SFPs information
<http://www.ohwr.org/projects/white-rabbit/wiki/SFP>
*
White Rabbit Calibration:
<http://www.ohwr.org/documents/213>
...
...
@@ -1743,6 +1755,9 @@ References
[
wr-starting-kit
]:
http://www.ohwr.org/projects/wr-starting-kit/
[
spec-sw
]:
http://www.ohwr.org/projects/spec-sw/
[
wrpc-sw
]:
http://www.ohwr.org/projects/wrpc-sw/
<!--TODO: spec-golden link does not exist -->
[
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-getting-started.pdf
]:
http://www.ohwr.org/projects/spec-getting-started/wiki
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment