xref: /xnu-10002.1.13/osfmk/man/io_done_queue_terminate.html (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions<h2>io_done_queue_terminate</h2>
2*1031c584SApple OSS Distributions<hr>
3*1031c584SApple OSS Distributions<p>
4*1031c584SApple OSS Distributions<strong>Function</strong> - Terminate an io_done_queue kernel object.
5*1031c584SApple OSS Distributions<h3>SYNOPSIS</h3>
6*1031c584SApple OSS Distributions<pre>
7*1031c584SApple OSS Distributions<strong>#include&ltdevice/device.h&gt</strong>
8*1031c584SApple OSS Distributions
9*1031c584SApple OSS Distributions<strong>kern_return_t	io_done_queue_terminate</strong>
10*1031c584SApple OSS Distributions		<strong>(mach_port_t</strong>	<var>queue</var><strong>);</strong>
11*1031c584SApple OSS Distributions</pre>
12*1031c584SApple OSS Distributions<h3>PARAMETERS</h3>
13*1031c584SApple OSS Distributions<dl>
14*1031c584SApple OSS Distributions<p>
15*1031c584SApple OSS Distributions<dt> <var>queue</var>
16*1031c584SApple OSS Distributions<dd>
17*1031c584SApple OSS Distributions[in io-done-queue send right] The port referencing the <strong>io_done_queue</strong>
18*1031c584SApple OSS Distributionsto be destroyed.
19*1031c584SApple OSS Distributions</dl>
20*1031c584SApple OSS Distributions<h3>DESCRIPTION</h3>
21*1031c584SApple OSS Distributions<p>
22*1031c584SApple OSS DistributionsThe <strong>io_done_queue_terminate</strong> function is called to destroy a previous
23*1031c584SApple OSS Distributionsinstatiation of the kernel object supporting asynchronous read/write
24*1031c584SApple OSS Distributionsoperations on a device.
25*1031c584SApple OSS Distributions<h3>RETURN VALUES</h3>
26*1031c584SApple OSS Distributions<dl>
27*1031c584SApple OSS Distributions  <dt> <strong>KERN_INVALID_ARGUMENT</strong>
28*1031c584SApple OSS Distributions<dd>
29*1031c584SApple OSS Distributions     Invalid <var>queue</var> parameter.
30*1031c584SApple OSS Distributions     <p>
31*1031c584SApple OSS Distributions</dl>
32*1031c584SApple OSS Distributions<h3>RELATED INFORMATION</h3>
33*1031c584SApple OSS Distributions<p>
34*1031c584SApple OSS DistributionsFunctions:
35*1031c584SApple OSS Distributions<a href="io_done_queue_create.html"><strong>io_done_queue_create</strong></a>,
36*1031c584SApple OSS Distributions<a href="io_done_queue_wait.html"><strong>io_done_queue_wait</strong></a>,
37*1031c584SApple OSS Distributions<a href="device_read_async.html"><strong>device_read_async</strong></a>,
38*1031c584SApple OSS Distributions<a href="device_read_async_inband.html"><strong>device_read_async_inband</strong></a>,
39*1031c584SApple OSS Distributions<a href="DR_overwrite_async.html"><strong>device_read_overwrite_async</strong></a>,
40*1031c584SApple OSS Distributions<a href="device_write_async.html"><strong>device_write_async</strong></a>,
41*1031c584SApple OSS Distributions<a href="device_write_async_inband.html"><strong>device_write_async_inband</strong></a>.
42