Go to file
Miroslav Lichvar 647bce1c0c Clarify c1, c2, c3 in negative path delay log message.
Signed-off-by: Miroslav Lichvar <mlichvar@redhat.com>
2014-01-08 15:50:02 +01:00
.gitignore Add .gitignore. 2012-11-08 18:17:30 +01:00
CODING_STYLE.org Add a coding style document. 2013-02-06 14:42:12 +01:00
COPYING Add the license, a readme, and some header files. 2011-11-01 17:39:14 +01:00
README.org Simplify the text of the driver support matrix in the readme file. 2014-01-04 14:28:11 +01:00
bmc.c Become the grand master when all alone. 2013-07-14 21:48:23 +02:00
bmc.h Add the best master clock algorithm. 2011-11-04 19:20:23 +01:00
clock.c Clarify c1, c2, c3 in negative path delay log message. 2014-01-08 15:50:02 +01:00
clock.h Introduce the gmCapable flag for use with 802.1AS clocks. 2013-12-01 20:32:05 +01:00
clockadj.c Adjust tick length with system clock. 2014-01-04 14:36:35 +01:00
clockadj.h Adjust tick length with system clock. 2014-01-04 14:36:35 +01:00
clockcheck.c Add clock sanity check. 2013-10-27 08:24:01 +01:00
clockcheck.h Add clock sanity check. 2013-10-27 08:24:01 +01:00
config.c Add a configuration file option for the 802.1AS gmCapable flag. 2013-12-18 18:34:33 +01:00
config.h Add options to configure delay filter. 2013-10-30 21:54:07 +01:00
contain.h Add a modular clock servo interface with a PI controller. 2011-11-12 12:31:18 +01:00
ddt.h adds CLOCK_DESCRIPTION struct 2013-02-25 18:11:03 +01:00
default.cfg Add options to configure delay filter. 2013-10-30 21:54:07 +01:00
dm.h Expose the peer delay flavors in their own header file. 2012-04-05 17:48:59 +02:00
ds.h Introduce the gmCapable flag for use with 802.1AS clocks. 2013-12-01 20:32:05 +01:00
ether.h raw: accept VLAN tagged packets. 2012-08-21 16:22:18 +02:00
fault.c Add support for FT_BAD_PEER_NETWORK 2013-03-20 19:10:22 +01:00
fault.h Add support for FT_BAD_PEER_NETWORK 2013-03-20 19:10:22 +01:00
fd.h Add a timer implementing the sync receive timeout. 2013-08-26 18:30:54 +02:00
filter.c Add median filter. 2013-10-30 21:54:07 +01:00
filter.h Add median filter. 2013-10-30 21:54:07 +01:00
filter_private.h Add modular filter interface. 2013-10-30 21:43:37 +01:00
foreign.h Implement the PTP clock. 2011-11-12 18:59:13 +01:00
fsm.c Fix the port finite state machine. 2012-01-07 08:07:56 +01:00
fsm.h Hide the grandmaster port state. 2013-02-06 13:34:49 +01:00
gPTP.cfg Add a configuration file option for the 802.1AS gmCapable flag. 2013-12-18 18:34:33 +01:00
hwstamp_ctl.8 Remove trailing whitespaces. 2013-02-06 19:30:02 +01:00
hwstamp_ctl.c hwstamp_ctl: explain ERANGE error better 2013-03-24 16:12:20 +01:00
incdefs.sh Make the CFLAGS more robust. 2013-09-29 20:16:16 +02:00
makefile Merge Miroslav's random PTP timeout branch. 2013-12-19 19:20:58 +01:00
mave.c Add modular filter interface. 2013-10-30 21:43:37 +01:00
mave.h Add modular filter interface. 2013-10-30 21:43:37 +01:00
missing.h Add missing semicolon to enumeration. 2013-09-04 20:55:11 +02:00
mmedian.c Add median filter. 2013-10-30 21:54:07 +01:00
mmedian.h Add median filter. 2013-10-30 21:54:07 +01:00
msg.c msg: Add missing network byte order conversion. 2013-07-22 21:46:20 +02:00
msg.h Distinguish between ignored and malformed packets 2013-03-28 18:48:52 +01:00
pdt.h Add the license, a readme, and some header files. 2011-11-01 17:39:14 +01:00
phc.c Don't return bogus clock id 2013-06-06 17:00:25 +02:00
phc.h phc2sys: enable PPS output from PHC 2013-04-19 17:52:25 +02:00
phc2sys.8 Add clock sanity check. 2013-10-27 08:24:01 +01:00
phc2sys.c Adjust tick length with system clock. 2014-01-04 14:36:35 +01:00
pi.c Fix drift calculation in PI servo with large values. 2014-01-08 15:46:15 +01:00
pi.h Adjust constants of PI servo according to sync interval. 2013-07-14 21:37:53 +02:00
pmc.8 pmc: bring the man page more up to date. 2013-10-08 20:11:20 +02:00
pmc.c pmc: add a command line option to select the server's UDS address. 2013-10-08 20:11:20 +02:00
pmc_common.c pmc_common: introduce a variable for the target port identity. 2013-07-22 21:47:28 +02:00
pmc_common.h pmc_common: introduce a variable for the target port identity. 2013-07-22 21:47:28 +02:00
port.c Merge Miroslav's random PTP timeout branch. 2013-12-19 19:20:58 +01:00
port.h Add random delay to announce timeout. 2013-10-27 13:59:26 +01:00
print.c Print messages with level below LOG_NOTICE to stderr. 2013-02-06 19:30:01 +01:00
print.h Set program name for print(). 2013-02-03 19:08:34 +01:00
ptp4l.8 Add a configuration file option for the 802.1AS gmCapable flag. 2013-12-18 18:34:33 +01:00
ptp4l.c Add a configuration file option for the 802.1AS gmCapable flag. 2013-12-18 18:34:33 +01:00
raw.c Add an optional extra check on sync and follow up message ordering. 2013-08-29 11:22:25 +02:00
raw.h Move shared layer 2 global declarations into an appropriate header file. 2012-08-26 14:39:57 +02:00
servo.c Add reset function to servo. 2013-10-27 08:24:01 +01:00
servo.h Add reset function to servo. 2013-10-27 08:24:01 +01:00
servo_private.h Add reset function to servo. 2013-10-27 08:24:01 +01:00
sk.c sk: update error message for Tx timestamp polling 2013-10-30 21:20:13 +01:00
sk.h Add an optional extra check on sync and follow up message ordering. 2013-08-29 11:22:25 +02:00
stats.c Add summary statistics. 2013-02-09 10:09:25 +01:00
stats.h Add summary statistics. 2013-02-09 10:09:25 +01:00
sysoff.c phc2sys: Print clock reading delay. 2013-02-08 18:41:34 +01:00
sysoff.h phc2sys: Print clock reading delay. 2013-02-08 18:41:34 +01:00
tlv.c Be more careful when receiving clock description TLVs. 2013-07-28 17:43:04 +02:00
tlv.h Introduce a non-portable management TLV for grand masters. 2013-07-07 18:55:45 +02:00
tmv.h Introduce a helper function to convert from tmv to nanoseconds. 2012-09-12 17:30:37 +02:00
transport.c transport: adds interface for getting type, and physical/protocol address 2013-01-14 19:12:18 +01:00
transport.h Add an optional extra check on sync and follow up message ordering. 2013-08-29 11:22:25 +02:00
transport_private.h transport: adds interface for getting type, and physical/protocol address 2013-01-14 19:12:18 +01:00
udp.c Add an optional extra check on sync and follow up message ordering. 2013-08-29 11:22:25 +02:00
udp.h Add missing release method to the UDPv4 transport. 2012-03-17 17:30:21 +01:00
udp6.c Add an optional extra check on sync and follow up message ordering. 2013-08-29 11:22:25 +02:00
udp6.h udp6: add an option to set the multicast scope. 2012-11-25 20:30:14 +01:00
uds.c Convert the hard coded UDS server path into a variable. 2013-09-29 20:17:01 +02:00
uds.h Convert the hard coded UDS server path into a variable. 2013-09-29 20:17:01 +02:00
util.c pmc: add a command to select the target port. 2013-07-22 21:47:28 +02:00
util.h pmc: add a command to select the target port. 2013-07-22 21:47:28 +02:00
version.c Add utility functions to get the software version string. 2012-12-10 15:11:51 +01:00
version.h Add utility functions to get the software version string. 2012-12-10 15:11:51 +01:00
version.sh Version 1.3 2013-08-02 11:24:40 +02:00

README.org

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.

  git clone git://git.code.sf.net/p/linuxptp/code linuxptp

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

  git clone http://git.code.sf.net/p/linuxptp/code linuxptp

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.

  ethtool -T eth0

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
bfin_mac Analog Blackfin 3.8
cpts Texas Instruments am335x 3.8
e1000e Intel 82574, 82583 3.9
fec Freescale i.mx6 3.8
gianfar Freescale eTSEC PowerPC 3.0
igb Intel 82576, 82580 3.5
ixgbe Intel 82599 3.5
ptp_ixp46x Intel IXP465 3.0
ptp_phc Lapis EG20T PCH 3.5
sfc Solarflare SFC9000 3.7

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
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
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
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

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.

   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

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

Thanks

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

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

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