From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id E4B565A45 for ; Fri, 15 May 2015 17:57:11 +0200 (CEST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga102.jf.intel.com with ESMTP; 15 May 2015 08:57:11 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.13,434,1427785200"; d="scan'208";a="571942988" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga003.jf.intel.com with ESMTP; 15 May 2015 08:57:10 -0700 Received: from sivswdev01.ir.intel.com (sivswdev01.ir.intel.com [10.237.217.45]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id t4FFv9nU030329; Fri, 15 May 2015 16:57:10 +0100 Received: from sivswdev01.ir.intel.com (localhost [127.0.0.1]) by sivswdev01.ir.intel.com with ESMTP id t4FFv9wA016309; Fri, 15 May 2015 16:57:09 +0100 Received: (from bricha3@localhost) by sivswdev01.ir.intel.com with id t4FFv9uv016304; Fri, 15 May 2015 16:57:09 +0100 From: Bruce Richardson To: dev@dpdk.org Date: Fri, 15 May 2015 16:57:03 +0100 Message-Id: <1431705423-16134-20-git-send-email-bruce.richardson@intel.com> X-Mailer: git-send-email 1.7.4.1 In-Reply-To: <1431705423-16134-1-git-send-email-bruce.richardson@intel.com> References: <1431450315-13179-1-git-send-email-bruce.richardson@intel.com> <1431705423-16134-1-git-send-email-bruce.richardson@intel.com> Subject: [dpdk-dev] [PATCH v2 19/19] doc: update source organisation text for drivers X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 15 May 2015 15:57:12 -0000 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..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 ------------ -- 2.1.0