Skip to content

Commit 451c790

Browse files
committed
Merge branch 'devlink-documentation-refactor'
Jacob Keller says: ==================== devlink documentation refactor This series updates the devlink documentation, with a few primary goals * move all of the devlink documentation into a dedicated subfolder * convert that documentation to the reStructuredText format * merge driver-specific documentations into a single file per driver * add missing documentation, including per-driver and devlink generally For each driver, I took the time to review the code and add further documentation on the various features it currently supports. Additionally, I added new documentation files for some of the features such as devlink-dpipe, devlink-resource, and devlink-regions. Note for the region snapshot triggering, I kept that as a separate patch as that is based on work that has not yet been merged to net-next, and may change. I also improved the existing documentation for devlink-info and devlink-param by adding a bit more of an introduction when converting it to the rst format. ==================== Signed-off-by: David S. Miller <[email protected]>
2 parents efa193b + 9cd3e2c commit 451c790

33 files changed

+1208
-317
lines changed

Documentation/networking/device_drivers/ti/cpsw_switchdev.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ but without enabling "switch" mode, or to different bridges.
3939

4040
Devlink configuration parameters
4141
====================
42-
See Documentation/networking/devlink-params-ti-cpsw-switch.txt
42+
See Documentation/networking/devlink/ti-cpsw-switch.rst
4343

4444
====================
4545
# Bridging in dual mac mode

Documentation/networking/devlink-health.txt

Lines changed: 0 additions & 86 deletions
This file was deleted.

Documentation/networking/devlink-info-versions.rst

Lines changed: 0 additions & 64 deletions
This file was deleted.

Documentation/networking/devlink-params-bnxt.txt

Lines changed: 0 additions & 18 deletions
This file was deleted.

Documentation/networking/devlink-params-mlx5.txt

Lines changed: 0 additions & 17 deletions
This file was deleted.

Documentation/networking/devlink-params-mlxsw.txt

Lines changed: 0 additions & 10 deletions
This file was deleted.

Documentation/networking/devlink-params-mv88e6xxx.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

Documentation/networking/devlink-params-nfp.txt

Lines changed: 0 additions & 5 deletions
This file was deleted.

Documentation/networking/devlink-params-ti-cpsw-switch.txt

Lines changed: 0 additions & 10 deletions
This file was deleted.

Documentation/networking/devlink-params.txt

Lines changed: 0 additions & 71 deletions
This file was deleted.

Documentation/networking/devlink-trap-netdevsim.rst

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
====================
4+
bnxt devlink support
5+
====================
6+
7+
This document describes the devlink features implemented by the ``bnxt``
8+
device driver.
9+
10+
Parameters
11+
==========
12+
13+
.. list-table:: Generic parameters implemented
14+
15+
* - Name
16+
- Mode
17+
* - ``enable_sriov``
18+
- Permanent
19+
* - ``ignore_ari``
20+
- Permanent
21+
* - ``msix_vec_per_pf_max``
22+
- Permanent
23+
* - ``msix_vec_per_pf_min``
24+
- Permanent
25+
26+
The ``bnxt`` driver also implements the following driver-specific
27+
parameters.
28+
29+
.. list-table:: Driver-specific parameters implemented
30+
:widths: 5 5 5 85
31+
32+
* - Name
33+
- Type
34+
- Mode
35+
- Description
36+
* - ``gre_ver_check``
37+
- Boolean
38+
- Permanent
39+
- Generic Routing Encapsulation (GRE) version check will be enabled in
40+
the device. If disabled, the device will skip the version check for
41+
incoming packets.

0 commit comments

Comments
 (0)