|
|
|
## User Documentation
|
|
|
|
|
|
|
|
### [White Rabbit Switch. Functional Specification.](Documents/White-Rabbit-Switch.-Functional-Specification.)
|
|
|
|
This document (preliminary version) describes the functional
|
|
|
|
requirements that the White Rabbit Switch must accomplish.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [White Rabbit Specification: Draft for Comments](Documents/White-Rabbit-Specification:-Draft-for-Comments)
|
|
|
|
Description of White Rabbit protocol which extends IEEE1588-2008
|
|
|
|
standard.
|
|
|
|
|
|
|
|
The files with White Rabbit specification have been moved to the project
|
|
|
|
[White Rabbit Standardization](https://www.ohwr.org/project/wr-std/wiki)
|
|
|
|
|
|
|
|
- [WR Specification - latest
|
|
|
|
version](https://www.ohwr.org/documents/160)
|
|
|
|
- [older versions of the WR Spec](https://www.ohwr.org/documents/161)
|
|
|
|
(to show how the WR Spec evolved)
|
|
|
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
25 March 2012
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [White Rabbit DEMO (1)](Documents/White-Rabbit-DEMO-(1))
|
|
|
|
Attached is a movie from Tomek's demo of White Rabbit during
|
|
|
|
presentation at CERN.
|
|
|
|
|
|
|
|
Demo highlights that synchronization in WR is completely plug\&play.
|
|
|
|
|
|
|
|
The movie is available with a bit better quality here:
|
|
|
|
http://www.youtube.com/watch?v=ZZsEr0TTTEk
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [White Rabbit DEMO (2)](Documents/White-Rabbit-DEMO-(2))
|
|
|
|
Attached is a movie from Tomek's demo of White Rabbit during
|
|
|
|
presentation at CERN.
|
|
|
|
|
|
|
|
Demo demonstrates delay tracking in variable conditions.
|
|
|
|
|
|
|
|
Of better quality and in one piece, the movie is available here:
|
|
|
|
http://www.youtube.com/watch?v=ZSRQEExbdq8
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [Tom's Master thesis](Documents/Tom's-Master-thesis)
|
|
|
|
T.Włostowski, *Precise time and frequency transfer in a White Rabbit
|
|
|
|
network*, 2011.
|
|
|
|
M.Sc thesis describing the exact synchronization algorithm used in WR
|
|
|
|
and the WR Switch.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [White Rabbit CERN Control and Timing Network](Documents/White-Rabbit-CERN-Control-and-Timing-Network)
|
|
|
|
This documents puts together some preliminary thoughts about White
|
|
|
|
Rabbit's application to control and provide timing for accelerators at
|
|
|
|
CERN (replacing General Machine Timing).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [Posters](Documents/Posters)
|
|
|
|
Posters in conferences, workshops and other meetings.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [White Rabbit logo](Documents/White-Rabbit-logo)
|
|
|
|
White Rabbit logo in different formats (including vector graphic) can be
|
|
|
|
found here.
|
|
|
|
|
|
|
|
These logos are intellectual property of CERN.
|
|
|
|
The logo is licensed under "Attribution-ShareAlike 4.0 International (CC
|
|
|
|
BY-SA 4.0)"
|
|
|
|
If in doubt, please contact CERN before attempting to use them.
|
|
|
|
|
|
|
|
The "\*-original" files contain the logo which was drawn by hand and
|
|
|
|
scanned (authored by Alexandra Lewis).
|
|
|
|
The "\*-vectorized" files contain the logo which was re-drawn from the
|
|
|
|
original in Corel Draw to provide useful vector graphic (accepted by the
|
|
|
|
original author).
|
|
|
|
Corel Draw version of the logo available on request (contact Maciej
|
|
|
|
Lipinski)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [White Rabbit as a fieldbus (presentation)](Documents/White-Rabbit-as-a-fieldbus-(presentation))
|
|
|
|
Presentation and demo done in the context of the CERN Fieldbus Working
|
|
|
|
Group on Thursday 26 January 2012.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [WR contribution for ITU-T Q13/15 meeting](Documents/WR-contribution-for-ITU-T-Q13/15-meeting)
|
|
|
|
Informative contribution prepared for ITU-T Q13/Q15 meeting in Boulder
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [Figures](Documents/Figures)
|
|
|
|
Here you can find all the figures used on White Rabbit Project wiki
|
|
|
|
pages.
|
|
|
|
The sources of the figures and more figures can be found in the
|
|
|
|
repository
|
|
|
|
([here](https://www.ohwr.org/project/white-rabbit/tree/master/trunk/documentation/figures))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [Temperature Tests (aka Torture Report)](Documents/Temperature-Tests-(aka-Torture-Report))
|
|
|
|
A small White Rabbit system with two WR SPEC nodes connected to two WR
|
|
|
|
switches was
|
|
|
|
built. All WR components were independently exposed to temperatures
|
|
|
|
ranging between 0 and
|
|
|
|
50 degrees Celsius to measure the actual synchronization performance.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [White Rabbit calibration procedure](Documents/White-Rabbit-calibration-procedure)
|
|
|
|
This document describes the calibration procedure for White Rabbit
|
|
|
|
devices. The procedure must be performed to ensure the sub-nanosecond
|
|
|
|
accuracy synchronization of the WR network.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [White Rabbit Users](Documents/White-Rabbit-Users)
|
|
|
|
This document contains information from Users and applications of White
|
|
|
|
Rabbit.
|
|
|
|
The [White Rabbit Users
|
|
|
|
page](https://www.ohwr.org/project/white-rabbit/wikis/WRUsers) shows a
|
|
|
|
large sample of users.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [WR Jobs](Documents/WR-Jobs)
|
|
|
|
Job descriptions where White Rabbit is mentioned.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Technical Documentation
|
|
|
|
|
|
|
|
### [FPGA transceivers propagation delay study](Documents/FPGA-transceivers-propagation-delay-study)
|
|
|
|
A great report by Nikhef's Peter Jansweijer and Henk Peek, with lots of
|
|
|
|
interesting material on Xilinx Gb/s transceivers. See the report stored
|
|
|
|
at its original location:
|
|
|
|
http://www.nikhef.nl/pub/services/biblio/technicalreports/ETR2010-01.pdf
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [Articles](Documents/Articles)
|
|
|
|
Papers in conferences, workshops and other meetings.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [WR switch technical specification](Documents/WR-switch-technical-specification)
|
|
|
|
|
|
|
|
### [White Rabbit Node Specifications](Documents/White-Rabbit-Node-Specifications)
|
|
|
|
Current version of the WR node functional specification
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [Presentations](Documents/Presentations)
|
|
|
|
Presentations in conferences, workshops and other meetings.
|
|
|
|
|
|
|
|
A list of WR-related presentation can be found
|
|
|
|
[here](https://www.ohwr.org/project/white-rabbit/wikis/WRpresentations).
|
|
|
|
|
|
|
|
NOTE: The idea of packet pre-emption mentioned in the presentations
|
|
|
|
WR\_Tomek\_ICALEPCS2009.pdf and WR\_Loschmidt\_ISPCS2009.pdf is not
|
|
|
|
retained.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [ptp proposal](Documents/ptp-proposal)
|
|
|
|
A proposal for a portable ptp daemon to be used in both WR-PTP and
|
|
|
|
standard PTP
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [White Rabbit and Robustness: Draft for Comments](Documents/White-Rabbit-and-Robustness:-Draft-for-Comments)
|
|
|
|
This document is a study of reliability and robustness of a White Rabbit
|
|
|
|
network.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [Greg's Master thesis](Documents/Greg's-Master-thesis)
|
|
|
|
G. Daniluk, White Rabbit PTP Core the sub-nanosecond time
|
|
|
|
synchronization over Ethernet, 2012.
|
|
|
|
M.Sc thesis describing the development and implementation of the first
|
|
|
|
standalone HDL module handling the sub-nanosecond synchronization over a
|
|
|
|
regular Ethernet - the White Rabbit PTP Core.
|
|
|
|
.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [WR Switch Debugging](Documents/WR-Switch-Debugging)
|
|
|
|
|
|
|
|
### [SFP data](Documents/SFP-data)
|
|
|
|
Technical data about SFPs.
|
|
|
|
Information linked from the wiki page [Which SFP transceiver and fibre
|
|
|
|
type to use for White
|
|
|
|
Rabbit](https://www.ohwr.org/project/white-rabbit/wikis/sfp)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### [White Rabbit: ultimate limits on phase noise and stability](Documents/White-Rabbit:-ultimate-limits-on-phase-noise-and-stability)
|
|
|
|
This article investigates the ultimate limits of
|
|
|
|
White Rabbit (WR), an high-accuracy time distribution system
|
|
|
|
based on FPGA.
|
|
|
|
|
|
|
|
This is the submitted version of a published paper.
|
|
|
|
https://ieeexplore.ieee.org/document/8400550
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
|
|
### [FAQ documents](Documents/FAQ-documents)
|
|
|
|
Documents that may be referred to from the FAQ
|
|
|
|
https://www.ohwr.org/project/white-rabbit/wikis/faqwr
|
|
|
|
|
|
|
|
|
|
|
|
|
