From mboxrd@z Thu Jan 1 00:00:00 1970 From: Bruce Richardson Subject: [PATCH 19/19] doc: update source organisation text for drivers Date: Tue, 12 May 2015 18:05:15 +0100 Message-ID: <1431450315-13179-20-git-send-email-bruce.richardson@intel.com> References: <1431012951-6423-1-git-send-email-bruce.richardson@intel.com> <1431450315-13179-1-git-send-email-bruce.richardson@intel.com> To: dev@dpdk.org Return-path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id 00B68C3EA for ; Tue, 12 May 2015 19:07:51 +0200 (CEST) In-Reply-To: <1431450315-13179-1-git-send-email-bruce.richardson@intel.com> List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- doc/guides/prog_guide/source_org.rst | 37 +++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst index 1bce0b8..f7d3a97 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, and each compiles to a library with the format +"librte_pmd_X.a" where "X" is the driver name. + +The drivers directory contains:: + + drivers + +-- 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 ------------ -- 2.1.0