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

NAME

6       mstlink - check and debug link status and issues related to them
7

SYNOPSIS

9       mstlink [OPTIONS]
10

DESCRIPTION

12       The  mlxlink tool is used to check and debug link status and issues re‐
13       lated to them.  The tool can be used  on  different  links  and  cables
14       (passive, active, transceiver and backplane).
15

OPTIONS

17       -h |--help
18              : Display help message.
19
20       -v |--version
21              : Display version info.
22
23       -d |--device
24              <device>                :  Perform operation for a specified mst
25              device
26
27       -p |--port
28              <port_number>          : Port Number
29
30       --port_type
31              <port_type>            : Port Type [NETWORK(Default)/PCIE]
32
33       --depth
34              <depth>                : depth level of the DUT of some  hierar‐
35              chy (PCIE only)
36
37       --pcie_index
38              <pcie_index>            : PCIe index number (Internal domain in‐
39              dex) (PCIE only)
40
41       --node <node>                 : the node within each depth (PCIE only)
42
43       --json : Print the output in json format
44
45              QUERIES:
46
47       --show_links
48              : Show valid PCIe links (PCIE only)
49
50       -m |--show_module
51              : Show Module Info
52
53       -c |--show_counters
54              : Show Physical Counters and BER Info
55
56       -e |--show_eye
57              : Show Eye Opening Info
58
59       --show_fec
60              : Show FEC Capabilities
61
62       --show_serdes_tx
63              : Show Transmitter Info
64
65       --show_device
66              : General Device Info
67
68       --show_ber_monitor
69              : Show BER Monitor Info (not supported for HCA)
70
71       --show_external_phy
72              : Show External PHY Info
73
74              COMMANDS:
75
76       -a |--port_state <port_state>
77              : Configure Port State [UP(up)/DN(down)/TG(toggle)]
78
79       -s |--speeds
80              <speeds>               : Configure Speeds [speed1,speed2,...]
81
82       --link_mode_force
83              : Configure Link Mode Force (Disable AN)
84
85       -l |--loopback
86              <loopback>             : Configure Loopback  Mode  [NO(no  loop‐
87              back)/PH(phy loopback)/EX(external loopback)]
88
89       -k |--fec
90              <fec_override>                       :       Configure       FEC
91              [AU(Auto)/NF(No-FEC)/FC(FireCode FEC)/RS(RS-FEC)]
92
93       --fec_speed
94              <fec_speed>                  :   Speed    to    Configure    FEC
95              [100G/50G/25G/...] (Default is Active Speed)
96
97       --serdes_tx
98              <params>                :  Configure Transmitter Parameters [po‐
99              larity,ob_tap0,...]
100
101       --serdes_tx_lane <transmitter_lane>
102              : Transmitter Lane to Set (Optional - Default All Lanes)
103
104       --database
105              : Save Transmitter Configuration for Current  Speed  Permanently
106              (Optional)
107
108       --test_mode
109              <prbs_mode>              :   Physical  Test  Mode  Configuration
110              [EN(enable)/DS(disable)/TU(perform tuning)]
111
112       --rx_prbs
113              <rx_prbs_mode>               :   RX   PRBS   Mode    [PRBS31(De‐
114              fault)/PRBS7/...] (Optional - Default PRBS31)
115
116       --tx_prbs
117              <tx_prbs_mode>                :   TX   PRBS   Mode   [PRBS31(De‐
118              fault)/PRBS7/...] (Optional - Default PRBS31)
119
120       --rx_rate
121              <rx_lane_rate>               :    RX    Lane    Rate    [EDR(De‐
122              fault)/25G/10G/...]  (Optional - Default 25G)
123
124       --tx_rate
125              <tx_lane_rate>                :    TX    Lane    Rate   [EDR(De‐
126              fault)/25G/10G/...]  (Optional - Default 25G)
127
128       -b |--ber_collect <csv_file>
129              : Port Extended Information Collection [CSV File]
130
131       --ber_limit
132              <limit_criteria>           :  BER  Limit  Criteria  [Nominal(De‐
133              fault)/Corner/Drift] (Optional - Default Nominal)
134
135       --iteration
136              <iteration>                : Iteration Number of BER Collection
137
138       --pc   : Clear Counters
139
140       --set_external_phy
141              : Set External PHY (not supported for HCA)
142
143       --twisted_pair_force_mode <twisted_pair_force_mode>
144              : Twisted Pair Force Mode [MA(Master)/SL(Slave)]
145

EXAMPLES

147       get info of <device>, <port_number>
148              :
149
150              mstlink -d <device> -p <port_number>
151
152              get info of <device>, <port_number> and BER Counters:
153
154              mstlink -d <device> -p <port_number> -c
155
156              get info of <device>, <port_number> and Transmitter Parameters:
157
158              mstlink -d <device> -p <port_number> --show_serdes_tx
159
160       Configure Port State
161              :
162
163              mstlink -d <device> -p <port_number> --port_state UP
164
165       Configure Port Speeds
166              :
167
168              mstlink -d <device> -p <port_number> --speeds 25G,50G,100G
169
170       Configure FEC
171              :
172
173              mstlink -d <device> -p <port_number> --fec RS
174
175       Configure Port for Physical Test Mode
176              :
177
178              mstlink  -d  <device> -p <port_number> --test_mode EN (--rx_prbs
179              PRBS31 --rx_rate 25G --tx_prbs PRBS7 --tx_rate 10G)
180
181       Perform PRBS Tuning
182              :
183
184              mstlink -d <device> -p <port_number> --test_mode TU
185
186              Configure Transmitter Parameters (on lane, to database):
187
188              mstlink -d <device>  -p  <port_number>  (--serdes_tx_lane  <lane
189              number>) (--database) \
190                --serdes_tx                                            <polar‐
191              ity>,<ob_tap0>,<ob_tap1>,<ob_tap2>,<ob_bias>,<ob_preemp_mode>
192

SEE ALSO

194       mstflint(1)
195
196
197
198mstflint                          March 2020                        MSTLINK(1)