Updated v2023.2.1 DPDK driver documentation

Xilinx · Nov 10, 2023 · 8ea2101 · 8ea2101
1 parent 1e62728
commit 8ea2101
Show file tree

Hide file tree

Showing 23 changed files with 36 additions and 24 deletions.
diff --git a/master/QDMA/DPDK/html/_sources/build.rst.txt b/master/QDMA/DPDK/html/_sources/build.rst.txt
@@ -171,12 +171,18 @@ support 2K queues and populate Xilinx devices for binding.
 
 		cflags += ['-DTHROUGHPUT_MEASUREMENT']
 
-	b. To enhance the DPDK driver's debugging capabilities, added support for latency measurement statistics in both the Tx path (TxQ SW PIDX to HW CIDX) and the Rx path (RxQ SW PIDX to CMPT PIDX). To enable this driver support, please add the following line to ./drivers/net/qdma/meson.build
+	c. To enhance the DPDK driver's debugging capabilities, added support for latency measurement statistics in both the Tx path (TxQ SW PIDX to HW CIDX) and the Rx path (RxQ SW PIDX to CMPT PIDX). To enable this driver support, please add the following line to ./drivers/net/qdma/meson.build
 
 	::
 
 		cflags += ['-DLATENCY_MEASUREMENT']
 
+	d. To enable 10 bit tag support in qdma dpdk driver for Gen5x8 performance measurements for CPM5 design, add below line to ./drivers/net/qdma/meson.build
+
+	::
+
+		cflags += ['-DEQDMA_CPM5_10BIT_TAG_ENABLE']
+
 Setup: Host system
 ^^^^^^^^^^^^^^^^^^
 

diff --git a/master/QDMA/DPDK/html/build.html b/master/QDMA/DPDK/html/build.html
@@ -605,12 +605,18 @@ <h3>Setup: Download and modifications<a class="headerlink" href="#setup-download
 <div class="highlight-none"><div class="highlight"><pre><span></span>cflags += [&#39;-DTHROUGHPUT_MEASUREMENT&#39;]
 </pre></div>
 </div>
-<ol class="loweralpha simple" start="2">
+<ol class="loweralpha simple" start="3">
 <li>To enhance the DPDK driver’s debugging capabilities, added support for latency measurement statistics in both the Tx path (TxQ SW PIDX to HW CIDX) and the Rx path (RxQ SW PIDX to CMPT PIDX). To enable this driver support, please add the following line to ./drivers/net/qdma/meson.build</li>
 </ol>
 <div class="highlight-none"><div class="highlight"><pre><span></span>cflags += [&#39;-DLATENCY_MEASUREMENT&#39;]
 </pre></div>
 </div>
+<ol class="loweralpha simple" start="4">
+<li>To enable 10 bit tag support in qdma dpdk driver for Gen5x8 performance measurements for CPM5 design, add below line to ./drivers/net/qdma/meson.build</li>
+</ol>
+<div class="highlight-none"><div class="highlight"><pre><span></span>cflags += [&#39;-DEQDMA_CPM5_10BIT_TAG_ENABLE&#39;]
+</pre></div>
+</div>
 </div></blockquote>
 </div>
 <div class="section" id="setup-host-system">
@@ -743,7 +749,7 @@ <h3>Setup: Make Commands<a class="headerlink" href="#setup-make-commands" title=
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/dev-guide.html b/master/QDMA/DPDK/html/dev-guide.html
@@ -463,7 +463,7 @@ <h1>Developers Guide<a class="headerlink" href="#developers-guide" title="Permal
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/dpdk-callbacks.html b/master/QDMA/DPDK/html/dpdk-callbacks.html
@@ -508,7 +508,7 @@ <h1>DPDK Callback APIs<a class="headerlink" href="#dpdk-callback-apis" title="Pe
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/dpdk_linux_interop.html b/master/QDMA/DPDK/html/dpdk_linux_interop.html
@@ -494,7 +494,7 @@ <h2><strong>Note</strong><a class="headerlink" href="#note" title="Permalink to
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/driver-design.html b/master/QDMA/DPDK/html/driver-design.html
@@ -590,7 +590,7 @@ <h2>DPDK Driver debug<a class="headerlink" href="#dpdk-driver-debug" title="Perm
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/features.html b/master/QDMA/DPDK/html/features.html
@@ -599,7 +599,7 @@ <h2>Software Features<a class="headerlink" href="#software-features" title="Perm
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/genindex.html b/master/QDMA/DPDK/html/genindex.html
@@ -589,7 +589,7 @@ <h2 id="S">S</h2>
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/index.html b/master/QDMA/DPDK/html/index.html
@@ -466,7 +466,7 @@ <h1>Xilinx QDMA DPDK Poll Mode Driver<a class="headerlink" href="#xilinx-qdma-dp
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/perf.html b/master/QDMA/DPDK/html/perf.html
@@ -451,7 +451,7 @@ <h1>QDMA DPDK Performance<a class="headerlink" href="#qdma-dpdk-performance" tit
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/pf_vf_shutdown.html b/master/QDMA/DPDK/html/pf_vf_shutdown.html
@@ -488,7 +488,7 @@ <h2>PF shutdown<a class="headerlink" href="#pf-shutdown" title="Permalink to thi
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/qdma_devops_functions.html b/master/QDMA/DPDK/html/qdma_devops_functions.html
@@ -1301,7 +1301,7 @@ <h1>Functions<a class="headerlink" href="#functions" title="Permalink to this he
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/qdma_mailbox.html b/master/QDMA/DPDK/html/qdma_mailbox.html
@@ -583,7 +583,7 @@ <h1>QDMA Mailbox<a class="headerlink" href="#qdma-mailbox" title="Permalink to t
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/qdma_pmd_export.html b/master/QDMA/DPDK/html/qdma_pmd_export.html
@@ -526,7 +526,7 @@ <h1>QDMA DPDK PMD Exported APIs<a class="headerlink" href="#qdma-dpdk-pmd-export
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/qdma_resmgmt.html b/master/QDMA/DPDK/html/qdma_resmgmt.html
@@ -512,7 +512,7 @@ <h2>Multiple devices on single Host managed by Single driver<a class="headerlink
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/qdma_usecases.html b/master/QDMA/DPDK/html/qdma_usecases.html
@@ -678,7 +678,7 @@ <h3>ST C2H(Card-to-Host)<a class="headerlink" href="#st-c2h-card-to-host" title=
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/rte_pmd_qdma_enums.html b/master/QDMA/DPDK/html/rte_pmd_qdma_enums.html
@@ -926,7 +926,7 @@
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/rte_pmd_qdma_functions.html b/master/QDMA/DPDK/html/rte_pmd_qdma_functions.html
@@ -1337,7 +1337,7 @@ <h1>Functions<a class="headerlink" href="#functions" title="Permalink to this he
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/rte_pmd_qdma_structs.html b/master/QDMA/DPDK/html/rte_pmd_qdma_structs.html
@@ -549,7 +549,7 @@
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/search.html b/master/QDMA/DPDK/html/search.html
@@ -445,7 +445,7 @@
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/searchindex.js b/master/QDMA/DPDK/html/searchindex.js
diff --git a/master/QDMA/DPDK/html/system-requirements.html b/master/QDMA/DPDK/html/system-requirements.html
@@ -583,7 +583,7 @@ <h2>Other Linux Distributions<a class="headerlink" href="#other-linux-distributi
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>

diff --git a/master/QDMA/DPDK/html/userguide.html b/master/QDMA/DPDK/html/userguide.html
@@ -1071,7 +1071,7 @@ <h3>Executing with vfio-pci driver in VM using QEMU<a class="headerlink" href="#
   <div role="contentinfo" class="copyright">
     <p class="footerinfo">
       <span class="lastupdated">
-        Last updated on October 18, 2023.
+        Last updated on November 10, 2023.
       </span>
 
     </p>