From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ferruh Yigit Subject: Re: [PATCH] net/af_packet: add docs guide Date: Tue, 18 Dec 2018 00:31:46 +0000 Message-ID: <772600cf-63c7-7a40-cc33-686a9df39083@intel.com> References: <1545038062-35465-1-git-send-email-tiago.lam@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Cc: linville@tuxdriver.com To: Tiago Lam , dev@dpdk.org Return-path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 435C31BA85 for ; Tue, 18 Dec 2018 01:31:53 +0100 (CET) In-Reply-To: <1545038062-35465-1-git-send-email-tiago.lam@intel.com> Content-Language: en-US List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 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