doc: add af_packet PMD guide
authorTiago Lam <tiago.lam@intel.com>
Mon, 17 Dec 2018 09:14:22 +0000 (09:14 +0000)
committerFerruh Yigit <ferruh.yigit@intel.com>
Fri, 21 Dec 2018 15:22:40 +0000 (16:22 +0100)
commit6ef75e405d5a88e8806b261c1a6c3f6b30385007
tree078b89ffa2b36fc2ed49f3ebfcd4fec79f863995
parentf2b76d22f85694864bbcd0f88267de9ef02d75c0
doc: add af_packet PMD guide

As of commit 364e08f2bbc0, DPDK allows an application to send and
receive raw packets using an AF_PACKET and PACKET_MMAP, when using
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>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
doc/guides/nics/af_packet.rst [new file with mode: 0644]
doc/guides/nics/index.rst