Imported Upstream version 16.04

Change-Id: I77eadcd8538a9122e4773cbe55b24033dc451757
Signed-off-by: C.J. Collier <cjcollier@linuxfoundation.org>

1 files changed, 248 insertions, 0 deletions

diff --git a/app/test-pmd/ieee1588fwd.c b/app/test-pmd/ieee1588fwd.c
new file mode 100644
index 00000000..0d3b37a7
--- /dev/null
+++ b/app/test-pmd/ieee1588fwd.c
@@ -0,0 +1,248 @@
+/*-
+ *   BSD LICENSE
+ *
+ *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
+ *   All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
+ *       distribution.
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
+ *       from this software without specific prior written permission.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
+#include <rte_cycles.h>
+#include <rte_ethdev.h>
+
+#include "testpmd.h"
+
+/**
+ * The structure of a PTP V2 packet.
+ *
+ * Only the minimum fields used by the ieee1588 test are represented.
+ */
+struct ptpv2_msg {
+	uint8_t msg_id;
+	uint8_t version; /**< must be 0x02 */
+	uint8_t unused[34];
+};
+
+#define PTP_SYNC_MESSAGE                0x0
+#define PTP_DELAY_REQ_MESSAGE           0x1
+#define PTP_PATH_DELAY_REQ_MESSAGE      0x2
+#define PTP_PATH_DELAY_RESP_MESSAGE     0x3
+#define PTP_FOLLOWUP_MESSAGE            0x8
+#define PTP_DELAY_RESP_MESSAGE          0x9
+#define PTP_PATH_DELAY_FOLLOWUP_MESSAGE 0xA
+#define PTP_ANNOUNCE_MESSAGE            0xB
+#define PTP_SIGNALLING_MESSAGE          0xC
+#define PTP_MANAGEMENT_MESSAGE          0xD
+
+/*
+ * Forwarding of IEEE1588 Precise Time Protocol (PTP) packets.
+ *
+ * In this mode, packets are received one by one and are expected to be
+ * PTP V2 L2 Ethernet frames (with the specific Ethernet type "0x88F7")
+ * containing PTP "sync" messages (version 2 at offset 1, and message ID
+ * 0 at offset 0).
+ *
+ * Check that each received packet is a IEEE1588 PTP V2 packet of type
+ * PTP_SYNC_MESSAGE, and that it has been identified and timestamped
+ * by the hardware.
+ * Check that the value of the last RX timestamp recorded by the controller
+ * is greater than the previous one.
+ *
+ * If everything is OK, send the received packet back on the same port,
+ * requesting for it to be timestamped by the hardware.
+ * Check that the value of the last TX timestamp recorded by the controller
+ * is greater than the previous one.
+ */
+
+static void
+port_ieee1588_rx_timestamp_check(portid_t pi, uint32_t index)
+{
+	struct timespec timestamp = {0, 0};
+
+	if (rte_eth_timesync_read_rx_timestamp(pi, &timestamp, index) < 0) {
+		printf("Port %u RX timestamp registers not valid\n",
+		       (unsigned) pi);
+		return;
+	}
+	printf("Port %u RX timestamp value %lu s %lu ns\n",
+	       (unsigned) pi, timestamp.tv_sec, timestamp.tv_nsec);
+}
+
+#define MAX_TX_TMST_WAIT_MICROSECS 1000 /**< 1 milli-second */
+
+static void
+port_ieee1588_tx_timestamp_check(portid_t pi)
+{
+	struct timespec timestamp = {0, 0};
+	unsigned wait_us = 0;
+
+	while ((rte_eth_timesync_read_tx_timestamp(pi, &timestamp) < 0) &&
+	       (wait_us < MAX_TX_TMST_WAIT_MICROSECS)) {
+		rte_delay_us(1);
+		wait_us++;
+	}
+	if (wait_us >= MAX_TX_TMST_WAIT_MICROSECS) {
+		printf("Port %u TX timestamp registers not valid after "
+		       "%u micro-seconds\n",
+		       (unsigned) pi, (unsigned) MAX_TX_TMST_WAIT_MICROSECS);
+		return;
+	}
+	printf("Port %u TX timestamp value %lu s %lu ns validated after "
+	       "%u micro-second%s\n",
+	       (unsigned) pi, timestamp.tv_sec, timestamp.tv_nsec, wait_us,
+	       (wait_us == 1) ? "" : "s");
+}
+
+static void
+ieee1588_packet_fwd(struct fwd_stream *fs)
+{
+	struct rte_mbuf  *mb;
+	struct ether_hdr *eth_hdr;
+	struct ether_addr addr;
+	struct ptpv2_msg *ptp_hdr;
+	uint16_t eth_type;
+	uint32_t timesync_index;
+
+	/*
+	 * Receive 1 packet at a time.
+	 */
+	if (rte_eth_rx_burst(fs->rx_port, fs->rx_queue, &mb, 1) == 0)
+		return;
+
+	fs->rx_packets += 1;
+
+	/*
+	 * Check that the received packet is a PTP packet that was detected
+	 * by the hardware.
+	 */
+	eth_hdr = rte_pktmbuf_mtod(mb, struct ether_hdr *);
+	eth_type = rte_be_to_cpu_16(eth_hdr->ether_type);
+
+	if (! (mb->ol_flags & PKT_RX_IEEE1588_PTP)) {
+		if (eth_type == ETHER_TYPE_1588) {
+			printf("Port %u Received PTP packet not filtered"
+			       " by hardware\n",
+			       (unsigned) fs->rx_port);
+		} else {
+			printf("Port %u Received non PTP packet type=0x%4x "
+			       "len=%u\n",
+			       (unsigned) fs->rx_port, eth_type,
+			       (unsigned) mb->pkt_len);
+		}
+		rte_pktmbuf_free(mb);
+		return;
+	}
+	if (eth_type != ETHER_TYPE_1588) {
+		printf("Port %u Received NON PTP packet incorrectly"
+		       " detected by hardware\n",
+		       (unsigned) fs->rx_port);
+		rte_pktmbuf_free(mb);
+		return;
+	}
+
+	/*
+	 * Check that the received PTP packet is a PTP V2 packet of type
+	 * PTP_SYNC_MESSAGE.
+	 */
+	ptp_hdr = (struct ptpv2_msg *) (rte_pktmbuf_mtod(mb, char *) +
+					sizeof(struct ether_hdr));
+	if (ptp_hdr->version != 0x02) {
+		printf("Port %u Received PTP V2 Ethernet frame with wrong PTP"
+		       " protocol version 0x%x (should be 0x02)\n",
+		       (unsigned) fs->rx_port, ptp_hdr->version);
+		rte_pktmbuf_free(mb);
+		return;
+	}
+	if (ptp_hdr->msg_id != PTP_SYNC_MESSAGE) {
+		printf("Port %u Received PTP V2 Ethernet frame with unexpected"
+		       " message ID 0x%x (expected 0x0 - PTP_SYNC_MESSAGE)\n",
+		       (unsigned) fs->rx_port, ptp_hdr->msg_id);
+		rte_pktmbuf_free(mb);
+		return;
+	}
+	printf("Port %u IEEE1588 PTP V2 SYNC Message filtered by hardware\n",
+	       (unsigned) fs->rx_port);
+
+	/*
+	 * Check that the received PTP packet has been timestamped by the
+	 * hardware.
+	 */
+	if (! (mb->ol_flags & PKT_RX_IEEE1588_TMST)) {
+		printf("Port %u Received PTP packet not timestamped"
+		       " by hardware\n",
+		       (unsigned) fs->rx_port);
+		rte_pktmbuf_free(mb);
+		return;
+	}
+
+	/* For i40e we need the timesync register index. It is ignored for the
+	 * other PMDs. */
+	timesync_index = mb->timesync & 0x3;
+	/* Read and check the RX timestamp. */
+	port_ieee1588_rx_timestamp_check(fs->rx_port, timesync_index);
+
+	/* Swap dest and src mac addresses. */
+	ether_addr_copy(&eth_hdr->d_addr, &addr);
+	ether_addr_copy(&eth_hdr->s_addr, &eth_hdr->d_addr);
+	ether_addr_copy(&addr, &eth_hdr->s_addr);
+
+	/* Forward PTP packet with hardware TX timestamp */
+	mb->ol_flags |= PKT_TX_IEEE1588_TMST;
+	fs->tx_packets += 1;
+	if (rte_eth_tx_burst(fs->rx_port, fs->tx_queue, &mb, 1) == 0) {
+		printf("Port %u sent PTP packet dropped\n",
+		       (unsigned) fs->rx_port);
+		fs->fwd_dropped += 1;
+		rte_pktmbuf_free(mb);
+		return;
+	}
+
+	/*
+	 * Check the TX timestamp.
+	 */
+	port_ieee1588_tx_timestamp_check(fs->rx_port);
+}
+
+static void
+port_ieee1588_fwd_begin(portid_t pi)
+{
+	rte_eth_timesync_enable(pi);
+}
+
+static void
+port_ieee1588_fwd_end(portid_t pi)
+{
+	rte_eth_timesync_disable(pi);
+}
+
+struct fwd_engine ieee1588_fwd_engine = {
+	.fwd_mode_name  = "ieee1588",
+	.port_fwd_begin = port_ieee1588_fwd_begin,
+	.port_fwd_end   = port_ieee1588_fwd_end,
+	.packet_fwd     = ieee1588_packet_fwd,
+};