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