Blame hwstamp_ctl.8

Packit 9c3e7e
.TH HWSTAMP_CTL 8 "June 2014" "linuxptp"
Packit 9c3e7e
.SH NAME
Packit 9c3e7e
hwstamp_ctl \- set time stamping policy at the driver level
Packit 9c3e7e
Packit 9c3e7e
.SH SYNOPSIS
Packit 9c3e7e
.B hwstamp_ctl
Packit 9c3e7e
.BI \-i " interface"
Packit 9c3e7e
[
Packit 9c3e7e
.BI \-r " rx-filter"
Packit 9c3e7e
] [
Packit 9c3e7e
.BI \-t " tx-type"
Packit 9c3e7e
] [
Packit 9c3e7e
.B \-v
Packit 9c3e7e
]
Packit 9c3e7e
Packit 9c3e7e
.SH DESCRIPTION
Packit 9c3e7e
.B hwstamp_ctl
Packit 9c3e7e
is a program used to set and get the hardware time stamping policy at the network
Packit 9c3e7e
driver level with the
Packit 9c3e7e
.B SIOCSHWTSTAMP
Packit 9c3e7e
.BR ioctl (2).
Packit 9c3e7e
The
Packit 9c3e7e
.I tx-type
Packit 9c3e7e
and
Packit 9c3e7e
.I rx-filter
Packit 9c3e7e
values are hints to the driver what it is expected to do. If the requested
Packit 9c3e7e
fine-grained filtering for incoming packets is not supported, the driver may
Packit 9c3e7e
time stamp more than just the requested types of packets.
Packit 9c3e7e
Packit 9c3e7e
If neither
Packit 9c3e7e
.I tx-type
Packit 9c3e7e
nor
Packit 9c3e7e
.I rx-filter
Packit 9c3e7e
values are passed to the program, it will use the
Packit 9c3e7e
.B SIOCGHWTSTAMP
Packit 9c3e7e
.BR ioctl(2)
Packit 9c3e7e
to non-destructively read the current hardware time stamping policy.
Packit 9c3e7e
Packit 9c3e7e
This program is a debugging tool. The
Packit 9c3e7e
.BR ptp4l (8)
Packit 9c3e7e
program does not need this program to function, it will set the policy
Packit 9c3e7e
automatically as appropriate.
Packit 9c3e7e
Packit 9c3e7e
.SH OPTIONS
Packit 9c3e7e
.TP
Packit 9c3e7e
.BI \-i " interface"
Packit 9c3e7e
Specify the network interface of which the policy should be changed.
Packit 9c3e7e
.TP
Packit 9c3e7e
.BI \-r " rx-filter"
Packit 9c3e7e
Specify which types of incoming packets should be time stamped,
Packit 9c3e7e
.I rx-filter
Packit 9c3e7e
is an integer value.
Packit 9c3e7e
.TP
Packit 9c3e7e
.BI \-t " tx-type"
Packit 9c3e7e
Enable or disable hardware time stamping for outgoing packets,
Packit 9c3e7e
.I tx-type
Packit 9c3e7e
is an integer value.
Packit 9c3e7e
.TP
Packit 9c3e7e
.BI \-h
Packit 9c3e7e
Display a help message and list of possible values for
Packit 9c3e7e
.I rx-filter
Packit 9c3e7e
and
Packit 9c3e7e
.IR tx-type .
Packit 9c3e7e
.TP
Packit 9c3e7e
.B \-v
Packit 9c3e7e
Prints the software version and exits.
Packit 9c3e7e
Packit 9c3e7e
.SH SEE ALSO
Packit 9c3e7e
.BR ioctl (2),
Packit 9c3e7e
.BR ptp4l (8)