From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v2 19/19] doc: update source organisation text for drivers
Date: Fri, 15 May 2015 16:57:03 +0100 [thread overview]
Message-ID: <1431705423-16134-20-git-send-email-bruce.richardson@intel.com> (raw)
In-Reply-To: <1431705423-16134-1-git-send-email-bruce.richardson@intel.com>
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 --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
next prev parent reply other threads:[~2015-05-15 15:57 UTC|newest]
Thread overview: 74+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-05-07 15:35 [dpdk-dev] [RFC PATCH 0/2] Move PMDs out of lib directory Bruce Richardson
2015-05-07 15:35 ` [dpdk-dev] [RFC PATCH 1/2] pmds: Use relative rather than absolute paths Bruce Richardson
2015-05-07 15:45 ` [dpdk-dev] [RFC PATCH 0/2] Move PMDs out of lib directory Marc Sune
2015-05-07 16:04 ` Bruce Richardson
2015-05-07 21:11 ` Wiles, Keith
2015-05-08 9:10 ` Bruce Richardson
2015-05-07 15:50 ` Bruce Richardson
2015-05-11 9:47 ` Thomas Monjalon
2015-05-12 17:04 ` [dpdk-dev] [PATCH 00/19] Move PMDs to drivers directory Bruce Richardson
2015-05-12 17:04 ` [dpdk-dev] [PATCH 01/19] pmds: Use relative rather than absolute paths Bruce Richardson
2015-05-12 17:04 ` [dpdk-dev] [PATCH 02/19] drivers: create new top-level drivers directory Bruce Richardson
2015-05-12 17:04 ` [dpdk-dev] [PATCH 03/19] af_packet: move af_packet pmd to " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 04/19] bond: Move bonded ethdev pmd to drivers Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 05/19] e1000: move e1000 pmd to drivers directory Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 06/19] enic: move enic PMD " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 07/19] fm10k: move fm10k " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 08/19] i40e: move i40e " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 09/19] ixbge: move ixgbe " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 10/19] mlx4: move mlx4 " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 11/19] null pmd: move null " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 12/19] pcap: move pcap pmd " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 13/19] ring pmd: move ring PMD to the " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 14/19] virtio: move virtio PMD to " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 15/19] xmvnet3: move vmxnet3 " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 16/19] xenvirt: move xenvirt " Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 17/19] maintainers: update maintainers with driver paths Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 18/19] doc: update GSG doc for new drivers subdirectory Bruce Richardson
2015-05-12 17:05 ` [dpdk-dev] [PATCH 19/19] doc: update source organisation text for drivers Bruce Richardson
2015-05-12 19:30 ` [dpdk-dev] [PATCH 00/19] Move PMDs to drivers directory Thomas Monjalon
2015-05-13 9:01 ` Bruce Richardson
2015-05-13 13:33 ` Thomas Monjalon
2015-05-13 13:40 ` Bruce Richardson
2015-05-13 15:58 ` Bruce Richardson
2015-05-15 12:54 ` Thomas Monjalon
2015-05-15 13:14 ` Bruce Richardson
2015-05-15 12:36 ` Bruce Richardson
2015-05-15 12:50 ` Thomas Monjalon
2015-05-15 12:56 ` Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 " Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 01/19] pmds: Use relative rather than absolute paths Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 02/19] drivers: create drivers and drivers/net directory Bruce Richardson
2015-05-20 15:04 ` Thomas Monjalon
2015-05-20 15:30 ` Richardson, Bruce
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 03/19] af_packet: move af_packet pmd to " Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 04/19] bond: Move bonded ethdev pmd to drivers/net Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 05/19] e1000: move e1000 pmd to drivers/net directory Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 06/19] enic: move enic PMD " Bruce Richardson
2015-05-20 15:56 ` Thomas Monjalon
2015-05-20 16:04 ` Richardson, Bruce
2015-05-20 16:14 ` Thomas Monjalon
2015-05-20 16:45 ` Sujith Sankar (ssujith)
2015-05-20 16:52 ` Thomas Monjalon
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 07/19] fm10k: move fm10k " Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 08/19] i40e: move i40e " Bruce Richardson
2015-05-18 11:05 ` [dpdk-dev] [PATCH v3 " Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 09/19] ixbge: move ixgbe " Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 10/19] mlx4: move mlx4 " Bruce Richardson
2015-05-23 4:46 ` Or Gerlitz
2015-05-23 20:37 ` Thomas Monjalon
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 11/19] null pmd: move null " Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 12/19] pcap: move pcap pmd to drivers/net Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 13/19] ring pmd: move ring PMD to the drivers directory Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 14/19] virtio: move virtio PMD to drivers/net Bruce Richardson
2015-05-15 15:56 ` [dpdk-dev] [PATCH v2 15/19] xmvnet3: move vmxnet3 " Bruce Richardson
2015-05-15 15:57 ` [dpdk-dev] [PATCH v2 16/19] xenvirt: move xenvirt " Bruce Richardson
2015-05-15 15:57 ` [dpdk-dev] [PATCH v2 17/19] maintainers: update maintainers with driver paths Bruce Richardson
2015-05-15 15:57 ` [dpdk-dev] [PATCH v2 18/19] doc: update GSG doc for new drivers subdirectory Bruce Richardson
2015-05-15 15:57 ` Bruce Richardson [this message]
2015-05-19 11:14 ` [dpdk-dev] [PATCH v2 00/19] Move PMDs to drivers directory Mcnamara, John
2015-05-19 11:24 ` Bruce Richardson
2015-05-19 12:01 ` Thomas Monjalon
2015-05-19 13:40 ` Thomas F Herbert
2015-05-22 14:09 ` Thomas Monjalon
2015-05-22 16:19 ` Bruce Richardson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1431705423-16134-20-git-send-email-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).