Merge branch 'for-linus' into next
[linux-2.6-microblaze.git] / Documentation / networking / devlink / mlx4.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 ====================
4 mlx4 devlink support
5 ====================
6
7 This document describes the devlink features implemented by the ``mlx4``
8 device driver.
9
10 Parameters
11 ==========
12
13 .. list-table:: Generic parameters implemented
14
15    * - Name
16      - Mode
17    * - ``internal_err_reset``
18      - driverinit, runtime
19    * - ``max_macs``
20      - driverinit
21    * - ``region_snapshot_enable``
22      - driverinit, runtime
23
24 The ``mlx4`` driver also implements the following driver-specific
25 parameters.
26
27 .. list-table:: Driver-specific parameters implemented
28    :widths: 5 5 5 85
29
30    * - Name
31      - Type
32      - Mode
33      - Description
34    * - ``enable_64b_cqe_eqe``
35      - Boolean
36      - driverinit
37      - Enable 64 byte CQEs/EQEs, if the FW supports it.
38    * - ``enable_4k_uar``
39      - Boolean
40      - driverinit
41      - Enable using the 4k UAR.
42
43 The ``mlx4`` driver supports reloading via ``DEVLINK_CMD_RELOAD``
44
45 Regions
46 =======
47
48 The ``mlx4`` driver supports dumping the firmware PCI crspace and health
49 buffer during a critical firmware issue.
50
51 In case a firmware command times out, firmware getting stuck, or a non zero
52 value on the catastrophic buffer, a snapshot will be taken by the driver.
53
54 The ``cr-space`` region will contain the firmware PCI crspace contents. The
55 ``fw-health`` region will contain the device firmware's health buffer.
56 Snapshots for both of these regions are taken on the same event triggers.