1 What: /sys/class/timecard/ 1 What: /sys/class/timecard/
2 Date: September 2021 2 Date: September 2021
3 Contact: Jonathan Lemon <jonathan.lemon@ 3 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
4 Description: This directory contains files 4 Description: This directory contains files and directories
5 providing a standardized inter 5 providing a standardized interface to the ancillary
6 features of the OpenCompute ti 6 features of the OpenCompute timecard.
7 7
8 What: /sys/class/timecard/ocpN/ 8 What: /sys/class/timecard/ocpN/
9 Date: September 2021 9 Date: September 2021
10 Contact: Jonathan Lemon <jonathan.lemon@ 10 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
11 Description: This directory contains the at 11 Description: This directory contains the attributes of the Nth timecard
12 registered. 12 registered.
13 13
14 What: /sys/class/timecard/ocpN/avail 14 What: /sys/class/timecard/ocpN/available_clock_sources
15 Date: September 2021 15 Date: September 2021
16 Contact: Jonathan Lemon <jonathan.lemon@ 16 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
17 Description: (RO) The list of available tim 17 Description: (RO) The list of available time sources that the PHC
18 uses for clock adjustments. 18 uses for clock adjustments.
19 19
20 ==== ======================== 20 ==== =================================================
21 NONE no adjustments 21 NONE no adjustments
22 PPS adjustments come from th 22 PPS adjustments come from the PPS1 selector (default)
23 TOD adjustments from the GNS 23 TOD adjustments from the GNSS/TOD module
24 IRIG adjustments from externa 24 IRIG adjustments from external IRIG-B signal
25 DCF adjustments from externa 25 DCF adjustments from external DCF signal
26 ==== ======================== 26 ==== =================================================
27 27
28 What: /sys/class/timecard/ocpN/avail 28 What: /sys/class/timecard/ocpN/available_sma_inputs
29 Date: September 2021 29 Date: September 2021
30 Contact: Jonathan Lemon <jonathan.lemon@ 30 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
31 Description: (RO) Set of available destinat 31 Description: (RO) Set of available destinations (sinks) for a SMA
32 input signal. 32 input signal.
33 33
34 ===== ======================= 34 ===== ================================================
35 10Mhz signal is used as the 1 35 10Mhz signal is used as the 10Mhz reference clock
36 PPS1 signal is sent to the P 36 PPS1 signal is sent to the PPS1 selector
37 PPS2 signal is sent to the P 37 PPS2 signal is sent to the PPS2 selector
38 TS1 signal is sent to times 38 TS1 signal is sent to timestamper 1
39 TS2 signal is sent to times 39 TS2 signal is sent to timestamper 2
40 TS3 signal is sent to times <<
41 TS4 signal is sent to times <<
42 IRIG signal is sent to the I 40 IRIG signal is sent to the IRIG-B module
43 DCF signal is sent to the D 41 DCF signal is sent to the DCF module
44 FREQ1 signal is sent to frequ <<
45 FREQ2 signal is sent to frequ <<
46 FREQ3 signal is sent to frequ <<
47 FREQ4 signal is sent to frequ <<
48 None signal input is disable <<
49 ===== ======================= 42 ===== ================================================
50 43
51 What: /sys/class/timecard/ocpN/avail 44 What: /sys/class/timecard/ocpN/available_sma_outputs
52 Date: May 2021 45 Date: May 2021
53 Contact: Jonathan Lemon <jonathan.lemon@ 46 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
54 Description: (RO) Set of available sources 47 Description: (RO) Set of available sources for a SMA output signal.
55 48
56 ===== ======================= 49 ===== ================================================
57 10Mhz output is from the 10Mh 50 10Mhz output is from the 10Mhz reference clock
58 PHC output PPS is from the 51 PHC output PPS is from the PHC clock
59 MAC output PPS is from the 52 MAC output PPS is from the Miniature Atomic Clock
60 GNSS1 output PPS is from the !! 53 GNSS output PPS is from the GNSS module
61 GNSS2 output PPS is from the 54 GNSS2 output PPS is from the second GNSS module
62 IRIG output is from the PHC, 55 IRIG output is from the PHC, in IRIG-B format
63 DCF output is from the PHC, 56 DCF output is from the PHC, in DCF format
64 GEN1 output is from frequenc <<
65 GEN2 output is from frequenc <<
66 GEN3 output is from frequenc <<
67 GEN4 output is from frequenc <<
68 GND output is GND <<
69 VCC output is VCC <<
70 ===== ======================= 57 ===== ================================================
71 58
72 What: /sys/class/timecard/ocpN/clock 59 What: /sys/class/timecard/ocpN/clock_source
73 Date: September 2021 60 Date: September 2021
74 Contact: Jonathan Lemon <jonathan.lemon@ 61 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
75 Description: (RW) Contains the current sync 62 Description: (RW) Contains the current synchronization source used by
76 the PHC. May be changed by wr 63 the PHC. May be changed by writing one of the listed
77 values from the available_cloc 64 values from the available_clock_sources attribute set.
78 65
79 What: /sys/class/timecard/ocpN/clock <<
80 Date: March 2022 <<
81 Contact: Jonathan Lemon <jonathan.lemon@ <<
82 Description: (RO) Contains the current drif <<
83 for internal disciplining of t <<
84 <<
85 What: /sys/class/timecard/ocpN/clock <<
86 Date: March 2022 <<
87 Contact: Jonathan Lemon <jonathan.lemon@ <<
88 Description: (RO) Contains the current offs <<
89 for internal disciplining of t <<
90 <<
91 What: /sys/class/timecard/ocpN/freqX <<
92 Date: March 2022 <<
93 Contact: Jonathan Lemon <jonathan.lemon@ <<
94 Description: (RO) Optional directory contai <<
95 frequency counter <X>. <<
96 <<
97 What: /sys/class/timecard/ocpN/freqX <<
98 Date: March 2022 <<
99 Contact: Jonathan Lemon <jonathan.lemon@ <<
100 Description: (RO) Contains the measured fre <<
101 measurement period. <<
102 <<
103 What: /sys/class/timecard/ocpN/freqX <<
104 Date: March 2022 <<
105 Contact: Jonathan Lemon <jonathan.lemon@ <<
106 Description: (RW) Specifies the number of s <<
107 frequency should be measured o <<
108 <<
109 What: /sys/class/timecard/ocpN/genX <<
110 Date: March 2022 <<
111 Contact: Jonathan Lemon <jonathan.lemon@ <<
112 Description: (RO) Optional directory contai <<
113 frequency generator <X>. <<
114 <<
115 What: /sys/class/timecard/ocpN/genX/ <<
116 Date: March 2022 <<
117 Contact: Jonathan Lemon <jonathan.lemon@ <<
118 Description: (RO) Specifies the signal duty <<
119 <<
120 What: /sys/class/timecard/ocpN/genX/ <<
121 Date: March 2022 <<
122 Contact: Jonathan Lemon <jonathan.lemon@ <<
123 Description: (RO) Specifies the signal peri <<
124 <<
125 What: /sys/class/timecard/ocpN/genX/ <<
126 Date: March 2022 <<
127 Contact: Jonathan Lemon <jonathan.lemon@ <<
128 Description: (RO) Specifies the signal phas <<
129 <<
130 What: /sys/class/timecard/ocpN/genX/ <<
131 Date: March 2022 <<
132 Contact: Jonathan Lemon <jonathan.lemon@ <<
133 Description: (RO) Specifies the signal pola <<
134 <<
135 What: /sys/class/timecard/ocpN/genX/ <<
136 Date: March 2022 <<
137 Contact: Jonathan Lemon <jonathan.lemon@ <<
138 Description: (RO) Either 0 or 1, showing if <<
139 <<
140 What: /sys/class/timecard/ocpN/genX/ <<
141 Date: March 2022 <<
142 Contact: Jonathan Lemon <jonathan.lemon@ <<
143 Description: (RO) Shows the time in <sec>.< <<
144 started running. <<
145 <<
146 What: /sys/class/timecard/ocpN/genX/ <<
147 Date: March 2022 <<
148 Contact: Jonathan Lemon <jonathan.lemon@ <<
149 Description: (RW) Used to start the signal <<
150 the current status. <<
151 <<
152 The signal generator may be st <<
153 period, followed by the option <<
154 optional values are not provid <<
155 settings, which may be obtaine <<
156 <<
157 period [duty [phase [polar <<
158 <<
159 echo 500000000 > signal <<
160 echo 1000000 40 100 > signal <<
161 echo 0 > signal <<
162 <<
163 Period and phase are specified <<
164 a percentage from 1-99. Polar <<
165 <<
166 Reading this node will return: <<
167 <<
168 period duty phase polarity <<
169 <<
170 What: /sys/class/timecard/ocpN/gnss_ 66 What: /sys/class/timecard/ocpN/gnss_sync
171 Date: September 2021 67 Date: September 2021
172 Contact: Jonathan Lemon <jonathan.lemon@ 68 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
173 Description: (RO) Indicates whether a valid 69 Description: (RO) Indicates whether a valid GNSS signal is received,
174 or when the signal was lost. 70 or when the signal was lost.
175 71
176 What: /sys/class/timecard/ocpN/i2c 72 What: /sys/class/timecard/ocpN/i2c
177 Date: September 2021 73 Date: September 2021
178 Contact: Jonathan Lemon <jonathan.lemon@ 74 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
179 Description: This optional attribute links 75 Description: This optional attribute links to the associated i2c device.
180 76
181 What: /sys/class/timecard/ocpN/irig_ 77 What: /sys/class/timecard/ocpN/irig_b_mode
182 Date: September 2021 78 Date: September 2021
183 Contact: Jonathan Lemon <jonathan.lemon@ 79 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
184 Description: (RW) An integer from 0-7 indic 80 Description: (RW) An integer from 0-7 indicating the timecode format
185 of the IRIG-B output signal: B 81 of the IRIG-B output signal: B00<n>
186 82
187 What: /sys/class/timecard/ocpN/pps 83 What: /sys/class/timecard/ocpN/pps
188 Date: September 2021 84 Date: September 2021
189 Contact: Jonathan Lemon <jonathan.lemon@ 85 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
190 Description: This optional attribute links 86 Description: This optional attribute links to the associated PPS device.
191 87
192 What: /sys/class/timecard/ocpN/ptp 88 What: /sys/class/timecard/ocpN/ptp
193 Date: September 2021 89 Date: September 2021
194 Contact: Jonathan Lemon <jonathan.lemon@ 90 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
195 Description: This attribute links to the as 91 Description: This attribute links to the associated PTP device.
196 92
197 What: /sys/class/timecard/ocpN/seria 93 What: /sys/class/timecard/ocpN/serialnum
198 Date: September 2021 94 Date: September 2021
199 Contact: Jonathan Lemon <jonathan.lemon@ 95 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
200 Description: (RO) Provides the serial numbe 96 Description: (RO) Provides the serial number of the timecard.
201 97
202 What: /sys/class/timecard/ocpN/sma1 98 What: /sys/class/timecard/ocpN/sma1
203 What: /sys/class/timecard/ocpN/sma2 99 What: /sys/class/timecard/ocpN/sma2
204 What: /sys/class/timecard/ocpN/sma3 100 What: /sys/class/timecard/ocpN/sma3
205 What: /sys/class/timecard/ocpN/sma4 101 What: /sys/class/timecard/ocpN/sma4
206 Date: September 2021 102 Date: September 2021
207 Contact: Jonathan Lemon <jonathan.lemon@ 103 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
208 Description: (RW) These attributes specify 104 Description: (RW) These attributes specify the direction of the signal
209 on the associated SMA connecto 105 on the associated SMA connectors, and also the signal sink
210 or source. 106 or source.
211 107
212 The display format of the attr 108 The display format of the attribute is a space separated
213 list of signals, prefixed by t 109 list of signals, prefixed by the input/output direction.
214 110
215 The signal direction may be ch 111 The signal direction may be changed (if supported) by
216 prefixing the signal list with 112 prefixing the signal list with either "in:" or "out:".
217 If neither prefix is present, 113 If neither prefix is present, then the direction is unchanged.
218 114
219 The output signal may be chang 115 The output signal may be changed by writing one of the listed
220 values from the available_sma_ 116 values from the available_sma_outputs attribute set.
221 117
222 The input destinations may be 118 The input destinations may be changed by writing multiple
223 values from the available_sma_ 119 values from the available_sma_inputs attribute set,
224 separated by spaces. If there 120 separated by spaces. If there are duplicated input
225 destinations between connector 121 destinations between connectors, the lowest numbered SMA
226 connector is given priority. 122 connector is given priority.
227 123
228 Note that not all input combin 124 Note that not all input combinations may make sense.
229 125
230 The 10Mhz reference clock inpu 126 The 10Mhz reference clock input is currently only valid
231 on SMA1 and may not be combine 127 on SMA1 and may not be combined with other destination sinks.
232 128
233 What: /sys/class/timecard/ocpN/tod_c <<
234 Date: March 2022 <<
235 Contact: Jonathan Lemon <jonathan.lemon@ <<
236 Description: (RW) The incoming GNSS signal <<
237 format messages do not provide <<
238 correction value for the incom <<
239 <<
240 If UBX_LS is enabled, this sho <<
241 taken from the UBX-NAV-TIMELS <<
242 <<
243 What: /sys/class/timecard/ocpN/ts_wi 129 What: /sys/class/timecard/ocpN/ts_window_adjust
244 Date: September 2021 130 Date: September 2021
245 Contact: Jonathan Lemon <jonathan.lemon@ 131 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
246 Description: (RW) When retrieving the PHC w 132 Description: (RW) When retrieving the PHC with the PTP SYS_OFFSET_EXTENDED
247 ioctl, a system timestamp is m 133 ioctl, a system timestamp is made before and after the PHC
248 time is retrieved. The midpoi 134 time is retrieved. The midpoint between the two system
249 timestamps is usually taken to 135 timestamps is usually taken to be the SYS time associated
250 with the PHC time. This estim 136 with the PHC time. This estimate may be wrong, as it depends
251 on PCI latencies, and when the 137 on PCI latencies, and when the PHC time was latched
252 138
253 The attribute value reduces th 139 The attribute value reduces the end timestamp by the given
254 number of nanoseconds, so the 140 number of nanoseconds, so the computed midpoint matches the
255 retrieved PHC time. 141 retrieved PHC time.
256 142
257 The initial value is set based 143 The initial value is set based on measured PCI latency and
258 the estimated point where the 144 the estimated point where the FPGA latches the PHC time. This
259 value may be changed by writin 145 value may be changed by writing an unsigned integer.
260 146
261 What: /sys/class/timecard/ocpN/tty !! 147 What: /sys/class/timecard/ocpN/ttyGNSS
262 Date: August 2024 !! 148 What: /sys/class/timecard/ocpN/ttyGNSS2
263 Contact: Vadim Fedorenko <vadim.fedorenk !! 149 Date: September 2021
264 Description: (RO) Directory containing the <<
265 <<
266 What: /sys/class/timecard/ocpN/tty/t <<
267 What: /sys/class/timecard/ocpN/tty/t <<
268 Date: August 2024 <<
269 Contact: Jonathan Lemon <jonathan.lemon@ 150 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
270 Description: (RO) These optional attributes !! 151 Description: These optional attributes link to the TTY serial ports
271 ports associated with the GNSS !! 152 associated with the GNSS devices.
272 153
273 What: /sys/class/timecard/ocpN/tty/t !! 154 What: /sys/class/timecard/ocpN/ttyMAC
274 Date: August 2024 !! 155 Date: September 2021
275 Contact: Jonathan Lemon <jonathan.lemon@ 156 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
276 Description: (RO) This optional attribute c !! 157 Description: This optional attribute links to the TTY serial port
277 port associated with the Minia !! 158 associated with the Miniature Atomic Clock.
278 159
279 What: /sys/class/timecard/ocpN/tty/t !! 160 What: /sys/class/timecard/ocpN/ttyNMEA
280 Date: August 2024 !! 161 Date: September 2021
281 Contact: Jonathan Lemon <jonathan.lemon@ 162 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
282 Description: (RO) This optional attribute c !! 163 Description: This optional attribute links to the TTY serial port
283 port which outputs the PHC tim !! 164 which outputs the PHC time in NMEA ZDA format.
284 165
285 What: /sys/class/timecard/ocpN/utc_t 166 What: /sys/class/timecard/ocpN/utc_tai_offset
286 Date: September 2021 167 Date: September 2021
287 Contact: Jonathan Lemon <jonathan.lemon@ 168 Contact: Jonathan Lemon <jonathan.lemon@gmail.com>
288 Description: (RW) The DCF and IRIG output s 169 Description: (RW) The DCF and IRIG output signals are in UTC, while the
289 TimeCard operates on TAI. Thi 170 TimeCard operates on TAI. This attribute allows setting the
290 offset in seconds, which is ad 171 offset in seconds, which is added to the TAI timebase for
291 these formats. 172 these formats.
292 173
293 The offset may be changed by w 174 The offset may be changed by writing an unsigned integer.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.