netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH net] docs: networkng: convert sja1105's devlink info to RTS
@ 2020-06-10 23:38 Jakub Kicinski
  2020-06-10 23:51 ` Vladimir Oltean
  0 siblings, 1 reply; 6+ messages in thread
From: Jakub Kicinski @ 2020-06-10 23:38 UTC (permalink / raw)
  To: davem; +Cc: netdev, vladimir.oltean, linux-doc, 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.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 .../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

diff --git a/Documentation/networking/devlink-params-sja1105.txt b/Documentation/networking/devlink-params-sja1105.txt
deleted file mode 100644
index 1d71742e270a..000000000000
--- a/Documentation/networking/devlink-params-sja1105.txt
+++ /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.
diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
index c536db2cc0f9..7684ae5c4a4a 100644
--- a/Documentation/networking/devlink/index.rst
+++ b/Documentation/networking/devlink/index.rst
@@ -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
index 000000000000..e2679c274085
--- /dev/null
+++ b/Documentation/networking/devlink/sja1105.rst
@@ -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.
-- 
2.26.2


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH net] docs: networkng: convert sja1105's devlink info to RTS
  2020-06-10 23:38 Jakub Kicinski
@ 2020-06-10 23:51 ` Vladimir Oltean
  2020-06-11  0:00   ` Jakub Kicinski
  0 siblings, 1 reply; 6+ messages in thread
From: Vladimir Oltean @ 2020-06-10 23:51 UTC (permalink / raw)
  To: Jakub Kicinski
  Cc: David S. Miller, netdev, Vladimir Oltean, Linux Doc Mailing List

On Thu, 11 Jun 2020 at 02:40, Jakub Kicinski <kuba@kernel.org> wrote:
>
> 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>

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

>  .../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
>
> diff --git a/Documentation/networking/devlink-params-sja1105.txt b/Documentation/networking/devlink-params-sja1105.txt
> deleted file mode 100644
> index 1d71742e270a..000000000000
> --- a/Documentation/networking/devlink-params-sja1105.txt
> +++ /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.
> diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
> index c536db2cc0f9..7684ae5c4a4a 100644
> --- a/Documentation/networking/devlink/index.rst
> +++ b/Documentation/networking/devlink/index.rst
> @@ -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
> index 000000000000..e2679c274085
> --- /dev/null
> +++ b/Documentation/networking/devlink/sja1105.rst
> @@ -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.
> --
> 2.26.2
>

Thanks,
-Vladimir

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH net] docs: networkng: convert sja1105's devlink info to RTS
@ 2020-06-10 23:59 Jakub Kicinski
  2020-06-11  0:08 ` David Miller
  0 siblings, 1 reply; 6+ messages in thread
From: Jakub Kicinski @ 2020-06-10 23:59 UTC (permalink / raw)
  To: davem; +Cc: netdev, vladimir.oltean, linux-doc, 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.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 .../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

diff --git a/Documentation/networking/devlink-params-sja1105.txt b/Documentation/networking/devlink-params-sja1105.txt
deleted file mode 100644
index 1d71742e270a..000000000000
--- a/Documentation/networking/devlink-params-sja1105.txt
+++ /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.
diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
index c536db2cc0f9..7684ae5c4a4a 100644
--- a/Documentation/networking/devlink/index.rst
+++ b/Documentation/networking/devlink/index.rst
@@ -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
index 000000000000..e2679c274085
--- /dev/null
+++ b/Documentation/networking/devlink/sja1105.rst
@@ -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.
-- 
2.26.2


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH net] docs: networkng: convert sja1105's devlink info to RTS
  2020-06-10 23:51 ` Vladimir Oltean
@ 2020-06-11  0:00   ` Jakub Kicinski
  0 siblings, 0 replies; 6+ messages in thread
From: Jakub Kicinski @ 2020-06-11  0:00 UTC (permalink / raw)
  To: Vladimir Oltean
  Cc: David S. Miller, netdev, Vladimir Oltean, Linux Doc Mailing List

On Thu, 11 Jun 2020 02:51:51 +0300 Vladimir Oltean wrote:
> On Thu, 11 Jun 2020 at 02:40, Jakub Kicinski <kuba@kernel.org> wrote:
> > 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>

Thanks!

> 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..

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH net] docs: networkng: convert sja1105's devlink info to RTS
  2020-06-10 23:59 [PATCH net] docs: networkng: convert sja1105's devlink info to RTS Jakub Kicinski
@ 2020-06-11  0:08 ` David Miller
  2020-06-11  0:13   ` Jakub Kicinski
  0 siblings, 1 reply; 6+ messages in thread
From: David Miller @ 2020-06-11  0:08 UTC (permalink / raw)
  To: kuba; +Cc: netdev, vladimir.oltean, linux-doc

From: Jakub Kicinski <kuba@kernel.org>
Date: Wed, 10 Jun 2020 16:59:11 -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>

Applied with Vlad's ack/test tags.

Please integrate those and add a v2 next time in this situation.

Thank you.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH net] docs: networkng: convert sja1105's devlink info to RTS
  2020-06-11  0:08 ` David Miller
@ 2020-06-11  0:13   ` Jakub Kicinski
  0 siblings, 0 replies; 6+ messages in thread
From: Jakub Kicinski @ 2020-06-11  0:13 UTC (permalink / raw)
  To: David Miller; +Cc: netdev, vladimir.oltean, linux-doc

On Wed, 10 Jun 2020 17:08:26 -0700 (PDT) David Miller wrote:
> From: Jakub Kicinski <kuba@kernel.org>
> Date: Wed, 10 Jun 2020 16:59:11 -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>  
> 
> Applied with Vlad's ack/test tags.
> 
> Please integrate those and add a v2 next time in this situation.
> 
> Thank you.

Ugh, sorry.

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2020-06-11  0:13 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-06-10 23:59 [PATCH net] docs: networkng: convert sja1105's devlink info to RTS Jakub Kicinski
2020-06-11  0:08 ` David Miller
2020-06-11  0:13   ` Jakub Kicinski
  -- strict thread matches above, loose matches on Subject: below --
2020-06-10 23:38 Jakub Kicinski
2020-06-10 23:51 ` Vladimir Oltean
2020-06-11  0:00   ` Jakub Kicinski

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).