All of lore.kernel.org
 help / color / mirror / Atom feed
From: Simon Horman <simon.horman@corigine.com>
To: Pavan Kumar Linga <pavan.kumar.linga@intel.com>
Cc: willemb@google.com, pabeni@redhat.com, netdev@vger.kernel.org,
	jesse.brandeburg@intel.com, kuba@kernel.org, edumazet@google.com,
	intel-wired-lan@lists.osuosl.org, anthony.l.nguyen@intel.com,
	Phani Burra <phani.r.burra@intel.com>,
	decot@google.com, davem@davemloft.net
Subject: Re: [Intel-wired-lan] [PATCH net-next v2 01/15] virtchnl: add virtchnl version 2 ops
Date: Tue, 11 Apr 2023 10:51:18 +0200	[thread overview]
Message-ID: <ZDUfhqA41BZOP9PW@corigine.com> (raw)
In-Reply-To: <20230411011354.2619359-2-pavan.kumar.linga@intel.com>

On Mon, Apr 10, 2023 at 06:13:40PM -0700, Pavan Kumar Linga wrote:
> Virtchnl version 1 is an interface used by the current generation of
> foundational NICs to negotiate the capabilities and configure the
> HW resources such as queues, vectors, RSS LUT, etc between the PF
> and VF drivers. It is not extensible to enable new features supported
> in the next generation of NICs/IPUs and to negotiate descriptor types,
> packet types and register offsets.
> 
> To overcome the limitations of the existing interface, introduce
> the virtchnl version 2 and add the necessary opcodes, structures,
> definitions, and descriptor formats. The driver also learns the
> data queue and other register offsets to use instead of hardcoding
> them. The advantage of this approach is that it gives the flexibility
> to modify the register offsets if needed, restrict the use of
> certain descriptor types and negotiate the supported packet types.
> 
> Co-developed-by: Alan Brady <alan.brady@intel.com>
> Signed-off-by: Alan Brady <alan.brady@intel.com>
> Co-developed-by: Joshua Hay <joshua.a.hay@intel.com>
> Signed-off-by: Joshua Hay <joshua.a.hay@intel.com>
> Co-developed-by: Madhu Chittim <madhu.chittim@intel.com>
> Signed-off-by: Madhu Chittim <madhu.chittim@intel.com>
> Co-developed-by: Phani Burra <phani.r.burra@intel.com>
> Signed-off-by: Phani Burra <phani.r.burra@intel.com>
> Co-developed-by: Sridhar Samudrala <sridhar.samudrala@intel.com>
> Signed-off-by: Sridhar Samudrala <sridhar.samudrala@intel.com>
> Signed-off-by: Pavan Kumar Linga <pavan.kumar.linga@intel.com>
> Reviewed-by: Sridhar Samudrala <sridhar.samudrala@intel.com>
> Reviewed-by: Willem de Bruijn <willemb@google.com>
> ---
>  drivers/net/ethernet/intel/idpf/virtchnl2.h   | 1201 +++++++++++++++++
>  .../ethernet/intel/idpf/virtchnl2_lan_desc.h  |  666 +++++++++
>  2 files changed, 1867 insertions(+)
>  create mode 100644 drivers/net/ethernet/intel/idpf/virtchnl2.h
>  create mode 100644 drivers/net/ethernet/intel/idpf/virtchnl2_lan_desc.h
> 
> diff --git a/drivers/net/ethernet/intel/idpf/virtchnl2.h b/drivers/net/ethernet/intel/idpf/virtchnl2.h

...

> +/**
> + * This macro is used to generate compilation errors if a structure
> + * is not exactly the correct length.
> + */

Hi Pavan,

./scripts/kernel-doc -none drivers/net/ethernet/intel/idpf/virtchnl2.h
reports that the comment above starts with '/**' but is not a kernel-doc
comment. Which seems to be correct. It also flags many other similar issues.

Please consider running kernel-doc and resolving the issues it flags.
_______________________________________________
Intel-wired-lan mailing list
Intel-wired-lan@osuosl.org
https://lists.osuosl.org/mailman/listinfo/intel-wired-lan

WARNING: multiple messages have this Message-ID (diff)
From: Simon Horman <simon.horman@corigine.com>
To: Pavan Kumar Linga <pavan.kumar.linga@intel.com>
Cc: intel-wired-lan@lists.osuosl.org, netdev@vger.kernel.org,
	emil.s.tantilov@intel.com, joshua.a.hay@intel.com,
	sridhar.samudrala@intel.com, jesse.brandeburg@intel.com,
	anthony.l.nguyen@intel.com, willemb@google.com, decot@google.com,
	pabeni@redhat.com, kuba@kernel.org, edumazet@google.com,
	davem@davemloft.net, Alan Brady <alan.brady@intel.com>,
	Madhu Chittim <madhu.chittim@intel.com>,
	Phani Burra <phani.r.burra@intel.com>
Subject: Re: [PATCH net-next v2 01/15] virtchnl: add virtchnl version 2 ops
Date: Tue, 11 Apr 2023 10:51:18 +0200	[thread overview]
Message-ID: <ZDUfhqA41BZOP9PW@corigine.com> (raw)
In-Reply-To: <20230411011354.2619359-2-pavan.kumar.linga@intel.com>

On Mon, Apr 10, 2023 at 06:13:40PM -0700, Pavan Kumar Linga wrote:
> Virtchnl version 1 is an interface used by the current generation of
> foundational NICs to negotiate the capabilities and configure the
> HW resources such as queues, vectors, RSS LUT, etc between the PF
> and VF drivers. It is not extensible to enable new features supported
> in the next generation of NICs/IPUs and to negotiate descriptor types,
> packet types and register offsets.
> 
> To overcome the limitations of the existing interface, introduce
> the virtchnl version 2 and add the necessary opcodes, structures,
> definitions, and descriptor formats. The driver also learns the
> data queue and other register offsets to use instead of hardcoding
> them. The advantage of this approach is that it gives the flexibility
> to modify the register offsets if needed, restrict the use of
> certain descriptor types and negotiate the supported packet types.
> 
> Co-developed-by: Alan Brady <alan.brady@intel.com>
> Signed-off-by: Alan Brady <alan.brady@intel.com>
> Co-developed-by: Joshua Hay <joshua.a.hay@intel.com>
> Signed-off-by: Joshua Hay <joshua.a.hay@intel.com>
> Co-developed-by: Madhu Chittim <madhu.chittim@intel.com>
> Signed-off-by: Madhu Chittim <madhu.chittim@intel.com>
> Co-developed-by: Phani Burra <phani.r.burra@intel.com>
> Signed-off-by: Phani Burra <phani.r.burra@intel.com>
> Co-developed-by: Sridhar Samudrala <sridhar.samudrala@intel.com>
> Signed-off-by: Sridhar Samudrala <sridhar.samudrala@intel.com>
> Signed-off-by: Pavan Kumar Linga <pavan.kumar.linga@intel.com>
> Reviewed-by: Sridhar Samudrala <sridhar.samudrala@intel.com>
> Reviewed-by: Willem de Bruijn <willemb@google.com>
> ---
>  drivers/net/ethernet/intel/idpf/virtchnl2.h   | 1201 +++++++++++++++++
>  .../ethernet/intel/idpf/virtchnl2_lan_desc.h  |  666 +++++++++
>  2 files changed, 1867 insertions(+)
>  create mode 100644 drivers/net/ethernet/intel/idpf/virtchnl2.h
>  create mode 100644 drivers/net/ethernet/intel/idpf/virtchnl2_lan_desc.h
> 
> diff --git a/drivers/net/ethernet/intel/idpf/virtchnl2.h b/drivers/net/ethernet/intel/idpf/virtchnl2.h

...

> +/**
> + * This macro is used to generate compilation errors if a structure
> + * is not exactly the correct length.
> + */

Hi Pavan,

./scripts/kernel-doc -none drivers/net/ethernet/intel/idpf/virtchnl2.h
reports that the comment above starts with '/**' but is not a kernel-doc
comment. Which seems to be correct. It also flags many other similar issues.

Please consider running kernel-doc and resolving the issues it flags.

  reply	other threads:[~2023-04-11  8:51 UTC|newest]

Thread overview: 84+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-11  1:13 [Intel-wired-lan] [PATCH net-next v2 00/15] Introduce Intel IDPF driver Pavan Kumar Linga
2023-04-11  1:13 ` Pavan Kumar Linga
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 01/15] virtchnl: add virtchnl version 2 ops Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  8:51   ` Simon Horman [this message]
2023-04-11  8:51     ` Simon Horman
2023-04-12 21:38     ` [Intel-wired-lan] " Tantilov, Emil S
2023-04-12 21:38       ` Tantilov, Emil S
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 02/15] idpf: add module register and probe functionality Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11 12:36   ` [Intel-wired-lan] " Leon Romanovsky
2023-04-11 12:36     ` Leon Romanovsky
2023-04-12 23:10     ` [Intel-wired-lan] " Tantilov, Emil S
2023-04-12 23:10       ` Tantilov, Emil S
2023-04-13  6:03       ` [Intel-wired-lan] " Leon Romanovsky
2023-04-13  6:03         ` Leon Romanovsky
2023-04-13 18:58         ` [Intel-wired-lan] " Tantilov, Emil S
2023-04-13 18:58           ` Tantilov, Emil S
2023-04-20 18:13       ` [Intel-wired-lan] " Tantilov, Emil S
2023-04-20 18:13         ` Tantilov, Emil S
2023-04-20 18:20         ` Leon Romanovsky
2023-04-20 18:20           ` Leon Romanovsky
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 03/15] idpf: add controlq init and reset checks Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  9:19   ` [Intel-wired-lan] " Simon Horman
2023-04-11  9:19     ` Simon Horman
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 04/15] idpf: add core init and interrupt request Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  9:52   ` [Intel-wired-lan] " Simon Horman
2023-04-11  9:52     ` Simon Horman
2023-04-13 19:10     ` [Intel-wired-lan] " Tantilov, Emil S
2023-04-13 19:10       ` Tantilov, Emil S
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 05/15] idpf: add create vport and netdev configuration Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 06/15] idpf: continue expanding init task Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  9:04   ` [Intel-wired-lan] " Simon Horman
2023-04-11  9:04     ` Simon Horman
2023-04-13 19:04     ` [Intel-wired-lan] " Tantilov, Emil S
2023-04-13 19:04       ` Tantilov, Emil S
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 07/15] idpf: configure resources for TX queues Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 08/15] idpf: configure resources for RX queues Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 09/15] idpf: initialize interrupts and enable vport Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 10/15] idpf: add splitq start_xmit Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 11/15] idpf: add TX splitq napi poll support Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 12/15] idpf: add RX " Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 13/15] idpf: add singleq start_xmit and napi poll Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 14/15] idpf: add ethtool callbacks Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-11  9:55   ` [Intel-wired-lan] " Simon Horman
2023-04-11  9:55     ` Simon Horman
2023-04-13 19:11     ` [Intel-wired-lan] " Tantilov, Emil S
2023-04-13 19:11       ` Tantilov, Emil S
2023-04-22  5:26       ` [Intel-wired-lan] " Tantilov, Emil S
2023-04-22  5:26         ` Tantilov, Emil S
2023-04-22  7:55         ` Simon Horman
2023-04-22  7:55           ` Simon Horman
2023-04-11  1:13 ` [Intel-wired-lan] [PATCH net-next v2 15/15] idpf: configure SRIOV and add other ndo_ops Pavan Kumar Linga
2023-04-11  1:13   ` Pavan Kumar Linga
2023-04-12 18:25 ` [Intel-wired-lan] [PATCH net-next v2 00/15] Introduce Intel IDPF driver Sasha Levin
2023-04-12 18:25   ` Sasha Levin
2023-04-12 19:16   ` Willem de Bruijn
2023-04-12 19:16     ` Willem de Bruijn
2023-04-13  0:03     ` Samudrala, Sridhar
2023-04-13  0:03       ` Samudrala, Sridhar
2023-04-13  2:24       ` Jakub Kicinski
2023-04-13  2:24         ` Jakub Kicinski
2023-04-13  7:15         ` Leon Romanovsky
2023-04-13  7:15           ` Leon Romanovsky
2023-04-14 22:01         ` Sasha Levin
2023-04-14 22:01           ` Sasha Levin
2023-04-14 22:27           ` Jakub Kicinski
2023-04-14 22:27             ` Jakub Kicinski
2023-04-15 17:16             ` Sasha Levin
2023-04-15 17:16               ` Sasha Levin
2023-04-17 16:38               ` Jakub Kicinski
2023-04-17 16:38                 ` Jakub Kicinski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ZDUfhqA41BZOP9PW@corigine.com \
    --to=simon.horman@corigine.com \
    --cc=anthony.l.nguyen@intel.com \
    --cc=davem@davemloft.net \
    --cc=decot@google.com \
    --cc=edumazet@google.com \
    --cc=intel-wired-lan@lists.osuosl.org \
    --cc=jesse.brandeburg@intel.com \
    --cc=kuba@kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=pavan.kumar.linga@intel.com \
    --cc=phani.r.burra@intel.com \
    --cc=willemb@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.