netdev - Re: [PATCH net] docs: networkng: convert sja1105's devlink info to RTS

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Date:   Thu, 11 Jun 2020 02:51:51 +0300
From:   Vladimir Oltean <olteanv@...il.com>
To:     Jakub Kicinski <kuba@...nel.org>
Cc:     "David S. Miller" <davem@...emloft.net>,
        netdev <netdev@...r.kernel.org>,
        Vladimir Oltean <vladimir.oltean@....com>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>
Subject: Re: [PATCH net] docs: networkng: convert sja1105's devlink info to RTS

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

Acked-by: Vladimir Oltean <vladimir.oltean@....com>
Tested-by: Vladimir Oltean <vladimir.oltean@....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