HWSTAMP_CTL(8)

✨ HWSTAMP_CTL ✨

okay so bestie, welcome to the hwstamp_ctl page β€” it lives in section 8 of the System Manager's Manual, which is the cool section where all the system-admin stuff hangs out πŸ’…


πŸŽ€ NAME πŸŽ€

hwstamp_ctl β€” literally just here to set the time stamping policy at the driver level. that's it. that's the job. πŸ¦‹


🌸 SYNOPSIS 🌸

hwstamp_ctl -i interface [ -r rx-filter ] [ -t tx-type ] [ -v ]

πŸ’– DESCRIPTION πŸ’–

so, hwstamp_ctl is the little program you use to set and get the hardware time stamping policy at the network driver level, and it does that with the SIOCSHWTSTAMP ioctl(2). iconic behaviour, no cap.

the tx-type and rx-filter values are basically hints to the driver telling it what it's supposed to be doing. and here's the tea: if the requested fine-grained filtering for incoming packets isn't supported, the driver may time stamp more than just the requested types of packets. so like… it might over-deliver. that's just how it is. πŸ™ˆ

if you don't pass <em>neither</em> tx-type nor rx-filter values to the program, it'll use the SIOCGHWTSTAMP ioctl(2) to non-destructively read the current hardware time stamping policy. reading, not wrecking. we love a gentle king. πŸ‘‘

heads up: this program is a debugging tool. the ptp4l(8) program does not need this program to function β€” it sets the policy automatically as appropriate. so don't come for ptp4l, it's doing fine on its own 🫢

✨ OPTIONS ✨

  • -i interface β€” specify the network interface of which the policy should be changed. this is the one you actually need, bestie, don't skip it πŸ’…
  • -r rx-filter β€” specify which types of incoming packets should be time stamped. rx-filter is an integer value. yes, a plain old integer. πŸ“
  • -t tx-type β€” enable or disable hardware time stamping for outgoing packets. tx-type is an integer value. also an integer. we stay consistent. ⭐
  • -h β€” display a help message and list of possible values for rx-filter and tx-type. run this one if you're lost, it literally lists the values for you 🌈
  • -v β€” prints the software version and exits. short and sweet, main character energy. ✨

πŸ‘‘ SEE ALSO πŸ‘‘

ioctl(2), ptp4l(8)


and that's the whole page, bestie!! this lil beauty comes from linuxptp, dated June 2014 β€” yes, she's been serving since 2014 and she's still booked and busy πŸ’– go forth and time stamp responsibly 🧚🌸