[dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license

2016-04-27 Thread Rasesh Mody
> From: Mcnamara, John [mailto:john.mcnamara at intel.com]
> Sent: Tuesday, April 26, 2016 8:50 AM
> 
> Hi,
> 
> Thanks for the documentation.
> 
> In general you should generate and view the Html output to make sure
> everything is okay:
> 
> make doc-guides-html
> firefox build/doc/html/guides/nics/qede.html &
> 
> Other comments below.

Thanks John for your comprehensive feedback on documentation.


[dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license

2016-04-26 Thread Thomas Monjalon
2016-04-26 18:27, Rasesh Mody:
> > From: Bruce Richardson [mailto:bruce.richardson at intel.com]
> > Sent: Tuesday, April 26, 2016 6:03 AM
> > 
> > On Mon, Apr 25, 2016 at 10:12:59PM -0700, Rasesh Mody wrote:
> > > Signed-off-by: Harish Patil 
> > > Signed-off-by: Rasesh Mody 
> > > Signed-off-by: Sony Chacko 
> > > ---
> > >  MAINTAINERS   |7 +
> > >  doc/guides/nics/index.rst |1 +
> > >  doc/guides/nics/overview.rst  |   86 +-
> > >  doc/guides/nics/qede.rst  |  314
> > +
> > >  drivers/net/qede/LICENSE.qede_pmd |   28 
> > >  5 files changed, 393 insertions(+), 43 deletions(-)  create mode
> > > 100644 doc/guides/nics/qede.rst  create mode 100644
> > > drivers/net/qede/LICENSE.qede_pmd
> > >
> > > diff --git a/MAINTAINERS b/MAINTAINERS index 1953ea2..ba4053a 100644
> > > --- a/MAINTAINERS
> > > +++ b/MAINTAINERS
> > > @@ -332,6 +332,13 @@ M: Rasesh Mody 
> > >  F: drivers/net/bnx2x/
> > >  F: doc/guides/nics/bnx2x.rst
> > >
> > > +QLogic qede PMD
> > > +M: Harish Patil 
> > > +M: Rasesh Mody 
> > > +M: Sony Chacko 
> > > +F: drivers/net/qede/
> > > +F: doc/guides/nics/qede.rst
> > > +
> > >  RedHat virtio
> > >  M: Huawei Xie 
> > >  M: Yuanhan Liu  diff --git
> > > a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index
> > > 769f677..d67f056 100644
> > > --- a/doc/guides/nics/index.rst
> > > +++ b/doc/guides/nics/index.rst
> > > @@ -53,6 +53,7 @@ Network Interface Controller Drivers
> > >  vhost
> > >  vmxnet3
> > >  pcap_ring
> > > +qede
> > 
> > Minor nit - this addition should be between "nfp" and "szedata2" as the 
> > list is
> > in alphabetical order apart from the last entry which covers two virtual 
> > NICs
> > in the one section.
> > 
> > /Bruce
> 
> During our v5 submission we received a comment to keep the logic order by 
> adding qede below bnx2x, hence the change. We can place it under "nfp" and 
> "szedata2" to maintain the alphabetical order.

I think you are talking of 2 different things:
MAINTAINERS file et doc/guides/nics.
For MAINTAINERS, this patch is right.
For doc, it is not.


[dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license

2016-04-26 Thread Rasesh Mody
> From: Thomas Monjalon [mailto:thomas.monjalon at 6wind.com]
> Sent: Tuesday, April 26, 2016 12:34 PM
> 
> 2016-04-26 18:27, Rasesh Mody:
> > > From: Bruce Richardson [mailto:bruce.richardson at intel.com]
> > > Sent: Tuesday, April 26, 2016 6:03 AM
> > >
> > > On Mon, Apr 25, 2016 at 10:12:59PM -0700, Rasesh Mody wrote:
> > > > Signed-off-by: Harish Patil 
> > > > Signed-off-by: Rasesh Mody 
> > > > Signed-off-by: Sony Chacko 
> > > > ---
> > > >  MAINTAINERS   |7 +
> > > >  doc/guides/nics/index.rst |1 +
> > > >  doc/guides/nics/overview.rst  |   86 +-
> > > >  doc/guides/nics/qede.rst  |  314
> > > +
> > > >  drivers/net/qede/LICENSE.qede_pmd |   28 
> > > >  5 files changed, 393 insertions(+), 43 deletions(-)  create mode
> > > > 100644 doc/guides/nics/qede.rst  create mode 100644
> > > > drivers/net/qede/LICENSE.qede_pmd
> > > >
> > > > diff --git a/MAINTAINERS b/MAINTAINERS index 1953ea2..ba4053a
> > > > 100644
> > > > --- a/MAINTAINERS
> > > > +++ b/MAINTAINERS
> > > > @@ -332,6 +332,13 @@ M: Rasesh Mody 
> > > >  F: drivers/net/bnx2x/
> > > >  F: doc/guides/nics/bnx2x.rst
> > > >
> > > > +QLogic qede PMD
> > > > +M: Harish Patil 
> > > > +M: Rasesh Mody 
> > > > +M: Sony Chacko 
> > > > +F: drivers/net/qede/
> > > > +F: doc/guides/nics/qede.rst
> > > > +
> > > >  RedHat virtio
> > > >  M: Huawei Xie 
> > > >  M: Yuanhan Liu  diff --git
> > > > a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index
> > > > 769f677..d67f056 100644
> > > > --- a/doc/guides/nics/index.rst
> > > > +++ b/doc/guides/nics/index.rst
> > > > @@ -53,6 +53,7 @@ Network Interface Controller Drivers
> > > >  vhost
> > > >  vmxnet3
> > > >  pcap_ring
> > > > +qede
> > >
> > > Minor nit - this addition should be between "nfp" and "szedata2" as
> > > the list is in alphabetical order apart from the last entry which
> > > covers two virtual NICs in the one section.
> > >
> > > /Bruce
> >
> > During our v5 submission we received a comment to keep the logic order
> by adding qede below bnx2x, hence the change. We can place it under "nfp"
> and "szedata2" to maintain the alphabetical order.
> 
> I think you are talking of 2 different things:
> MAINTAINERS file et doc/guides/nics.
> For MAINTAINERS, this patch is right.
> For doc, it is not.

You are right, I overlooked it, will modify it.
Thanks!
Rasesh


[dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license

2016-04-26 Thread Rasesh Mody
> From: Bruce Richardson [mailto:bruce.richardson at intel.com]
> Sent: Tuesday, April 26, 2016 6:03 AM
> 
> On Mon, Apr 25, 2016 at 10:12:59PM -0700, Rasesh Mody wrote:
> > Signed-off-by: Harish Patil 
> > Signed-off-by: Rasesh Mody 
> > Signed-off-by: Sony Chacko 
> > ---
> >  MAINTAINERS   |7 +
> >  doc/guides/nics/index.rst |1 +
> >  doc/guides/nics/overview.rst  |   86 +-
> >  doc/guides/nics/qede.rst  |  314
> +
> >  drivers/net/qede/LICENSE.qede_pmd |   28 
> >  5 files changed, 393 insertions(+), 43 deletions(-)  create mode
> > 100644 doc/guides/nics/qede.rst  create mode 100644
> > drivers/net/qede/LICENSE.qede_pmd
> >
> > diff --git a/MAINTAINERS b/MAINTAINERS index 1953ea2..ba4053a 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -332,6 +332,13 @@ M: Rasesh Mody 
> >  F: drivers/net/bnx2x/
> >  F: doc/guides/nics/bnx2x.rst
> >
> > +QLogic qede PMD
> > +M: Harish Patil 
> > +M: Rasesh Mody 
> > +M: Sony Chacko 
> > +F: drivers/net/qede/
> > +F: doc/guides/nics/qede.rst
> > +
> >  RedHat virtio
> >  M: Huawei Xie 
> >  M: Yuanhan Liu  diff --git
> > a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index
> > 769f677..d67f056 100644
> > --- a/doc/guides/nics/index.rst
> > +++ b/doc/guides/nics/index.rst
> > @@ -53,6 +53,7 @@ Network Interface Controller Drivers
> >  vhost
> >  vmxnet3
> >  pcap_ring
> > +qede
> 
> Minor nit - this addition should be between "nfp" and "szedata2" as the list 
> is
> in alphabetical order apart from the last entry which covers two virtual NICs
> in the one section.
> 
> /Bruce

During our v5 submission we received a comment to keep the logic order by 
adding qede below bnx2x, hence the change. We can place it under "nfp" and 
"szedata2" to maintain the alphabetical order.

Thanks!
Rasesh


[dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license

2016-04-26 Thread Thomas Monjalon
2016-04-26 15:19, Mcnamara, John:
> > From: Richardson, Bruce
> > Ideally, the feature matrix would be updated as each patch adds new
> > features, but since this is a new driver, I'm ok with just having this as
> > part of that core driver patch too - with a note in the commit stating
> > that the following commits contain the code for the features not
> > implemented in that one.
> > 
> > Thomas, John McNamara, as keen viewers and maintainers of our
> > documentation, any comments or strong objection to this?
> 
> Hi,
> 
> No objection from me. That sounds reasonable.

Yes sounds a reasonable requirement.
Having everything split in feature's patches would be perfect,
so do at your best. Thanks


[dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license

2016-04-26 Thread Bruce Richardson
On Mon, Apr 25, 2016 at 10:12:59PM -0700, Rasesh Mody wrote:
> Signed-off-by: Harish Patil 
> Signed-off-by: Rasesh Mody 
> Signed-off-by: Sony Chacko 
> ---
>  MAINTAINERS   |7 +
>  doc/guides/nics/index.rst |1 +
>  doc/guides/nics/overview.rst  |   86 +-
>  doc/guides/nics/qede.rst  |  314 
> +
>  drivers/net/qede/LICENSE.qede_pmd |   28 
>  5 files changed, 393 insertions(+), 43 deletions(-)
>  create mode 100644 doc/guides/nics/qede.rst
>  create mode 100644 drivers/net/qede/LICENSE.qede_pmd
> 
Hi,

While it's great to see the documentation for each driver coming in the same
patchset as the driver itself, can you perhaps see about merging some of the doc
changes here in with the other patches. For example, the license and maintainers
changes can probably go with the base code drop, while the NIC overview
documentation should go with the core code for the driver. 

Ideally, the feature matrix would be updated as each patch adds new features,
but since this is a new driver, I'm ok with just having this as part of that
core driver patch too - with a note in the commit stating that the following
commits contain the code for the features not implemented in that one.

Thomas, John McNamara, as keen viewers and maintainers of our documentation,
any comments or strong objection to this?

Regards,
/Bruce


[dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license

2016-04-26 Thread Mcnamara, John
Hi,

Thanks for the documentation. 

In general you should generate and view the Html output to make sure
everything is okay:

make doc-guides-html 
firefox build/doc/html/guides/nics/qede.html &

Other comments below.


> -Original Message-
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Rasesh Mody
> Sent: Tuesday, April 26, 2016 6:13 AM
> To: thomas.monjalon at 6wind.com; Richardson, Bruce
> 
> Cc: dev at dpdk.org; ameen.rahman at qlogic.com; Rasesh Mody
> ; Harish Patil ; Sony
> Chacko 
> Subject: [dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation
> and license
> 
> ...
>
> +
> +Prerequisites
> +-
> +
> +- Requires firmware version **8.7.x. ** and management

Omit the space before the second "**" bold or it won't render properly.


> +  firmware version **8.7.x or higher**. Firmware may be available
> +  inbox in certain newer Linux distros under the standard directory
> +  E.g. /lib/firmware/qed/qed_init_values_zipped-8.7.7.0.bin

Paths should be wrapped in fixed  quotes.


> +
> +- If the required firmware files are not available then visit
> +  `QLogic Driver Download Center <http://driverdownloads.qlogic.com>`

The link requires a _ at the end to render correctly, and a full stop at
the end would be better as well.




> +- ``CONFIG_RTE_LIBRTE_QEDE_FW`` (default **""**)
> +
> +  Gives absolute path of firmware file.
> +  Eg: "/lib/firmware/qed/qed_init_values_zipped-8.7.7.0.bin"

Paths should be wrapped in fixed  quotes.



> +  Empty string indicates driver will pick up the firmware file  from
> + the default location.
> +
> +Driver Compilation
> +~~
> +
> +To compile QEDE PMD for Linux x86_64 gcc target, run the following "make"
> +command::

Commands like "make" and constants should be wrapped in fixed  quotes.


> +
> +#. Bind the QLogic 4 adapters to ``igb_uio`` loaded in the
> +   previous step::
> +
> +   .. code-block:: console
> +  ./tools/dpdk_nic_bind.py --bind igb_uio :84:00.0 :84:00.1 \


The :: after step is overriding/confusing the ::console directive. Use ore
or the other. Also there should be a blank line between ::console and the
text.


> +
> +**Note**: librte_pmd_qede will be used to bind to SR-IOV VF device and
> +Linux native kernel driver (QEDE) will function as SR-IOV PF

The second line of the note shouldn't be indented or else it doesn't render
correctly.

Alternatively, you could use a real RST note:

  .. Note::

 Some text here indent 3 spaces.



+
> +   Assign MAC address to the VF using iproute2 utility. The syntax is::
> +  ip link set  vf  mac 
> +

There should be a blank line between :: and the text.

John.
-- 



[dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license

2016-04-26 Thread Mcnamara, John


> -Original Message-
> From: Richardson, Bruce
> Sent: Tuesday, April 26, 2016 4:04 PM
> To: Rasesh Mody 
> Cc: thomas.monjalon at 6wind.com; dev at dpdk.org; ameen.rahman at qlogic.com;
> Harish Patil ; Sony Chacko
> ; Mcnamara, John 
> Subject: Re: [PATCH v6 1/8] qede: Add maintainers, documentation and
> license
> 
> Ideally, the feature matrix would be updated as each patch adds new
> features, but since this is a new driver, I'm ok with just having this as
> part of that core driver patch too - with a note in the commit stating
> that the following commits contain the code for the features not
> implemented in that one.
> 
> Thomas, John McNamara, as keen viewers and maintainers of our
> documentation, any comments or strong objection to this?

Hi,

No objection from me. That sounds reasonable.

John


[dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license

2016-04-26 Thread Bruce Richardson
On Mon, Apr 25, 2016 at 10:12:59PM -0700, Rasesh Mody wrote:
> Signed-off-by: Harish Patil 
> Signed-off-by: Rasesh Mody 
> Signed-off-by: Sony Chacko 
> ---
>  MAINTAINERS   |7 +
>  doc/guides/nics/index.rst |1 +
>  doc/guides/nics/overview.rst  |   86 +-
>  doc/guides/nics/qede.rst  |  314 
> +
>  drivers/net/qede/LICENSE.qede_pmd |   28 
>  5 files changed, 393 insertions(+), 43 deletions(-)
>  create mode 100644 doc/guides/nics/qede.rst
>  create mode 100644 drivers/net/qede/LICENSE.qede_pmd
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 1953ea2..ba4053a 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -332,6 +332,13 @@ M: Rasesh Mody 
>  F: drivers/net/bnx2x/
>  F: doc/guides/nics/bnx2x.rst
>  
> +QLogic qede PMD
> +M: Harish Patil 
> +M: Rasesh Mody 
> +M: Sony Chacko 
> +F: drivers/net/qede/
> +F: doc/guides/nics/qede.rst
> +
>  RedHat virtio
>  M: Huawei Xie 
>  M: Yuanhan Liu 
> diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
> index 769f677..d67f056 100644
> --- a/doc/guides/nics/index.rst
> +++ b/doc/guides/nics/index.rst
> @@ -53,6 +53,7 @@ Network Interface Controller Drivers
>  vhost
>  vmxnet3
>  pcap_ring
> +qede

Minor nit - this addition should be between "nfp" and "szedata2" as the list
is in alphabetical order apart from the last entry which covers two virtual
NICs in the one section.

/Bruce


[dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license

2016-04-25 Thread Rasesh Mody
Signed-off-by: Harish Patil 
Signed-off-by: Rasesh Mody 
Signed-off-by: Sony Chacko 
---
 MAINTAINERS   |7 +
 doc/guides/nics/index.rst |1 +
 doc/guides/nics/overview.rst  |   86 +-
 doc/guides/nics/qede.rst  |  314 +
 drivers/net/qede/LICENSE.qede_pmd |   28 
 5 files changed, 393 insertions(+), 43 deletions(-)
 create mode 100644 doc/guides/nics/qede.rst
 create mode 100644 drivers/net/qede/LICENSE.qede_pmd

diff --git a/MAINTAINERS b/MAINTAINERS
index 1953ea2..ba4053a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -332,6 +332,13 @@ M: Rasesh Mody 
 F: drivers/net/bnx2x/
 F: doc/guides/nics/bnx2x.rst

+QLogic qede PMD
+M: Harish Patil 
+M: Rasesh Mody 
+M: Sony Chacko 
+F: drivers/net/qede/
+F: doc/guides/nics/qede.rst
+
 RedHat virtio
 M: Huawei Xie 
 M: Yuanhan Liu 
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index 769f677..d67f056 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -53,6 +53,7 @@ Network Interface Controller Drivers
 vhost
 vmxnet3
 pcap_ring
+qede

 **Figures**

diff --git a/doc/guides/nics/overview.rst b/doc/guides/nics/overview.rst
index ed116e3..955887b 100644
--- a/doc/guides/nics/overview.rst
+++ b/doc/guides/nics/overview.rst
@@ -74,40 +74,40 @@ Most of these differences are summarized below.

 .. table:: Features availability in networking drivers

-    = = = = = = = = = = = = = = = = = = = = = = = = = = = 
= = = = = = = =
-   Feature  a b b b c e e e i i i i i i i i i i f f f f m m m n n 
p r s v v v v x
-f n n o x 1 n n 4 4 4 4 g g x x x x m m m m l l p f u 
c i z h i i m e
-p x x n g 0 a i 0 0 0 0 b b g g g g 1 1 1 1 x x i p l 
a n e o r r x n
-a 2 2 d b 0   c e e e e   v b b b b 0 0 0 0 4 5 p   l 
p g d s t t n v
-c x x i e 0   . v v   f e e e e k k k k e  
   a t i i e i
-k   v n   . f f   . v v   . v v
   t   o o t r
-e   f g   .   .   . f f   . f f
   a . 3 t
-t v   v   v   v   v   v
   2 v
-  e   e   e   e   e   e
 e
-  c   c   c   c   c   c
 c
-    = = = = = = = = = = = = = = = = = = = = = = = = = = = 
= = = = = = = =
+    = = = = = = = = = = = = = = = = = = = = = = = = = = = 
= = = = = = = = = =
+   Feature  a b b b c e e e i i i i i i i i i i f f f f m m m n n 
p q q r s v v v v x
+f n n o x 1 n n 4 4 4 4 g g x x x x m m m m l l p f u 
c e e i z h i i m e
+p x x n g 0 a i 0 0 0 0 b b g g g g 1 1 1 1 x x i p l 
a d d n e o r r x n
+a 2 2 d b 0   c e e e e   v b b b b 0 0 0 0 4 5 p   l 
p e e g d s t t n v
+c x x i e 0   . v v   f e e e e k k k k e  
   v   a t i i e i
+k   v n   . f f   . v v   . v v
   f   t   o o t r
+e   f g   .   .   . f f   . f f
   a . 3 t
+t v   v   v   v   v   v
   2 v
+  e   e   e   e   e   e
 e
+  c   c   c   c   c   c
 c
+    = = = = = = = = = = = = = = = = = = = = = = = = = = = 
= = = = = = = = = =
speed capabilities
-   link statusX X   X X   X X X X   X X X X X X
   X X X X
-   link status event  X X X X X X   X X X X
 X
-   queue status event  
 X
+   link statusX X   X X   X X X X   X X X X X X
 X X   X X X X
+   link status event  X X X X X X   X X X X
 X X X
+   queue status event  
 X
Rx interrupt   X X X X X X X X X X X X X X X
-   queue start/stop X   X X X X X X X X X X X X X X
   X   X X
+   queue start/stop X   X X X X X X X X X X X X X X
   X   X X
MTU update   X X X   X   X X X X X X
-   jumbo frame  X X X X X X X X X   X X X X X X X X X X   X
-   scattered Rx X X X   X X X X X X X X X X X X X X X X
   X   X
+   jumbo frame  X X X X X X X X X   X X X X X X X X X X   
X X X
+   scattered Rx X X X   X X X X X X X X