Commit 6c39e015 authored by Jacob Keller's avatar Jacob Keller Committed by David S. Miller
Browse files

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: default avatarJacob 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: default avatarDavid S. Miller <davem@davemloft.net>
parent 5948f85b
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -39,7 +39,7 @@ but without enabling "switch" mode, or to different bridges.

Devlink configuration parameters
====================
See Documentation/networking/devlink-params-ti-cpsw-switch.txt
See Documentation/networking/devlink/ti-cpsw-switch.rst

====================
# Bridging in dual mac mode
+41 −0
Original line number Diff line number Diff line
.. 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.
+0 −18
Original line number Diff line number Diff line
enable_sriov		[DEVICE, GENERIC]
			Configuration mode: Permanent

ignore_ari		[DEVICE, GENERIC]
			Configuration mode: Permanent

msix_vec_per_pf_max	[DEVICE, GENERIC]
			Configuration mode: Permanent

msix_vec_per_pf_min	[DEVICE, GENERIC]
			Configuration mode: Permanent

gre_ver_check		[DEVICE, DRIVER-SPECIFIC]
			Generic Routing Encapsulation (GRE) version check will
			be enabled in the device. If disabled, device skips
			version checking for incoming packets.
			Type: Boolean
			Configuration mode: Permanent
+0 −17
Original line number Diff line number Diff line
flow_steering_mode	[DEVICE, DRIVER-SPECIFIC]
			Controls the flow steering mode of the driver.
			Two modes are supported:
			1. 'dmfs' - Device managed flow steering.
			2. 'smfs  - Software/Driver managed flow steering.
			In DMFS mode, the HW steering entities are created and
			managed through the Firmware.
			In SMFS mode, the HW steering entities are created and
			managed though by the driver directly into Hardware
			without firmware intervention.
			Type: String
			Configuration mode: runtime

enable_roce		[DEVICE, GENERIC]
			Enable handling of RoCE traffic in the device.
			Defaultly enabled.
			Configuration mode: driverinit
+0 −10
Original line number Diff line number Diff line
fw_load_policy		[DEVICE, GENERIC]
			Configuration mode: driverinit

acl_region_rehash_interval	[DEVICE, DRIVER-SPECIFIC]
			Sets an interval for periodic ACL region rehashes.
			The value is in milliseconds, minimal value is "3000".
			Value "0" disables the periodic work.
			The first rehash will be run right after value is set.
			Type: u32
			Configuration mode: runtime
Loading