docs: networkng: convert sja1105's devlink info to RTS
authorJakub Kicinski <kuba@kernel.org>
Wed, 10 Jun 2020 23:59:11 +0000 (16:59 -0700)
committerDavid S. Miller <davem@davemloft.net>
Thu, 11 Jun 2020 00:07:04 +0000 (17:07 -0700)
A new file snuck into the tree after all existing documentation
was converted to RST. Convert sja1105's devlink info and move
it where the rest of the drivers are documented.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Acked-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Tested-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/networking/devlink-params-sja1105.txt [deleted file]
Documentation/networking/devlink/index.rst
Documentation/networking/devlink/sja1105.rst [new file with mode: 0644]

diff --git a/Documentation/networking/devlink-params-sja1105.txt b/Documentation/networking/devlink-params-sja1105.txt
deleted file mode 100644 (file)
index 1d71742..0000000
+++ /dev/null
@@ -1,27 +0,0 @@
-best_effort_vlan_filtering
-                       [DEVICE, DRIVER-SPECIFIC]
-                       Allow plain ETH_P_8021Q headers to be used as DSA tags.
-                       Benefits:
-                       - Can terminate untagged traffic over switch net
-                         devices even when enslaved to a bridge with
-                         vlan_filtering=1.
-                       - Can terminate VLAN-tagged traffic over switch net
-                         devices even when enslaved to a bridge with
-                         vlan_filtering=1, with some constraints (no more than
-                         7 non-pvid VLANs per user port).
-                       - Can do QoS based on VLAN PCP and VLAN membership
-                         admission control for autonomously forwarded frames
-                         (regardless of whether they can be terminated on the
-                         CPU or not).
-                       Drawbacks:
-                       - User cannot use VLANs in range 1024-3071. If the
-                         switch receives frames with such VIDs, it will
-                         misinterpret them as DSA tags.
-                       - Switch uses Shared VLAN Learning (FDB lookup uses
-                         only DMAC as key).
-                       - When VLANs span cross-chip topologies, the total
-                         number of permitted VLANs may be less than 7 per
-                         port, due to a maximum number of 32 VLAN retagging
-                         rules per switch.
-                       Configuration mode: runtime
-                       Type: bool.
index c536db2..7684ae5 100644 (file)
@@ -40,5 +40,6 @@ parameters, info versions, and other features it supports.
    mv88e6xxx
    netdevsim
    nfp
+   sja1105
    qed
    ti-cpsw-switch
diff --git a/Documentation/networking/devlink/sja1105.rst b/Documentation/networking/devlink/sja1105.rst
new file mode 100644 (file)
index 0000000..e2679c2
--- /dev/null
@@ -0,0 +1,49 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=======================
+sja1105 devlink support
+=======================
+
+This document describes the devlink features implemented
+by the ``sja1105`` device driver.
+
+Parameters
+==========
+
+.. list-table:: Driver-specific parameters implemented
+  :widths: 5 5 5 85
+
+  * - Name
+    - Type
+    - Mode
+    - Description
+  * - ``best_effort_vlan_filtering``
+    - Boolean
+    - runtime
+    - Allow plain ETH_P_8021Q headers to be used as DSA tags.
+
+      Benefits:
+
+      - Can terminate untagged traffic over switch net
+        devices even when enslaved to a bridge with
+        vlan_filtering=1.
+      - Can terminate VLAN-tagged traffic over switch net
+        devices even when enslaved to a bridge with
+        vlan_filtering=1, with some constraints (no more than
+        7 non-pvid VLANs per user port).
+      - Can do QoS based on VLAN PCP and VLAN membership
+        admission control for autonomously forwarded frames
+        (regardless of whether they can be terminated on the
+        CPU or not).
+
+      Drawbacks:
+
+      - User cannot use VLANs in range 1024-3071. If the
+       switch receives frames with such VIDs, it will
+       misinterpret them as DSA tags.
+      - Switch uses Shared VLAN Learning (FDB lookup uses
+       only DMAC as key).
+      - When VLANs span cross-chip topologies, the total
+       number of permitted VLANs may be less than 7 per
+       port, due to a maximum number of 32 VLAN retagging
+       rules per switch.