pcilmr: Update usage and man: new arguments format and grading

[pciutils.git] / lmr / margin_args.c

diff --git a/lmr/margin_args.c b/lmr/margin_args.c
index 8a6345f6bee86c8588fb574a641d15e11a144ea3..57a1d0aa96db731fec5a2dbccc76b29840348439 100644 (file)
--- a/lmr/margin_args.c
+++ b/lmr/margin_args.c
@@ -16,44 +16,25 @@
 
 const char *usage
   = "! Utility requires preliminary preparation of the system. Refer to the pcilmr man page !\n\n"
-    "Usage:\n"
-    "pcilmr [--margin] [<margining options>] <downstream component> ...\n"
-    "pcilmr --full [<margining options>]\n"
+    "Brief usage (see man for all options):\n"
+    "pcilmr [--margin] [<common options>] <link port> [<link options>] [<link port> [<link "
+    "options>] ...]\n"
+    "pcilmr --full [<common options>]\n"
     "pcilmr --scan\n\n"
-    "Device Specifier:\n"
+    "You can specify Downstream or Upstream Port of the Link.\nPort Specifier:\n"
     "<device/component>:\t[<domain>:]<bus>:<dev>.<func>\n\n"
     "Modes:\n"
     "--margin\t\tMargin selected Links\n"
     "--full\t\t\tMargin all ready for testing Links in the system (one by one)\n"
     "--scan\t\t\tScan for Links available for margining\n\n"
-    "Margining options:\n\n"
-    "Margining Test settings:\n"
-    "-c\t\t\tPrint Device Lane Margining Capabilities only. Do not run margining.\n"
-    "-l <lane>[,<lane>...]\tSpecify lanes for margining. Default: all link lanes.\n"
-    "\t\t\tRemember that Device may use Lane Reversal for Lane numbering.\n"
-    "\t\t\tHowever, utility uses logical lane numbers in arguments and for logging.\n"
-    "\t\t\tUtility will automatically determine Lane Reversal and tune its calls.\n"
-    "-e <errors>\t\tSpecify Error Count Limit for margining. Default: 4.\n"
+    "Margining options (see man for all options):\n\n"
+    "Common (for all specified links) options:\n"
+    "-c\t\t\tPrint Device Lane Margining Capabilities only. Do not run margining.\n\n"
+    "Link specific options:\n"
     "-r <recvn>[,<recvn>...]\tSpecify Receivers to select margining targets.\n"
     "\t\t\tDefault: all available Receivers (including Retimers).\n"
-    "-p <parallel_lanes>\tSpecify number of lanes to margin simultaneously.\n"
-    "\t\t\tDefault: 1.\n"
-    "\t\t\tAccording to spec it's possible for Receiver to margin up\n"
-    "\t\t\tto MaxLanes + 1 lanes simultaneously, but usually this works\n"
-    "\t\t\tbad, so this option is for experiments mostly.\n"
-    "-T\t\t\tTime Margining will continue until the Error Count is no more\n"
-    "\t\t\tthan an Error Count Limit. Use this option to find Link limit.\n"
-    "-V\t\t\tSame as -T option, but for Voltage.\n"
     "-t <steps>\t\tSpecify maximum number of steps for Time Margining.\n"
-    "-v <steps>\t\tSpecify maximum number of steps for Voltage Margining.\n"
-    "Use only one of -T/-t options at the same time (same for -V/-v).\n"
-    "Without these options utility will use MaxSteps from Device\n"
-    "capabilities as test limit.\n\n"
-    "Margining Log settings:\n"
-    "-o <directory>\t\tSave margining results in csv form into the\n"
-    "\t\t\tspecified directory. Utility will generate file with the\n"
-    "\t\t\tname in form of 'lmr_<downstream component>_Rx#_<timestamp>.csv'\n"
-    "\t\t\tfor each successfully tested receiver.\n";
+    "-v <steps>\t\tSpecify maximum number of steps for Voltage Margining.\n";
 
 static struct pci_dev *
 dev_for_filter(struct pci_access *pacc, char *filter)