summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/xdma.4 3.html
diff options
context:
space:
mode:
Diffstat (limited to 'static/freebsd/man4/xdma.4 3.html')
-rw-r--r--static/freebsd/man4/xdma.4 3.html65
1 files changed, 65 insertions, 0 deletions
diff --git a/static/freebsd/man4/xdma.4 3.html b/static/freebsd/man4/xdma.4 3.html
new file mode 100644
index 00000000..4f11bd07
--- /dev/null
+++ b/static/freebsd/man4/xdma.4 3.html
@@ -0,0 +1,65 @@
+<table class="head">
+ <tr>
+ <td class="head-ltitle">XDMA(4)</td>
+ <td class="head-vol">Device Drivers Manual</td>
+ <td class="head-rtitle">XDMA(4)</td>
+ </tr>
+</table>
+<div class="manual-text">
+<section class="Sh">
+<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
+<p class="Pp"><code class="Nm">xdma</code> &#x2014; <span class="Nd">DMA
+ abstraction layer</span></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
+<p class="Pp">To compile xDMA device support into the kernel, place the
+ following line in your kernel configuration file:</p>
+<div class="Bd Pp Bd-indent"><code class="Cd">device xdma</code></div>
+<p class="Pp">To compile xDMA FDT-based test driver, place the following line as
+ well:</p>
+<div class="Bd Pp Bd-indent Li">
+<pre><code class="Cd">device xdma_test</code></pre>
+</div>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
+<p class="Pp">xDMA is a DMA framework designed to abstract the interaction
+ between device drivers and DMA engines.</p>
+<p class="Pp">xDMA defines an interface for efficient interaction between the
+ device driver and DMA controller. The <code class="Nm">xdma</code> device
+ provides a virtual DMA controller and virtual channels called xchans. The
+ controller provides virtual channels management (allocation, deallocation,
+ configuration) and interrupt notification esteblishment needed to receive
+ events from the hardware DMA controller. <code class="Nm">xdma</code>
+ supports the following transfer types:</p>
+<dl class="Bl-hang Bd-indent">
+ <dt><code class="Nm">Cyclic</code></dt>
+ <dd>A non-stop periodic transfer designed for applications like audio.</dd>
+ <dt><code class="Nm">Memcpy</code></dt>
+ <dd>A memory-to-memory transfer.</dd>
+</dl>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
+ ALSO</a></h1>
+<p class="Pp"><a class="Xr">bus_dma(9)</a></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
+<p class="Pp">Support for xDMA first appeared in <span class="Ux">FreeBSD
+ 12.0</span>.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
+<p class="Pp"><span class="Ux">FreeBSD</span> xDMA framework was first added by
+ <span class="An">Ruslan Bukin</span>
+ &lt;<a class="Mt" href="mailto:br@FreeBSD.org">br@FreeBSD.org</a>&gt;.</p>
+</section>
+</div>
+<table class="foot">
+ <tr>
+ <td class="foot-date">December 12, 2016</td>
+ <td class="foot-os">FreeBSD 15.0</td>
+ </tr>
+</table>