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