-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
devlink: convert driver-specific files to reStructuredText
Several drivers document what parameters they support in a devlink-params-*.txt file. This file is supposed to contain both the list of generic parameters implemented by the driver, as well as a list of driver-specific parameters and their descriptions. It would also be good if the driver documentation included other driver-specific implementations, such as info versions, devlink regions, and so forth. Convert all of these documentation files to reStructuredText, and rename them to just the driver name. Future changes will include other driver-specific implementations. Each file will contain a table for the generic parameters implemented, as well as a separate table for the driver-specific parameters. Future sections such as for devlink info versions will be added to these files. This avoids creating additional devlink-<feature>-<driver> files for each devlink feature, reducing clutter in the documentation folder. Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> Cc: Tariq Toukan <tariqt@mellanox.com> Cc: Saeed Mahameed <saeedm@mellanox.com> Cc: Leon Romanovsky <leonro@mellanox.com> Cc: Michael Chan <michael.chan@broadcom.com> Cc: Andrew Lunn <andrew@lunn.ch> Cc: Vivien Didelot <vivien.didelot@gmail.com> Cc: Jiri Pirko <jiri@mellanox.com> Cc: Ido Schimmel <idosch@mellanox.com> Cc: Jakub Kicinski <jakub.kicinski@netronome.com> Cc: Grygorii Strashko <grygorii.strashko@ti.com> Signed-off-by: David S. Miller <davem@davemloft.net>
- Loading branch information
Jacob Keller
authored and
David S. Miller
committed
Jan 11, 2020
1 parent
5948f85
commit 6c39e01
Showing
15 changed files
with
222 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
.. SPDX-License-Identifier: GPL-2.0 | ||
==================== | ||
bnxt devlink support | ||
==================== | ||
|
||
This document describes the devlink features implemented by the ``bnxt`` | ||
device driver. | ||
|
||
Parameters | ||
========== | ||
|
||
.. list-table:: Generic parameters implemented | ||
|
||
* - Name | ||
- Mode | ||
* - ``enable_sriov`` | ||
- Permanent | ||
* - ``ignore_ari`` | ||
- Permanent | ||
* - ``msix_vec_per_pf_max`` | ||
- Permanent | ||
* - ``msix_vec_per_pf_min`` | ||
- Permanent | ||
|
||
The ``bnxt`` driver also implements the following driver-specific | ||
parameters. | ||
|
||
.. list-table:: Driver-specific parameters implemented | ||
:widths: 5 5 5 85 | ||
|
||
* - Name | ||
- Type | ||
- Mode | ||
- Description | ||
* - ``gre_ver_check`` | ||
- Boolean | ||
- Permanent | ||
- Generic Routing Encapsulation (GRE) version check will be enabled in | ||
the device. If disabled, the device will skip the version check for | ||
incoming packets. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
7 changes: 0 additions & 7 deletions
7
Documentation/networking/devlink/devlink-params-mv88e6xxx.txt
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
10 changes: 0 additions & 10 deletions
10
Documentation/networking/devlink/devlink-params-ti-cpsw-switch.txt
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
.. SPDX-License-Identifier: GPL-2.0 | ||
==================== | ||
mlx5 devlink support | ||
==================== | ||
|
||
This document describes the devlink features implemented by the ``mlx5`` | ||
device driver. | ||
|
||
Parameters | ||
========== | ||
|
||
.. list-table:: Generic parameters implemented | ||
|
||
* - Name | ||
- Mode | ||
* - ``enable_roce`` | ||
- driverinit | ||
|
||
The ``mlx5`` driver also implements the following driver-specific | ||
parameters. | ||
|
||
.. list-table:: Driver-specific parameters implemented | ||
:widths: 5 5 5 85 | ||
|
||
* - Name | ||
- Type | ||
- Mode | ||
- Description | ||
* - ``flow_steering_mode`` | ||
- string | ||
- runtime | ||
- Controls the flow steering mode of the driver | ||
|
||
* ``dmfs`` Device managed flow steering. In DMFS mode, the HW | ||
steering entities are created and managed through firmware. | ||
* ``smfs`` Software managed flow steering. In SMFS mode, the HW | ||
steering entities are created and manage through the driver without | ||
firmware intervention. | ||
|
||
The ``mlx5`` driver supports reloading via ``DEVLINK_CMD_RELOAD`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
.. SPDX-License-Identifier: GPL-2.0 | ||
===================== | ||
mlxsw devlink support | ||
===================== | ||
|
||
This document describes the devlink features implemented by the ``mlxsw`` | ||
device driver. | ||
|
||
Parameters | ||
========== | ||
|
||
.. list-table:: Generic parameters implemented | ||
|
||
* - Name | ||
- Mode | ||
* - ``fw_load_policy`` | ||
- driverinit | ||
|
||
The ``mlxsw`` driver also implements the following driver-specific | ||
parameters. | ||
|
||
.. list-table:: Driver-specific parameters implemented | ||
:widths: 5 5 5 85 | ||
|
||
* - Name | ||
- Type | ||
- Mode | ||
- Description | ||
* - ``acl_region_rehash_interval`` | ||
- u32 | ||
- runtime | ||
- Sets an interval for periodic ACL region rehashes. The value is | ||
specified in milliseconds, with a minimum of ``3000``. The value of | ||
``0`` disables periodic work entirely. The first rehash will be run | ||
immediately after the value is set. | ||
|
||
The ``mlxsw`` driver supports reloading via ``DEVLINK_CMD_RELOAD`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
.. SPDX-License-Identifier: GPL-2.0 | ||
========================= | ||
mv88e6xxx devlink support | ||
========================= | ||
|
||
This document describes the devlink features implemented by the ``mv88e6xxx`` | ||
device driver. | ||
|
||
Parameters | ||
========== | ||
|
||
The ``mv88e6xxx`` driver implements the following driver-specific parameters. | ||
|
||
.. list-table:: Driver-specific parameters implemented | ||
:widths: 5 5 5 85 | ||
|
||
* - Name | ||
- Type | ||
- Mode | ||
- Description | ||
* - ``ATU_hash`` | ||
- u8 | ||
- runtime | ||
- Select one of four possible hashing algorithms for MAC addresses in | ||
the Address Translation Unit. A value of 3 may work better than the | ||
default of 1 when many MAC addresses have the same OUI. Only the | ||
values 0 to 3 are valid for this parameter. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
.. SPDX-License-Identifier: GPL-2.0 | ||
=================== | ||
nfp devlink support | ||
=================== | ||
|
||
This document describes the devlink features implemented by the ``nfp`` | ||
device driver. | ||
|
||
Parameters | ||
========== | ||
|
||
.. list-table:: Generic parameters implemented | ||
|
||
* - Name | ||
- Mode | ||
* - ``fw_load_policy`` | ||
- permanent | ||
* - ``reset_dev_on_drv_probe`` | ||
- permanent |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
.. SPDX-License-Identifier: GPL-2.0 | ||
============================== | ||
ti-cpsw-switch devlink support | ||
============================== | ||
|
||
This document describes the devlink features implemented by the ``ti-cpsw-switch`` | ||
device driver. | ||
|
||
Parameters | ||
========== | ||
|
||
The ``ti-cpsw-switch`` driver implements the following driver-specific | ||
parameters. | ||
|
||
.. list-table:: Driver-specific parameters implemented | ||
:widths: 5 5 5 85 | ||
|
||
* - Name | ||
- Type | ||
- Mode | ||
- Description | ||
* - ``ale_bypass`` | ||
- Boolean | ||
- runtime | ||
- Enables ALE_CONTROL(4).BYPASS mode for debugging purposes. In this | ||
mode, all packets will be sent to the host port only. | ||
* - ``switch_mode`` | ||
- Boolean | ||
- runtime | ||
- Enable switch mode |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters