diff mbox series

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

Message ID 1538116103-12356-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. 28, 2018, 6:28 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 | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 Documentation/networking/devlink-params-bnxt.txt

Comments

Jiri Pirko Sept. 29, 2018, 12:53 p.m. UTC | #1 
Fri, Sep 28, 2018 at 08:28:23AM CEST, vasundhara-v.volam@broadcom.com 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 | 22 ++++++++++++++++++++++
> 1 file changed, 22 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..c7bc9d8
>--- /dev/null
>+++ b/Documentation/networking/devlink-params-bnxt.txt
>@@ -0,0 +1,22 @@
>+enable_sriov		[DEVICE, GENERIC]
>+			Type: Boolean

No need to list "Type" here. You have it in devlink-params.txt for
generic params already.


>+			Configuration mode: Permanent
>+
>+ignore_ari		[DEVICE, GENERIC]
>+			Type: Boolean
>+			Configuration mode: Permanent
>+
>+msix_vec_per_pf_max	[DEVICE, GENERIC]
>+			Type: u32
>+			Configuration mode: Permanent
>+
>+msix_vec_per_pf_min	[DEVICE, GENERIC]
>+			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
>-- 
>1.8.3.1
>
Vasundhara Volam Oct. 1, 2018, 4:04 a.m. UTC | #2 
On Sat, Sep 29, 2018 at 6:27 PM Jiri Pirko <jiri@resnulli.us> wrote:
>
> Fri, Sep 28, 2018 at 08:28:23AM CEST, vasundhara-v.volam@broadcom.com 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 | 22 ++++++++++++++++++++++
> > 1 file changed, 22 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..c7bc9d8
> >--- /dev/null
> >+++ b/Documentation/networking/devlink-params-bnxt.txt
> >@@ -0,0 +1,22 @@
> >+enable_sriov          [DEVICE, GENERIC]
> >+                      Type: Boolean
>
> No need to list "Type" here. You have it in devlink-params.txt for
> generic params already.
Ok, I thought type will give clarity when configuration mode is listed and
when user checks out only driver specific readme file.
I can remove it in next version of patchset.
>
>
> >+                      Configuration mode: Permanent
> >+
> >+ignore_ari            [DEVICE, GENERIC]
> >+                      Type: Boolean
> >+                      Configuration mode: Permanent
> >+
> >+msix_vec_per_pf_max   [DEVICE, GENERIC]
> >+                      Type: u32
> >+                      Configuration mode: Permanent
> >+
> >+msix_vec_per_pf_min   [DEVICE, GENERIC]
> >+                      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
> >--
> >1.8.3.1
> >
Jiri Pirko Oct. 1, 2018, 6:49 a.m. UTC | #3 
Mon, Oct 01, 2018 at 06:04:08AM CEST, vasundhara-v.volam@broadcom.com wrote:
>On Sat, Sep 29, 2018 at 6:27 PM Jiri Pirko <jiri@resnulli.us> wrote:
>>
>> Fri, Sep 28, 2018 at 08:28:23AM CEST, vasundhara-v.volam@broadcom.com 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 | 22 ++++++++++++++++++++++
>> > 1 file changed, 22 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..c7bc9d8
>> >--- /dev/null
>> >+++ b/Documentation/networking/devlink-params-bnxt.txt
>> >@@ -0,0 +1,22 @@
>> >+enable_sriov          [DEVICE, GENERIC]
>> >+                      Type: Boolean
>>
>> No need to list "Type" here. You have it in devlink-params.txt for
>> generic params already.
>Ok, I thought type will give clarity when configuration mode is listed and
>when user checks out only driver specific readme file.
>I can remove it in next version of patchset.

Yes please. The thing is, once this info is on 2 places, I'm pretty sure
what eventually there would be different types on different places.
Leaving the type only on one place reduces need for sync.

Thanks.

>>
>>
>> >+                      Configuration mode: Permanent
>> >+
>> >+ignore_ari            [DEVICE, GENERIC]
>> >+                      Type: Boolean
>> >+                      Configuration mode: Permanent
>> >+
>> >+msix_vec_per_pf_max   [DEVICE, GENERIC]
>> >+                      Type: u32
>> >+                      Configuration mode: Permanent
>> >+
>> >+msix_vec_per_pf_min   [DEVICE, GENERIC]
>> >+                      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
>> >--
>> >1.8.3.1
>> >
Vasundhara Volam Oct. 1, 2018, 6:57 a.m. UTC | #4 
On Mon, Oct 1, 2018 at 12:24 PM Jiri Pirko <jiri@resnulli.us> wrote:
>
> Mon, Oct 01, 2018 at 06:04:08AM CEST, vasundhara-v.volam@broadcom.com wrote:
> >On Sat, Sep 29, 2018 at 6:27 PM Jiri Pirko <jiri@resnulli.us> wrote:
> >>
> >> Fri, Sep 28, 2018 at 08:28:23AM CEST, vasundhara-v.volam@broadcom.com 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 | 22 ++++++++++++++++++++++
> >> > 1 file changed, 22 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..c7bc9d8
> >> >--- /dev/null
> >> >+++ b/Documentation/networking/devlink-params-bnxt.txt
> >> >@@ -0,0 +1,22 @@
> >> >+enable_sriov          [DEVICE, GENERIC]
> >> >+                      Type: Boolean
> >>
> >> No need to list "Type" here. You have it in devlink-params.txt for
> >> generic params already.
> >Ok, I thought type will give clarity when configuration mode is listed and
> >when user checks out only driver specific readme file.
> >I can remove it in next version of patchset.
>
> Yes please. The thing is, once this info is on 2 places, I'm pretty sure
> what eventually there would be different types on different places.
> Leaving the type only on one place reduces need for sync.
>
> Thanks.
Okay, got it. Thanks, I will remove it.
>
> >>
> >>
> >> >+                      Configuration mode: Permanent
> >> >+
> >> >+ignore_ari            [DEVICE, GENERIC]
> >> >+                      Type: Boolean
> >> >+                      Configuration mode: Permanent
> >> >+
> >> >+msix_vec_per_pf_max   [DEVICE, GENERIC]
> >> >+                      Type: u32
> >> >+                      Configuration mode: Permanent
> >> >+
> >> >+msix_vec_per_pf_min   [DEVICE, GENERIC]
> >> >+                      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
> >> >--
> >> >1.8.3.1
> >> >
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..c7bc9d8
--- /dev/null
+++ b/Documentation/networking/devlink-params-bnxt.txt
@@ -0,0 +1,22 @@ 
+enable_sriov		[DEVICE, GENERIC]
+			Type: Boolean
+			Configuration mode: Permanent
+
+ignore_ari		[DEVICE, GENERIC]
+			Type: Boolean
+			Configuration mode: Permanent
+
+msix_vec_per_pf_max	[DEVICE, GENERIC]
+			Type: u32
+			Configuration mode: Permanent
+
+msix_vec_per_pf_min	[DEVICE, GENERIC]
+			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