Skip to content

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

Merge branch 'klyone-20190412-fix_copyright_licenses' into 'proposed_master' 

Klyone 20190412 fix copyright licenses

See merge request !3
parents 44d493d1 f238eefc
Hide whitespace changes
Inline Side-by-side
Showing with 213 additions and 25 deletions
doc/wr-starting-kit.md
View file @ 7ef5a3d5
......@@ -68,11 +68,14 @@ Revision table
2.0 15/05/2014 Benoit Rat\ Updating for v2.0 release
[Seven Solutions]
3.0 06/11/2019 Manuel Castilla\ Updating for v3.0 release
3.0 06/11/2019 Manuel Castilla\ Updating for v3.0 release
Benoit Rat\
Francesco Colella\
[Seven Solutions]
3.1 04/12/2019 Miguel Jimenez\ Minor changes for v3.0 release
[Seven Solutions]
------------------------------------------------------------------------
You can also check the [Changelog section](#changelog) for more information.
......@@ -397,7 +400,7 @@ sudo apt-get install texinfo emacs texlive-xetex pandoc
[^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.
![Grandmaster setup](img/ssk_grandmaster.jpg)
......@@ -1568,8 +1574,6 @@ following `promgen` (ISE Tool) parameters should be used:
promgen -w -spi -p mcs -c FF -s 32768 -u 0 <your_bitstream>.bit -bd sdbfs-standalone-160812.bin start 0x170000 -o output.mcs
~~~~~~~~~~
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`)
~~~~~~{.bash}
## From the wr-starting-kit repo
$ cd fmc-dio/hdl/syn/dio-nic
## Initialize git submodule for fmc-dio project
$ cd fmd-dio
$ git submodule init
$ git submodule update
## Goto synthesis folder
$ cd hdl/syn/dio-nic
## Synthetize using hdlmake
$ hdlmake
......@@ -1963,4 +1978,4 @@ References
[wr-starting-kit-v3.0_bin.tar.gz]: <https://ohwr.org/project/wr-starting-kit/wikis/uploads/b63d12f90cd0dbb89b78587603fdcfe6/wr-starting-kit-v3.0_bin.tar.gz>
[spec-golden]: https://www.ohwr.org/project/spec-sw/uploads/636e7eaa2e1c3a884e2f9f694fdfd1b9/spec-init.bin-2015-09-18
[sdbfs-standalone-160812.bin]: <https://www.ohwr.org/project/wr-cores/uploads/9dad995e74a3d49b472b8654833be01a/sdbfs-standalone-160812.bin>
\ No newline at end of file
[sdbfs-standalone-160812.bin]: <https://www.ohwr.org/project/wr-cores/uploads/9dad995e74a3d49b472b8654833be01a/sdbfs-standalone-160812.bin>
fmc-dio @ 033ff03d
Subproject commit eea7bfc82e4cb3554d4343d93dfa75773d7b2fc2
Subproject commit 033ff03d41d896f65424440d5f097adfce49597b
scripts/wr-git-patch
View file @ 7ef5a3d5
#!/bin/dash
## Script to apply git patches for submodules.
##
## Authors:
## Authors:
## - Miguel Jimenez Lopez (Seven Solutions, www.sevensols.com)
##
## GNU Lesser General Public License Usage
## This file may be used under the terms of the GNU Lesser
## General Public License version 2.1 as published by the Free Software
## Foundation and appearing in the file LICENSE.LGPL included in the
## packaging of this file. Please review the following information to
## ensure the GNU Lesser General Public License version 2.1 requirements
## will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
## Copyright 2019 CERN (www.cern.ch)
##
## This file is part of WR Starting Kit project.
## (see https://www.ohwr.org/project/wr-starting-kit).
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>
#######################################################################################################
### Show help of the function
......
spec-sw @ 25ec5c3d
Subproject commit e76f5ca3bcda171318757b603abca131712d086e
Subproject commit 25ec5c3d76b5f8a767020de2e9fbe6f4a1745b8c
test/validation/dio.py
View file @ 7ef5a3d5
......@@ -5,6 +5,24 @@
# @author Manuel Castilla
# @date 23/04/2019
#
# Copyright (c) 2019 CERN (www.cern.ch).
#
# This file is part of WR Starting Kit project
# (see https://www.ohwr.org/project/wr-starting-kit).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
#(at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
###########################################################################
from ssh import SshCmd,SshCmdException
......
test/validation/loadDriver.py
View file @ 7ef5a3d5
......@@ -6,8 +6,27 @@
# @author Manuel Castilla
# @date 16/04/2019
#
# Copyright (c) 2019 CERN (www.cern.ch).
#
# This file is part of WR Starting Kit project
# (see https://www.ohwr.org/project/wr-starting-kit).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
#(at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
###########################################################################
from ssh import SshCmd,SshCmdException
import sys
import getpass
......
test/validation/ssh.py
View file @ 7ef5a3d5
......@@ -5,6 +5,24 @@
# @author Manuel Castilla
# @date 05/04/2019
#
# Copyright (c) 2019 CERN (www.cern.ch).
#
# This file is part of WR Starting Kit project
# (see https://www.ohwr.org/project/wr-starting-kit).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
#(at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
###########################################################################
import paramiko
......
test/validation/testAdvDIO.py
View file @ 7ef5a3d5
......@@ -6,6 +6,24 @@
# @author Manuel Castilla
# @date 25/04/2019
#
# Copyright (c) 2019 CERN (www.cern.ch).
#
# This file is part of WR Starting Kit project
# (see https://www.ohwr.org/project/wr-starting-kit).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
#(at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
###########################################################################
import configparser
......
test/validation/testAll.py
View file @ 7ef5a3d5
......@@ -6,6 +6,24 @@
# @author Manuel Castilla
# @date 29/04/2019
#
# Copyright (c) 2019 CERN (www.cern.ch).
#
# This file is part of WR Starting Kit project
# (see https://www.ohwr.org/project/wr-starting-kit).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
#(at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
###########################################################################
import configparser
......
test/validation/testDIO.py
View file @ 7ef5a3d5
......@@ -6,6 +6,24 @@
# @author Manuel Castilla
# @date 25/04/2019
#
# Copyright (c) 2019 CERN (www.cern.ch).
#
# This file is part of WR Starting Kit project
# (see https://www.ohwr.org/project/wr-starting-kit).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
#(at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
###########################################################################
import configparser
......
test/validation/testNIC.py
View file @ 7ef5a3d5
......@@ -6,6 +6,24 @@
# @author Manuel Castilla
# @date 16/04/2019
#
# Copyright (c) 2019 CERN (www.cern.ch).
#
# This file is part of WR Starting Kit project
# (see https://www.ohwr.org/project/wr-starting-kit).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
#(at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
###########################################################################
from ssh import SshCmd,SshCmdException
......
test/validation/testWR.py
View file @ 7ef5a3d5
......@@ -6,6 +6,24 @@
# @author Manuel Castilla
# @date 23/04/2019
#
# Copyright (c) 2019 CERN (www.cern.ch).
#
# This file is part of WR Starting Kit project
# (see https://www.ohwr.org/project/wr-starting-kit).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
#(at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
###########################################################################
from vuart import Vuart
......
test/validation/vuart.py
View file @ 7ef5a3d5
......@@ -5,6 +5,24 @@
# @author Manuel Castilla
# @date 23/04/2019
#
# Copyright (c) 2019 CERN (www.cern.ch).
#
# This file is part of WR Starting Kit project
# (see https://www.ohwr.org/project/wr-starting-kit).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
#(at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
###########################################################################
from ssh import SshCmd,SshCmdException
......
wr-nic @ aef6f1fb
Subproject commit 2ff6c419ea4a23cb9ffc043f6c03d831e81f9f2f
Subproject commit aef6f1fba9792f99db3014c2ed62305baaed5b5c
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