1.. SPDX-License-Identifier: GPL-2.0
2
3====================
4mlx5 devlink support
5====================
6
7This document describes the devlink features implemented by the ``mlx5``
8device driver.
9
10Parameters
11==========
12
13.. list-table:: Generic parameters implemented
14
15   * - Name
16     - Mode
17     - Validation
18   * - ``enable_roce``
19     - driverinit
20     - Type: Boolean
21   * - ``io_eq_size``
22     - driverinit
23     - The range is between 64 and 4096.
24   * - ``event_eq_size``
25     - driverinit
26     - The range is between 64 and 4096.
27   * - ``max_macs``
28     - driverinit
29     - The range is between 1 and 2^31. Only power of 2 values are supported.
30
31The ``mlx5`` driver also implements the following driver-specific
32parameters.
33
34.. list-table:: Driver-specific parameters implemented
35   :widths: 5 5 5 85
36
37   * - Name
38     - Type
39     - Mode
40     - Description
41   * - ``flow_steering_mode``
42     - string
43     - runtime
44     - Controls the flow steering mode of the driver
45
46       * ``dmfs`` Device managed flow steering. In DMFS mode, the HW
47         steering entities are created and managed through firmware.
48       * ``smfs`` Software managed flow steering. In SMFS mode, the HW
49         steering entities are created and manage through the driver without
50         firmware intervention.
51   * - ``fdb_large_groups``
52     - u32
53     - driverinit
54     - Control the number of large groups (size > 1) in the FDB table.
55
56       * The default value is 15, and the range is between 1 and 1024.
57   * - ``esw_multiport``
58     - Boolean
59     - runtime
60     - Control MultiPort E-Switch shared fdb mode.
61
62       An experimental mode where a single E-Switch is used and all the vports
63       and physical ports on the NIC are connected to it.
64
65       An example is to send traffic from a VF that is created on PF0 to an
66       uplink that is natively associated with the uplink of PF1
67
68       Note: Future devices, ConnectX-8 and onward, will eventually have this
69       as the default to allow forwarding between all NIC ports in a single
70       E-switch environment and the dual E-switch mode will likely get
71       deprecated.
72
73       Default: disabled
74
75
76The ``mlx5`` driver supports reloading via ``DEVLINK_CMD_RELOAD``
77
78Info versions
79=============
80
81The ``mlx5`` driver reports the following versions
82
83.. list-table:: devlink info versions implemented
84   :widths: 5 5 90
85
86   * - Name
87     - Type
88     - Description
89   * - ``fw.psid``
90     - fixed
91     - Used to represent the board id of the device.
92   * - ``fw.version``
93     - stored, running
94     - Three digit major.minor.subminor firmware version number.
95