daemons/gptp/windows/daemon_cl/ReadMe.txt

   1 ========================================================================\r
   2 (C) Copyright 2009-2012 Intel Corporation, All Rights Reserved\r
   3 Author: Christopher Hall <christopher.s.hall@intel.com>\r
   4 ========================================================================\r
   5 \r
   6 ========================================================================\r
   7     CONSOLE APPLICATION : daemon_cl Project Overview\r
   8 ========================================================================\r
   9 \r
  10 * Dependencies\r
  11 \r
  12         WinPCAP Developer's Pack is required for linking (WpdPack_*.zip)\r
  13         WinPCAP must also be installed on any machine where the daemon runs (WinPcap_*.exe installer for windows)\r
  14 \r
  15 To run from the command line:\r
  16 \r
  17 daemon_cl.exe xx-xx-xx-xx-xx-xx\r
  18 \r
  19         where xx-xx-xx-xx-xx-xx is the mac address of the local interface\r
  20 \r
  21 * Terminology\r
  22 \r
  23         master - 802.1AS Grandmaster Clock\r
  24         local  - local network device clock (802.1AS timestamp source)\r
  25         system - clock use elsewhere on a PC-like device, e.g. TSC or HPET timer\r
  26 \r
  27 * Interprocess Communication:\r
  28 \r
  29 The daemon communicates with other user processes through a named pipe.  The pipe name and message format is defined in ipcdef.hpp.\r
  30 \r
  31 The pipe name is "gptp-update".  An example is in the project named_pipe_test.\r
  32 \r
  33 The message format is:\r
  34 \r
  35     Integer64  <master-local phase offset>\r
  36     Integer64  <local-system phase offset>\r
  37     Integer32  <master-local frequency offset>\r
  38     Integer32  <local-system frequency offset>\r
  39     UInteger64 <local time of last update>\r
  40 \r
  41 * Meaning of IPC provided values:\r
  42 \r
  43         master  ~= local  - <master-local phase offset>\r
  44         local   ~= system - <local-system phase offset>\r
  45         Dmaster ~= Dlocal * (1-<master-local phase offset>/1e12)\r
  46                 (where D denotes a delta rather than a specific value)\r
  47         Dlocal ~= Dsystem * (1-<local-system freq offset>/1e12)\r
  48                 (where D denotes a delta rather than a specific value)\r
  49 \r
  50 * Known Limitations:\r
  51 \r
  52         * There are problems with timestamp accuracy create problems using switches that impose limits on the peer rate offset\r
  53         * The current driver version does not allow timestamping between the system clock (e.g. TCS) and the network device clock;\r
  54                 systems offsets are not valid\r
  55 \r
  56 \r