networking/devlink/mlx5.rst

1 .. SPDX-License-Identifier: GPL-2.0
13 .. list-table:: Generic parameters implemented
15    * - Name
16      - Mode
17      - Validation
18    * - ``enable_roce``
19      - driverinit
20      - Type: Boolean
24        driver stack. When RoCE is disabled at the driver level, only raw
26    * - ``io_eq_size``
27      - driverinit
28      - The range is between 64 and 4096.
29    * - ``event_eq_size``
30      - driverinit
31      - The range is between 64 and 4096.
32    * - ``max_macs``
33      - driverinit
34      - The range is between 1 and 2^31. Only power of 2 values are supported.
36 The ``mlx5`` driver also implements the following driver-specific
39 .. list-table:: Driver-specific parameters implemented
42    * - Name
43      - Type
44      - Mode
45      - Description
46    * - ``flow_steering_mode``
47      - string
48      - runtime
49      - Controls the flow steering mode of the driver
59    * - ``fdb_large_groups``
60      - u32
61      - driverinit
62      - Control the number of large groups (size > 1) in the FDB table.
65    * - ``esw_multiport``
66      - Boolean
67      - runtime
68      - Control MultiPort E-Switch shared fdb mode.
70        An experimental mode where a single E-Switch is used and all the vports
76        Note: Future devices, ConnectX-8 and onward, will eventually have this
78        E-switch environment and the dual E-switch mode will likely get
82    * - ``esw_port_metadata``
83      - Boolean
84      - runtime
85      - When applicable, disabling eswitch metadata can increase packet rate up
89        with metadata. Metadata tagging must be enabled for multi-port RoCE,
91        enabled on the supported devices in E-switch. Metadata is applicable only
92        for E-switch in switchdev mode and users may disable it when NONE of the
94        1. HCA is in Dual/multi-port RoCE mode.
104    * - ``hairpin_num_queues``
105      - u32
106      - driverinit
107      - We refer to a TC NIC rule that involves forwarding as "hairpin".
112    * - ``hairpin_queue_size``
113      - u32
114      - driverinit
115      - Control the size (in packets) of the hairpin queues.
124 .. list-table:: devlink info versions implemented
127    * - Name
128      - Type
129      - Description
130    * - ``fw.psid``
131      - fixed
132      - Used to represent the board id of the device.
133    * - ``fw.version``
134      - stored, running
135      - Three digit major.minor.subminor firmware version number.
141 -----------
144 - tx timeout
147 - tx error completion
150 - tx PTP port timestamping CQ unhealthy
152     Recover by flushing and re-creating all PTP channels.
159 - Diagnose send queues status::
164    This command has valid output only when interface is up, otherwise the command has empty output.
166 - Show number of tx errors indicated, number of recover flows ended successfully,
171 rx reporter
172 -----------
173 The rx reporter is responsible for reporting and recovering of the following two error scenarios:
175 - rx queues' initialization (population) timeout
176     Population of rx queues' descriptors on ring initialization is done
180 - rx completions with errors (reported by HW on interrupt context)
181     Report on rx completion error.
184 rx reporter also supports on demand diagnose callback, on which it
187 - Diagnose rx queues' status and corresponding completion queue::
189     $ devlink health diagnose pci/0000:82:00.0 reporter rx
192    This command has valid output only when interface is up. Otherwise, the command has empty output.
194 - Show number of rx errors indicated, number of recover flows ended successfully,
197     $ devlink health show pci/0000:82:00.0 reporter rx
200 -----------
209 - Check fw heath status::
213 - Read FW core dump if already stored or trigger new one::
218    This command can run only on the PF which has fw tracer ownership,
222 -----------------
224 It follows fatal errors indications by CR-space dump and recover flow.
225 The CR-space dump uses vsc interface which is valid even if the FW command
234 - Run fw recover flow manually::
238 - Read FW CR-space dump if already stored or trigger new one::
243    This command can run only on PF.
246 -------------
247 The vnic reporter implements only the `diagnose` callback.
253 - total_error_queues
256 - send_queue_priority_update_flow
258 - cq_overrun
260 - async_eq_overrun
262 - comp_eq_overrun
265 - quota_exceeded_command
267 - invalid_command
270 - nic_receive_steering_discard
271         number of packets that completed RX flow
273 - generated_pkt_steering_fail
276 - handled_pkt_steering_fail
283 - Diagnose PF/VF vnic counters::
287 - Diagnose representor vnic counters (performed by supplying devlink port of the