Mention branches and keyring.
[releases.git] / devlink / mlx5.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 ====================
4 mlx5 devlink support
5 ====================
6
7 This document describes the devlink features implemented by the ``mlx5``
8 device driver.
9
10 Parameters
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
31 The ``mlx5`` driver also implements the following driver-specific
32 parameters.
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
58 The ``mlx5`` driver supports reloading via ``DEVLINK_CMD_RELOAD``
59
60 Info versions
61 =============
62
63 The ``mlx5`` driver reports the following versions
64
65 .. list-table:: devlink info versions implemented
66    :widths: 5 5 90
67
68    * - Name
69      - Type
70      - Description
71    * - ``fw.psid``
72      - fixed
73      - Used to represent the board id of the device.
74    * - ``fw.version``
75      - stored, running
76      - Three digit major.minor.subminor firmware version number.