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