^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) What: /sys/class/ptp/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) This directory contains files and directories
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) providing a standardized interface to the ancillary
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) features of PTP hardware clocks.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) What: /sys/class/ptp/ptpN/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) This directory contains the attributes of the Nth PTP
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) hardware clock registered into the PTP class driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) subsystem.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) What: /sys/class/ptp/ptpN/clock_name
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) This file contains the name of the PTP hardware clock
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) as a human readable string. The purpose of this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) attribute is to provide the user with a "friendly
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) name" and to help distinguish PHY based devices from
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) MAC based ones. The string does not necessarily have
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) to be any kind of unique id.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) What: /sys/class/ptp/ptpN/max_adjustment
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) This file contains the PTP hardware clock's maximum
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) frequency adjustment value (a positive integer) in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) parts per billion.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) What: /sys/class/ptp/ptpN/n_alarms
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) This file contains the number of periodic or one shot
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) alarms offer by the PTP hardware clock.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) What: /sys/class/ptp/ptpN/n_external_timestamps
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) This file contains the number of external timestamp
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) channels offered by the PTP hardware clock.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) What: /sys/class/ptp/ptpN/n_periodic_outputs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) This file contains the number of programmable periodic
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) output channels offered by the PTP hardware clock.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) What: /sys/class/ptp/ptpN/n_pins
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) Date: March 2014
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) This file contains the number of programmable pins
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) offered by the PTP hardware clock.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) What: /sys/class/ptp/ptpN/pins
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) Date: March 2014
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) This directory contains one file for each programmable
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) pin offered by the PTP hardware clock. The file name
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) is the hardware dependent pin name. Reading from this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) file produces two numbers, the assigned function (see
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) the `PTP_PF_` enumeration values in linux/ptp_clock.h)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) and the channel number. The function and channel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) assignment may be changed by two writing numbers into
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) the file.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) What: /sys/class/ptp/ptpN/pps_available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) This file indicates whether the PTP hardware clock
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) supports a Pulse Per Second to the host CPU. Reading
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) "1" means that the PPS is supported, while "0" means
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) not supported.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) What: /sys/class/ptp/ptpN/extts_enable
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) This write-only file enables or disables external
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) timestamps. To enable external timestamps, write the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) channel index followed by a "1" into the file.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) To disable external timestamps, write the channel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) index followed by a "0" into the file.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) What: /sys/class/ptp/ptpN/fifo
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) This file provides timestamps on external events, in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) the form of three integers: channel index, seconds,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) and nanoseconds.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) What: /sys/class/ptp/ptpN/period
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) This write-only file enables or disables periodic
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) outputs. To enable a periodic output, write five
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) integers into the file: channel index, start time
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) seconds, start time nanoseconds, period seconds, and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) period nanoseconds. To disable a periodic output, set
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) all the seconds and nanoseconds values to zero.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) What: /sys/class/ptp/ptpN/pps_enable
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) Date: September 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) Contact: Richard Cochran <richardcochran@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) This write-only file enables or disables delivery of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) PPS events to the Linux PPS subsystem. To enable PPS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) events, write a "1" into the file. To disable events,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) write a "0" into the file.