Update and move the ptp readme

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

diff --git a/daemons/gptp/windows/daemon_cl/ReadMe.txt b/daemons/gptp/windows/daemon_cl/ReadMe.txt
deleted file mode 100644 (file)
index ae30f53..0000000
--- a/daemons/gptp/windows/daemon_cl/ReadMe.txt
+++ /dev/null
@@ -1,56 +0,0 @@
-========================================================================\r
-(C) Copyright 2009-2012 Intel Corporation, All Rights Reserved\r
-Author: Christopher Hall <christopher.s.hall@intel.com>\r
-========================================================================\r
-\r
-========================================================================\r
-    CONSOLE APPLICATION : daemon_cl Project Overview\r
-========================================================================\r
-\r
-* Dependencies\r
-\r
-       WinPCAP Developer's Pack is required for linking (WpdPack_*.zip)\r
-       WinPCAP must also be installed on any machine where the daemon runs (WinPcap_*.exe installer for windows)\r
-\r
-To run from the command line:\r
-\r
-daemon_cl.exe xx-xx-xx-xx-xx-xx\r
-\r
-       where xx-xx-xx-xx-xx-xx is the mac address of the local interface\r
-\r
-* Terminology\r
-\r
-       master - 802.1AS Grandmaster Clock\r
-       local  - local network device clock (802.1AS timestamp source)\r
-       system - clock use elsewhere on a PC-like device, e.g. TSC or HPET timer\r
-\r
-* Interprocess Communication:\r
-\r
-The daemon communicates with other user processes through a named pipe.  The pipe name and message format is defined in ipcdef.hpp.\r
-\r
-The pipe name is "gptp-update".  An example is in the project named_pipe_test.\r
-\r
-The message format is:\r
-\r
-    Integer64  <master-local phase offset>\r
-    Integer64  <local-system phase offset>\r
-    Integer32  <master-local frequency offset>\r
-    Integer32  <local-system frequency offset>\r
-    UInteger64 <local time of last update>\r
-\r
-* Meaning of IPC provided values:\r
-\r
-       master  ~= local  - <master-local phase offset>\r
-       local   ~= system - <local-system phase offset>\r
-       Dmaster ~= Dlocal * (1-<master-local phase offset>/1e12)\r
-               (where D denotes a delta rather than a specific value)\r
-       Dlocal ~= Dsystem * (1-<local-system freq offset>/1e12)\r
-               (where D denotes a delta rather than a specific value)\r
-\r
-* Known Limitations:\r
-\r
-       * There are problems with timestamp accuracy create problems using switches that impose limits on the peer rate offset\r
-       * The current driver version does not allow timestamping between the system clock (e.g. TCS) and the network device clock;\r
-               systems offsets are not valid\r
-\r
-\r