Add Link error injection commands

Chetana2791 · BenReed161 · commit 3beebe7ed521 · 2025-06-10T09:37:50.000-07:00
Add new link error injection commands introduced with gen5 allows the
user to inject a link error into a physical port.
List of Errors:
 - DLLP
 - DLLP CRC
 - TLP LCRC
 - TLP seq num err
 - ACK/NAK err
 - Credit timeout err

Include the inject header file for switchtec library to invoke
the link inject error options.
diff --git a/cli/diag.c b/cli/diag.c
@@ -2194,6 +2194,160 @@ static int aer_event_gen(int argc, char **argv)
 	return 0;
 }
 
+#define CMD_DESC_LNKERR_INJECT "Inject a link error"
+
+static int linkerr_inject(int argc, char ** argv)
+{
+	int ret = 0;
+	uint32_t * dllp_data_dword = NULL;
+	int num_dwords = 0;
+	static struct {
+		struct switchtec_dev *dev;
+		int inject_dllp;
+		int inject_dllp_crc;
+		int inject_tlp_lcrc;
+		int inject_tlp_seq;
+		int inject_nack;
+		int inject_cto;
+		uint8_t enable;
+		uint8_t count;
+		uint16_t dllp_rate;
+		uint16_t tlp_rate;
+		uint16_t seq_num;
+		char * dllp_data;
+		int phy_port;
+	} cfg = {};
+
+	const struct argconfig_options opts[] = {
+		DEVICE_OPTION,
+		{"dllp", 'd', "", CFG_NONE, &cfg.inject_dllp, 
+		 no_argument, "Inject a DLLP"},
+		{"dllp-crc", 'D', "", CFG_NONE, &cfg.inject_dllp_crc, 
+		 no_argument, "Inject a DLLP CRC error"},
+		{"tlp-lcrc", 'l', "", CFG_NONE, &cfg.inject_tlp_lcrc, 
+		 no_argument, "Inject a TLP LCRC error"},
+		{"tlp-seq", 's', "", CFG_NONE, &cfg.inject_tlp_seq, 
+		 no_argument, "Inject a TLP Sequence Number error"},
+		{"nack", 'n', "", CFG_NONE, &cfg.inject_nack, no_argument,
+		 "Inject an ACK to NACK error"},
+		{"cto", 't', "", CFG_NONE, &cfg.inject_cto, no_argument,
+		 "Inject a TLP Credit Timeout"},
+		{"port", 'p', "", CFG_NONNEGATIVE, &cfg.phy_port, 
+		 required_argument, "physical port ID, default: port 0"},
+		{"enable", 'e', "", CFG_NONNEGATIVE, &cfg.enable, 
+		 required_argument, "enable DLLP CRC Error Injection or TLP LCRC Error Injection, default: 0"},
+		{"data", 'i', "", CFG_STRING, &cfg.dllp_data, required_argument,
+		 "DLLP data to inject, a single dword in hex prefixed with \"0x\""},
+		{"seq_num", 'S', "", CFG_NONNEGATIVE, &cfg.seq_num, 
+		 required_argument, "sequence number of ACK to be replaced by NACK (0-4095)"},
+		{"count", 'c', "", CFG_NONNEGATIVE, &cfg.count, 
+		 required_argument, "number of times to replace ACK with NACK (0-255)"},
+		{"dllp-crc-rate", 'r', "", CFG_NONNEGATIVE, &cfg.dllp_rate, 
+		 required_argument, "valid range (0-4096). errors are injected at intervals of rate x 256 x clk "},
+		{"tlp-lcrc-rate", 'R', "", CFG_NONNEGATIVE, &cfg.tlp_rate, 
+		 required_argument, "valid range (0-7). Ex. rate = 1 -> every other TLP has an error"},
+		{NULL}
+	};
+
+	argconfig_parse(argc, argv, CMD_DESC_LNKERR_INJECT, opts, &cfg, 
+			sizeof(cfg));
+
+	uint8_t *ptr = (uint8_t *)&cfg + 5;
+	int total_en = 0;
+	for (size_t i = 0; i < 6; i++) {
+		ptr += 3;
+		if (ptr[i] == 1)
+			total_en++;
+	}
+	if (total_en > 1) {
+		fprintf(stderr, "Cannot enable more than one link error injection command at a time.\n");
+		return -1;
+	}
+	if (total_en == 0) {
+		fprintf(stderr, "Must enable one link error injection command.\n");
+		return -1;
+	}
+
+	if (cfg.enable && !(cfg.inject_dllp_crc || cfg.inject_tlp_lcrc))
+		printf("Ignoring -e enable flag, not valid for the currently selected command.\n");
+	if (!cfg.inject_nack && cfg.count)
+		printf("Ignoring -c flag, not valid for the currently selected command.\n");
+	if (!cfg.inject_nack && cfg.seq_num)
+		printf("Ignoring -S flag, not valid for the currently selected command.\n");
+	if (!cfg.inject_tlp_lcrc && cfg.tlp_rate)
+		printf("Ignoring -R flag, not valid for the currently selected command.\n");
+	if (!cfg.inject_dllp_crc && cfg.dllp_rate)
+		printf("Ignoring -r flag, not valid for the currently selected command.\n");
+	if (!cfg.inject_dllp && cfg.dllp_data) {
+		printf("Ignoring -i flag, not valid for the currently selected command.\n");
+	} else if (cfg.inject_dllp && cfg.dllp_data) {
+		ret = convert_str_to_dwords(cfg.dllp_data, &dllp_data_dword, 
+				    &num_dwords);
+		if (ret) {
+			fprintf(stderr, "Error with DLLP data provided\n");
+			return -1;
+		}
+		if (num_dwords == 0) {
+			fprintf(stderr, "Must provide a single valid DLLP data dword\n");
+			free(dllp_data_dword);
+			return -1;
+		}
+	}
+
+	if (cfg.dllp_rate && cfg.tlp_rate) {
+		fprintf(stderr, "Cannot enable both rate configurations.\n");
+		return -1;
+	}
+
+	if (cfg.inject_dllp) {
+		ret = switchtec_inject_err_dllp(cfg.dev, cfg.phy_port, 
+						cfg.dllp_data != NULL ? *dllp_data_dword : 0);
+		free(dllp_data_dword);
+	}
+	if (cfg.inject_dllp_crc) {
+		if (cfg.dllp_rate > 4096) {
+			fprintf(stderr, "DLLP CRC rate out of range. Valid range is 0-4095.\n");
+			return -1;
+		}
+		ret = switchtec_inject_err_dllp_crc(cfg.dev, cfg.phy_port, 
+						    cfg.enable, cfg.dllp_rate);
+	}
+	if (cfg.inject_tlp_lcrc) {
+		if (cfg.tlp_rate > 7) {
+			fprintf(stderr, "TLP LCRC rate out of range. Valid range is 0-7.\n");
+			return -1;
+		}
+		ret = switchtec_inject_err_tlp_lcrc(cfg.dev, cfg.phy_port, 
+						    cfg.enable, cfg.tlp_rate);
+		if (ret)
+			return -1;
+	}
+	if (cfg.inject_tlp_seq)
+		ret = switchtec_inject_err_tlp_seq_num(cfg.dev, cfg.phy_port);
+	if (cfg.inject_nack) {
+		if (cfg.seq_num > 4095) {
+			fprintf(stderr, "Sequence number out of range. Valid range is 0-4095).\n");
+			return -1;
+		}
+		if (cfg.count > 255) {
+			fprintf(stderr, "Count out of range. Valid range is 0-255\n");
+			return -1;
+		}
+		ret = switchtec_inject_err_ack_nack(cfg.dev, cfg.phy_port, 
+						    cfg.seq_num, cfg.count);
+	}
+	if (cfg.inject_cto) {
+		if (!switchtec_is_gen5(cfg.dev)) {
+			fprintf(stderr, "Credit timeout error injection is only supported on Gen5.\n");
+			return -1;
+		}
+		ret = switchtec_inject_err_cto(cfg.dev, cfg.phy_port);
+	}
+
+	switchtec_perror("linkerr-inject");
+	return ret;
+}
+
 static const struct cmd commands[] = {
 	CMD(crosshair,		CMD_DESC_CROSS_HAIR),
 	CMD(eye,		CMD_DESC_EYE),
@@ -2209,6 +2363,7 @@ static const struct cmd commands[] = {
 	CMD(ltssm_log,		CMD_DESC_LTSSM_LOG),
 	CMD(tlp_inject,		CMD_TLP_INJECT),
 	CMD(aer_event_gen,	CMD_DESC_AER_EVENT_GEN),
+	CMD(linkerr_inject,	CMD_DESC_LNKERR_INJECT),
 	{}
 };
 
diff --git a/inc/switchtec/inject.h b/inc/switchtec/inject.h
@@ -0,0 +1,79 @@
+/*
+ * Microsemi Switchtec(tm) PCIe Management Library
+ * Copyright (c) 2025, Microsemi Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ *
+ */
+
+#include <switchtec/switchtec.h>
+#include <stdint.h>
+
+struct switchtec_lnkerr_dllp_in {
+	uint8_t subcmd;
+	uint8_t phys_port_id;
+	uint8_t resvd[2];
+	uint32_t data;
+};
+
+struct switchtec_lnkerr_dllp_crc_in {
+	uint8_t subcmd;
+	uint8_t phys_port_id;
+	uint8_t enable;
+	uint8_t resvd1;
+	uint16_t rate;
+	uint8_t resvd2[2];
+};
+
+struct switchtec_lnkerr_tlp_lcrc_gen5_in {
+	uint8_t subcmd;
+	uint8_t phys_port_id;
+	uint8_t enable;
+	uint8_t resvd1;
+	uint8_t rate;
+	uint8_t resvd[3];
+};
+
+struct switchtec_lnkerr_tlp_lcrc_gen4_in {
+	uint8_t subcmd;
+	uint8_t phys_port_id;
+	uint8_t enable;
+	uint8_t rate;
+};
+
+struct switchtec_lnkerr_tlp_seqn_in {
+	uint8_t subcmd;
+	uint8_t phys_port_id;
+	uint8_t resvd[2];
+};
+
+struct switchtec_lnkerr_ack_nack_in {
+	uint8_t subcmd;
+	uint8_t phys_port_id;
+	uint8_t resvd1[2];
+	uint16_t seq_num;
+	uint8_t count;
+	uint8_t resvd2;
+};
+
+struct switchtec_lnkerr_cto_in {
+	uint8_t subcmd;
+	uint8_t phys_port_id;
+	uint8_t resvd[2];
+};
diff --git a/inc/switchtec/mrpc.h b/inc/switchtec/mrpc.h
@@ -283,6 +283,13 @@ enum mrpc_sub_cmd {
 	MRPC_LTMON_LOG_DUMP_GEN4 = 15,
 	MRPC_LTMON_GET_STATUS_GEN5 = 20,
 	MRPC_LTMON_LOG_DUMP_GEN5 = 21,
+	
+	MRPC_ERR_INJ_DLLP = 0,
+	MRPC_ERR_INJ_DLLP_CRC = 1,
+	MRPC_ERR_INJ_TLP_LCRC = 2,
+	MRPC_ERR_INJ_TLP_SEQ = 3,
+	MRPC_ERR_INJ_ACK_NACK = 4,
+	MRPC_ERR_INJ_CTO = 5,
 };
 
 #endif
diff --git a/inc/switchtec/switchtec.h b/inc/switchtec/switchtec.h
@@ -35,6 +35,7 @@
 #include "portable.h"
 #include "registers.h"
 #include "utils.h"
+#include "inject.h"
 
 #include <stdbool.h>
 #include <stdlib.h>
@@ -423,6 +424,22 @@ int switchtec_calc_lane_mask(struct switchtec_dev *dev, int phys_port_id,
 		int lane_id, int num_lanes, int *lane_mask,
 		struct switchtec_status *port);
 
+/**
+ * @brief Return Link error injection command outputs for DLLP, DLLP_CRC,
+ * LCRC, SEQ_NUM, ACK_NACK, CTO.
+ */
+
+int switchtec_inject_err_dllp(struct switchtec_dev *dev, int phys_port_id,
+                	      int data);
+int switchtec_inject_err_dllp_crc(struct switchtec_dev *dev, int phys_port_id,
+                		  int enable, uint16_t rate);
+int switchtec_inject_err_tlp_lcrc(struct switchtec_dev *dev, int phys_port_id,
+                		  int enable, uint8_t rate);
+int switchtec_inject_err_tlp_seq_num(struct switchtec_dev *dev, int phys_port_id);
+int switchtec_inject_err_ack_nack(struct switchtec_dev *dev, int phys_port_id,
+                		  uint16_t seq_num, uint8_t count);
+int switchtec_inject_err_cto(struct switchtec_dev *dev, int phys_port_id);
+
 /**
  * @brief Return whether a Switchtec device is a Gen 3 device.
  */
diff --git a/lib/diag.c b/lib/diag.c
