daemons/gptp/README.rst

   1 Introduction\r
   2 ------------\r
   3 This is an example Intel provided gptp daemon which can be used on Linux\r
   4 and Windows platforms. There are a number of other ptp daemons available\r
   5 for Linux which can be used to establish clock synchronization, although\r
   6 not all may export the required APIs needed for an AVB system.\r
   7 \r
   8 The daemon communicates with other user processes through a named pipe.\r
   9 The pipe name and message format is defined in ipcdef.hpp.\r
  10 \r
  11 The pipe name is "gptp-update".  A Windows example is in the project named_pipe_test.\r
  12 \r
  13 The message format is:\r
  14 \r
  15     Integer64  <master-local phase offset>\r
  16     Integer64  <local-system phase offset>\r
  17     Integer32  <master-local frequency offset>\r
  18     Integer32  <local-system frequency offset>\r
  19     UInteger64 <local time of last update>\r
  20 \r
  21 * Meaning of IPC provided values:\r
  22 \r
  23 - master  ~= local  - <master-local phase offset>\r
  24 - local   ~= system - <local-system phase offset>\r
  25 - Dmaster ~= Dlocal * (1-<master-local phase offset>/1e12)\r
  26         (where D denotes a delta rather than a specific value)\r
  27 - Dlocal ~= Dsystem * (1-<local-system freq offset>/1e12)\r
  28         (where D denotes a delta rather than a specific value)\r
  29 \r
  30 Known Limitations\r
  31 -----------------\r
  32 \r
  33 * There are problems with timestamp accuracy create problems using switches \r
  34 that impose limits on the peer rate offset\r
  35 \r
  36 * The current Windows driver version does not allow timestamping between the system \r
  37 clock (e.g. TCS) and the network device clock; systems offsets are not valid\r
  38 \r
  39 \r
  40 \r
  41 Linux Version\r
  42 -------------\r
  43 \r
  44 To build, execute the linux/build makefile.\r
  45 \r
  46 To execute, run ./daemon_cl <interface-name>, such as './daemon_cl eth0'\r
  47 \r
  48 Windows Version\r
  49 ---------------\r
  50 \r
  51 Build Dependencies\r
  52 \r
  53 * WinPCAP Developer's Pack is required for linking - downloadable from \r
  54 http://www.winpcap.org/devel.htm.\r
  55 \r
  56 * WinPCAP must also be installed on any machine where the daemon runs.\r
  57 \r
  58 To run from the command line:\r
  59 \r
  60 daemon_cl.exe xx-xx-xx-xx-xx-xx\r
  61 \r
  62         where xx-xx-xx-xx-xx-xx is the mac address of the local interface\r
  63 \r
  64 Other Available PTP Daemons\r
  65 ---------------------------\r
  66 There are a number of existing ptp daemon projects. Some of the other known \r
  67 ptp daemons are listed below. Intel has not tested Open AVB with the following \r
  68 ptp daemons.\r
  69 \r
  70 * Richard Cochran's ptp4l daemon - https://sourceforge.net/p/linuxptp/\r
  71 \r
  72   Note with thsi version to use gPTP specific settings, which differ \r
  73   slightly from IEEE 1588.\r
  74 \r
  75 * http://ptpd.sourceforge.net/\r
  76 \r
  77 * http://ptpd2.sourceforge.net/\r
  78 \r
  79 * http://code.google.com/p/ptpv2d\r
  80 \r
  81 * http://home.mit.bme.hu/~khazy/ptpd/\r
  82 \r
  83 \r