chao
/
linuxptp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
linuxptp/hwstamp_ctl.8

71 lines
1.5 KiB
Groff
Raw Normal View History

Bump the date on the hwstamp_ctl man page. Signed-off-by: Richard Cochran <richardcochran@gmail.com>
2014-06-04 21:17:22 +08:00
.TH HWSTAMP_CTL 8 "June 2014" "linuxptp"
Add man pages. Signed-off-by: Miroslav Lichvar <mlichvar@redhat.com>
2012-11-01 18:24:24 +08:00
.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"
Add command line options to print the software version. Signed-off-by: Richard Cochran <richardcochran@gmail.com>
2012-12-10 17:28:28 +08:00
] [
.B \-v
Add man pages. Signed-off-by: Miroslav Lichvar <mlichvar@redhat.com>
2012-11-01 18:24:24 +08:00
]
.SH DESCRIPTION
.B hwstamp_ctl
hwtstamp_ctl: use SIOCGHWTSTAMP ioctl before destructively setting policy This patch modifies the hwtstamp_ctl program, so that it will (attempt to) use the SIOCGHWTSTAMP ioctl to non-destructively read the current hardware timestamping policy, prior to setting it with SIOCSHWTSTAMP. This change has 3 primary advantages: 1) It allows reading the current settings of the device, which was previously not possible since SIOCSHWTSTAMP is destructive. 2) The default behavior without rx-filter or tx-type selected on the command line is no longer destructive, since it does not attempt to set the values to 0. The user must explicitly request to disable the settings, by using the provided options. 3) It allows only modifying tx-type or rx-filter separately, without destroying the other setting. This patch supersedes a previous submission which added a -g flag. This new method of getting first is more advantageous and doesn't require adding an additional option flag. - v4 * only display results if command succeeds, as the contents are otherwise expected to be identical to what we passed in. Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
2014-06-04 05:03:11 +08:00
is a program used to set and get the hardware time stamping policy at the network
Add man pages. Signed-off-by: Miroslav Lichvar <mlichvar@redhat.com>
2012-11-01 18:24:24 +08:00
driver level with the
.B SIOCSHWTSTAMP
.BR ioctl (2).
Remove trailing whitespaces. Signed-off-by: Miroslav Lichvar <mlichvar@redhat.com>
2013-02-06 00:36:12 +08:00
The
Add man pages. Signed-off-by: Miroslav Lichvar <mlichvar@redhat.com>
2012-11-01 18:24:24 +08:00
.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.
hwtstamp_ctl: use SIOCGHWTSTAMP ioctl before destructively setting policy This patch modifies the hwtstamp_ctl program, so that it will (attempt to) use the SIOCGHWTSTAMP ioctl to non-destructively read the current hardware timestamping policy, prior to setting it with SIOCSHWTSTAMP. This change has 3 primary advantages: 1) It allows reading the current settings of the device, which was previously not possible since SIOCSHWTSTAMP is destructive. 2) The default behavior without rx-filter or tx-type selected on the command line is no longer destructive, since it does not attempt to set the values to 0. The user must explicitly request to disable the settings, by using the provided options. 3) It allows only modifying tx-type or rx-filter separately, without destroying the other setting. This patch supersedes a previous submission which added a -g flag. This new method of getting first is more advantageous and doesn't require adding an additional option flag. - v4 * only display results if command succeeds, as the contents are otherwise expected to be identical to what we passed in. Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
2014-06-04 05:03:11 +08:00
If neither
.I tx-type
nor
.I rx-filter
values are passed to the program, it will use the
.B SIOCGHWTSTAMP
.BR ioctl(2)
to non-destructively read the current hardware time stamping policy.
Add man pages. Signed-off-by: Miroslav Lichvar <mlichvar@redhat.com>
2012-11-01 18:24:24 +08:00
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 of which the policy should be 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 .
Add command line options to print the software version. Signed-off-by: Richard Cochran <richardcochran@gmail.com>
2012-12-10 17:28:28 +08:00
.TP
.B \-v
Prints the software version and exits.
Add man pages. Signed-off-by: Miroslav Lichvar <mlichvar@redhat.com>
2012-11-01 18:24:24 +08:00
.SH SEE ALSO
.BR ioctl (2),
.BR ptp4l (8)