diff mbox series

[v2,net-next,9/9] devlink: Add Documentation/networking/devlink-params-bnxt.txt

Message ID 1537766181-18994-10-git-send-email-vasundhara-v.volam@broadcom.com
State Changes Requested, archived
Delegated to: David Miller
Headers show
Series bnxt_en: devlink param updates | expand

Commit Message

Vasundhara Volam Sept. 24, 2018, 5:16 a.m. UTC
This patch adds a new file to add information about configuration
parameters that are supported by bnxt_en driver via devlink.

Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Jiri Pirko <jiri@mellanox.com>
Cc: Michael Chan <michael.chan@broadcom.com>

Signed-off-by: Vasundhara Volam <vasundhara-v.volam@broadcom.com>
---
 Documentation/networking/devlink-params-bnxt.txt | 35 ++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 Documentation/networking/devlink-params-bnxt.txt

Comments

Jakub Kicinski Sept. 24, 2018, 4:24 p.m. UTC | #1
On Mon, 24 Sep 2018 10:46:21 +0530, Vasundhara Volam wrote:
> This patch adds a new file to add information about configuration
> parameters that are supported by bnxt_en driver via devlink.
> 
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Cc: Jiri Pirko <jiri@mellanox.com>
> Cc: Michael Chan <michael.chan@broadcom.com>
> 
> Signed-off-by: Vasundhara Volam <vasundhara-v.volam@broadcom.com>
> ---
>  Documentation/networking/devlink-params-bnxt.txt | 35 ++++++++++++++++++++++++
>  1 file changed, 35 insertions(+)
>  create mode 100644 Documentation/networking/devlink-params-bnxt.txt
> 
> diff --git a/Documentation/networking/devlink-params-bnxt.txt b/Documentation/networking/devlink-params-bnxt.txt
> new file mode 100644
> index 0000000..ca7c457
> --- /dev/null
> +++ b/Documentation/networking/devlink-params-bnxt.txt
> @@ -0,0 +1,35 @@
> +enable_sriov		[DEVICE, GENERIC]
> +			Enable Single Root I/O Virtualisation (SRIOV) in
> +			the device.
> +			Type: Boolean
> +			Configuration mode: Permanent
> +
> +ignore_ari		[DEVICE, GENERIC]
> +			Ignore Alternative Routing-ID Interpretation (ARI)
> +			capability. If enabled, adapter will ignore ARI
> +			capability even when platforms has the support
> +			enabled and creates same number of partitions when
> +			platform does not support ARI.
> +			Type: Boolean
> +			Configuration mode: Permanent
> +
> +msix_vec_per_pf_max	[DEVICE, GENERIC]
> +			Provides the maximum number of MSIX interrupts that
> +			a device can create. Value is same across all
> +			physical functions (PFs) in the device.
> +			Type: u32
> +			Configuration mode: Permanent
> +
> +msix_vec_per_pf_min	[DEVICE, GENERIC]
> +			Provides the minimum number of MSIX interrupts required
> +			or the device initialization. Value is same across all
> +			physical functions (PFs) in the device.
> +			Type: u32
> +			Configuration mode: Permanent

Why duplicate the description of the generic parameters?

> +gre_ver_check		[DEVICE, DRIVER-SPECIFIC]
> +			Generic Routing Encapsulation (GRE) version check will
> +			be enabled in the device. If disabled, device skips
> +			version checking for incoming packets.
> +			Type: Boolean
> +			Configuration mode: Permanent
Vasundhara Volam Sept. 25, 2018, 4:07 a.m. UTC | #2
On Mon, Sep 24, 2018 at 9:54 PM Jakub Kicinski
<jakub.kicinski@netronome.com> wrote:
>
> On Mon, 24 Sep 2018 10:46:21 +0530, Vasundhara Volam wrote:
> > This patch adds a new file to add information about configuration
> > parameters that are supported by bnxt_en driver via devlink.
> >
> > Cc: "David S. Miller" <davem@davemloft.net>
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Cc: linux-doc@vger.kernel.org
> > Cc: Jiri Pirko <jiri@mellanox.com>
> > Cc: Michael Chan <michael.chan@broadcom.com>
> >
> > Signed-off-by: Vasundhara Volam <vasundhara-v.volam@broadcom.com>
> > ---
> >  Documentation/networking/devlink-params-bnxt.txt | 35 ++++++++++++++++++++++++
> >  1 file changed, 35 insertions(+)
> >  create mode 100644 Documentation/networking/devlink-params-bnxt.txt
> >
> > diff --git a/Documentation/networking/devlink-params-bnxt.txt b/Documentation/networking/devlink-params-bnxt.txt
> > new file mode 100644
> > index 0000000..ca7c457
> > --- /dev/null
> > +++ b/Documentation/networking/devlink-params-bnxt.txt
> > @@ -0,0 +1,35 @@
> > +enable_sriov         [DEVICE, GENERIC]
> > +                     Enable Single Root I/O Virtualisation (SRIOV) in
> > +                     the device.
> > +                     Type: Boolean
> > +                     Configuration mode: Permanent
> > +
> > +ignore_ari           [DEVICE, GENERIC]
> > +                     Ignore Alternative Routing-ID Interpretation (ARI)
> > +                     capability. If enabled, adapter will ignore ARI
> > +                     capability even when platforms has the support
> > +                     enabled and creates same number of partitions when
> > +                     platform does not support ARI.
> > +                     Type: Boolean
> > +                     Configuration mode: Permanent
> > +
> > +msix_vec_per_pf_max  [DEVICE, GENERIC]
> > +                     Provides the maximum number of MSIX interrupts that
> > +                     a device can create. Value is same across all
> > +                     physical functions (PFs) in the device.
> > +                     Type: u32
> > +                     Configuration mode: Permanent
> > +
> > +msix_vec_per_pf_min  [DEVICE, GENERIC]
> > +                     Provides the minimum number of MSIX interrupts required
> > +                     or the device initialization. Value is same across all
> > +                     physical functions (PFs) in the device.
> > +                     Type: u32
> > +                     Configuration mode: Permanent
>
> Why duplicate the description of the generic parameters?
Not all generic parameters are used by all drivers. So, I want to add
information about
type and configuration mode about generic parameters used by bnxt_en driver.
I can remove description part keeping type and configuration mode, if
it looks duplication.
>
> > +gre_ver_check                [DEVICE, DRIVER-SPECIFIC]
> > +                     Generic Routing Encapsulation (GRE) version check will
> > +                     be enabled in the device. If disabled, device skips
> > +                     version checking for incoming packets.
> > +                     Type: Boolean
> > +                     Configuration mode: Permanent
>
Jakub Kicinski Sept. 25, 2018, 2:05 p.m. UTC | #3
On Tue, 25 Sep 2018 09:37:20 +0530, Vasundhara Volam wrote:
> > Why duplicate the description of the generic parameters?  
> Not all generic parameters are used by all drivers. So, I want to add
> information about
> type and configuration mode about generic parameters used by bnxt_en driver.
> I can remove description part keeping type and configuration mode, if
> it looks duplication.

That'd be better.
diff mbox series

Patch

diff --git a/Documentation/networking/devlink-params-bnxt.txt b/Documentation/networking/devlink-params-bnxt.txt
new file mode 100644
index 0000000..ca7c457
--- /dev/null
+++ b/Documentation/networking/devlink-params-bnxt.txt
@@ -0,0 +1,35 @@ 
+enable_sriov		[DEVICE, GENERIC]
+			Enable Single Root I/O Virtualisation (SRIOV) in
+			the device.
+			Type: Boolean
+			Configuration mode: Permanent
+
+ignore_ari		[DEVICE, GENERIC]
+			Ignore Alternative Routing-ID Interpretation (ARI)
+			capability. If enabled, adapter will ignore ARI
+			capability even when platforms has the support
+			enabled and creates same number of partitions when
+			platform does not support ARI.
+			Type: Boolean
+			Configuration mode: Permanent
+
+msix_vec_per_pf_max	[DEVICE, GENERIC]
+			Provides the maximum number of MSIX interrupts that
+			a device can create. Value is same across all
+			physical functions (PFs) in the device.
+			Type: u32
+			Configuration mode: Permanent
+
+msix_vec_per_pf_min	[DEVICE, GENERIC]
+			Provides the minimum number of MSIX interrupts required
+			or the device initialization. Value is same across all
+			physical functions (PFs) in the device.
+			Type: u32
+			Configuration mode: Permanent
+
+gre_ver_check		[DEVICE, DRIVER-SPECIFIC]
+			Generic Routing Encapsulation (GRE) version check will
+			be enabled in the device. If disabled, device skips
+			version checking for incoming packets.
+			Type: Boolean
+			Configuration mode: Permanent