Docs update: 42de062

[email protected] [doc] Added OPCFG documentation (#361)
intel · Sep 25, 2024 · ce74ddd · ce74ddd
1 parent 0d8f816
commit ce74ddd
Show file tree

Hide file tree

Showing 16 changed files with 45 additions and 3 deletions.
diff --git a/.doctrees/documentation/api_docs/high_level_api.doctree b/.doctrees/documentation/api_docs/high_level_api.doctree
diff --git a/.doctrees/documentation/api_docs/low_level_api.doctree b/.doctrees/documentation/api_docs/low_level_api.doctree
diff --git a/.doctrees/documentation/bench_docs/guide.doctree b/.doctrees/documentation/bench_docs/guide.doctree
diff --git a/.doctrees/documentation/contributing_docs/issue_reporting.doctree b/.doctrees/documentation/contributing_docs/issue_reporting.doctree
diff --git a/.doctrees/documentation/get_started_docs/code_samples_and_examples.doctree b/.doctrees/documentation/get_started_docs/code_samples_and_examples.doctree
diff --git a/.doctrees/documentation/get_started_docs/installation.doctree b/.doctrees/documentation/get_started_docs/installation.doctree
diff --git a/.doctrees/documentation/get_started_docs/quick_start.doctree b/.doctrees/documentation/get_started_docs/quick_start.doctree
diff --git a/.doctrees/documentation/get_started_docs/testing.doctree b/.doctrees/documentation/get_started_docs/testing.doctree
diff --git a/.doctrees/documentation/introduction_docs/introduction.doctree b/.doctrees/documentation/introduction_docs/introduction.doctree
diff --git a/.doctrees/documentation/introduction_docs/legal.doctree b/.doctrees/documentation/introduction_docs/legal.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/_sources/documentation/introduction_docs/introduction.rst b/_sources/documentation/introduction_docs/introduction.rst
@@ -55,6 +55,27 @@ The library supports several groups of operations:
 - Memory Hash
 - Utility
 
+.. _library_work_queue_support_reference_link:
+
+Work Queue Support
+==================
+
+Intel® Data Streaming Accelerator (Intel® DSA) 2.0 supports the ability
+to configure which operations are supported using the OPCFG register.
+
+As of Intel DML 1.2.0 or higher with ``libaccel-config`` library version 4.0
+or higher, the device dispatcher respects each work queue's OPCFG register.
+The operation isn't submitted to work queues that do not support it and returns a
+:c:macro:`DML_STATUS_NOT_SUPPORTED_BY_WQ` status on the Low-Level API and
+`not_supported_by_wqs` status on the High-Level API if no available
+work queue supports the operation.
+
+In the case of older Intel DML version, operations are submitted to any available
+work queue. This could cause a status code to be returned when any work queue does not support an operation.
+
+In the case of an older Intel DSA or ``libaccel-config`` version without OPCFG support, no issues
+would arise as work queues would allow all available operations.
+
 .. _library_limitations_reference_link:
 
 Library Limitations

diff --git a/documentation/introduction_docs/introduction.html b/documentation/introduction_docs/introduction.html
@@ -367,7 +367,10 @@ <h2> Contents </h2>
             </div>
             <nav aria-label="Page">
                 <ul class="visible nav section-nav flex-column">
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#library-possibilities">Library Possibilities</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#library-possibilities">Library Possibilities</a><ul class="nav section-nav flex-column">
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#work-queue-support">Work Queue Support</a></li>
+</ul>
+</li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#library-limitations">Library Limitations</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#library-apis">Library APIs</a></li>
 </ul>
@@ -427,6 +430,21 @@ <h2>Library Possibilities<a class="headerlink" href="#library-possibilities" tit
 <li><p>Memory Hash</p></li>
 <li><p>Utility</p></li>
 </ul>
+<section id="work-queue-support">
+<span id="library-work-queue-support-reference-link"></span><h3>Work Queue Support<a class="headerlink" href="#work-queue-support" title="Link to this heading">#</a></h3>
+<p>Intel® Data Streaming Accelerator (Intel® DSA) 2.0 supports the ability
+to configure which operations are supported using the OPCFG register.</p>
+<p>As of Intel DML 1.2.0 or higher with <code class="docutils literal notranslate"><span class="pre">libaccel-config</span></code> library version 4.0
+or higher, the device dispatcher respects each work queue’s OPCFG register.
+The operation isn’t submitted to work queues that do not support it and returns a
+<code class="xref c c-macro docutils literal notranslate"><span class="pre">DML_STATUS_NOT_SUPPORTED_BY_WQ</span></code> status on the Low-Level API and
+<cite>not_supported_by_wqs</cite> status on the High-Level API if no available
+work queue supports the operation.</p>
+<p>In the case of older Intel DML version, operations are submitted to any available
+work queue. This could cause a status code to be returned when any work queue does not support an operation.</p>
+<p>In the case of an older Intel DSA or <code class="docutils literal notranslate"><span class="pre">libaccel-config</span></code> version without OPCFG support, no issues
+would arise as work queues would allow all available operations.</p>
+</section>
 </section>
 <section id="library-limitations">
 <span id="library-limitations-reference-link"></span><h2>Library Limitations<a class="headerlink" href="#library-limitations" title="Link to this heading">#</a></h2>
@@ -499,7 +517,10 @@ <h2>Library APIs<a class="headerlink" href="#library-apis" title="Link to this h
   </div>
   <nav class="bd-toc-nav page-toc">
     <ul class="visible nav section-nav flex-column">
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#library-possibilities">Library Possibilities</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#library-possibilities">Library Possibilities</a><ul class="nav section-nav flex-column">
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#work-queue-support">Work Queue Support</a></li>
+</ul>
+</li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#library-limitations">Library Limitations</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#library-apis">Library APIs</a></li>
 </ul>

diff --git a/objects.inv b/objects.inv
diff --git a/searchindex.js b/searchindex.js