294 lines · plain
1What: /sys/class/timecard/2Date: September 20213Contact: Jonathan Lemon <jonathan.lemon@gmail.com>4Description: This directory contains files and directories5 providing a standardized interface to the ancillary6 features of the OpenCompute timecard.7 8What: /sys/class/timecard/ocpN/9Date: September 202110Contact: Jonathan Lemon <jonathan.lemon@gmail.com>11Description: This directory contains the attributes of the Nth timecard12 registered.13 14What: /sys/class/timecard/ocpN/available_clock_sources15Date: September 202116Contact: Jonathan Lemon <jonathan.lemon@gmail.com>17Description: (RO) The list of available time sources that the PHC18 uses for clock adjustments.19 20 ==== =================================================21 NONE no adjustments22 PPS adjustments come from the PPS1 selector (default)23 TOD adjustments from the GNSS/TOD module24 IRIG adjustments from external IRIG-B signal25 DCF adjustments from external DCF signal26 ==== =================================================27 28What: /sys/class/timecard/ocpN/available_sma_inputs29Date: September 202130Contact: Jonathan Lemon <jonathan.lemon@gmail.com>31Description: (RO) Set of available destinations (sinks) for a SMA32 input signal.33 34 ===== ================================================35 10Mhz signal is used as the 10Mhz reference clock36 PPS1 signal is sent to the PPS1 selector37 PPS2 signal is sent to the PPS2 selector38 TS1 signal is sent to timestamper 139 TS2 signal is sent to timestamper 240 TS3 signal is sent to timestamper 341 TS4 signal is sent to timestamper 442 IRIG signal is sent to the IRIG-B module43 DCF signal is sent to the DCF module44 FREQ1 signal is sent to frequency counter 145 FREQ2 signal is sent to frequency counter 246 FREQ3 signal is sent to frequency counter 347 FREQ4 signal is sent to frequency counter 448 None signal input is disabled49 ===== ================================================50 51What: /sys/class/timecard/ocpN/available_sma_outputs52Date: May 202153Contact: Jonathan Lemon <jonathan.lemon@gmail.com>54Description: (RO) Set of available sources for a SMA output signal.55 56 ===== ================================================57 10Mhz output is from the 10Mhz reference clock58 PHC output PPS is from the PHC clock59 MAC output PPS is from the Miniature Atomic Clock60 GNSS1 output PPS is from the first GNSS module61 GNSS2 output PPS is from the second GNSS module62 IRIG output is from the PHC, in IRIG-B format63 DCF output is from the PHC, in DCF format64 GEN1 output is from frequency generator 165 GEN2 output is from frequency generator 266 GEN3 output is from frequency generator 367 GEN4 output is from frequency generator 468 GND output is GND69 VCC output is VCC70 ===== ================================================71 72What: /sys/class/timecard/ocpN/clock_source73Date: September 202174Contact: Jonathan Lemon <jonathan.lemon@gmail.com>75Description: (RW) Contains the current synchronization source used by76 the PHC. May be changed by writing one of the listed77 values from the available_clock_sources attribute set.78 79What: /sys/class/timecard/ocpN/clock_status_drift80Date: March 202281Contact: Jonathan Lemon <jonathan.lemon@gmail.com>82Description: (RO) Contains the current drift value used by the firmware83 for internal disciplining of the atomic clock.84 85What: /sys/class/timecard/ocpN/clock_status_offset86Date: March 202287Contact: Jonathan Lemon <jonathan.lemon@gmail.com>88Description: (RO) Contains the current offset value used by the firmware89 for internal disciplining of the atomic clock.90 91What: /sys/class/timecard/ocpN/freqX92Date: March 202293Contact: Jonathan Lemon <jonathan.lemon@gmail.com>94Description: (RO) Optional directory containing the sysfs nodes for95 frequency counter <X>.96 97What: /sys/class/timecard/ocpN/freqX/frequency98Date: March 202299Contact: Jonathan Lemon <jonathan.lemon@gmail.com>100Description: (RO) Contains the measured frequency over the specified101 measurement period.102 103What: /sys/class/timecard/ocpN/freqX/seconds104Date: March 2022105Contact: Jonathan Lemon <jonathan.lemon@gmail.com>106Description: (RW) Specifies the number of seconds from 0-255 that the107 frequency should be measured over. Write 0 to disable.108 109What: /sys/class/timecard/ocpN/genX110Date: March 2022111Contact: Jonathan Lemon <jonathan.lemon@gmail.com>112Description: (RO) Optional directory containing the sysfs nodes for113 frequency generator <X>.114 115What: /sys/class/timecard/ocpN/genX/duty116Date: March 2022117Contact: Jonathan Lemon <jonathan.lemon@gmail.com>118Description: (RO) Specifies the signal duty cycle as a percentage from 1-99.119 120What: /sys/class/timecard/ocpN/genX/period121Date: March 2022122Contact: Jonathan Lemon <jonathan.lemon@gmail.com>123Description: (RO) Specifies the signal period in nanoseconds.124 125What: /sys/class/timecard/ocpN/genX/phase126Date: March 2022127Contact: Jonathan Lemon <jonathan.lemon@gmail.com>128Description: (RO) Specifies the signal phase offset in nanoseconds.129 130What: /sys/class/timecard/ocpN/genX/polarity131Date: March 2022132Contact: Jonathan Lemon <jonathan.lemon@gmail.com>133Description: (RO) Specifies the signal polarity, either 1 or 0.134 135What: /sys/class/timecard/ocpN/genX/running136Date: March 2022137Contact: Jonathan Lemon <jonathan.lemon@gmail.com>138Description: (RO) Either 0 or 1, showing if the signal generator is running.139 140What: /sys/class/timecard/ocpN/genX/start141Date: March 2022142Contact: Jonathan Lemon <jonathan.lemon@gmail.com>143Description: (RO) Shows the time in <sec>.<nsec> that the signal generator144 started running.145 146What: /sys/class/timecard/ocpN/genX/signal147Date: March 2022148Contact: Jonathan Lemon <jonathan.lemon@gmail.com>149Description: (RW) Used to start the signal generator, and summarize150 the current status.151 152 The signal generator may be started by writing the signal153 period, followed by the optional signal values. If the154 optional values are not provided, they default to the current155 settings, which may be obtained from the other sysfs nodes.156 157 period [duty [phase [polarity]]]158 159 echo 500000000 > signal # 1/2 second period160 echo 1000000 40 100 > signal161 echo 0 > signal # turn off generator162 163 Period and phase are specified in nanoseconds. Duty cycle is164 a percentage from 1-99. Polarity is 1 or 0.165 166 Reading this node will return:167 168 period duty phase polarity start_time169 170What: /sys/class/timecard/ocpN/gnss_sync171Date: September 2021172Contact: Jonathan Lemon <jonathan.lemon@gmail.com>173Description: (RO) Indicates whether a valid GNSS signal is received,174 or when the signal was lost.175 176What: /sys/class/timecard/ocpN/i2c177Date: September 2021178Contact: Jonathan Lemon <jonathan.lemon@gmail.com>179Description: This optional attribute links to the associated i2c device.180 181What: /sys/class/timecard/ocpN/irig_b_mode182Date: September 2021183Contact: Jonathan Lemon <jonathan.lemon@gmail.com>184Description: (RW) An integer from 0-7 indicating the timecode format185 of the IRIG-B output signal: B00<n>186 187What: /sys/class/timecard/ocpN/pps188Date: September 2021189Contact: Jonathan Lemon <jonathan.lemon@gmail.com>190Description: This optional attribute links to the associated PPS device.191 192What: /sys/class/timecard/ocpN/ptp193Date: September 2021194Contact: Jonathan Lemon <jonathan.lemon@gmail.com>195Description: This attribute links to the associated PTP device.196 197What: /sys/class/timecard/ocpN/serialnum198Date: September 2021199Contact: Jonathan Lemon <jonathan.lemon@gmail.com>200Description: (RO) Provides the serial number of the timecard.201 202What: /sys/class/timecard/ocpN/sma1203What: /sys/class/timecard/ocpN/sma2204What: /sys/class/timecard/ocpN/sma3205What: /sys/class/timecard/ocpN/sma4206Date: September 2021207Contact: Jonathan Lemon <jonathan.lemon@gmail.com>208Description: (RW) These attributes specify the direction of the signal209 on the associated SMA connectors, and also the signal sink210 or source.211 212 The display format of the attribute is a space separated213 list of signals, prefixed by the input/output direction.214 215 The signal direction may be changed (if supported) by216 prefixing the signal list with either "in:" or "out:".217 If neither prefix is present, then the direction is unchanged.218 219 The output signal may be changed by writing one of the listed220 values from the available_sma_outputs attribute set.221 222 The input destinations may be changed by writing multiple223 values from the available_sma_inputs attribute set,224 separated by spaces. If there are duplicated input225 destinations between connectors, the lowest numbered SMA226 connector is given priority.227 228 Note that not all input combinations may make sense.229 230 The 10Mhz reference clock input is currently only valid231 on SMA1 and may not be combined with other destination sinks.232 233What: /sys/class/timecard/ocpN/tod_correction234Date: March 2022235Contact: Jonathan Lemon <jonathan.lemon@gmail.com>236Description: (RW) The incoming GNSS signal is in UTC time, and the NMEA237 format messages do not provide a TAI offset. This sets the238 correction value for the incoming time.239 240 If UBX_LS is enabled, this should be 0, and the offset is241 taken from the UBX-NAV-TIMELS message.242 243What: /sys/class/timecard/ocpN/ts_window_adjust244Date: September 2021245Contact: Jonathan Lemon <jonathan.lemon@gmail.com>246Description: (RW) When retrieving the PHC with the PTP SYS_OFFSET_EXTENDED247 ioctl, a system timestamp is made before and after the PHC248 time is retrieved. The midpoint between the two system249 timestamps is usually taken to be the SYS time associated250 with the PHC time. This estimate may be wrong, as it depends251 on PCI latencies, and when the PHC time was latched252 253 The attribute value reduces the end timestamp by the given254 number of nanoseconds, so the computed midpoint matches the255 retrieved PHC time.256 257 The initial value is set based on measured PCI latency and258 the estimated point where the FPGA latches the PHC time. This259 value may be changed by writing an unsigned integer.260 261What: /sys/class/timecard/ocpN/tty262Date: August 2024263Contact: Vadim Fedorenko <vadim.fedorenko@linux.dev>264Description: (RO) Directory containing the sysfs nodes for TTY attributes265 266What: /sys/class/timecard/ocpN/tty/ttyGNSS267What: /sys/class/timecard/ocpN/tty/ttyGNSS2268Date: August 2024269Contact: Jonathan Lemon <jonathan.lemon@gmail.com>270Description: (RO) These optional attributes contain names of the TTY serial271 ports associated with the GNSS devices.272 273What: /sys/class/timecard/ocpN/tty/ttyMAC274Date: August 2024275Contact: Jonathan Lemon <jonathan.lemon@gmail.com>276Description: (RO) This optional attribute contains name of the TTY serial277 port associated with the Miniature Atomic Clock.278 279What: /sys/class/timecard/ocpN/tty/ttyNMEA280Date: August 2024281Contact: Jonathan Lemon <jonathan.lemon@gmail.com>282Description: (RO) This optional attribute contains name of the TTY serial283 port which outputs the PHC time in NMEA ZDA format.284 285What: /sys/class/timecard/ocpN/utc_tai_offset286Date: September 2021287Contact: Jonathan Lemon <jonathan.lemon@gmail.com>288Description: (RW) The DCF and IRIG output signals are in UTC, while the289 TimeCard operates on TAI. This attribute allows setting the290 offset in seconds, which is added to the TAI timebase for291 these formats.292 293 The offset may be changed by writing an unsigned integer.294