Menu

Tree [d37852] master /
 History

HTTPS access


File Date Author Commit
 configs 2018-10-03 Vedang Patel Vedang Patel [4d251d] Add example configuration for Automotive Profile.
 .gitignore 2018-08-21 Anders Selhammer Anders Selhammer [b2f2c9] snmp4lptp: Add snmp sub agent for linuxptp
 CODING_STYLE.org 2013-02-06 Richard Cochran Richard Cochran [89562f] Add a coding style document.
 COPYING 2011-11-01 Richard Cochran Richard Cochran [af380e] Add the license, a readme, and some header files.
 README.org 2017-11-25 Richard Cochran Richard Cochran [dacf9d] Add an acknowledgment in the readme for Meinberg.
 address.h 2017-08-09 Feras Daoud Feras Daoud [754643] ptp4l: Add IPoIB interface support for ptp4l
 as_capable.h 2018-10-03 Vedang Patel Vedang Patel [3f764a] port: Add configurable option to set asCapable.
 bmc.c 2018-10-03 Vedang Patel Vedang Patel [83be05] Add BMCA config option.
 bmc.h 2017-02-14 Richard Cochran Richard Cochran [0c30ab] telecom: Add a configuration option to use the ...
 clock.c 2018-11-29 Fabrice Fontaine Fabrice Fontaine [d37852] fix build with kernel headers >= 4.19
 clock.h 2018-09-14 Anders Selhammer Anders Selhammer [1173e7] Introduce the maxStepsRemoved attribute
 clockadj.c 2017-06-16 Brian Olson Brian Olson [7c6a98] added workaround for ticks being returned as ze...
 clockadj.h 2014-06-18 Miroslav Lichvar Miroslav Lichvar [fefd5b] Set TAI offset of system clock.
 clockcheck.c 2013-10-22 Miroslav Lichvar Miroslav Lichvar [ed379b] Add clock sanity check.
 clockcheck.h 2013-10-22 Miroslav Lichvar Miroslav Lichvar [ed379b] Add clock sanity check.
 config.c 2018-10-03 Vedang Patel Vedang Patel [d58b10] Add ignore_source_id config option.
 config.h 2018-03-09 Richard Cochran Richard Cochran [e22dc6] config: Introduce a unicast master table.
 contain.h 2014-06-02 Richard Cochran Richard Cochran [8a92b1] Fix a trivial spelling mistake in a comment.
 ddt.h 2013-02-24 Geoff Salmon Geoff Salmon [e91997] adds CLOCK_DESCRIPTION struct
 designated_fsm.c 2018-10-03 Vedang Patel Vedang Patel [83be05] Add BMCA config option.
 designated_fsm.h 2018-10-30 Cliff Spradlin via Linuxptp-devel Cliff Spradlin via Linuxptp-devel [e27cc2] Include missing headers.
 dm.h 2012-04-05 Richard Cochran Richard Cochran [a8a540] Expose the peer delay flavors in their own head...
 ds.h 2017-02-14 Richard Cochran Richard Cochran [a8d0eb] telecom: Introduce the local priority attribute...
 e2e_tc.c 2018-03-31 Richard Cochran Richard Cochran [dfa9e6] fd: Introduce a unicast service timer.
 ether.h 2017-08-09 Feras Daoud Feras Daoud [754643] ptp4l: Add IPoIB interface support for ptp4l
 fault.c 2014-11-01 Richard Cochran Richard Cochran [e706f4] port: allow running a boundary clock with multi...
 fault.h 2015-11-03 Richard Cochran Richard Cochran [62ce44] fault: protect header against multiple inclusion.
 fd.h 2018-03-31 Richard Cochran Richard Cochran [dfa9e6] fd: Introduce a unicast service timer.
 filter.c 2013-10-29 Miroslav Lichvar Miroslav Lichvar [ed9e0f] Add median filter.
 filter.h 2013-10-29 Miroslav Lichvar Miroslav Lichvar [ed9e0f] Add median filter.
 filter_private.h 2013-10-29 Miroslav Lichvar Miroslav Lichvar [2c9718] Add modular filter interface.
 foreign.h 2011-11-12 Richard Cochran Richard Cochran [49cd10] Implement the PTP clock.
 fsm.c 2016-10-27 Richard Cochran Richard Cochran [b738af] fsm: Make the transition out of INITIALIZING pa...
 fsm.h 2018-10-03 Vedang Patel Vedang Patel [83be05] Add BMCA config option.
 hash.c 2015-08-08 Richard Cochran Richard Cochran [8601aa] Introduce a simple hash table implementation.
 hash.h 2015-08-08 Richard Cochran Richard Cochran [8601aa] Introduce a simple hash table implementation.
 hwstamp_ctl.8 2014-06-04 Richard Cochran Richard Cochran [abd433] Bump the date on the hwstamp_ctl man page.
 hwstamp_ctl.c 2014-09-17 Miroslav Lichvar Miroslav Lichvar [9ddd2a] Fix copying of device name to ifreq.
 incdefs.sh 2018-02-15 Richard Cochran Richard Cochran [4842d2] Introduce peer to peer one step.
 linreg.c 2015-03-26 Miroslav Lichvar Miroslav Lichvar [5d6c34] linreg: use sample weight.
 linreg.h 2014-03-13 Miroslav Lichvar Miroslav Lichvar [a5890c] Add an adaptive servo based on linear regression.
 makefile 2018-10-03 Vedang Patel Vedang Patel [83be05] Add BMCA config option.
 mave.c 2018-03-01 Michael Brown Michael Brown [288810] tmv: Add missing uses of tmv_zero()
 mave.h 2013-10-29 Miroslav Lichvar Miroslav Lichvar [2c9718] Add modular filter interface.
 missing.h 2018-03-31 Richard Cochran Richard Cochran [635986] Introduce unicast service.
 mmedian.c 2018-03-01 Michael Brown Michael Brown [1b7ff8] tmv: Generalise tmv_eq() to tmv_cmp()
 mmedian.h 2013-10-29 Miroslav Lichvar Miroslav Lichvar [ed9e0f] Add median filter.
 msg.c 2018-07-10 Michael Walle Michael Walle [57c2b4] msg: inline net2host64() and host2net64()
 msg.h 2018-07-10 Michael Walle Michael Walle [57c2b4] msg: inline net2host64() and host2net64()
 mtab.h 2018-03-27 Richard Cochran Richard Cochran [0fffa6] Introduce the unicast client finite state machine.
 notification.h 2014-05-06 Jiri Benc Jiri Benc [c8c6f7] Event notification: port state
 nsm.c 2018-03-09 Richard Cochran Richard Cochran [40480f] util: Make a useful helper function more public.
 ntpshm.c 2015-08-14 Richard Cochran Richard Cochran [4c9c44] config: convert 'ntpshm_segment' to the new sch...
 ntpshm.h 2015-08-14 Richard Cochran Richard Cochran [4c9c44] config: convert 'ntpshm_segment' to the new sch...
 nullf.c 2018-10-30 Cliff Spradlin via Linuxptp-devel Cliff Spradlin via Linuxptp-devel [2c3a50] Use llabs() instead of fabs() for integers.
 nullf.h 2015-06-08 Richard Cochran Richard Cochran [fa7914] Add a servo that inhibits all frequency adjustment
 p2p_tc.c 2018-03-31 Richard Cochran Richard Cochran [dfa9e6] fd: Introduce a unicast service timer.
 pdt.h 2018-06-18 Anders Selhammer Anders Selhammer [f32553] pdt: Added check if already defined
 phc.c 2013-06-06 Ken ICHIKAWA Ken ICHIKAWA [67c925] Don't return bogus clock id
 phc.h 2013-04-19 Jiri Benc Jiri Benc [400427] phc2sys: enable PPS output from PHC
 phc2sys.8 2018-05-08 Jacob Keller Jacob Keller [cacf27] phc2sys: fix manpage documentation for -F
 phc2sys.c 2018-08-09 Miroslav Lichvar Miroslav Lichvar [d08bee] Fix -Wformat-overflow warnings.
 phc_ctl.8 2014-07-18 Jacob Keller Jacob Keller [bdb6a3] linuxptp: add phc_ctl program to help debug PHC...
 phc_ctl.c 2018-08-09 Miroslav Lichvar Miroslav Lichvar [d08bee] Fix -Wformat-overflow warnings.
 pi.c 2018-10-30 Cliff Spradlin via Linuxptp-devel Cliff Spradlin via Linuxptp-devel [2c3a50] Use llabs() instead of fabs() for integers.
 pi.h 2015-08-14 Richard Cochran Richard Cochran [177a71] config: convert 'pi_integral_norm_max' to the n...
 pmc.8 2018-03-21 Peter Schneider Peter Schneider [c4e587] pmc: Documentation for long opts / cfg file
 pmc.c 2018-07-10 Michael Walle Michael Walle [8f484e] msg: Drop msg->tlv_count.
 pmc_common.c 2018-07-19 Andriy Kohut Andriy Kohut [f977a6] pmc_common: Recycle message if allocation of tl...
 pmc_common.h 2018-06-18 Anders Selhammer Anders Selhammer [d85c59] pmc: Move new common funtionality into pmc_common
 port.c 2018-10-10 Anders Selhammer Anders Selhammer [8f2f9b] port: correction of port name used port_open
 port.h 2018-10-03 Vedang Patel Vedang Patel [83be05] Add BMCA config option.
 port_private.h 2018-10-03 Vedang Patel Vedang Patel [d58b10] Add ignore_source_id config option.
 port_signaling.c 2018-04-05 Richard Cochran Richard Cochran [b9b182] port: Hook into the unicast service logic.
 pqueue.c 2018-04-04 Richard Cochran Richard Cochran [a076fd] Introduce a priority queue implementation.
 pqueue.h 2018-04-04 Richard Cochran Richard Cochran [a076fd] Introduce a priority queue implementation.
 print.c 2017-01-17 Miroslav Lichvar Miroslav Lichvar [0f6c69] Add options to tag ptp4l and phc2sys log messages.
 print.h 2017-01-17 Miroslav Lichvar Miroslav Lichvar [0f6c69] Add options to tag ptp4l and phc2sys log messages.
 ptp4l.8 2018-10-03 Vedang Patel Vedang Patel [d58b10] Add ignore_source_id config option.
 ptp4l.c 2018-08-28 Erez Geva Erez Geva [399907] config: Add hardware time stamp filter setting ...
 raw.c 2018-03-17 Richard Cochran Richard Cochran [e160ba] transport: Introduce transmit time stamp deferral.
 raw.h 2015-08-21 Richard Cochran Richard Cochran [852c28] config: convert 'p2p_dst_mac', letting it be a ...
 rtnl.c 2018-04-13 Miroslav Lichvar Miroslav Lichvar [742f87] rtnl: remove dependency on config.h.
 rtnl.h 2018-04-13 Miroslav Lichvar Miroslav Lichvar [742f87] rtnl: remove dependency on config.h.
 servo.c 2017-04-04 Burkhard Ilsen Burkhard Ilsen [7e1cca] servo: NULL pointer check for servo constructors
 servo.h 2015-08-12 Richard Cochran Richard Cochran [e8a295] config: convert the 'max_frequency' option to t...
 servo_private.h 2018-10-30 Cliff Spradlin via Linuxptp-devel Cliff Spradlin via Linuxptp-devel [e27cc2] Include missing headers.
 sk.c 2018-11-29 Fabrice Fontaine Fabrice Fontaine [d37852] fix build with kernel headers >= 4.19
 sk.h 2018-10-24 Anders Selhammer Anders Selhammer [80b1d2] sk: Added address family as inargument in sk_se...
 snmp4lptp.8 2018-09-20 Ethel Nilsson Ethel Nilsson [2b0060] snmp4lptp: added snmp4lptp.8
 snmp4lptp.c 2018-08-21 Anders Selhammer Anders Selhammer [1d0832] snmp4lptp: Added function for data collection f...
 snmp4lptp_mib.h 2018-08-21 Anders Selhammer Anders Selhammer [1d0832] snmp4lptp: Added function for data collection f...
 snmpflg.sh 2018-08-21 Anders Selhammer Anders Selhammer [b2f2c9] snmp4lptp: Add snmp sub agent for linuxptp
 stats.c 2013-02-07 Miroslav Lichvar Miroslav Lichvar [3136e3] Add summary statistics.
 stats.h 2013-02-07 Miroslav Lichvar Miroslav Lichvar [3136e3] Add summary statistics.
 sysoff.c 2013-02-07 Miroslav Lichvar Miroslav Lichvar [42b305] phc2sys: Print clock reading delay.
 sysoff.h 2013-02-07 Miroslav Lichvar Miroslav Lichvar [42b305] phc2sys: Print clock reading delay.
 tc.c 2018-06-25 Rafaël Carré Rafaël Carré [bdaff2] transport_txts(): transport argument is unused
 tc.h 2015-11-02 Richard Cochran Richard Cochran [a13212] tc: Add the transparent clock implementation.
 telecom.c 2017-02-14 Richard Cochran Richard Cochran [f848a3] telecom: Add the data set comparison algorithm ...
 timemaster.8 2018-09-25 Miroslav Lichvar Miroslav Lichvar [78a720] timemaster: Allow ptp4l-specific sections in [p...
 timemaster.c 2018-11-29 Fabrice Fontaine Fabrice Fontaine [d37852] fix build with kernel headers >= 4.19
 tlv.c 2018-04-01 Richard Cochran Richard Cochran [1d4505] msg: Support unicast negotiation message formats.
 tlv.h 2018-04-01 Richard Cochran Richard Cochran [1d4505] msg: Support unicast negotiation message formats.
 tmv.h 2017-11-27 Richard Cochran Richard Cochran [7a2013] tmv: Add a method to convert to a struct Timest...
 transport.c 2018-06-25 Rafaël Carré Rafaël Carré [bdaff2] transport_txts(): transport argument is unused
 transport.h 2018-06-25 Rafaël Carré Rafaël Carré [bdaff2] transport_txts(): transport argument is unused
 transport_private.h 2018-03-17 Richard Cochran Richard Cochran [4247ee] transport: Use the proper enumerated event code.
 tsproc.c 2018-03-01 Michael Brown Michael Brown [ffc5b9] tmv: Add tmv_sign()
 tsproc.h 2015-03-26 Miroslav Lichvar Miroslav Lichvar [06fcfe] tsproc: add raw and weighting modes.
 udp.c 2018-10-24 Anders Selhammer Anders Selhammer [80b1d2] sk: Added address family as inargument in sk_se...
 udp.h 2012-03-17 Richard Cochran Richard Cochran [9d4d68] Add missing release method to the UDPv4 transport.
 udp6.c 2018-10-24 Anders Selhammer Anders Selhammer [80b1d2] sk: Added address family as inargument in sk_se...
 udp6.h 2015-08-15 Richard Cochran Richard Cochran [6fa42d] config: convert 'udp6_scope' to the new scheme.
 uds.c 2018-03-17 Richard Cochran Richard Cochran [4247ee] transport: Use the proper enumerated event code.
 uds.h 2015-08-21 Richard Cochran Richard Cochran [e27b03] config: convert 'uds_address' to the new scheme.
 unicast_client.c 2018-04-01 Richard Cochran Richard Cochran [faf0e0] Introduce unicast client logic.
 unicast_client.h 2018-04-01 Richard Cochran Richard Cochran [faf0e0] Introduce unicast client logic.
 unicast_fsm.c 2018-03-27 Richard Cochran Richard Cochran [0fffa6] Introduce the unicast client finite state machine.
 unicast_fsm.h 2018-03-27 Richard Cochran Richard Cochran [0fffa6] Introduce the unicast client finite state machine.
 unicast_service.c 2018-09-25 Miroslav Lichvar Miroslav Lichvar [241d8a] unicast: Process timeouts equal to current time.
 unicast_service.h 2018-03-31 Richard Cochran Richard Cochran [635986] Introduce unicast service.
 util.c 2018-10-23 Anders Selhammer Anders Selhammer [d88b4f] util: Added IPv6 support in help funtions addre...
 util.h 2018-09-14 Anders Selhammer Anders Selhammer [57b98c] Add possibility to set clockIdentity
 version.c 2012-12-09 Richard Cochran Richard Cochran [c31198] Add utility functions to get the software versi...
 version.h 2012-12-09 Richard Cochran Richard Cochran [c31198] Add utility functions to get the software versi...
 version.sh 2018-08-12 Richard Cochran Richard Cochran [059269] Version 2.0

Read Me

* Introduction

  This software is an implementation of the Precision Time Protocol
  (PTP) according to IEEE standard 1588 for Linux. The dual design
  goals are to provide a robust implementation of the standard and to
  use the most relevant and modern Application Programming Interfaces
  (API) offered by the Linux kernel. Supporting legacy APIs and other
  platforms is not a goal.

* License

  The software is copyrighted by the authors and is licensed under the
  GNU General Public License. See the file, COPYING, for details of
  the license terms.

* Features

  - Supports hardware and software time stamping via the Linux
    SO_TIMESTAMPING socket option.

  - Supports the Linux PTP Hardware Clock (PHC) subsystem by using the
    clock_gettime family of calls, including the new clock_adjtimex
    system call.

  - Implements Boundary Clock (BC) and Ordinary Clock (OC).

  - Transport over UDP/IPv4, UDP/IPv6, and raw Ethernet (Layer 2).

  - Supports IEEE 802.1AS-2011 in the role of end station.

  - Modular design allowing painless addition of new transports and
    clock servos.

* Getting the Code

  You can download the latest released version at Source Forge.

  http://sourceforge.net/projects/linuxptp/files/latest/download

  The source code is managed using the git version control system. To
  get your own copy of the project sources, use the following command.

#+BEGIN_EXAMPLE
  git clone git://git.code.sf.net/p/linuxptp/code linuxptp
#+END_EXAMPLE

  If the git protocol is blocked by your local area network, then you
  can use the alternative HTTP protocol instead.

#+BEGIN_EXAMPLE
  git clone http://git.code.sf.net/p/linuxptp/code linuxptp
#+END_EXAMPLE

* System Requirements

  In order to run this software, you need Linux kernel
  version 3.0 or newer, and the kernel header files must available at
  compile time.

  In addition, you will also need to have either:

  1. A supported Ethernet MAC device.

  2. A supported PHY device paired with a MAC that allows time
     stamping in the PHY (indicated by PHY=Y in the table below).

** Linux Kernel Support

   In order to support PTP, the operating system needs to provide two
   services: network packet time stamping and clock control. In 2009,
   Patrick Ohly added a new socket option called SO_TIMESTAMPING for
   packet time stamping, especially for PTP. This work appeared in
   Linux version 2.6.30.

   In July of 2011, the PTP Hardware Clock (PHC) subsystem was merged
   into Linux version 3.0. The PHC code provides a driver framework and
   the user space API for clock control.

** Ethtool Support

   Starting with version 3.5 of the Linux kernel, you can query the
   time stamping capabilities of a network interface using the
   ETHTOOL_GET_TS_INFO ioctl. Using ethtool version 3.4 or later, you
   can check your system's time stamping support as shown in the
   following example.

#+BEGIN_EXAMPLE
  ethtool -T eth0
#+END_EXAMPLE

   If the ethtool ioctl is available, then the ptp4l program will use
   it in order to discover the proper PHC device.

** Driver Support Matrix

   The following two tables list the drivers that support the PHC
   subsystem and the Linux kernel version when they first appeared.
   These drivers will create a PHC device for controlling the hardware
   clock.

*** Hardware Timestamping - PHY

    |---------+-------------------------------+---------|
    | Driver  | Hardware                      | Version |
    |---------+-------------------------------+---------|
    | dp83640 | National Semiconductor PHYTER |     3.0 |
    |---------+-------------------------------+---------|

*** Hardware Timestamping - MAC

    |------------+--------------------------+---------|
    | Driver     | Hardware                 | Version |
    |------------+--------------------------+---------|
    | amd-xgbe   | AMD 10GbE Ethernet Soc   |    3.17 |
    | bfin_mac   | Analog Blackfin          |     3.8 |
    | bnx2x      | Broadcom NetXtremeII 10G |    3.18 |
    | cpts       | Texas Instruments am335x |     3.8 |
    | e1000e     | Intel 82574, 82583       |     3.9 |
    | fm10k      | Intel FM10000            |    3.18 |
    | fec        | Freescale i.mx6          |     3.8 |
    | gianfar    | Freescale eTSEC PowerPC  |     3.0 |
    | i40e       | Intel XL710 Family       |    3.14 |
    | igb        | Intel 82576, 82580       |     3.5 |
    | ixgbe      | Intel 82599              |     3.5 |
    | mlx4       | Mellanox 40G PCI         |    3.14 |
    | ptp_ixp46x | Intel IXP465             |     3.0 |
    | ptp_phc    | Lapis EG20T PCH          |     3.5 |
    | sfc        | Solarflare SFC9000       |     3.7 |
    | stmmac     | STM Synopsys IP Core     |    3.10 |
    | tg3        | Broadcom Tigon3 PCI      |     3.8 |
    | tilegx     | Tilera GBE/XGBE          |    3.12 |
    |------------+--------------------------+---------|

*** Software Timestamping

    The table below shows the Linux drivers that support software time
    stamping. In addition, the 'PHY' column indicates whether the
    Ethernet MAC driver can support a PTP Hardware Clock in an
    external PHY. The letter 'Y' in this column means that if you
    design a mother board that combines such a MAC with a PTP capable
    PHY, then it will work with the Linux PHC subsystem.

    |--------------+--------------------------+---------+-----|
    | Driver       | Hardware                 | Version | PHY |
    |--------------+--------------------------+---------+-----|
    | 3c59x        | 3Com EtherLink PCI       |    3.14 | N   |
    | altera_tse   | Altera Triple-Speed MAC  |    3.15 | Y   |
    | bna          | Brocade 1010/1020 10Gb   |    3.14 | N   |
    | bnx2x        | Broadcom Everest         |     3.5 | N   |
    | davinci_emac | TI DaVinci, Sitara       |     3.1 | Y   |
    | dnet         | Dave Ethernet MAC        |     3.1 | Y   |
    | e100         | Intel PRO/100            |     3.5 | N   |
    | e1000        | Intel PRO/1000 PCI/PCI-X |     3.5 | N   |
    | e1000e       | Intel PRO/1000 PCIe      |     3.5 | N   |
    | emaclite     | Xilinx Ethernet Lite     |     3.1 | Y   |
    | ethoc        | OpenCores 10/100 MAC     |     3.1 | Y   |
    | fec          | Freescale Coldfire       |     3.1 | Y   |
    | fec_mpc52xx  | Freescale MPC5200        |     3.1 | Y   |
    | forcedeth    | NVIDIA nForce            |     3.5 | N   |
    | fs_enet      | Freescale MPC512x        |     3.1 | Y   |
    | genet        | Broadcom GENET           |    3.15 | Y   |
    | ixp4xx_eth   | Intel IXP4xx             |     3.0 | Y   |
    | lib8390      | Asix AX88796             |     3.1 | Y   |
    | lib8390      | Various 8390 based HW    |     3.1 | N   |
    | ll_temac     | Xilinx LL TEMAC          |     3.1 | Y   |
    | macb         | Atmel AT32, AT91         |     3.1 | Y   |
    | mv643xx_eth  | Marvell Discovery, Orion |     3.1 | Y   |
    | pxa168_eth   | Marvell pxa168           |     3.1 | Y   |
    | r6040        | RDC Ethernet MAC         |     3.1 | Y   |
    | r8169        | Realtek 8169/8168/8101   |     3.4 | N   |
    | samsun-sxgbe | Samsung SXGBE 10G        |    3.15 | Y   |
    | smsc911x     | SMSC LAN911x, LAN921x    |     3.1 | Y   |
    | smsc9420     | SMSC LAN9420 PCI         |     3.1 | Y   |
    | stmmac       | STM Synopsys IP Core     |     3.1 | Y   |
    | tg3          | Broadcom Tigon3 PCI      |     3.1 | Y   |
    | ucc_geth     | Freescale QE Gigabit     |     3.1 | Y   |
    | usbnet       | USB network devices      |     3.2 | Y/N |
    | xgene-enet   | APM X-Gene SoC           |    3.17 | Y   |
    |--------------+--------------------------+---------+-----|

* Installation

** Linux kernel

   There are many ways of getting a precompiled Linux kernel or
   compiling your own, so this section is only meant as an example. It
   is important to have the kernel headers available when compiling
   the Linux PTP stack.

#+BEGIN_EXAMPLE
   export ARCH=x86
   export CROSS_COMPILE=
   export KBUILD_OUTPUT=/home/richard/kernel/ptp_debian
   mkdir -p $KBUILD_OUTPUT
   cp /boot/config-2.6.38-bpo.2-686 $KBUILD_OUTPUT/.config
   make oldnoconfig
   make menuconfig
   time make -j4
   make headers_install
#+END_EXAMPLE

   Here is a table of kernel configuration options needed for PTP
   support. In addtion to these, you should enable the specific
   Ethernet MAC and PHY drivers for your hardware.

   |---------------------------------+-----------------------------|
   | Option                          | Description                 |
   |---------------------------------+-----------------------------|
   | CONFIG_PPS                      | Required                    |
   | CONFIG_NETWORK_PHY_TIMESTAMPING | Timestamping in PHY devices |
   | PTP_1588_CLOCK                  | PTP clock support           |
   |---------------------------------+-----------------------------|

** PTP stack

   1. Just type 'make'

   2. If you compiled your own kernel (and the headers are not
      installed into the system path), then you should set the
      KBUILD_OUTPUT environment variable as in the example, above.

   3. In order to install the programs and man pages into /usr/local,
      run the 'make install' target. You can change the installation
      directories by setttings the variables prefix, sbindir, mandir,
      and man8dir on the make command line.

* Getting Involved

  The software development is hosted at Source Forge.

  https://sourceforge.net/projects/linuxptp/

** Reporting Bugs

   Please report any bugs or other issues with the software to the
   linuxptp-users mailing list.

   https://lists.sourceforge.net/lists/listinfo/linuxptp-users

** Development

   If you would like to get involved in improving the software, please
   join the linuxptp-devel mailing list.

   https://lists.sourceforge.net/lists/listinfo/linuxptp-devel

*** Submitting Patches

   1. Before submitting patches, please make sure that you are starting
      your work on the *current HEAD* of the git repository.

   2. Please checkout the ~CODING_STYLE.org~ file for guidelines on how to
      properly format your code.

   3. Describe your changes. Each patch will be reviewed, and the reviewers
      need to understand why you did what you did.

   4. *Sign-Off* each commit, so the changes can be properly attributed to
      you and you explicitely give your agreement for distribution under
      linuxptp's license. Signing-off is as simple as:

      #+BEGIN_EXAMPLE
      git commit -s
      #+END_EXAMPLE

      or by adding the following line (replace your real name and email)
      to your patch:

      #+BEGIN_EXAMPLE
      Signed-off-by: Random J Developer <random@developer.example.org>
      #+END_EXAMPLE

   5. Finally, send your patches via email to the linuxptp-devel mailing
      list, where they will be reviewed, and eventually be included in the
      official code base.

      #+BEGIN_EXAMPLE
      git send-email --to linuxptp-devel@lists.sourceforge.net origin/master
      #+END_EXAMPLE

* Thanks

  Thanks to AudioScience Inc for sponsoring the 8021.AS support.

  - http://www.audioscience.com

  Thanks to Exablaze for donating an ExaNIC X10

  - http://exablaze.com/exanic-x10

  Thanks to Intel Corporation for donating four NICs, the 82574,
  82580, 82599, and the i210.

  - http://www.intel.com
  - http://e1000.sourceforge.net

  Thanks to Meinberg Funkuhren for donating a LANTIME M1000.

  - https://www.meinbergglobal.com

  For testing I use an OTMC 100 grandmaster clock donated by OMICRON Lab.

  - http://www.omicron-lab.com/ptp
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.