diff mbox

[dpdk-dev,v2,19/19] doc: update source organisation text for drivers

Message ID 1431705423-16134-20-git-send-email-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Headers show

Commit Message

Bruce Richardson May 15, 2015, 3:57 p.m. UTC
Since the PMDs have moved to the drivers directory, update the docs that
cover the source code organisation of DPDK

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/prog_guide/source_org.rst | 37 +++++++++++++++++++++++++-----------
 1 file changed, 26 insertions(+), 11 deletions(-)
diff mbox

Patch

diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst
index 1bce0b8..4f6f489 100644
--- a/doc/guides/prog_guide/source_org.rst
+++ b/doc/guides/prog_guide/source_org.rst
@@ -79,22 +79,37 @@  The lib directory contains::
     +-- librte_mempool      # memory pool manager (fixedsized objects)
     +-- librte_meter        # QoS metering library
     +-- librte_net          # various IP-related headers
-    +-- librte_pmd_bond     # bonding poll mode driver
-    +-- librte_pmd_e1000    # 1GbE poll mode drivers (igb and em)
-    +-- librte_pmd_fm10k    # Host interface PMD driver for FM10000 Series
-    +-- librte_pmd_ixgbe    # 10GbE poll mode driver
-    +-- librte_pmd_i40e     # 40GbE poll mode driver
-    +-- librte_pmd_mlx4     # Mellanox ConnectX-3 poll mode driver
-    +-- librte_pmd_pcap     # PCAP poll mode driver
-    +-- librte_pmd_ring     # ring poll mode driver
-    +-- librte_pmd_virtio   # virtio poll mode driver
-    +-- librte_pmd_vmxnet3  # VMXNET3 poll mode driver
-    +-- librte_pmd_xenvirt  # Xen virtio poll mode driver
     +-- librte_power        # power management library
     +-- librte_ring         # software rings (act as lockless FIFOs)
     +-- librte_sched        # QoS scheduler and dropper library
     +-- librte_timer        # timer library
 
+Drivers
+-------
+
+Drivers are special libraries which provide poll-mode driver implementations for
+devices - either hardware devices or pseudo/virtual devices. They are contained
+in the "drivers" subdirectory, classified by type, and each compiles to a
+library with the format "librte_pmd_X.a" where "X" is the driver name.
+
+The drivers directory has a net subdirectory which contains::
+
+    drivers/net
+    +-- af_packet          # poll mode driver based on linux af_packet
+    +-- bonding            # bonding poll mode driver
+    +-- e1000              # 1GbE poll mode drivers (igb and em)
+    +-- enic               # Cisco VIC Ethernet NIC Poll-mode Driver
+    +-- fm10k              # Host interface PMD driver for FM10000 Series
+    +-- i40e               # 40GbE poll mode driver
+    +-- ixgbe              # 10GbE poll mode driver
+    +-- mlx4               # Mellanox ConnectX-3 poll mode driver
+    +-- null               # NULL poll mode driver for testing
+    +-- pcap               # PCAP poll mode driver
+    +-- ring               # ring poll mode driver
+    +-- virtio             # virtio poll mode driver
+    +-- vmxnet3            # VMXNET3 poll mode driver
+    +-- xenvirt            # Xen virtio poll mode driver
+
 Applications
 ------------