2 * PTP 1588 clock support - User space test program
4 * Copyright (C) 2010 OMICRON electronics GmbH
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.
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.
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.
27 #include <sys/ioctl.h>
31 #include <sys/timex.h>
32 #include <sys/types.h>
36 #include <linux/ptp_clock.h>
38 #define DEVICE "/dev/ptp0"
41 #define ADJ_SETOFFSET 0x0100
45 #define CLOCK_INVALID -1
48 /* When glibc offers the syscall, this will go away. */
49 #include <sys/syscall.h>
50 static int clock_adjtime(clockid_t id, struct timex *tx)
52 return syscall(__NR_clock_adjtime, id, tx);
55 static clockid_t get_clockid(int fd)
58 #define FD_TO_CLOCKID(fd) ((~(clockid_t) (fd) << 3) | CLOCKFD)
60 return FD_TO_CLOCKID(fd);
63 static void handle_alarm(int s)
65 printf("received signal %d\n", s);
68 static int install_handler(int signum, void (*handler)(int))
70 struct sigaction action;
73 /* Unblock the signal. */
75 sigaddset(&mask, signum);
76 sigprocmask(SIG_UNBLOCK, &mask, NULL);
78 /* Install the signal handler. */
79 action.sa_handler = handler;
81 sigemptyset(&action.sa_mask);
82 sigaction(signum, &action, NULL);
87 static long ppb_to_scaled_ppm(int ppb)
90 * The 'freq' field in the 'struct timex' is in parts per
91 * million, but with a 16 bit binary fractional field.
92 * Instead of calculating either one of
94 * scaled_ppm = (ppb / 1000) << 16 [1]
95 * scaled_ppm = (ppb << 16) / 1000 [2]
97 * we simply use double precision math, in order to avoid the
98 * truncation in [1] and the possible overflow in [2].
100 return (long) (ppb * 65.536);
103 static int64_t pctns(struct ptp_clock_time *t)
105 return t->sec * 1000000000LL + t->nsec;
108 static void usage(char *progname)
111 "usage: %s [options]\n"
112 " -a val request a one-shot alarm after 'val' seconds\n"
113 " -A val request a periodic alarm every 'val' seconds\n"
114 " -c query the ptp clock's capabilities\n"
115 " -d name device to open\n"
116 " -e val read 'val' external time stamp events\n"
117 " -f val adjust the ptp clock frequency by 'val' ppb\n"
118 " -g get the ptp clock time\n"
119 " -h prints this message\n"
120 " -i val index for event/trigger\n"
121 " -k val measure the time offset between system and phc clock\n"
122 " for 'val' times (Maximum 25)\n"
123 " -p val enable output with a period of 'val' nanoseconds\n"
124 " -P val enable or disable (val=1|0) the system clock PPS\n"
125 " -s set the ptp clock time from the system time\n"
126 " -S set the system time from the ptp clock time\n"
127 " -t val shift the ptp clock time by 'val' seconds\n",
131 int main(int argc, char *argv[])
133 struct ptp_clock_caps caps;
134 struct ptp_extts_event event;
135 struct ptp_extts_request extts_request;
136 struct ptp_perout_request perout_request;
140 static timer_t timerid;
141 struct itimerspec timeout;
142 struct sigevent sigevent;
144 struct ptp_clock_time *pct;
145 struct ptp_sys_offset *sysoff;
151 char *device = DEVICE;
153 int adjfreq = 0x7fffffff;
155 int capabilities = 0;
168 int64_t interval, offset;
170 progname = strrchr(argv[0], '/');
171 progname = progname ? 1+progname : argv[0];
172 while (EOF != (c = getopt(argc, argv, "a:A:cd:e:f:ghi:k:p:P:sSt:v"))) {
175 oneshot = atoi(optarg);
178 periodic = atoi(optarg);
187 extts = atoi(optarg);
190 adjfreq = atoi(optarg);
196 index = atoi(optarg);
200 n_samples = atoi(optarg);
203 perout = atoi(optarg);
215 adjtime = atoi(optarg);
227 fd = open(device, O_RDWR);
229 fprintf(stderr, "opening %s: %s\n", device, strerror(errno));
233 clkid = get_clockid(fd);
234 if (CLOCK_INVALID == clkid) {
235 fprintf(stderr, "failed to read clock id\n");
240 if (ioctl(fd, PTP_CLOCK_GETCAPS, &caps)) {
241 perror("PTP_CLOCK_GETCAPS");
243 printf("capabilities:\n"
244 " %d maximum frequency adjustment (ppb)\n"
245 " %d programmable alarms\n"
246 " %d external time stamp channels\n"
247 " %d programmable periodic signals\n"
248 " %d pulse per second\n",
257 if (0x7fffffff != adjfreq) {
258 memset(&tx, 0, sizeof(tx));
259 tx.modes = ADJ_FREQUENCY;
260 tx.freq = ppb_to_scaled_ppm(adjfreq);
261 if (clock_adjtime(clkid, &tx)) {
262 perror("clock_adjtime");
264 puts("frequency adjustment okay");
269 memset(&tx, 0, sizeof(tx));
270 tx.modes = ADJ_SETOFFSET;
271 tx.time.tv_sec = adjtime;
273 if (clock_adjtime(clkid, &tx) < 0) {
274 perror("clock_adjtime");
276 puts("time shift okay");
281 if (clock_gettime(clkid, &ts)) {
282 perror("clock_gettime");
284 printf("clock time: %ld.%09ld or %s",
285 ts.tv_sec, ts.tv_nsec, ctime(&ts.tv_sec));
290 clock_gettime(CLOCK_REALTIME, &ts);
291 if (clock_settime(clkid, &ts)) {
292 perror("clock_settime");
294 puts("set time okay");
299 clock_gettime(clkid, &ts);
300 if (clock_settime(CLOCK_REALTIME, &ts)) {
301 perror("clock_settime");
303 puts("set time okay");
308 memset(&extts_request, 0, sizeof(extts_request));
309 extts_request.index = index;
310 extts_request.flags = PTP_ENABLE_FEATURE;
311 if (ioctl(fd, PTP_EXTTS_REQUEST, &extts_request)) {
312 perror("PTP_EXTTS_REQUEST");
315 puts("external time stamp request okay");
317 for (; extts; extts--) {
318 cnt = read(fd, &event, sizeof(event));
319 if (cnt != sizeof(event)) {
323 printf("event index %u at %lld.%09u\n", event.index,
324 event.t.sec, event.t.nsec);
327 /* Disable the feature again. */
328 extts_request.flags = 0;
329 if (ioctl(fd, PTP_EXTTS_REQUEST, &extts_request)) {
330 perror("PTP_EXTTS_REQUEST");
335 install_handler(SIGALRM, handle_alarm);
336 /* Create a timer. */
337 sigevent.sigev_notify = SIGEV_SIGNAL;
338 sigevent.sigev_signo = SIGALRM;
339 if (timer_create(clkid, &sigevent, &timerid)) {
340 perror("timer_create");
343 /* Start the timer. */
344 memset(&timeout, 0, sizeof(timeout));
345 timeout.it_value.tv_sec = oneshot;
346 if (timer_settime(timerid, 0, &timeout, NULL)) {
347 perror("timer_settime");
351 timer_delete(timerid);
355 install_handler(SIGALRM, handle_alarm);
356 /* Create a timer. */
357 sigevent.sigev_notify = SIGEV_SIGNAL;
358 sigevent.sigev_signo = SIGALRM;
359 if (timer_create(clkid, &sigevent, &timerid)) {
360 perror("timer_create");
363 /* Start the timer. */
364 memset(&timeout, 0, sizeof(timeout));
365 timeout.it_interval.tv_sec = periodic;
366 timeout.it_value.tv_sec = periodic;
367 if (timer_settime(timerid, 0, &timeout, NULL)) {
368 perror("timer_settime");
374 timer_delete(timerid);
378 if (clock_gettime(clkid, &ts)) {
379 perror("clock_gettime");
382 memset(&perout_request, 0, sizeof(perout_request));
383 perout_request.index = index;
384 perout_request.start.sec = ts.tv_sec + 2;
385 perout_request.start.nsec = 0;
386 perout_request.period.sec = 0;
387 perout_request.period.nsec = perout;
388 if (ioctl(fd, PTP_PEROUT_REQUEST, &perout_request)) {
389 perror("PTP_PEROUT_REQUEST");
391 puts("periodic output request okay");
396 int enable = pps ? 1 : 0;
397 if (ioctl(fd, PTP_ENABLE_PPS, enable)) {
398 perror("PTP_ENABLE_PPS");
400 puts("pps for system time request okay");
405 if (n_samples <= 0 || n_samples > 25) {
406 puts("n_samples should be between 1 and 25");
411 sysoff = calloc(1, sizeof(*sysoff));
416 sysoff->n_samples = n_samples;
418 if (ioctl(fd, PTP_SYS_OFFSET, sysoff))
419 perror("PTP_SYS_OFFSET");
421 puts("system and phc clock time offset request okay");
423 pct = &sysoff->ts[0];
424 for (i = 0; i < sysoff->n_samples; i++) {
426 tp = pctns(pct+2*i+1);
427 t2 = pctns(pct+2*i+2);
429 offset = (t2 + t1) / 2 - tp;
431 printf("system time: %ld.%ld\n",
432 (pct+2*i)->sec, (pct+2*i)->nsec);
433 printf("phc time: %ld.%ld\n",
434 (pct+2*i+1)->sec, (pct+2*i+1)->nsec);
435 printf("system time: %ld.%ld\n",
436 (pct+2*i+2)->sec, (pct+2*i+2)->nsec);
437 printf("system/phc clock time offset is %ld ns\n"
438 "system clock time delay is %ld ns\n",