Skip to contentSkip to conversation

docs: networkng: convert sja1105's devlink info to RTS

PATCH In review Jakub Kicinski 2 participants 3 messages Jun 10, 2020 – Jun 11, 2020

Subsystems (4)
lore
Share & tools
lore

Jakub Kicinski

author maintainer
#0 lore raw

PATCH 1/1 docs: networkng: convert sja1105's devlink info to RTS

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.

---
 .../networking/devlink-params-sja1105.txt     | 27 ----------
 Documentation/networking/devlink/index.rst    |  1 +
 Documentation/networking/devlink/sja1105.rst  | 49 +++++++++++++++++++
 3 files changed, 50 insertions(+), 27 deletions(-)
 delete mode 100644 Documentation/networking/devlink-params-sja1105.txt
 create mode 100644 Documentation/networking/devlink/sja1105.rst
Documentation/networking/devlink-params-sja1105.txt deleted +0 -27
deleted file mode 100644
index 1d71742e270a..000000000000
@@ -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.
Documentation/networking/devlink/index.rst +1 -0
index c536db2cc0f9..7684ae5c4a4a 100644
@@ -40,5 +40,6 @@ parameters, info versions, and other features it supports.
    mv88e6xxx
    netdevsim
    nfp
+   sja1105
    qed
    ti-cpsw-switch
Documentation/networking/devlink/sja1105.rst new file +49 -0

49 lines not on this page · raw message

Signature · 1 line
2.26.2
Acked-by Tested-by on v1 1/1
#1 lore raw
Quoted 7 lines · Jakub Kicinski

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.

---

Only if you need to resend, there are 2 typos in the commit title:
networkng and RTS -> RST.

Quoted 107 lines
 .../networking/devlink-params-sja1105.txt     | 27 ----------
 Documentation/networking/devlink/index.rst    |  1 +
 Documentation/networking/devlink/sja1105.rst  | 49 +++++++++++++++++++
 3 files changed, 50 insertions(+), 27 deletions(-)
 delete mode 100644 Documentation/networking/devlink-params-sja1105.txt
 create mode 100644 Documentation/networking/devlink/sja1105.rst
Documentation/networking/devlink-params-sja1105.txt deleted +0 -27
deleted file mode 100644
index 1d71742e270a..000000000000
@@ -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.
Documentation/networking/devlink/index.rst +1 -0
index c536db2cc0f9..7684ae5c4a4a 100644
@@ -40,5 +40,6 @@ parameters, info versions, and other features it supports.
    mv88e6xxx
    netdevsim
    nfp
+   sja1105
    qed
    ti-cpsw-switch
Documentation/networking/devlink/sja1105.rst new file +49 -1
new file mode 100644
index 000000000000..e2679c274085
@@ -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.
--
Quoted 2 lines

2.26.2

Thanks,
-Vladimir

author maintainer
#2 lore raw
Quoted 9 lines · On Thu, 11 Jun 2020 02:51:51 +0300 Vladimir Oltean wrote:
Quoted 5 lines · Jakub Kicinski

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.

Thanks!

Quoted 2 lines

Only if you need to resend, there are 2 typos in the commit title:
networkng and RTS -> RST.

Ah damn, I got distracted checking if snuck is a valid word and didn't spell check the rest :S Sent v2..