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 = ETHER_MAX_LEN,
53 .ignore_offload_bitfield = 1,
57 static const struct ether_addr ether_multicast = {
58 .addr_bytes = {0x01, 0x1b, 0x19, 0x0, 0x0, 0x0}
61 /* Structs used for PTP handling. */
66 } __attribute__((packed));
73 struct clock_id clock_id;
75 } __attribute__((packed));
80 uint16_t message_length;
81 uint8_t domain_number;
83 uint8_t flag_field[2];
86 struct port_id source_port_id;
89 int8_t log_message_interval;
90 } __attribute__((packed));
93 struct ptp_header hdr;
94 struct tstamp origin_tstamp;
95 } __attribute__((packed));
97 struct follow_up_msg {
98 struct ptp_header hdr;
99 struct tstamp precise_origin_tstamp;
101 } __attribute__((packed));
103 struct delay_req_msg {
104 struct ptp_header hdr;
105 struct tstamp origin_tstamp;
106 } __attribute__((packed));
108 struct delay_resp_msg {
109 struct ptp_header hdr;
110 struct tstamp rx_tstamp;
111 struct port_id req_port_id;
113 } __attribute__((packed));
117 struct ptp_header header;
118 struct sync_msg sync;
119 struct delay_req_msg delay_req;
120 struct follow_up_msg follow_up;
121 struct delay_resp_msg delay_resp;
122 } __attribute__((packed));
125 struct ptpv2_data_slave_ordinary {
127 struct timespec tstamp1;
128 struct timespec tstamp2;
129 struct timespec tstamp3;
130 struct timespec tstamp4;
131 struct clock_id client_clock_id;
132 struct clock_id master_clock_id;
133 struct timeval new_adj;
137 uint16_t seqID_FOLLOWUP;
139 uint8_t kernel_time_set;
140 uint16_t current_ptp_port;
143 static struct ptpv2_data_slave_ordinary ptp_data;
145 static inline uint64_t timespec64_to_ns(const struct timespec *ts)
147 return ((uint64_t) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
150 static struct timeval
151 ns_to_timeval(int64_t nsec)
153 struct timespec t_spec = {0, 0};
154 struct timeval t_eval = {0, 0};
159 rem = nsec % NSEC_PER_SEC;
160 t_spec.tv_sec = nsec / NSEC_PER_SEC;
167 t_spec.tv_nsec = rem;
168 t_eval.tv_sec = t_spec.tv_sec;
169 t_eval.tv_usec = t_spec.tv_nsec / 1000;
175 * Initializes a given port using global settings and with the RX buffers
176 * coming from the mbuf_pool passed as a parameter.
179 port_init(uint16_t port, struct rte_mempool *mbuf_pool)
181 struct rte_eth_dev_info dev_info;
182 struct rte_eth_conf port_conf = port_conf_default;
183 const uint16_t rx_rings = 1;
184 const uint16_t tx_rings = 1;
187 uint16_t nb_rxd = RX_RING_SIZE;
188 uint16_t nb_txd = TX_RING_SIZE;
190 if (port >= rte_eth_dev_count())
193 rte_eth_dev_info_get(port, &dev_info);
194 if (dev_info.tx_offload_capa & DEV_TX_OFFLOAD_MBUF_FAST_FREE)
195 port_conf.txmode.offloads |=
196 DEV_TX_OFFLOAD_MBUF_FAST_FREE;
197 /* Force full Tx path in the driver, required for IEEE1588 */
198 port_conf.txmode.offloads |= DEV_TX_OFFLOAD_MULTI_SEGS;
200 /* Configure the Ethernet device. */
201 retval = rte_eth_dev_configure(port, rx_rings, tx_rings, &port_conf);
205 retval = rte_eth_dev_adjust_nb_rx_tx_desc(port, &nb_rxd, &nb_txd);
209 /* Allocate and set up 1 RX queue per Ethernet port. */
210 for (q = 0; q < rx_rings; q++) {
211 retval = rte_eth_rx_queue_setup(port, q, nb_rxd,
212 rte_eth_dev_socket_id(port), NULL, mbuf_pool);
218 /* Allocate and set up 1 TX queue per Ethernet port. */
219 for (q = 0; q < tx_rings; q++) {
220 /* Setup txq_flags */
221 struct rte_eth_txconf *txconf;
223 txconf = &dev_info.default_txconf;
224 txconf->txq_flags = ETH_TXQ_FLAGS_IGNORE;
225 txconf->offloads = port_conf.txmode.offloads;
227 retval = rte_eth_tx_queue_setup(port, q, nb_txd,
228 rte_eth_dev_socket_id(port), txconf);
233 /* Start the Ethernet port. */
234 retval = rte_eth_dev_start(port);
238 /* Enable timesync timestamping for the Ethernet device */
239 rte_eth_timesync_enable(port);
241 /* Enable RX in promiscuous mode for the Ethernet device. */
242 rte_eth_promiscuous_enable(port);
248 print_clock_info(struct ptpv2_data_slave_ordinary *ptp_data)
251 struct timespec net_time, sys_time;
253 printf("Master Clock id: %02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x",
254 ptp_data->master_clock_id.id[0],
255 ptp_data->master_clock_id.id[1],
256 ptp_data->master_clock_id.id[2],
257 ptp_data->master_clock_id.id[3],
258 ptp_data->master_clock_id.id[4],
259 ptp_data->master_clock_id.id[5],
260 ptp_data->master_clock_id.id[6],
261 ptp_data->master_clock_id.id[7]);
263 printf("\nT2 - Slave Clock. %lds %ldns",
264 (ptp_data->tstamp2.tv_sec),
265 (ptp_data->tstamp2.tv_nsec));
267 printf("\nT1 - Master Clock. %lds %ldns ",
268 ptp_data->tstamp1.tv_sec,
269 (ptp_data->tstamp1.tv_nsec));
271 printf("\nT3 - Slave Clock. %lds %ldns",
272 ptp_data->tstamp3.tv_sec,
273 (ptp_data->tstamp3.tv_nsec));
275 printf("\nT4 - Master Clock. %lds %ldns ",
276 ptp_data->tstamp4.tv_sec,
277 (ptp_data->tstamp4.tv_nsec));
279 printf("\nDelta between master and slave clocks:%"PRId64"ns\n",
282 clock_gettime(CLOCK_REALTIME, &sys_time);
283 rte_eth_timesync_read_time(ptp_data->current_ptp_port, &net_time);
285 time_t ts = net_time.tv_sec;
287 printf("\n\nComparison between Linux kernel Time and PTP:");
289 printf("\nCurrent PTP Time: %.24s %.9ld ns",
290 ctime(&ts), net_time.tv_nsec);
292 nsec = (int64_t)timespec64_to_ns(&net_time) -
293 (int64_t)timespec64_to_ns(&sys_time);
294 ptp_data->new_adj = ns_to_timeval(nsec);
296 gettimeofday(&ptp_data->new_adj, NULL);
298 time_t tp = ptp_data->new_adj.tv_sec;
300 printf("\nCurrent SYS Time: %.24s %.6ld ns",
301 ctime(&tp), ptp_data->new_adj.tv_usec);
303 printf("\nDelta between PTP and Linux Kernel time:%"PRId64"ns\n",
306 printf("[Ctrl+C to quit]\n");
308 /* Clear screen and put cursor in column 1, row 1 */
309 printf("\033[2J\033[1;1H");
313 delta_eval(struct ptpv2_data_slave_ordinary *ptp_data)
321 t1 = timespec64_to_ns(&ptp_data->tstamp1);
322 t2 = timespec64_to_ns(&ptp_data->tstamp2);
323 t3 = timespec64_to_ns(&ptp_data->tstamp3);
324 t4 = timespec64_to_ns(&ptp_data->tstamp4);
326 delta = -((int64_t)((t2 - t1) - (t4 - t3))) / 2;
332 * Parse the PTP SYNC message.
335 parse_sync(struct ptpv2_data_slave_ordinary *ptp_data, uint16_t rx_tstamp_idx)
337 struct ptp_header *ptp_hdr;
339 ptp_hdr = (struct ptp_header *)(rte_pktmbuf_mtod(ptp_data->m, char *)
340 + sizeof(struct ether_hdr));
341 ptp_data->seqID_SYNC = rte_be_to_cpu_16(ptp_hdr->seq_id);
343 if (ptp_data->ptpset == 0) {
344 rte_memcpy(&ptp_data->master_clock_id,
345 &ptp_hdr->source_port_id.clock_id,
346 sizeof(struct clock_id));
347 ptp_data->ptpset = 1;
350 if (memcmp(&ptp_hdr->source_port_id.clock_id,
351 &ptp_hdr->source_port_id.clock_id,
352 sizeof(struct clock_id)) == 0) {
354 if (ptp_data->ptpset == 1)
355 rte_eth_timesync_read_rx_timestamp(ptp_data->portid,
356 &ptp_data->tstamp2, rx_tstamp_idx);
362 * Parse the PTP FOLLOWUP message and send DELAY_REQ to the master clock.
365 parse_fup(struct ptpv2_data_slave_ordinary *ptp_data)
367 struct ether_hdr *eth_hdr;
368 struct ptp_header *ptp_hdr;
369 struct clock_id *client_clkid;
370 struct ptp_message *ptp_msg;
371 struct rte_mbuf *created_pkt;
372 struct tstamp *origin_tstamp;
373 struct ether_addr eth_multicast = ether_multicast;
376 struct rte_mbuf *m = ptp_data->m;
378 eth_hdr = rte_pktmbuf_mtod(m, struct ether_hdr *);
379 ptp_hdr = (struct ptp_header *)(rte_pktmbuf_mtod(m, char *)
380 + sizeof(struct ether_hdr));
381 if (memcmp(&ptp_data->master_clock_id,
382 &ptp_hdr->source_port_id.clock_id,
383 sizeof(struct clock_id)) != 0)
386 ptp_data->seqID_FOLLOWUP = rte_be_to_cpu_16(ptp_hdr->seq_id);
387 ptp_msg = (struct ptp_message *) (rte_pktmbuf_mtod(m, char *) +
388 sizeof(struct ether_hdr));
390 origin_tstamp = &ptp_msg->follow_up.precise_origin_tstamp;
391 ptp_data->tstamp1.tv_nsec = ntohl(origin_tstamp->ns);
392 ptp_data->tstamp1.tv_sec =
393 ((uint64_t)ntohl(origin_tstamp->sec_lsb)) |
394 (((uint64_t)ntohs(origin_tstamp->sec_msb)) << 32);
396 if (ptp_data->seqID_FOLLOWUP == ptp_data->seqID_SYNC) {
398 created_pkt = rte_pktmbuf_alloc(mbuf_pool);
399 pkt_size = sizeof(struct ether_hdr) +
400 sizeof(struct ptp_message);
401 created_pkt->data_len = pkt_size;
402 created_pkt->pkt_len = pkt_size;
403 eth_hdr = rte_pktmbuf_mtod(created_pkt, struct ether_hdr *);
404 rte_eth_macaddr_get(ptp_data->portid, ð_hdr->s_addr);
406 /* Set multicast address 01-1B-19-00-00-00. */
407 ether_addr_copy(ð_multicast, ð_hdr->d_addr);
409 eth_hdr->ether_type = htons(PTP_PROTOCOL);
410 ptp_msg = (struct ptp_message *)
411 (rte_pktmbuf_mtod(created_pkt, char *) +
412 sizeof(struct ether_hdr));
414 ptp_msg->delay_req.hdr.seq_id = htons(ptp_data->seqID_SYNC);
415 ptp_msg->delay_req.hdr.msg_type = DELAY_REQ;
416 ptp_msg->delay_req.hdr.ver = 2;
417 ptp_msg->delay_req.hdr.control = 1;
418 ptp_msg->delay_req.hdr.log_message_interval = 127;
420 /* Set up clock id. */
422 &ptp_msg->delay_req.hdr.source_port_id.clock_id;
424 client_clkid->id[0] = eth_hdr->s_addr.addr_bytes[0];
425 client_clkid->id[1] = eth_hdr->s_addr.addr_bytes[1];
426 client_clkid->id[2] = eth_hdr->s_addr.addr_bytes[2];
427 client_clkid->id[3] = 0xFF;
428 client_clkid->id[4] = 0xFE;
429 client_clkid->id[5] = eth_hdr->s_addr.addr_bytes[3];
430 client_clkid->id[6] = eth_hdr->s_addr.addr_bytes[4];
431 client_clkid->id[7] = eth_hdr->s_addr.addr_bytes[5];
433 rte_memcpy(&ptp_data->client_clock_id,
435 sizeof(struct clock_id));
437 /* Enable flag for hardware timestamping. */
438 created_pkt->ol_flags |= PKT_TX_IEEE1588_TMST;
440 /*Read value from NIC to prevent latching with old value. */
441 rte_eth_timesync_read_tx_timestamp(ptp_data->portid,
444 /* Transmit the packet. */
445 rte_eth_tx_burst(ptp_data->portid, 0, &created_pkt, 1);
448 ptp_data->tstamp3.tv_nsec = 0;
449 ptp_data->tstamp3.tv_sec = 0;
451 /* Wait at least 1 us to read TX timestamp. */
452 while ((rte_eth_timesync_read_tx_timestamp(ptp_data->portid,
453 &ptp_data->tstamp3) < 0) && (wait_us < 1000)) {
461 * Update the kernel time with the difference between it and the current NIC
465 update_kernel_time(void)
468 struct timespec net_time, sys_time;
470 clock_gettime(CLOCK_REALTIME, &sys_time);
471 rte_eth_timesync_read_time(ptp_data.current_ptp_port, &net_time);
473 nsec = (int64_t)timespec64_to_ns(&net_time) -
474 (int64_t)timespec64_to_ns(&sys_time);
476 ptp_data.new_adj = ns_to_timeval(nsec);
479 * If difference between kernel time and system time in NIC is too big
480 * (more than +/- 20 microseconds), use clock_settime to set directly
481 * the kernel time, as adjtime is better for small adjustments (takes
482 * longer to adjust the time).
485 if (nsec > KERNEL_TIME_ADJUST_LIMIT || nsec < -KERNEL_TIME_ADJUST_LIMIT)
486 clock_settime(CLOCK_REALTIME, &net_time);
488 adjtime(&ptp_data.new_adj, 0);
494 * Parse the DELAY_RESP message.
497 parse_drsp(struct ptpv2_data_slave_ordinary *ptp_data)
499 struct rte_mbuf *m = ptp_data->m;
500 struct ptp_message *ptp_msg;
501 struct tstamp *rx_tstamp;
504 ptp_msg = (struct ptp_message *) (rte_pktmbuf_mtod(m, char *) +
505 sizeof(struct ether_hdr));
506 seq_id = rte_be_to_cpu_16(ptp_msg->delay_resp.hdr.seq_id);
507 if (memcmp(&ptp_data->client_clock_id,
508 &ptp_msg->delay_resp.req_port_id.clock_id,
509 sizeof(struct clock_id)) == 0) {
510 if (seq_id == ptp_data->seqID_FOLLOWUP) {
511 rx_tstamp = &ptp_msg->delay_resp.rx_tstamp;
512 ptp_data->tstamp4.tv_nsec = ntohl(rx_tstamp->ns);
513 ptp_data->tstamp4.tv_sec =
514 ((uint64_t)ntohl(rx_tstamp->sec_lsb)) |
515 (((uint64_t)ntohs(rx_tstamp->sec_msb)) << 32);
517 /* Evaluate the delta for adjustment. */
518 ptp_data->delta = delta_eval(ptp_data);
520 rte_eth_timesync_adjust_time(ptp_data->portid,
523 ptp_data->current_ptp_port = ptp_data->portid;
525 /* Update kernel time if enabled in app parameters. */
526 if (ptp_data->kernel_time_set == 1)
527 update_kernel_time();
535 /* This function processes PTP packets, implementing slave PTP IEEE1588 L2
539 parse_ptp_frames(uint16_t portid, struct rte_mbuf *m) {
540 struct ptp_header *ptp_hdr;
541 struct ether_hdr *eth_hdr;
544 eth_hdr = rte_pktmbuf_mtod(m, struct ether_hdr *);
545 eth_type = rte_be_to_cpu_16(eth_hdr->ether_type);
547 if (eth_type == PTP_PROTOCOL) {
549 ptp_data.portid = portid;
550 ptp_hdr = (struct ptp_header *)(rte_pktmbuf_mtod(m, char *)
551 + sizeof(struct ether_hdr));
553 switch (ptp_hdr->msg_type) {
555 parse_sync(&ptp_data, m->timesync);
558 parse_fup(&ptp_data);
561 parse_drsp(&ptp_data);
562 print_clock_info(&ptp_data);
571 * The lcore main. This is the main thread that does the work, reading from an
572 * input port and writing to an output port.
574 static __attribute__((noreturn)) void
582 * Check that the port is on the same NUMA node as the polling thread
583 * for best performance.
585 printf("\nCore %u Waiting for SYNC packets. [Ctrl+C to quit]\n",
588 /* Run until the application is quit or killed. */
591 /* Read packet from RX queues. */
592 for (portid = 0; portid < ptp_enabled_port_nb; portid++) {
594 portid = ptp_enabled_ports[portid];
595 nb_rx = rte_eth_rx_burst(portid, 0, &m, 1);
597 if (likely(nb_rx == 0))
600 if (m->ol_flags & PKT_RX_IEEE1588_PTP)
601 parse_ptp_frames(portid, m);
609 print_usage(const char *prgname)
611 printf("%s [EAL options] -- -p PORTMASK -T VALUE\n"
612 " -T VALUE: 0 - Disable, 1 - Enable Linux Clock"
613 " Synchronization (0 default)\n"
614 " -p PORTMASK: hexadecimal bitmask of ports to configure\n",
619 ptp_parse_portmask(const char *portmask)
624 /* Parse the hexadecimal string. */
625 pm = strtoul(portmask, &end, 16);
627 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
637 parse_ptp_kernel(const char *param)
642 /* Parse the hexadecimal string. */
643 pm = strtoul(param, &end, 16);
645 if ((param[0] == '\0') || (end == NULL) || (*end != '\0'))
653 /* Parse the commandline arguments. */
655 ptp_parse_args(int argc, char **argv)
660 char *prgname = argv[0];
661 static struct option lgopts[] = { {NULL, 0, 0, 0} };
665 while ((opt = getopt_long(argc, argvopt, "p:T:",
666 lgopts, &option_index)) != EOF) {
672 ptp_enabled_port_mask = ptp_parse_portmask(optarg);
673 if (ptp_enabled_port_mask == 0) {
674 printf("invalid portmask\n");
675 print_usage(prgname);
679 /* Time synchronization. */
681 ret = parse_ptp_kernel(optarg);
683 print_usage(prgname);
687 ptp_data.kernel_time_set = ret;
691 print_usage(prgname);
696 argv[optind-1] = prgname;
698 optind = 1; /* Reset getopt lib. */
704 * The main function, which does initialization and calls the per-lcore
708 main(int argc, char *argv[])
714 /* Initialize the Environment Abstraction Layer (EAL). */
715 int ret = rte_eal_init(argc, argv);
718 rte_exit(EXIT_FAILURE, "Error with EAL initialization\n");
720 memset(&ptp_data, '\0', sizeof(struct ptpv2_data_slave_ordinary));
725 ret = ptp_parse_args(argc, argv);
727 rte_exit(EXIT_FAILURE, "Error with PTP initialization\n");
729 /* Check that there is an even number of ports to send/receive on. */
730 nb_ports = rte_eth_dev_count();
732 /* Creates a new mempool in memory to hold the mbufs. */
733 mbuf_pool = rte_pktmbuf_pool_create("MBUF_POOL", NUM_MBUFS * nb_ports,
734 MBUF_CACHE_SIZE, 0, RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
736 if (mbuf_pool == NULL)
737 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
739 /* Initialize all ports. */
740 for (portid = 0; portid < nb_ports; portid++) {
741 if ((ptp_enabled_port_mask & (1 << portid)) != 0) {
742 if (port_init(portid, mbuf_pool) == 0) {
743 ptp_enabled_ports[ptp_enabled_port_nb] = portid;
744 ptp_enabled_port_nb++;
746 rte_exit(EXIT_FAILURE,
747 "Cannot init port %"PRIu8 "\n",
751 printf("Skipping disabled port %u\n", portid);
754 if (ptp_enabled_port_nb == 0) {
755 rte_exit(EXIT_FAILURE,
756 "All available ports are disabled."
757 " Please set portmask.\n");
760 if (rte_lcore_count() > 1)
761 printf("\nWARNING: Too many lcores enabled. Only 1 used.\n");
763 /* Call lcore_main on the master core only. */