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
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
57          is configuring steering rules directly to the HW using Work Queues with
60        SMFS mode is faster and provides better rule insertion rate compared to
62    * - ``fdb_large_groups``
63      - u32
64      - driverinit
65      - Control the number of large groups (size > 1) in the FDB table.
68    * - ``esw_multiport``
69      - Boolean
70      - runtime
71      - Control MultiPort E-Switch shared fdb mode.
73        An experimental mode where a single E-Switch is used and all the vports
74        and physical ports on the NIC are connected to it.
76        An example is to send traffic from a VF that is created on PF0 to an
79        Note: Future devices, ConnectX-8 and onward, will eventually have this
80        as the default to allow forwarding between all NIC ports in a single
81        E-switch environment and the dual E-switch mode will likely get
85    * - ``esw_port_metadata``
86      - Boolean
87      - runtime
88      - When applicable, disabling eswitch metadata can increase packet rate up
89        to 20% depending on the use case and packet sizes.
91        Eswitch port metadata state controls whether to internally tag packets
92        with metadata. Metadata tagging must be enabled for multi-port RoCE,
94        enabled on the supported devices in E-switch. Metadata is applicable only
95        for E-switch in switchdev mode and users may disable it when NONE of the
96        below use cases will be in use:
97        1. HCA is in Dual/multi-port RoCE mode.
101        When metadata is disabled, the above use cases will fail to initialize if
102        users try to enable them.
107    * - ``hairpin_num_queues``
108      - u32
109      - driverinit
110      - We refer to a TC NIC rule that involves forwarding as "hairpin".
111        Hairpin queues are mlx5 hardware specific implementation for hardware
114        Control the number of hairpin queues.
115    * - ``hairpin_queue_size``
116      - u32
117      - driverinit
118      - Control the size (in packets) of the hairpin queues.
127 .. list-table:: devlink info versions implemented
130    * - Name
131      - Type
132      - Description
133    * - ``fw.psid``
134      - fixed
135      - Used to represent the board id of the device.
136    * - ``fw.version``
137      - stored, running
138      - Three digit major.minor.subminor firmware version number.
143 tx reporter
144 -----------
145 The tx reporter is responsible for reporting and recovering of the following three error scenarios:
147 - tx timeout
148     Report on kernel tx timeout detection.
150 - tx error completion
151     Report on error tx completion.
152     Recover by flushing the tx queue and reset it.
153 - tx PTP port timestamping CQ unhealthy
155     Recover by flushing and re-creating all PTP channels.
157 tx reporter also support on demand diagnose callback, on which it provides
158 real time information of its send queues status.
162 - Diagnose send queues status::
164     $ devlink health diagnose pci/0000:82:00.0 reporter tx
169 - Show number of tx errors indicated, number of recover flows ended successfully,
172     $ devlink health show pci/0000:82:00.0 reporter tx
175 -----------
178 - rx queues' initialization (population) timeout
179     Population of rx queues' descriptors on ring initialization is done
180     in napi context via triggering an irq. In case of a failure to get
183 - rx completions with errors (reported by HW on interrupt context)
188 provides real time information of its receive queues' status.
190 - Diagnose rx queues' status and corresponding completion queue::
197 - Show number of rx errors indicated, number of recover flows ended successfully,
203 -----------
207 The fw reporter diagnose command can be triggered any time by the user to check
212 - Check fw heath status::
216 - Read FW core dump if already stored or trigger new one::
225 -----------------
227 It follows fatal errors indications by CR-space dump and recover flow.
228 The CR-space dump uses vsc interface which is valid even if the FW command
237 - Run fw recover flow manually::
241 - Read FW CR-space dump if already stored or trigger new one::
249 -------------
256 - total_error_queues
257         number of queues in an error state due to
259 - send_queue_priority_update_flow
261 - cq_overrun
262         number of times CQ entered an error state due to an overflow.
263 - async_eq_overrun
264         number of times an EQ mapped to async events was overrun.
265 - comp_eq_overrun
266         number of times an EQ mapped to completion events was
268 - quota_exceeded_command
269         number of commands issued and failed due to quota exceeded.
270 - invalid_command
271         number of commands issued and failed dues to any reason other than quota
273 - nic_receive_steering_discard
275         steering but were discarded due to a mismatch in flow table.
276 - generated_pkt_steering_fail
279 - handled_pkt_steering_fail
283 - icm_consumption
290 - Diagnose PF/VF vnic counters::
294 - Diagnose representor vnic counters (performed by supplying devlink port of the