From 0f2c5b169a236cb4e8c66ca4a3dc1d14456f2a37 Mon Sep 17 00:00:00 2001 From: intel-ethernet Date: Fri, 16 Nov 2012 09:59:47 -0800 Subject: [PATCH] Fixup formatting, text --- daemons/gptp/README.rst | 159 +++++++++++++++++++++++------------------------- 1 file changed, 76 insertions(+), 83 deletions(-) diff --git a/daemons/gptp/README.rst b/daemons/gptp/README.rst index 832cb4c..9c6dc66 100644 --- a/daemons/gptp/README.rst +++ b/daemons/gptp/README.rst @@ -1,83 +1,76 @@ -Introduction ------------- -This is an example Intel provided gptp daemon which can be used on Linux -and Windows platforms. There are a number of other ptp daemons available -for Linux which can be used to establish clock synchronization, although -not all may export the required APIs needed for an AVB system. - -The daemon communicates with other user processes through a named pipe. -The pipe name and message format is defined in ipcdef.hpp. - -The pipe name is "gptp-update". A Windows example is in the project named_pipe_test. - -The message format is: - - Integer64 - Integer64 - Integer32 - Integer32 - UInteger64 - -* Meaning of IPC provided values: - -- master ~= local - -- local ~= system - -- Dmaster ~= Dlocal * (1-/1e12) - (where D denotes a delta rather than a specific value) -- Dlocal ~= Dsystem * (1-/1e12) - (where D denotes a delta rather than a specific value) - -Known Limitations ------------------ - -* There are problems with timestamp accuracy create problems using switches -that impose limits on the peer rate offset - -* The current Windows driver version does not allow timestamping between the system -clock (e.g. TCS) and the network device clock; systems offsets are not valid - - - -Linux Version -------------- - -To build, execute the linux/build makefile. - -To execute, run ./daemon_cl , such as './daemon_cl eth0' - -Windows Version ---------------- - -Build Dependencies - -* WinPCAP Developer's Pack is required for linking - downloadable from -http://www.winpcap.org/devel.htm. - -* WinPCAP must also be installed on any machine where the daemon runs. - -To run from the command line: - -daemon_cl.exe xx-xx-xx-xx-xx-xx - - where xx-xx-xx-xx-xx-xx is the mac address of the local interface - -Other Available PTP Daemons ---------------------------- -There are a number of existing ptp daemon projects. Some of the other known -ptp daemons are listed below. Intel has not tested Open AVB with the following -ptp daemons. - -* Richard Cochran's ptp4l daemon - https://sourceforge.net/p/linuxptp/ - - Note with thsi version to use gPTP specific settings, which differ - slightly from IEEE 1588. - -* http://ptpd.sourceforge.net/ - -* http://ptpd2.sourceforge.net/ - -* http://code.google.com/p/ptpv2d - -* http://home.mit.bme.hu/~khazy/ptpd/ - - +Introduction +------------ +This is an example Intel provided gptp daemon which can be used on Linux +and Windows platforms. There are a number of other ptp daemons available +for Linux which can be used to establish clock synchronization, although +not all may export the required APIs needed for an AVB system. + +The daemon communicates with other processes through a named pipe. +The pipe name and message format is defined in ipcdef.hpp. The pipe name +is "gptp-update". A Windows example is in the project named_pipe_test. + +The message format is: + + Integer64 + Integer64 + Integer32 + Integer32 + UInteger64 + +Meaning of IPC provided values +++++++++++++++++++++++++++++++ +- master ~= local - +- local ~= system - +- Dmaster ~= Dlocal * (1-/1e12) (where D denotes a delta rather than a specific value) +- Dlocal ~= Dsystem * (1-/1e12) (where D denotes a delta rather than a specific value) + +Known Limitations ++++++++++++++++++ + +* There are problems with timestamp accuracy create problems using switches that impose limits on the peer rate offset + +* The current Windows driver version does not allow timestamping between the system clock (e.g. TCS) and the network device clock; systems offsets are not valid + + +Linux Specific +++++++++++++++ + +To build, execute the linux/build makefile. + +To execute, run ./daemon_cl , such as './daemon_cl eth0' + +Windows Version ++++++++++++++++ + +Build Dependencies + +* WinPCAP Developer's Pack is required for linking - downloadable from http://www.winpcap.org/devel.htm. + +* WinPCAP must also be installed on any machine where the daemon runs. + +To run from the command line: + + daemon_cl.exe xx-xx-xx-xx-xx-xx + +where xx-xx-xx-xx-xx-xx is the mac address of the local interface + +Other Available PTP Daemons +--------------------------- +There are a number of existing ptp daemon projects. Some of the other known +ptp daemons are listed below. Intel has not tested Open AVB with the following +ptp daemons. + +* Richard Cochran's ptp4l daemon - https://sourceforge.net/p/linuxptp/ + + Note with thsi version to use gPTP specific settings, which differ + slightly from IEEE 1588. + +* http://ptpd.sourceforge.net/ + +* http://ptpd2.sourceforge.net/ + +* http://code.google.com/p/ptpv2d + +* http://home.mit.bme.hu/~khazy/ptpd/ + + -- 2.7.4