aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/networking/devlink/mv88e6xxx.rst
diff options
context:
space:
mode:
authorJacob Keller <jacob.e.keller@intel.com>2020-01-09 14:46:16 -0800
committerDavid S. Miller <davem@davemloft.net>2020-01-10 17:06:59 -0800
commit6c39e015f87fb46f68532d063d4fd337d094fdeb (patch)
tree0b38819273d985cc715898420c82af20e3c31b87 /Documentation/networking/devlink/mv88e6xxx.rst
parentdevlink: mention reloading in devlink-params.rst (diff)
downloadlinux-dev-6c39e015f87fb46f68532d063d4fd337d094fdeb.tar.xz
linux-dev-6c39e015f87fb46f68532d063d4fd337d094fdeb.zip
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>
Diffstat (limited to 'Documentation/networking/devlink/mv88e6xxx.rst')
-rw-r--r--Documentation/networking/devlink/mv88e6xxx.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/Documentation/networking/devlink/mv88e6xxx.rst b/Documentation/networking/devlink/mv88e6xxx.rst
new file mode 100644
index 000000000000..c621212a47a1
--- /dev/null
+++ b/Documentation/networking/devlink/mv88e6xxx.rst
@@ -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.