1MSTLINK,(1)                      User Commands                     MSTLINK,(1)
2
3
4

NAME

6       mstlink,  -  manual  page for mstlink, mstflint 4.14.0, built on Mar  3
7       2020, 14:03:31. Git SHA Hash: N/A
8

DESCRIPTION

10              NAME:
11
12              mstlink
13
14              SYNOPSIS:
15
16              mstlink [OPTIONS]
17
18              DESCRIPTION:
19
20              The mstlink tool is used to check  and  debug  link  status  and
21              issues related to them.  The tool can be used on different links
22              and cables (passive, active, transceiver and backplane).
23
24              OPTIONS:
25
26       -h |--help
27              : Display help message.
28
29       -v |--version
30              : Display version info.
31
32       -d |--device
33              <device>               : Perform operation for a  specified  mst
34              device
35
36       -p |--port
37              <port_number>          : Port Number
38
39       --port_type
40              <port_type>            : Port Type [NETWORK(Default)/PCIE]
41
42       --depth
43              <depth>                 : depth level of the DUT of some hierar‐
44              chy (PCIE only)
45
46       --pcie_index
47              <pcie_index>           :  PCIe  index  number  (Internal  domain
48              index) (PCIE only)
49
50       --node <node>                 : the node within each depth (PCIE only)
51
52       --json : Print the output in json format
53
54              QUERIES:
55
56       --show_links
57              : Show valid PCIe links (PCIE only)
58
59       -m |--show_module
60              : Show Module Info
61
62       -c |--show_counters
63              : Show Physical Counters and BER Info
64
65       -e |--show_eye
66              : Show Eye Opening Info
67
68       --show_fec
69              : Show FEC Capabilities
70
71       --show_serdes_tx
72              : Show Transmitter Info
73
74       --show_device
75              : General Device Info
76
77       --show_ber_monitor
78              : Show BER Monitor Info (not supported for HCA)
79
80       --show_external_phy
81              : Show External PHY Info
82
83              COMMANDS:
84
85       -a |--port_state <port_state>
86              : Configure Port State [UP(up)/DN(down)/TG(toggle)]
87
88       -s |--speeds
89              <speeds>               : Configure Speeds [speed1,speed2,...]
90
91       --link_mode_force
92              : Configure Link Mode Force (Disable AN)
93
94       -l |--loopback
95              <loopback>              :  Configure  Loopback Mode [NO(no loop‐
96              back)/PH(phy loopback)/EX(external loopback)]
97
98       -k |--fec
99              <fec_override>                       :       Configure       FEC
100              [AU(Auto)/NF(No-FEC)/FC(FireCode FEC)/RS(RS-FEC)]
101
102       --fec_speed
103              <fec_speed>                   :    Speed    to   Configure   FEC
104              [100G/50G/25G/...] (Default is Active Speed)
105
106       --serdes_tx
107              <params>                :   Configure   Transmitter   Parameters
108              [polarity,ob_tap0,...]
109
110       --serdes_tx_lane <transmitter_lane>
111              : Transmitter Lane to Set (Optional - Default All Lanes)
112
113       --database
114              :  Save  Transmitter Configuration for Current Speed Permanently
115              (Optional)
116
117       --test_mode
118              <prbs_mode>             :  Physical  Test   Mode   Configuration
119              [EN(enable)/DS(disable)/TU(perform tuning)]
120
121       --rx_prbs
122              <rx_prbs_mode>                   :       RX       PRBS      Mode
123              [PRBS31(Default)/PRBS7/...] (Optional - Default PRBS31)
124
125       --tx_prbs
126              <tx_prbs_mode>                  :       TX       PRBS       Mode
127              [PRBS31(Default)/PRBS7/...] (Optional - Default PRBS31)
128
129       --rx_rate
130              <rx_lane_rate>                   :       RX       Lane      Rate
131              [EDR(Default)/25G/10G/...]  (Optional - Default 25G)
132
133       --tx_rate
134              <tx_lane_rate>                  :       TX       Lane       Rate
135              [EDR(Default)/25G/10G/...]  (Optional - Default 25G)
136
137       -b |--ber_collect <csv_file>
138              : Port Extended Information Collection [CSV File]
139
140       --ber_limit
141              <limit_criteria>             :   BER   Limit   Criteria   [Nomi‐
142              nal(Default)/Corner/Drift] (Optional - Default Nominal)
143
144       --iteration
145              <iteration>                : Iteration Number of BER Collection
146
147       --pc   : Clear Counters
148
149       --set_external_phy
150              : Set External PHY (not supported for HCA)
151
152       --twisted_pair_force_mode <twisted_pair_force_mode>
153              : Twisted Pair Force Mode [MA(Master)/SL(Slave)]
154
155              Examples:
156
157       get info of <device>, <port_number>
158              :
159
160              mstlink -d <device> -p <port_number>
161
162              get info of <device>, <port_number> and BER Counters:
163
164              mstlink -d <device> -p <port_number> -c
165
166              get info of <device>, <port_number> and Transmitter Parameters:
167
168              mstlink -d <device> -p <port_number> --show_serdes_tx
169
170       Configure Port State
171              :
172
173              mstlink -d <device> -p <port_number> --port_state UP
174
175       Configure Port Speeds
176              :
177
178              mstlink -d <device> -p <port_number> --speeds 25G,50G,100G
179
180       Configure FEC
181              :
182
183              mstlink -d <device> -p <port_number> --fec RS
184
185       Configure Port for Physical Test Mode
186              :
187
188              mstlink -d <device> -p <port_number> --test_mode  EN  (--rx_prbs
189              PRBS31 --rx_rate 25G --tx_prbs PRBS7 --tx_rate 10G)
190
191       Perform PRBS Tuning
192              :
193
194              mstlink -d <device> -p <port_number> --test_mode TU
195
196              Configure Transmitter Parameters (on lane, to database):
197
198              mstlink   -d   <device>  -p  <port_number>  --serdes_tx  <polar‐
199              ity>,<ob_tap0>,<ob_tap1>,<ob_tap2>,<ob_bias>,<ob_preemp_mode>
200              (--serdes_tx_lane <lane number>) (--database)
201

SEE ALSO

203       The  full documentation for mstlink, is maintained as a Texinfo manual.
204       If the info and mstlink, programs are properly installed at your  site,
205       the command
206
207              info mstlink,
208
209       should give you access to the complete manual.
210
211
212
213mstlink, mstflint 4.14.0, built onMMaarrch 320220020, 14:03:31. Git SHA HaMsShT:LINN/KA,(1)