1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015 Intel Corporation
6 * This application is a simple Layer 2 PTP v2 client. It shows delta values
7 * which are used to synchronize the PHC clock. if the "-T 1" parameter is
8 * passed to the application the Linux kernel clock is also synchronized.
14 #include <rte_ethdev.h>
15 #include <rte_cycles.h>
16 #include <rte_lcore.h>
23 #define RX_RING_SIZE 1024
24 #define TX_RING_SIZE 1024
26 #define NUM_MBUFS 8191
27 #define MBUF_CACHE_SIZE 250
29 /* Values for the PTP messageType field. */
32 #define PDELAY_REQ 0x2
33 #define PDELAY_RESP 0x3
35 #define DELAY_RESP 0x9
36 #define PDELAY_RESP_FOLLOW_UP 0xA
39 #define MANAGEMENT 0xD
41 #define NSEC_PER_SEC 1000000000L
42 #define KERNEL_TIME_ADJUST_LIMIT 20000
43 #define PTP_PROTOCOL 0x88F7
45 struct rte_mempool *mbuf_pool;
46 uint32_t ptp_enabled_port_mask;
47 uint8_t ptp_enabled_port_nb;
48 static uint8_t ptp_enabled_ports[RTE_MAX_ETHPORTS];
50 static const struct rte_eth_conf port_conf_default = {
52 .max_rx_pkt_len = RTE_ETHER_MAX_LEN,
56 static const struct rte_ether_addr ether_multicast = {
57 .addr_bytes = {0x01, 0x1b, 0x19, 0x0, 0x0, 0x0}
60 /* Structs used for PTP handling. */
65 } __attribute__((packed));
72 struct clock_id clock_id;
74 } __attribute__((packed));
79 uint16_t message_length;
80 uint8_t domain_number;
82 uint8_t flag_field[2];
85 struct port_id source_port_id;
88 int8_t log_message_interval;
89 } __attribute__((packed));
92 struct ptp_header hdr;
93 struct tstamp origin_tstamp;
94 } __attribute__((packed));
96 struct follow_up_msg {
97 struct ptp_header hdr;
98 struct tstamp precise_origin_tstamp;
100 } __attribute__((packed));
102 struct delay_req_msg {
103 struct ptp_header hdr;
104 struct tstamp origin_tstamp;
105 } __attribute__((packed));
107 struct delay_resp_msg {
108 struct ptp_header hdr;
109 struct tstamp rx_tstamp;
110 struct port_id req_port_id;
112 } __attribute__((packed));
116 struct ptp_header header;
117 struct sync_msg sync;
118 struct delay_req_msg delay_req;
119 struct follow_up_msg follow_up;
120 struct delay_resp_msg delay_resp;
121 } __attribute__((packed));
124 struct ptpv2_data_slave_ordinary {
126 struct timespec tstamp1;
127 struct timespec tstamp2;
128 struct timespec tstamp3;
129 struct timespec tstamp4;
130 struct clock_id client_clock_id;
131 struct clock_id master_clock_id;
132 struct timeval new_adj;
136 uint16_t seqID_FOLLOWUP;
138 uint8_t kernel_time_set;
139 uint16_t current_ptp_port;
142 static struct ptpv2_data_slave_ordinary ptp_data;
144 static inline uint64_t timespec64_to_ns(const struct timespec *ts)
146 return ((uint64_t) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
149 static struct timeval
150 ns_to_timeval(int64_t nsec)
152 struct timespec t_spec = {0, 0};
153 struct timeval t_eval = {0, 0};
158 rem = nsec % NSEC_PER_SEC;
159 t_spec.tv_sec = nsec / NSEC_PER_SEC;
166 t_spec.tv_nsec = rem;
167 t_eval.tv_sec = t_spec.tv_sec;
168 t_eval.tv_usec = t_spec.tv_nsec / 1000;
174 * Initializes a given port using global settings and with the RX buffers
175 * coming from the mbuf_pool passed as a parameter.
178 port_init(uint16_t port, struct rte_mempool *mbuf_pool)
180 struct rte_eth_dev_info dev_info;
181 struct rte_eth_conf port_conf = port_conf_default;
182 const uint16_t rx_rings = 1;
183 const uint16_t tx_rings = 1;
186 uint16_t nb_rxd = RX_RING_SIZE;
187 uint16_t nb_txd = TX_RING_SIZE;
189 if (!rte_eth_dev_is_valid_port(port))
192 retval = rte_eth_dev_info_get(port, &dev_info);
194 printf("Error during getting device (port %u) info: %s\n",
195 port, strerror(-retval));
200 if (dev_info.tx_offload_capa & DEV_TX_OFFLOAD_MBUF_FAST_FREE)
201 port_conf.txmode.offloads |=
202 DEV_TX_OFFLOAD_MBUF_FAST_FREE;
203 /* Force full Tx path in the driver, required for IEEE1588 */
204 port_conf.txmode.offloads |= DEV_TX_OFFLOAD_MULTI_SEGS;
206 /* Configure the Ethernet device. */
207 retval = rte_eth_dev_configure(port, rx_rings, tx_rings, &port_conf);
211 retval = rte_eth_dev_adjust_nb_rx_tx_desc(port, &nb_rxd, &nb_txd);
215 /* Allocate and set up 1 RX queue per Ethernet port. */
216 for (q = 0; q < rx_rings; q++) {
217 retval = rte_eth_rx_queue_setup(port, q, nb_rxd,
218 rte_eth_dev_socket_id(port), NULL, mbuf_pool);
224 /* Allocate and set up 1 TX queue per Ethernet port. */
225 for (q = 0; q < tx_rings; q++) {
226 struct rte_eth_txconf *txconf;
228 txconf = &dev_info.default_txconf;
229 txconf->offloads = port_conf.txmode.offloads;
231 retval = rte_eth_tx_queue_setup(port, q, nb_txd,
232 rte_eth_dev_socket_id(port), txconf);
237 /* Start the Ethernet port. */
238 retval = rte_eth_dev_start(port);
242 /* Enable timesync timestamping for the Ethernet device */
243 retval = rte_eth_timesync_enable(port);
245 printf("Timesync enable failed: %d\n", retval);
249 /* Enable RX in promiscuous mode for the Ethernet device. */
250 retval = rte_eth_promiscuous_enable(port);
252 printf("Promiscuous mode enable failed: %s\n",
253 rte_strerror(-retval));
261 print_clock_info(struct ptpv2_data_slave_ordinary *ptp_data)
264 struct timespec net_time, sys_time;
266 printf("Master Clock id: %02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x",
267 ptp_data->master_clock_id.id[0],
268 ptp_data->master_clock_id.id[1],
269 ptp_data->master_clock_id.id[2],
270 ptp_data->master_clock_id.id[3],
271 ptp_data->master_clock_id.id[4],
272 ptp_data->master_clock_id.id[5],
273 ptp_data->master_clock_id.id[6],
274 ptp_data->master_clock_id.id[7]);
276 printf("\nT2 - Slave Clock. %lds %ldns",
277 (ptp_data->tstamp2.tv_sec),
278 (ptp_data->tstamp2.tv_nsec));
280 printf("\nT1 - Master Clock. %lds %ldns ",
281 ptp_data->tstamp1.tv_sec,
282 (ptp_data->tstamp1.tv_nsec));
284 printf("\nT3 - Slave Clock. %lds %ldns",
285 ptp_data->tstamp3.tv_sec,
286 (ptp_data->tstamp3.tv_nsec));
288 printf("\nT4 - Master Clock. %lds %ldns ",
289 ptp_data->tstamp4.tv_sec,
290 (ptp_data->tstamp4.tv_nsec));
292 printf("\nDelta between master and slave clocks:%"PRId64"ns\n",
295 clock_gettime(CLOCK_REALTIME, &sys_time);
296 rte_eth_timesync_read_time(ptp_data->current_ptp_port, &net_time);
298 time_t ts = net_time.tv_sec;
300 printf("\n\nComparison between Linux kernel Time and PTP:");
302 printf("\nCurrent PTP Time: %.24s %.9ld ns",
303 ctime(&ts), net_time.tv_nsec);
305 nsec = (int64_t)timespec64_to_ns(&net_time) -
306 (int64_t)timespec64_to_ns(&sys_time);
307 ptp_data->new_adj = ns_to_timeval(nsec);
309 gettimeofday(&ptp_data->new_adj, NULL);
311 time_t tp = ptp_data->new_adj.tv_sec;
313 printf("\nCurrent SYS Time: %.24s %.6ld ns",
314 ctime(&tp), ptp_data->new_adj.tv_usec);
316 printf("\nDelta between PTP and Linux Kernel time:%"PRId64"ns\n",
319 printf("[Ctrl+C to quit]\n");
321 /* Clear screen and put cursor in column 1, row 1 */
322 printf("\033[2J\033[1;1H");
326 delta_eval(struct ptpv2_data_slave_ordinary *ptp_data)
334 t1 = timespec64_to_ns(&ptp_data->tstamp1);
335 t2 = timespec64_to_ns(&ptp_data->tstamp2);
336 t3 = timespec64_to_ns(&ptp_data->tstamp3);
337 t4 = timespec64_to_ns(&ptp_data->tstamp4);
339 delta = -((int64_t)((t2 - t1) - (t4 - t3))) / 2;
345 * Parse the PTP SYNC message.
348 parse_sync(struct ptpv2_data_slave_ordinary *ptp_data, uint16_t rx_tstamp_idx)
350 struct ptp_header *ptp_hdr;
352 ptp_hdr = (struct ptp_header *)(rte_pktmbuf_mtod(ptp_data->m, char *)
353 + sizeof(struct rte_ether_hdr));
354 ptp_data->seqID_SYNC = rte_be_to_cpu_16(ptp_hdr->seq_id);
356 if (ptp_data->ptpset == 0) {
357 rte_memcpy(&ptp_data->master_clock_id,
358 &ptp_hdr->source_port_id.clock_id,
359 sizeof(struct clock_id));
360 ptp_data->ptpset = 1;
363 if (memcmp(&ptp_hdr->source_port_id.clock_id,
364 &ptp_hdr->source_port_id.clock_id,
365 sizeof(struct clock_id)) == 0) {
367 if (ptp_data->ptpset == 1)
368 rte_eth_timesync_read_rx_timestamp(ptp_data->portid,
369 &ptp_data->tstamp2, rx_tstamp_idx);
375 * Parse the PTP FOLLOWUP message and send DELAY_REQ to the master clock.
378 parse_fup(struct ptpv2_data_slave_ordinary *ptp_data)
380 struct rte_ether_hdr *eth_hdr;
381 struct ptp_header *ptp_hdr;
382 struct clock_id *client_clkid;
383 struct ptp_message *ptp_msg;
384 struct rte_mbuf *created_pkt;
385 struct tstamp *origin_tstamp;
386 struct rte_ether_addr eth_multicast = ether_multicast;
389 struct rte_mbuf *m = ptp_data->m;
391 eth_hdr = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
392 ptp_hdr = (struct ptp_header *)(rte_pktmbuf_mtod(m, char *)
393 + sizeof(struct rte_ether_hdr));
394 if (memcmp(&ptp_data->master_clock_id,
395 &ptp_hdr->source_port_id.clock_id,
396 sizeof(struct clock_id)) != 0)
399 ptp_data->seqID_FOLLOWUP = rte_be_to_cpu_16(ptp_hdr->seq_id);
400 ptp_msg = (struct ptp_message *) (rte_pktmbuf_mtod(m, char *) +
401 sizeof(struct rte_ether_hdr));
403 origin_tstamp = &ptp_msg->follow_up.precise_origin_tstamp;
404 ptp_data->tstamp1.tv_nsec = ntohl(origin_tstamp->ns);
405 ptp_data->tstamp1.tv_sec =
406 ((uint64_t)ntohl(origin_tstamp->sec_lsb)) |
407 (((uint64_t)ntohs(origin_tstamp->sec_msb)) << 32);
409 if (ptp_data->seqID_FOLLOWUP == ptp_data->seqID_SYNC) {
411 created_pkt = rte_pktmbuf_alloc(mbuf_pool);
412 pkt_size = sizeof(struct rte_ether_hdr) +
413 sizeof(struct ptp_message);
414 created_pkt->data_len = pkt_size;
415 created_pkt->pkt_len = pkt_size;
416 eth_hdr = rte_pktmbuf_mtod(created_pkt, struct rte_ether_hdr *);
417 rte_eth_macaddr_get(ptp_data->portid, ð_hdr->s_addr);
419 /* Set multicast address 01-1B-19-00-00-00. */
420 rte_ether_addr_copy(ð_multicast, ð_hdr->d_addr);
422 eth_hdr->ether_type = htons(PTP_PROTOCOL);
423 ptp_msg = (struct ptp_message *)
424 (rte_pktmbuf_mtod(created_pkt, char *) +
425 sizeof(struct rte_ether_hdr));
427 ptp_msg->delay_req.hdr.seq_id = htons(ptp_data->seqID_SYNC);
428 ptp_msg->delay_req.hdr.msg_type = DELAY_REQ;
429 ptp_msg->delay_req.hdr.ver = 2;
430 ptp_msg->delay_req.hdr.control = 1;
431 ptp_msg->delay_req.hdr.log_message_interval = 127;
432 ptp_msg->delay_req.hdr.message_length =
433 htons(sizeof(struct delay_req_msg));
434 ptp_msg->delay_req.hdr.domain_number = ptp_hdr->domain_number;
436 /* Set up clock id. */
438 &ptp_msg->delay_req.hdr.source_port_id.clock_id;
440 client_clkid->id[0] = eth_hdr->s_addr.addr_bytes[0];
441 client_clkid->id[1] = eth_hdr->s_addr.addr_bytes[1];
442 client_clkid->id[2] = eth_hdr->s_addr.addr_bytes[2];
443 client_clkid->id[3] = 0xFF;
444 client_clkid->id[4] = 0xFE;
445 client_clkid->id[5] = eth_hdr->s_addr.addr_bytes[3];
446 client_clkid->id[6] = eth_hdr->s_addr.addr_bytes[4];
447 client_clkid->id[7] = eth_hdr->s_addr.addr_bytes[5];
449 rte_memcpy(&ptp_data->client_clock_id,
451 sizeof(struct clock_id));
453 /* Enable flag for hardware timestamping. */
454 created_pkt->ol_flags |= PKT_TX_IEEE1588_TMST;
456 /*Read value from NIC to prevent latching with old value. */
457 rte_eth_timesync_read_tx_timestamp(ptp_data->portid,
460 /* Transmit the packet. */
461 rte_eth_tx_burst(ptp_data->portid, 0, &created_pkt, 1);
464 ptp_data->tstamp3.tv_nsec = 0;
465 ptp_data->tstamp3.tv_sec = 0;
467 /* Wait at least 1 us to read TX timestamp. */
468 while ((rte_eth_timesync_read_tx_timestamp(ptp_data->portid,
469 &ptp_data->tstamp3) < 0) && (wait_us < 1000)) {
477 * Update the kernel time with the difference between it and the current NIC
481 update_kernel_time(void)
484 struct timespec net_time, sys_time;
486 clock_gettime(CLOCK_REALTIME, &sys_time);
487 rte_eth_timesync_read_time(ptp_data.current_ptp_port, &net_time);
489 nsec = (int64_t)timespec64_to_ns(&net_time) -
490 (int64_t)timespec64_to_ns(&sys_time);
492 ptp_data.new_adj = ns_to_timeval(nsec);
495 * If difference between kernel time and system time in NIC is too big
496 * (more than +/- 20 microseconds), use clock_settime to set directly
497 * the kernel time, as adjtime is better for small adjustments (takes
498 * longer to adjust the time).
501 if (nsec > KERNEL_TIME_ADJUST_LIMIT || nsec < -KERNEL_TIME_ADJUST_LIMIT)
502 clock_settime(CLOCK_REALTIME, &net_time);
504 adjtime(&ptp_data.new_adj, 0);
510 * Parse the DELAY_RESP message.
513 parse_drsp(struct ptpv2_data_slave_ordinary *ptp_data)
515 struct rte_mbuf *m = ptp_data->m;
516 struct ptp_message *ptp_msg;
517 struct tstamp *rx_tstamp;
520 ptp_msg = (struct ptp_message *) (rte_pktmbuf_mtod(m, char *) +
521 sizeof(struct rte_ether_hdr));
522 seq_id = rte_be_to_cpu_16(ptp_msg->delay_resp.hdr.seq_id);
523 if (memcmp(&ptp_data->client_clock_id,
524 &ptp_msg->delay_resp.req_port_id.clock_id,
525 sizeof(struct clock_id)) == 0) {
526 if (seq_id == ptp_data->seqID_FOLLOWUP) {
527 rx_tstamp = &ptp_msg->delay_resp.rx_tstamp;
528 ptp_data->tstamp4.tv_nsec = ntohl(rx_tstamp->ns);
529 ptp_data->tstamp4.tv_sec =
530 ((uint64_t)ntohl(rx_tstamp->sec_lsb)) |
531 (((uint64_t)ntohs(rx_tstamp->sec_msb)) << 32);
533 /* Evaluate the delta for adjustment. */
534 ptp_data->delta = delta_eval(ptp_data);
536 rte_eth_timesync_adjust_time(ptp_data->portid,
539 ptp_data->current_ptp_port = ptp_data->portid;
541 /* Update kernel time if enabled in app parameters. */
542 if (ptp_data->kernel_time_set == 1)
543 update_kernel_time();
551 /* This function processes PTP packets, implementing slave PTP IEEE1588 L2
555 parse_ptp_frames(uint16_t portid, struct rte_mbuf *m) {
556 struct ptp_header *ptp_hdr;
557 struct rte_ether_hdr *eth_hdr;
560 eth_hdr = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
561 eth_type = rte_be_to_cpu_16(eth_hdr->ether_type);
563 if (eth_type == PTP_PROTOCOL) {
565 ptp_data.portid = portid;
566 ptp_hdr = (struct ptp_header *)(rte_pktmbuf_mtod(m, char *)
567 + sizeof(struct rte_ether_hdr));
569 switch (ptp_hdr->msg_type) {
571 parse_sync(&ptp_data, m->timesync);
574 parse_fup(&ptp_data);
577 parse_drsp(&ptp_data);
578 print_clock_info(&ptp_data);
587 * The lcore main. This is the main thread that does the work, reading from an
588 * input port and writing to an output port.
590 static __attribute__((noreturn)) void
598 * Check that the port is on the same NUMA node as the polling thread
599 * for best performance.
601 printf("\nCore %u Waiting for SYNC packets. [Ctrl+C to quit]\n",
604 /* Run until the application is quit or killed. */
607 /* Read packet from RX queues. */
608 for (portid = 0; portid < ptp_enabled_port_nb; portid++) {
610 portid = ptp_enabled_ports[portid];
611 nb_rx = rte_eth_rx_burst(portid, 0, &m, 1);
613 if (likely(nb_rx == 0))
616 if (m->ol_flags & PKT_RX_IEEE1588_PTP)
617 parse_ptp_frames(portid, m);
625 print_usage(const char *prgname)
627 printf("%s [EAL options] -- -p PORTMASK -T VALUE\n"
628 " -T VALUE: 0 - Disable, 1 - Enable Linux Clock"
629 " Synchronization (0 default)\n"
630 " -p PORTMASK: hexadecimal bitmask of ports to configure\n",
635 ptp_parse_portmask(const char *portmask)
640 /* Parse the hexadecimal string. */
641 pm = strtoul(portmask, &end, 16);
643 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
653 parse_ptp_kernel(const char *param)
658 /* Parse the hexadecimal string. */
659 pm = strtoul(param, &end, 16);
661 if ((param[0] == '\0') || (end == NULL) || (*end != '\0'))
669 /* Parse the commandline arguments. */
671 ptp_parse_args(int argc, char **argv)
676 char *prgname = argv[0];
677 static struct option lgopts[] = { {NULL, 0, 0, 0} };
681 while ((opt = getopt_long(argc, argvopt, "p:T:",
682 lgopts, &option_index)) != EOF) {
688 ptp_enabled_port_mask = ptp_parse_portmask(optarg);
689 if (ptp_enabled_port_mask == 0) {
690 printf("invalid portmask\n");
691 print_usage(prgname);
695 /* Time synchronization. */
697 ret = parse_ptp_kernel(optarg);
699 print_usage(prgname);
703 ptp_data.kernel_time_set = ret;
707 print_usage(prgname);
712 argv[optind-1] = prgname;
714 optind = 1; /* Reset getopt lib. */
720 * The main function, which does initialization and calls the per-lcore
724 main(int argc, char *argv[])
730 /* Initialize the Environment Abstraction Layer (EAL). */
731 int ret = rte_eal_init(argc, argv);
734 rte_exit(EXIT_FAILURE, "Error with EAL initialization\n");
736 memset(&ptp_data, '\0', sizeof(struct ptpv2_data_slave_ordinary));
741 ret = ptp_parse_args(argc, argv);
743 rte_exit(EXIT_FAILURE, "Error with PTP initialization\n");
745 /* Check that there is an even number of ports to send/receive on. */
746 nb_ports = rte_eth_dev_count_avail();
748 /* Creates a new mempool in memory to hold the mbufs. */
749 mbuf_pool = rte_pktmbuf_pool_create("MBUF_POOL", NUM_MBUFS * nb_ports,
750 MBUF_CACHE_SIZE, 0, RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
752 if (mbuf_pool == NULL)
753 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
755 /* Initialize all ports. */
756 RTE_ETH_FOREACH_DEV(portid) {
757 if ((ptp_enabled_port_mask & (1 << portid)) != 0) {
758 if (port_init(portid, mbuf_pool) == 0) {
759 ptp_enabled_ports[ptp_enabled_port_nb] = portid;
760 ptp_enabled_port_nb++;
762 rte_exit(EXIT_FAILURE,
763 "Cannot init port %"PRIu8 "\n",
767 printf("Skipping disabled port %u\n", portid);
770 if (ptp_enabled_port_nb == 0) {
771 rte_exit(EXIT_FAILURE,
772 "All available ports are disabled."
773 " Please set portmask.\n");
776 if (rte_lcore_count() > 1)
777 printf("\nWARNING: Too many lcores enabled. Only 1 used.\n");
779 /* Call lcore_main on the master core only. */