Miroslav Lichvar
2012-09-27 15:49:25 UTC
---
hwstamp_ctl.8 | 56 +++++++++++++++++++++++++++
phc2sys.8 | 91 ++++++++++++++++++++++++++++++++++++++++++++
pmc.8 | 64 +++++++++++++++++++++++++++++++
ptp4l.8 | 116 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 327 insertions(+), 0 deletions(-)
create mode 100644 hwstamp_ctl.8
create mode 100644 phc2sys.8
create mode 100644 pmc.8
create mode 100644 ptp4l.8
diff --git a/hwstamp_ctl.8 b/hwstamp_ctl.8
new file mode 100644
index 0000000..3bd5716
--- /dev/null
+++ b/hwstamp_ctl.8
@@ -0,0 +1,56 @@
+.TH HWSTAMP_CTL 8 "September 2012" "linuxptp"
+.SH NAME
+hwstamp_ctl \- set time stamping policy at the driver level
+
+.SH SYNOPSIS
+.B hwstamp_ctl
+.BI \-i " interface"
+[
+.BI \-r " rx-filter"
+] [
+.BI \-t " tx-type"
+]
+
+.SH DESCRIPTION
+.B hwstamp_ctl
+is a program used to set the hardware time stamping policy at the network
+driver level with the
+.B SIOCSHWTSTAMP
+.BR ioctl (2).
+The
+.I tx-type
+and
+.I rx-filter
+values are hints to the driver what it is expected to do. If the requested
+fine-grained filtering for incoming packets is not supported, the driver may
+time stamp more than just the requested types of packets.
+
+This program is a debugging tool. The
+.BR ptp4l (8)
+program does not need this program to function, it will set the policy
+automatically as appropriate.
+
+.SH OPTIONS
+.TP
+.BI \-i " interface"
+Specify the network interface which should have its policy changed.
+.TP
+.BI \-r " rx-filter"
+Specify which types of incoming packets should be time stamped,
+.I rx-filter
+is an integer value.
+.TP
+.BI \-t " tx-type"
+Enable or disable hardware time stamping for outgoing packets,
+.I tx-type
+is an integer value.
+.TP
+.BI \-h
+Display a help message and list of possible values for
+.I rx-filter
+and
+.IR tx-type .
+
+.SH SEE ALSO
+.BR ioctl (2),
+.BR ptp4l (8)
diff --git a/phc2sys.8 b/phc2sys.8
new file mode 100644
index 0000000..bbde595
--- /dev/null
+++ b/phc2sys.8
@@ -0,0 +1,91 @@
+.TH PHC2SYS 8 "September 2012" "linuxptp"
+.SH NAME
+phc2sys \- synchronize two clocks
+
+.SH SYNOPSIS
+.B phc2sys
+{
+.BI \-d " pps-device"
+[
+.BI \-s " phc-device"
+|
+.BI \-i " interface"
+] |
+.BI \-s " phc-device"
+|
+.BI \-i " interface"
+} [
+.BI \-c " phc-device"
+] [
+.BI \-P " kp"
+] [
+.BI \-I " ki"
+] [
+.BI \-R " update-rate"
+] [
+.BI \-N " clock-readings"
+]
+
+.SH DESCRIPTION
+.B phc2sys
+is a program which synchronizes two clocks in the system. Typically it is used
+to synchronize the system clock to a PTP hardware clock (PHC), which itself is
+synchronized by the
+.BR ptp4l (8)
+program.
+
+Two synchronization modes are supported, one uses a pulse per second (PPS)
+signal provided by the source clock and the other mode reads time from the
+source clock directly. The PPS mode is usually preferred, because reading the
+PHC is slow and introduces an unknown error in the readings, but not all PHCs
+provide the PPS signal.
+
+.SH OPTIONS
+.TP
+.BI \-d " pps-device"
+Specify the PPS device of the master clock (e.g. /dev/pps0). With this option
+the PPS synchronization mode is used instead of the direct mode. As the PPS
+signal does not specify time and only marks start of a second, the slave clock
+should be already close to the correct time before
+.B phc2sys
+is started or the
+.B \-s
+option should be used too.
+.TP
+.BI \-s " phc-device"
+Specify the device of the master clock (e.g. /dev/ptp0). When this option is
+used together with the
+.B \-d
+option, the master clock is read only on start to fix an offset over 0.5
+seconds which cannot be fixed with PPS alone.
+.TP
+.BI \-i " interface"
+Similar to the
+.B \-s
+option, but specified by the interface which provides the master clock.
+.TP
+.BI \-c " phc-device"
+Specify the device of the slave clock (e.g. /dev/ptp1). The default slave clock
+is the system clock (CLOCK_REALTIME).
+.TP
+.BI \-P " kp"
+Specify the proportional constant of the PI controller. The default is 0.7.
+.TP
+.BI \-I " ki"
+Specify the intergral constant of the PI controller. The default is 0.3.
+.TP
+.BI \-R " update-rate"
+Specify the slave clock update rate when running in the direct synchronization
+mode. The default is 1 per second.
+.TP
+.BI \-N " phc-num"
+Specify the number of master clock readings per one slave clock update. Only
+the fastest reading is used to update the slave clock, this is useful to
+minimize the error caused by random delays in scheduling and bus utilization.
+The default is 5.
+.TP
+.BI \-h
+Display a help message.
+
+.SH SEE ALSO
+.BR ptp4l (8)
diff --git a/pmc.8 b/pmc.8
new file mode 100644
index 0000000..204be11
--- /dev/null
+++ b/pmc.8
@@ -0,0 +1,64 @@
+.TH PMC 8 "September 2012" "linuxptp"
+.SH NAME
+pmc \- PTP management client
+
+.SH SYNOPSIS
+.B pmc
+[
+.B \-2
+|
+.B \-4
+|
+.B \-6
+|
+.B \-u
+] [
+.BI \-b " boundary-hops"
+] [
+.BI \-d " domain-number"
+] [
+.BI \-i " interface"
+] [
+.BI \-t " transport-specific-field"
+]
+
+.SH DESCRIPTION
+.B pmc
+is a program which implements a PTP management client according to
+IEEE standard 1588.
+
+.SH OPTIONS
+.TP
+.B \-2
+Select the IEEE 802.3 network transport.
+.TP
+.B \-4
+Select the UDP IPv4 network transport. This is the default transport.
+.TP
+.B \-6
+Select the UDP IPv6 network transport.
+.TP
+.B \-u
+Select the Unix Domain Socket transport.
+.TP
+.BI \-b " boundary-hops"
+Specify the boundary hops value in sent messages. The default is 1.
+.TP
+.BI \-d " domain-number"
+Specify the domain number in sent messages. The default is 0.
+.TP
+.BI \-i " interface"
+Specify the network interface. The default /tmp/pmc for the Unix Domain Socket
+transport and eth0 for the other transports.
+.TP
+.BI \-t " transport-specific-field"
+Specify the transport specific field in sent messages as a hexadecimal number.
+The default is 0x0.
+.TP
+.BI \-h
+Display a help message.
+
+.SH COMMANDS
+
+.SH SEE ALSO
+.BR ptp4l (8)
diff --git a/ptp4l.8 b/ptp4l.8
new file mode 100644
index 0000000..0db1d05
--- /dev/null
+++ b/ptp4l.8
@@ -0,0 +1,116 @@
+.TH PTP4l 8 "September 2012" "linuxptp"
+.SH NAME
+ptp4l \- PTP Boundary/Ordinary Clock
+
+.SH SYNOPSIS
+.B ptp4l
+[
+.B \-A
+|
+.B \-E
+|
+.B \-P
+] [
+.B \-2
+|
+.B \-4
+|
+.B \-6
+] [
+.B \-H
+|
+.B \-S
+|
+.B \-L
+] [
+.BI \-f " config"
+] [
+.BI \-p " phc-device"
+] [
+.B \-s
+] [
+.BI \-l " print-level"
+] [
+.B \-q
+] [
+.B \-v
+]
+.BI \-i " interface"
+[
+.BI \-i " interface"
+]
+.I .\|.\|.
+
+.SH DESCRIPTION
+.B ptp4l
+is an implementation of the Precision Time Protocol (PTP) according to IEEE
+standard 1588 for Linux. It implements Boundary Clock (BC) and Ordinary Clock
+(OC).
+
+.SH OPTIONS
+.TP
+.B \-A
+Select the delay mechanism automatically. Start with E2E and switch to P2P when
+a peer delay request is received.
+.TP
+.B \-E
+Select the delay request-response (E2E) mechanism. This is the default
+mechanism.
+.TP
+.B \-P
+Select the peer delay (P2P) mechanism.
+.TP
+.B \-2
+Select the IEEE 802.3 network transport.
+.TP
+.B \-4
+Select the UDP IPv4 network transport. This is the default transport.
+.TP
+.B \-6
+Select the UDP IPv6 network transport.
+.TP
+.B \-H
+Select the hardware time stamping. All network interfaces specified by the
+.B \-i
+option must have a PTP hardware clock (PHC). This is the default time stamping.
+.TP
+.B \-S
+Select the software time stamping.
+.TP
+.B \-L
+Select the legacy hardware time stamping.
+.TP
+.BI \-f " config"
+Read configuration from the specified file. Its syntax is described in the
+.B CONFIGURATION FILE
+section of this man page.
+.TP
+.BI \-p " phc-device"
+With hardware timestamping, force which PHC device (e.g. /dev/ptp0) should be
+used.
+.TP
+.B \-s
+Enable the slaveOnly mode.
+.TP
+.BI \-l " print-level"
+Specify the maximum syslog level of messages which should be printed or sent to
+the system logger. The default is 6 (LOG_INFO).
+.TP
+.B \-q
+Don't send messages to the system logger.
+.TP
+.B \-v
+Print messages to the standard output.
+.TP
+.BI \-i " interface"
+Specify the network interface which should be used as a PTP port. It may be
+specified multiple times.
+.TP
+.BI \-h
+Display a help message.
+
+.SH CONFIGURATION FILE
+
+.SH SEE ALSO
+.BR pmc (8),
+.BR phc2sys (8)
hwstamp_ctl.8 | 56 +++++++++++++++++++++++++++
phc2sys.8 | 91 ++++++++++++++++++++++++++++++++++++++++++++
pmc.8 | 64 +++++++++++++++++++++++++++++++
ptp4l.8 | 116 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 327 insertions(+), 0 deletions(-)
create mode 100644 hwstamp_ctl.8
create mode 100644 phc2sys.8
create mode 100644 pmc.8
create mode 100644 ptp4l.8
diff --git a/hwstamp_ctl.8 b/hwstamp_ctl.8
new file mode 100644
index 0000000..3bd5716
--- /dev/null
+++ b/hwstamp_ctl.8
@@ -0,0 +1,56 @@
+.TH HWSTAMP_CTL 8 "September 2012" "linuxptp"
+.SH NAME
+hwstamp_ctl \- set time stamping policy at the driver level
+
+.SH SYNOPSIS
+.B hwstamp_ctl
+.BI \-i " interface"
+[
+.BI \-r " rx-filter"
+] [
+.BI \-t " tx-type"
+]
+
+.SH DESCRIPTION
+.B hwstamp_ctl
+is a program used to set the hardware time stamping policy at the network
+driver level with the
+.B SIOCSHWTSTAMP
+.BR ioctl (2).
+The
+.I tx-type
+and
+.I rx-filter
+values are hints to the driver what it is expected to do. If the requested
+fine-grained filtering for incoming packets is not supported, the driver may
+time stamp more than just the requested types of packets.
+
+This program is a debugging tool. The
+.BR ptp4l (8)
+program does not need this program to function, it will set the policy
+automatically as appropriate.
+
+.SH OPTIONS
+.TP
+.BI \-i " interface"
+Specify the network interface which should have its policy changed.
+.TP
+.BI \-r " rx-filter"
+Specify which types of incoming packets should be time stamped,
+.I rx-filter
+is an integer value.
+.TP
+.BI \-t " tx-type"
+Enable or disable hardware time stamping for outgoing packets,
+.I tx-type
+is an integer value.
+.TP
+.BI \-h
+Display a help message and list of possible values for
+.I rx-filter
+and
+.IR tx-type .
+
+.SH SEE ALSO
+.BR ioctl (2),
+.BR ptp4l (8)
diff --git a/phc2sys.8 b/phc2sys.8
new file mode 100644
index 0000000..bbde595
--- /dev/null
+++ b/phc2sys.8
@@ -0,0 +1,91 @@
+.TH PHC2SYS 8 "September 2012" "linuxptp"
+.SH NAME
+phc2sys \- synchronize two clocks
+
+.SH SYNOPSIS
+.B phc2sys
+{
+.BI \-d " pps-device"
+[
+.BI \-s " phc-device"
+|
+.BI \-i " interface"
+] |
+.BI \-s " phc-device"
+|
+.BI \-i " interface"
+} [
+.BI \-c " phc-device"
+] [
+.BI \-P " kp"
+] [
+.BI \-I " ki"
+] [
+.BI \-R " update-rate"
+] [
+.BI \-N " clock-readings"
+]
+
+.SH DESCRIPTION
+.B phc2sys
+is a program which synchronizes two clocks in the system. Typically it is used
+to synchronize the system clock to a PTP hardware clock (PHC), which itself is
+synchronized by the
+.BR ptp4l (8)
+program.
+
+Two synchronization modes are supported, one uses a pulse per second (PPS)
+signal provided by the source clock and the other mode reads time from the
+source clock directly. The PPS mode is usually preferred, because reading the
+PHC is slow and introduces an unknown error in the readings, but not all PHCs
+provide the PPS signal.
+
+.SH OPTIONS
+.TP
+.BI \-d " pps-device"
+Specify the PPS device of the master clock (e.g. /dev/pps0). With this option
+the PPS synchronization mode is used instead of the direct mode. As the PPS
+signal does not specify time and only marks start of a second, the slave clock
+should be already close to the correct time before
+.B phc2sys
+is started or the
+.B \-s
+option should be used too.
+.TP
+.BI \-s " phc-device"
+Specify the device of the master clock (e.g. /dev/ptp0). When this option is
+used together with the
+.B \-d
+option, the master clock is read only on start to fix an offset over 0.5
+seconds which cannot be fixed with PPS alone.
+.TP
+.BI \-i " interface"
+Similar to the
+.B \-s
+option, but specified by the interface which provides the master clock.
+.TP
+.BI \-c " phc-device"
+Specify the device of the slave clock (e.g. /dev/ptp1). The default slave clock
+is the system clock (CLOCK_REALTIME).
+.TP
+.BI \-P " kp"
+Specify the proportional constant of the PI controller. The default is 0.7.
+.TP
+.BI \-I " ki"
+Specify the intergral constant of the PI controller. The default is 0.3.
+.TP
+.BI \-R " update-rate"
+Specify the slave clock update rate when running in the direct synchronization
+mode. The default is 1 per second.
+.TP
+.BI \-N " phc-num"
+Specify the number of master clock readings per one slave clock update. Only
+the fastest reading is used to update the slave clock, this is useful to
+minimize the error caused by random delays in scheduling and bus utilization.
+The default is 5.
+.TP
+.BI \-h
+Display a help message.
+
+.SH SEE ALSO
+.BR ptp4l (8)
diff --git a/pmc.8 b/pmc.8
new file mode 100644
index 0000000..204be11
--- /dev/null
+++ b/pmc.8
@@ -0,0 +1,64 @@
+.TH PMC 8 "September 2012" "linuxptp"
+.SH NAME
+pmc \- PTP management client
+
+.SH SYNOPSIS
+.B pmc
+[
+.B \-2
+|
+.B \-4
+|
+.B \-6
+|
+.B \-u
+] [
+.BI \-b " boundary-hops"
+] [
+.BI \-d " domain-number"
+] [
+.BI \-i " interface"
+] [
+.BI \-t " transport-specific-field"
+]
+
+.SH DESCRIPTION
+.B pmc
+is a program which implements a PTP management client according to
+IEEE standard 1588.
+
+.SH OPTIONS
+.TP
+.B \-2
+Select the IEEE 802.3 network transport.
+.TP
+.B \-4
+Select the UDP IPv4 network transport. This is the default transport.
+.TP
+.B \-6
+Select the UDP IPv6 network transport.
+.TP
+.B \-u
+Select the Unix Domain Socket transport.
+.TP
+.BI \-b " boundary-hops"
+Specify the boundary hops value in sent messages. The default is 1.
+.TP
+.BI \-d " domain-number"
+Specify the domain number in sent messages. The default is 0.
+.TP
+.BI \-i " interface"
+Specify the network interface. The default /tmp/pmc for the Unix Domain Socket
+transport and eth0 for the other transports.
+.TP
+.BI \-t " transport-specific-field"
+Specify the transport specific field in sent messages as a hexadecimal number.
+The default is 0x0.
+.TP
+.BI \-h
+Display a help message.
+
+.SH COMMANDS
+
+.SH SEE ALSO
+.BR ptp4l (8)
diff --git a/ptp4l.8 b/ptp4l.8
new file mode 100644
index 0000000..0db1d05
--- /dev/null
+++ b/ptp4l.8
@@ -0,0 +1,116 @@
+.TH PTP4l 8 "September 2012" "linuxptp"
+.SH NAME
+ptp4l \- PTP Boundary/Ordinary Clock
+
+.SH SYNOPSIS
+.B ptp4l
+[
+.B \-A
+|
+.B \-E
+|
+.B \-P
+] [
+.B \-2
+|
+.B \-4
+|
+.B \-6
+] [
+.B \-H
+|
+.B \-S
+|
+.B \-L
+] [
+.BI \-f " config"
+] [
+.BI \-p " phc-device"
+] [
+.B \-s
+] [
+.BI \-l " print-level"
+] [
+.B \-q
+] [
+.B \-v
+]
+.BI \-i " interface"
+[
+.BI \-i " interface"
+]
+.I .\|.\|.
+
+.SH DESCRIPTION
+.B ptp4l
+is an implementation of the Precision Time Protocol (PTP) according to IEEE
+standard 1588 for Linux. It implements Boundary Clock (BC) and Ordinary Clock
+(OC).
+
+.SH OPTIONS
+.TP
+.B \-A
+Select the delay mechanism automatically. Start with E2E and switch to P2P when
+a peer delay request is received.
+.TP
+.B \-E
+Select the delay request-response (E2E) mechanism. This is the default
+mechanism.
+.TP
+.B \-P
+Select the peer delay (P2P) mechanism.
+.TP
+.B \-2
+Select the IEEE 802.3 network transport.
+.TP
+.B \-4
+Select the UDP IPv4 network transport. This is the default transport.
+.TP
+.B \-6
+Select the UDP IPv6 network transport.
+.TP
+.B \-H
+Select the hardware time stamping. All network interfaces specified by the
+.B \-i
+option must have a PTP hardware clock (PHC). This is the default time stamping.
+.TP
+.B \-S
+Select the software time stamping.
+.TP
+.B \-L
+Select the legacy hardware time stamping.
+.TP
+.BI \-f " config"
+Read configuration from the specified file. Its syntax is described in the
+.B CONFIGURATION FILE
+section of this man page.
+.TP
+.BI \-p " phc-device"
+With hardware timestamping, force which PHC device (e.g. /dev/ptp0) should be
+used.
+.TP
+.B \-s
+Enable the slaveOnly mode.
+.TP
+.BI \-l " print-level"
+Specify the maximum syslog level of messages which should be printed or sent to
+the system logger. The default is 6 (LOG_INFO).
+.TP
+.B \-q
+Don't send messages to the system logger.
+.TP
+.B \-v
+Print messages to the standard output.
+.TP
+.BI \-i " interface"
+Specify the network interface which should be used as a PTP port. It may be
+specified multiple times.
+.TP
+.BI \-h
+Display a help message.
+
+.SH CONFIGURATION FILE
+
+.SH SEE ALSO
+.BR pmc (8),
+.BR phc2sys (8)
--
1.7.7.6
1.7.7.6