?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Linux 4.1.18
[linux/fpc-iii.git] / Documentation / ptp / testptp.c
blob2bc8abc57fa04c1a4e47bb2d2b8626f8209b24a9
1 /*
2 * PTP 1588 clock support - User space test program
3 *
4 * Copyright (C) 2010 OMICRON electronics GmbH
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20 #define _GNU_SOURCE
21 #include <errno.h>
22 #include <fcntl.h>
23 #include <inttypes.h>
24 #include <math.h>
25 #include <signal.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <sys/ioctl.h>
30 #include <sys/mman.h>
31 #include <sys/stat.h>
32 #include <sys/time.h>
33 #include <sys/timex.h>
34 #include <sys/types.h>
35 #include <time.h>
36 #include <unistd.h>
37
38 #include <linux/ptp_clock.h>
39
40 #define DEVICE "/dev/ptp0"
41
42 #ifndef ADJ_SETOFFSET
43 #define ADJ_SETOFFSET 0x0100
44 #endif
45
46 #ifndef CLOCK_INVALID
47 #define CLOCK_INVALID -1
48 #endif
49
50 /* clock_adjtime is not available in GLIBC < 2.14 */
51 #if !__GLIBC_PREREQ(2, 14)
52 #include <sys/syscall.h>
53 static int clock_adjtime(clockid_t id, struct timex *tx)
54 {
55 return syscall(__NR_clock_adjtime, id, tx);
56 }
57 #endif
58
59 static clockid_t get_clockid(int fd)
60 {
61 #define CLOCKFD 3
62 #define FD_TO_CLOCKID(fd) ((~(clockid_t) (fd) << 3) | CLOCKFD)
63
64 return FD_TO_CLOCKID(fd);
65 }
66
67 static void handle_alarm(int s)
68 {
69 printf("received signal %d\n", s);
70 }
71
72 static int install_handler(int signum, void (*handler)(int))
73 {
74 struct sigaction action;
75 sigset_t mask;
76
77 /* Unblock the signal. */
78 sigemptyset(&mask);
79 sigaddset(&mask, signum);
80 sigprocmask(SIG_UNBLOCK, &mask, NULL);
81
82 /* Install the signal handler. */
83 action.sa_handler = handler;
84 action.sa_flags = 0;
85 sigemptyset(&action.sa_mask);
86 sigaction(signum, &action, NULL);
87
88 return 0;
89 }
90
91 static long ppb_to_scaled_ppm(int ppb)
92 {
93 /*
94 * The 'freq' field in the 'struct timex' is in parts per
95 * million, but with a 16 bit binary fractional field.
96 * Instead of calculating either one of
97 *
98 * scaled_ppm = (ppb / 1000) << 16 [1]
99 * scaled_ppm = (ppb << 16) / 1000 [2]
100 *
101 * we simply use double precision math, in order to avoid the
102 * truncation in [1] and the possible overflow in [2].
103 */
104 return (long) (ppb * 65.536);
105 }
106
107 static int64_t pctns(struct ptp_clock_time *t)
108 {
109 return t->sec * 1000000000LL + t->nsec;
110 }
111
112 static void usage(char *progname)
113 {
114 fprintf(stderr,
115 "usage: %s [options]\n"
116 " -a val request a one-shot alarm after 'val' seconds\n"
117 " -A val request a periodic alarm every 'val' seconds\n"
118 " -c query the ptp clock's capabilities\n"
119 " -d name device to open\n"
120 " -e val read 'val' external time stamp events\n"
121 " -f val adjust the ptp clock frequency by 'val' ppb\n"
122 " -g get the ptp clock time\n"
123 " -h prints this message\n"
124 " -i val index for event/trigger\n"
125 " -k val measure the time offset between system and phc clock\n"
126 " for 'val' times (Maximum 25)\n"
127 " -l list the current pin configuration\n"
128 " -L pin,val configure pin index 'pin' with function 'val'\n"
129 " the channel index is taken from the '-i' option\n"
130 " 'val' specifies the auxiliary function:\n"
131 " 0 - none\n"
132 " 1 - external time stamp\n"
133 " 2 - periodic output\n"
134 " -p val enable output with a period of 'val' nanoseconds\n"
135 " -P val enable or disable (val=1|0) the system clock PPS\n"
136 " -s set the ptp clock time from the system time\n"
137 " -S set the system time from the ptp clock time\n"
138 " -t val shift the ptp clock time by 'val' seconds\n"
139 " -T val set the ptp clock time to 'val' seconds\n",
140 progname);
141 }
142
143 int main(int argc, char *argv[])
144 {
145 struct ptp_clock_caps caps;
146 struct ptp_extts_event event;
147 struct ptp_extts_request extts_request;
148 struct ptp_perout_request perout_request;
149 struct ptp_pin_desc desc;
150 struct timespec ts;
151 struct timex tx;
152
153 static timer_t timerid;
154 struct itimerspec timeout;
155 struct sigevent sigevent;
156
157 struct ptp_clock_time *pct;
158 struct ptp_sys_offset *sysoff;
159
160
161 char *progname;
162 int i, c, cnt, fd;
163
164 char *device = DEVICE;
165 clockid_t clkid;
166 int adjfreq = 0x7fffffff;
167 int adjtime = 0;
168 int capabilities = 0;
169 int extts = 0;
170 int gettime = 0;
171 int index = 0;
172 int list_pins = 0;
173 int oneshot = 0;
174 int pct_offset = 0;
175 int n_samples = 0;
176 int periodic = 0;
177 int perout = -1;
178 int pin_index = -1, pin_func;
179 int pps = -1;
180 int seconds = 0;
181 int settime = 0;
182
183 int64_t t1, t2, tp;
184 int64_t interval, offset;
185
186 progname = strrchr(argv[0], '/');
187 progname = progname ? 1+progname : argv[0];
188 while (EOF != (c = getopt(argc, argv, "a:A:cd:e:f:ghi:k:lL:p:P:sSt:T:v"))) {
189 switch (c) {
190 case 'a':
191 oneshot = atoi(optarg);
192 break;
193 case 'A':
194 periodic = atoi(optarg);
195 break;
196 case 'c':
197 capabilities = 1;
198 break;
199 case 'd':
200 device = optarg;
201 break;
202 case 'e':
203 extts = atoi(optarg);
204 break;
205 case 'f':
206 adjfreq = atoi(optarg);
207 break;
208 case 'g':
209 gettime = 1;
210 break;
211 case 'i':
212 index = atoi(optarg);
213 break;
214 case 'k':
215 pct_offset = 1;
216 n_samples = atoi(optarg);
217 break;
218 case 'l':
219 list_pins = 1;
220 break;
221 case 'L':
222 cnt = sscanf(optarg, "%d,%d", &pin_index, &pin_func);
223 if (cnt != 2) {
224 usage(progname);
225 return -1;
226 }
227 break;
228 case 'p':
229 perout = atoi(optarg);
230 break;
231 case 'P':
232 pps = atoi(optarg);
233 break;
234 case 's':
235 settime = 1;
236 break;
237 case 'S':
238 settime = 2;
239 break;
240 case 't':
241 adjtime = atoi(optarg);
242 break;
243 case 'T':
244 settime = 3;
245 seconds = atoi(optarg);
246 break;
247 case 'h':
248 usage(progname);
249 return 0;
250 case '?':
251 default:
252 usage(progname);
253 return -1;
254 }
255 }
256
257 fd = open(device, O_RDWR);
258 if (fd < 0) {
259 fprintf(stderr, "opening %s: %s\n", device, strerror(errno));
260 return -1;
261 }
262
263 clkid = get_clockid(fd);
264 if (CLOCK_INVALID == clkid) {
265 fprintf(stderr, "failed to read clock id\n");
266 return -1;
267 }
268
269 if (capabilities) {
270 if (ioctl(fd, PTP_CLOCK_GETCAPS, &caps)) {
271 perror("PTP_CLOCK_GETCAPS");
272 } else {
273 printf("capabilities:\n"
274 " %d maximum frequency adjustment (ppb)\n"
275 " %d programmable alarms\n"
276 " %d external time stamp channels\n"
277 " %d programmable periodic signals\n"
278 " %d pulse per second\n"
279 " %d programmable pins\n",
280 caps.max_adj,
281 caps.n_alarm,
282 caps.n_ext_ts,
283 caps.n_per_out,
284 caps.pps,
285 caps.n_pins);
286 }
287 }
288
289 if (0x7fffffff != adjfreq) {
290 memset(&tx, 0, sizeof(tx));
291 tx.modes = ADJ_FREQUENCY;
292 tx.freq = ppb_to_scaled_ppm(adjfreq);
293 if (clock_adjtime(clkid, &tx)) {
294 perror("clock_adjtime");
295 } else {
296 puts("frequency adjustment okay");
297 }
298 }
299
300 if (adjtime) {
301 memset(&tx, 0, sizeof(tx));
302 tx.modes = ADJ_SETOFFSET;
303 tx.time.tv_sec = adjtime;
304 tx.time.tv_usec = 0;
305 if (clock_adjtime(clkid, &tx) < 0) {
306 perror("clock_adjtime");
307 } else {
308 puts("time shift okay");
309 }
310 }
311
312 if (gettime) {
313 if (clock_gettime(clkid, &ts)) {
314 perror("clock_gettime");
315 } else {
316 printf("clock time: %ld.%09ld or %s",
317 ts.tv_sec, ts.tv_nsec, ctime(&ts.tv_sec));
318 }
319 }
320
321 if (settime == 1) {
322 clock_gettime(CLOCK_REALTIME, &ts);
323 if (clock_settime(clkid, &ts)) {
324 perror("clock_settime");
325 } else {
326 puts("set time okay");
327 }
328 }
329
330 if (settime == 2) {
331 clock_gettime(clkid, &ts);
332 if (clock_settime(CLOCK_REALTIME, &ts)) {
333 perror("clock_settime");
334 } else {
335 puts("set time okay");
336 }
337 }
338
339 if (settime == 3) {
340 ts.tv_sec = seconds;
341 ts.tv_nsec = 0;
342 if (clock_settime(clkid, &ts)) {
343 perror("clock_settime");
344 } else {
345 puts("set time okay");
346 }
347 }
348
349 if (extts) {
350 memset(&extts_request, 0, sizeof(extts_request));
351 extts_request.index = index;
352 extts_request.flags = PTP_ENABLE_FEATURE;
353 if (ioctl(fd, PTP_EXTTS_REQUEST, &extts_request)) {
354 perror("PTP_EXTTS_REQUEST");
355 extts = 0;
356 } else {
357 puts("external time stamp request okay");
358 }
359 for (; extts; extts--) {
360 cnt = read(fd, &event, sizeof(event));
361 if (cnt != sizeof(event)) {
362 perror("read");
363 break;
364 }
365 printf("event index %u at %lld.%09u\n", event.index,
366 event.t.sec, event.t.nsec);
367 fflush(stdout);
368 }
369 /* Disable the feature again. */
370 extts_request.flags = 0;
371 if (ioctl(fd, PTP_EXTTS_REQUEST, &extts_request)) {
372 perror("PTP_EXTTS_REQUEST");
373 }
374 }
375
376 if (list_pins) {
377 int n_pins = 0;
378 if (ioctl(fd, PTP_CLOCK_GETCAPS, &caps)) {
379 perror("PTP_CLOCK_GETCAPS");
380 } else {
381 n_pins = caps.n_pins;
382 }
383 for (i = 0; i < n_pins; i++) {
384 desc.index = i;
385 if (ioctl(fd, PTP_PIN_GETFUNC, &desc)) {
386 perror("PTP_PIN_GETFUNC");
387 break;
388 }
389 printf("name %s index %u func %u chan %u\n",
390 desc.name, desc.index, desc.func, desc.chan);
391 }
392 }
393
394 if (oneshot) {
395 install_handler(SIGALRM, handle_alarm);
396 /* Create a timer. */
397 sigevent.sigev_notify = SIGEV_SIGNAL;
398 sigevent.sigev_signo = SIGALRM;
399 if (timer_create(clkid, &sigevent, &timerid)) {
400 perror("timer_create");
401 return -1;
402 }
403 /* Start the timer. */
404 memset(&timeout, 0, sizeof(timeout));
405 timeout.it_value.tv_sec = oneshot;
406 if (timer_settime(timerid, 0, &timeout, NULL)) {
407 perror("timer_settime");
408 return -1;
409 }
410 pause();
411 timer_delete(timerid);
412 }
413
414 if (periodic) {
415 install_handler(SIGALRM, handle_alarm);
416 /* Create a timer. */
417 sigevent.sigev_notify = SIGEV_SIGNAL;
418 sigevent.sigev_signo = SIGALRM;
419 if (timer_create(clkid, &sigevent, &timerid)) {
420 perror("timer_create");
421 return -1;
422 }
423 /* Start the timer. */
424 memset(&timeout, 0, sizeof(timeout));
425 timeout.it_interval.tv_sec = periodic;
426 timeout.it_value.tv_sec = periodic;
427 if (timer_settime(timerid, 0, &timeout, NULL)) {
428 perror("timer_settime");
429 return -1;
430 }
431 while (1) {
432 pause();
433 }
434 timer_delete(timerid);
435 }
436
437 if (perout >= 0) {
438 if (clock_gettime(clkid, &ts)) {
439 perror("clock_gettime");
440 return -1;
441 }
442 memset(&perout_request, 0, sizeof(perout_request));
443 perout_request.index = index;
444 perout_request.start.sec = ts.tv_sec + 2;
445 perout_request.start.nsec = 0;
446 perout_request.period.sec = 0;
447 perout_request.period.nsec = perout;
448 if (ioctl(fd, PTP_PEROUT_REQUEST, &perout_request)) {
449 perror("PTP_PEROUT_REQUEST");
450 } else {
451 puts("periodic output request okay");
452 }
453 }
454
455 if (pin_index >= 0) {
456 memset(&desc, 0, sizeof(desc));
457 desc.index = pin_index;
458 desc.func = pin_func;
459 desc.chan = index;
460 if (ioctl(fd, PTP_PIN_SETFUNC, &desc)) {
461 perror("PTP_PIN_SETFUNC");
462 } else {
463 puts("set pin function okay");
464 }
465 }
466
467 if (pps != -1) {
468 int enable = pps ? 1 : 0;
469 if (ioctl(fd, PTP_ENABLE_PPS, enable)) {
470 perror("PTP_ENABLE_PPS");
471 } else {
472 puts("pps for system time request okay");
473 }
474 }
475
476 if (pct_offset) {
477 if (n_samples <= 0 || n_samples > 25) {
478 puts("n_samples should be between 1 and 25");
479 usage(progname);
480 return -1;
481 }
482
483 sysoff = calloc(1, sizeof(*sysoff));
484 if (!sysoff) {
485 perror("calloc");
486 return -1;
487 }
488 sysoff->n_samples = n_samples;
489
490 if (ioctl(fd, PTP_SYS_OFFSET, sysoff))
491 perror("PTP_SYS_OFFSET");
492 else
493 puts("system and phc clock time offset request okay");
494
495 pct = &sysoff->ts[0];
496 for (i = 0; i < sysoff->n_samples; i++) {
497 t1 = pctns(pct+2*i);
498 tp = pctns(pct+2*i+1);
499 t2 = pctns(pct+2*i+2);
500 interval = t2 - t1;
501 offset = (t2 + t1) / 2 - tp;
502
503 printf("system time: %lld.%u\n",
504 (pct+2*i)->sec, (pct+2*i)->nsec);
505 printf("phc time: %lld.%u\n",
506 (pct+2*i+1)->sec, (pct+2*i+1)->nsec);
507 printf("system time: %lld.%u\n",
508 (pct+2*i+2)->sec, (pct+2*i+2)->nsec);
509 printf("system/phc clock time offset is %" PRId64 " ns\n"
510 "system clock time delay is %" PRId64 " ns\n",
511 offset, interval);
512 }
513
514 free(sysoff);
515 }
516
517 close(fd);
518 return 0;
519 }
Linux with added FPC-III support