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        SMFS mode is faster and provides better rule insertion rate compared to
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
71        and physical ports on the NIC are connected to it.
73        An example is to send traffic from a VF that is created on PF0 to an
76        Note: Future devices, ConnectX-8 and onward, will eventually have this
77        as the default to allow forwarding between all NIC ports in a single
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
86        to 20% depending on the use case and packet sizes.
88        Eswitch port metadata state controls whether to internally tag packets
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
93        below use cases will be in use:
94        1. HCA is in Dual/multi-port RoCE mode.
98        When metadata is disabled, the above use cases will fail to initialize if
99        users try to enable them.
100    * - ``hairpin_num_queues``
101      - u32
102      - driverinit
103      - We refer to a TC NIC rule that involves forwarding as "hairpin".
104        Hairpin queues are mlx5 hardware specific implementation for hardware
107        Control the number of hairpin queues.
108    * - ``hairpin_queue_size``
109      - u32
110      - driverinit
111      - Control the size (in packets) of the hairpin queues.
120 .. list-table:: devlink info versions implemented
123    * - Name
124      - Type
125      - Description
126    * - ``fw.psid``
127      - fixed
128      - Used to represent the board id of the device.
129    * - ``fw.version``
130      - stored, running
131      - Three digit major.minor.subminor firmware version number.
136 tx reporter
137 -----------
138 The tx reporter is responsible for reporting and recovering of the following three error scenarios:
140 - tx timeout
141     Report on kernel tx timeout detection.
143 - tx error completion
144     Report on error tx completion.
145     Recover by flushing the tx queue and reset it.
146 - tx PTP port timestamping CQ unhealthy
148     Recover by flushing and re-creating all PTP channels.
150 tx reporter also support on demand diagnose callback, on which it provides
151 real time information of its send queues status.
155 - Diagnose send queues status::
157     $ devlink health diagnose pci/0000:82:00.0 reporter tx
162 - Show number of tx errors indicated, number of recover flows ended successfully,
165     $ devlink health show pci/0000:82:00.0 reporter tx
168 -----------
171 - rx queues' initialization (population) timeout
172     Population of rx queues' descriptors on ring initialization is done
173     in napi context via triggering an irq. In case of a failure to get
176 - rx completions with errors (reported by HW on interrupt context)
181 provides real time information of its receive queues' status.
183 - Diagnose rx queues' status and corresponding completion queue::
190 - Show number of rx errors indicated, number of recover flows ended successfully,
196 -----------
200 The fw reporter diagnose command can be triggered any time by the user to check
205 - Check fw heath status::
209 - Read FW core dump if already stored or trigger new one::
218 -----------------
220 It follows fatal errors indications by CR-space dump and recover flow.
221 The CR-space dump uses vsc interface which is valid even if the FW command
230 - Run fw recover flow manually::
234 - Read FW CR-space dump if already stored or trigger new one::
242 -------------
249 - total_q_under_processor_handle
250         number of queues in an error state due to
252 - send_queue_priority_update_flow
254 - cq_overrun
255         number of times CQ entered an error state due to an overflow.
256 - async_eq_overrun
257         number of times an EQ mapped to async events was overrun.
258         comp_eq_overrun number of times an EQ mapped to completion events was
260 - quota_exceeded_command
261         number of commands issued and failed due to quota exceeded.
262 - invalid_command
263         number of commands issued and failed dues to any reason other than quota
265 - nic_receive_steering_discard
267         steering but were discarded due to a mismatch in flow table.
268 - generated_pkt_steering_fail
271 - handled_pkt_steering_fail
278 - Diagnose PF/VF vnic counters::
282 - Diagnose representor vnic counters (performed by supplying devlink port of the