linuxptp/ptp4l.c

/**
 * @file ptp4l.c
 * @brief PTP Boundary Clock main program
 * @note Copyright (C) 2011 Richard Cochran <richardcochran@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include "clock.h"
#include "config.h"
#include "print.h"
#include "sk.h"
#include "transport.h"

#define DEFAULT_PHC "/dev/ptp0"

int sk_tx_retries = 2; /*see sk.c*/
double configured_pi_kp, configured_pi_ki; /*see pi.c*/

static int running = 1;
static struct defaultDS ds;
static struct port_defaults pod;
static struct config cfg_settings;

static int generate_clock_identity(struct ClockIdentity *ci, char *name)
{
	unsigned char mac[6];
	if (sk_interface_macaddr(name, mac, sizeof(mac)))
		return -1;
	ci->id[0] = mac[0];
	ci->id[1] = mac[1];
	ci->id[2] = mac[2];
	ci->id[3] = 0xFF;
	ci->id[4] = 0xFE;
	ci->id[5] = mac[3];
	ci->id[6] = mac[4];
	ci->id[7] = mac[5];
	return 0;
}

static void usage(char *progname)
{
	fprintf(stderr,
		"\nusage: %s [options]\n\n"
		" Delay Mechanism (per interface)\n\n"
		" -A        Auto, starting with E2E\n"
		" -E        E2E, delay request-response (default)\n"
		" -P        P2P, peer delay mechanism\n\n"
		" Network Transport (per interface)\n\n"
		" -2        IEEE 802.3\n"
		" -4        UDP IPV4 (default)\n"
		" -6        UDP IPV6\n\n"
		" Time Stamping\n\n"
		" -r        HARDWARE (default)\n"
		" -s        SOFTWARE\n"
		" -z        LEGACY HW\n\n"
		" Other Options\n\n"
		" -f [file] read configuration from 'file'\n"
		" -h        prints this message and exits\n"
		" -i [dev]  interface device to use, for example 'eth0'\n"
		"           (may be specified multiple times)\n"
		" -l [num]  set the logging level to 'num'\n"
		" -m        slave only mode (overrides configuration file)\n"
		" -p [dev]  PTP hardware clock device to use, default '%s'\n"
		"           (ignored for SOFTWARE/LEGACY HW time stamping)\n"
		" -q        quiet mode, do not use syslog(3)\n"
		" -v        verbose mode, print messages to stdout\n"
		"\n",
		progname, DEFAULT_PHC);
}

int main(int argc, char *argv[])
{
	char *config = NULL, *phc = DEFAULT_PHC, *progname;
	int c, i, nports = 0, slaveonly = 0;
	struct interface iface[MAX_PORTS];
	enum delay_mechanism dm = DM_E2E;
	enum transport_type transport = TRANS_UDP_IPV4;
	enum timestamp_type timestamping = TS_HARDWARE;
	struct clock *clock;

	/* Process the command line arguments. */
	progname = strrchr(argv[0], '/');
	progname = progname ? 1+progname : argv[0];
	while (EOF != (c = getopt(argc, argv, "246AEf:hi:l:mPp:qrsvz"))) {
		switch (c) {
		case '2':
			transport = TRANS_IEEE_802_3;
			break;
		case '4':
			transport = TRANS_UDP_IPV4;
			break;
		case '6':
			transport = TRANS_UDP_IPV6;
			break;
		case 'A':
			dm = DM_AUTO;
			break;
		case 'E':
			dm = DM_E2E;
			break;
		case 'f':
			config = optarg;
			break;
		case 'i':
			if (nports < MAX_PORTS) {
				iface[nports].name = optarg;
				iface[nports].dm = dm;
				iface[nports].transport = transport;
				nports++;
			} else {
				fprintf(stderr, "too many interfaces\n");
				return -1;
			}
			break;
		case 'l':
			print_set_level(atoi(optarg));
			break;
		case 'm':
			slaveonly = 1;
			break;
		case 'P':
			dm = DM_P2P;
			break;
		case 'p':
			phc = optarg;
			break;
		case 'q':
			print_no_syslog();
			break;
		case 'r':
			timestamping = TS_HARDWARE;
			break;
		case 's':
			timestamping = TS_SOFTWARE;
			break;
		case 'v':
			print_verbose();
			break;
		case 'z':
			timestamping = TS_LEGACY_HW;
			break;
		case 'h':
			usage(progname);
			return 0;
		case '?':
			usage(progname);
			return -1;
		default:
			usage(progname);
			return -1;
		}
	}

	if (!nports) {
		fprintf(stderr, "no interface specified\n");
		usage(progname);
		return -1;
	}
	for (i = 0; i < nports; i++) {
		iface[i].timestamping = timestamping;
	}
	if (timestamping == TS_SOFTWARE || timestamping == TS_LEGACY_HW) {
		phc = NULL;
	}

	ds.slaveOnly = FALSE;
	ds.priority1 = 128;
	ds.clockQuality.clockClass = 248;
	ds.clockQuality.clockAccuracy = 0xfe;
	ds.clockQuality.offsetScaledLogVariance = 0xffff;
	ds.priority2 = 128;

	pod.logAnnounceInterval = 1;
	pod.logSyncInterval = 0;
	pod.logMinDelayReqInterval = 0;
	pod.announceReceiptTimeout = 3;

	if (generate_clock_identity(&ds.clockIdentity, iface[0].name)) {
		fprintf(stderr, "failed to generate a clock identity\n");
		return -1;
	}

	cfg_settings.dds = &ds;
	cfg_settings.pod = &pod;
	cfg_settings.tx_timestamp_retries = &sk_tx_retries;
	cfg_settings.pi_proportional_const = &configured_pi_kp;
	cfg_settings.pi_integral_const = &configured_pi_ki;

	if (config && config_read(config, &cfg_settings)) {
		fprintf(stderr, "failed to read configuration file\n");
		return -1;
	}

	if (slaveonly) {
		ds.slaveOnly = TRUE;
		ds.clockQuality.clockClass = 255;
	}

	clock = clock_create(phc, iface, nports, &ds, &pod);
	if (!clock) {
		fprintf(stderr, "failed to create a clock\n");
		return -1;
	}

	while (running) {
		if (clock_poll(clock))
			break;
	}

	return 0;
}