DPDK patches and discussions
 help / color / mirror / Atom feed
From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Tiago Lam <tiago.lam@intel.com>, dev@dpdk.org
Cc: linville@tuxdriver.com
Subject: Re: [dpdk-dev] [PATCH] net/af_packet: add docs guide
Date: Tue, 18 Dec 2018 00:31:46 +0000	[thread overview]
Message-ID: <772600cf-63c7-7a40-cc33-686a9df39083@intel.com> (raw)
In-Reply-To: <1545038062-35465-1-git-send-email-tiago.lam@intel.com>

On 12/17/2018 9:14 AM, Tiago Lam wrote:
> As of commit 364e08f2bbc0, DPDK allows an aplication to send and receive
> raw packets using an AF_PACKET and PACKET_MMAP, when using a Linux
> Kernel. This complements it by adding a simple guide with the following
> information:
> - An introduction, where a brief explanation of this driver is given,
>   pointing out the dependency on PACKET_MMAP;
> - Which options are supported at configuration time, while setting up an
>   interface, and it's inherent limitations;
> - What the prerequisites are;
> - A command line example of how to set up a DPDK port using the
>   af_packet driver.
> 
> Since there's a dependency in PACKET_MMAP, the guide also points to the
> original Kernel documentation, so the reader can get more details.
> 
> Signed-off-by: Tiago Lam <tiago.lam@intel.com>

Thanks Tiago, appreciated.

> ---
>  doc/guides/nics/af_packet.rst | 67 +++++++++++++++++++++++++++++++++++++++++++

index file (doc/guides/nics/index.rst) also needs to be updated to include new
doc, I can update this while merging.

<...>

> +Options and inherent limitations
> +--------------------------------
> +
> +The following options can be provided to set up an af_packet port in DPDK.
> +Some of these, in turn, will be used to configure the PAKET_MMAP settings.
> +
> +*   "iface" - name of the Kernel interface to attach to (required);
> +*   "qpairs" - number of Rx and Tx queues (optional, default 1);
> +*   "qdisc_bypass" - set PACKET_QDISC_BYPASS option in AF_PACKET (optional,
> +    disabled by default);
> +*   "blocksz" - PACKET_MMAP block size (optional, default 4096);
> +*   "framesz" - PACKET_MMAP frame size (optional, default 2048B; Note: multiple
> +    of 16B);
> +*   "framecnt" - PACKET_MMAP frame count (optional, default 512B).

using `` instead of " highlights the text, I can update this while merging.

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

  reply	other threads:[~2018-12-18  0:31 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-17  9:14 Tiago Lam
2018-12-18  0:31 ` Ferruh Yigit [this message]
2018-12-18  0:39   ` Ferruh Yigit
2018-12-18  8:23     ` Lam, Tiago

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=772600cf-63c7-7a40-cc33-686a9df39083@intel.com \
    --to=ferruh.yigit@intel.com \
    --cc=dev@dpdk.org \
    --cc=linville@tuxdriver.com \
    --cc=tiago.lam@intel.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).