xref: /xnu-10002.41.9/osfmk/man/io_done_queue_create.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>io_done_queue_create</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Create an <strong>io_done_queue</strong> kernel object.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>kern_return_t   io_done_queue_create</strong>
8*699cd480SApple OSS Distributions                <strong>(mach_port_t</strong>                               <var>host</var>,
9*699cd480SApple OSS Distributions                 <strong>mach_port_t</strong>                               <var>queue</var><strong>);</strong>
10*699cd480SApple OSS Distributions</pre>
11*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
12*699cd480SApple OSS Distributions<dl>
13*699cd480SApple OSS Distributions<p>
14*699cd480SApple OSS Distributions<dt> <var>host</var>
15*699cd480SApple OSS Distributions<dd>
16*699cd480SApple OSS Distributions[in host-name send right] The name (or control) port for the host on
17*699cd480SApple OSS Distributionswhich the io_done_queue should be created.
18*699cd480SApple OSS Distributions<p>
19*699cd480SApple OSS Distributions<dt> <var>queue</var>
20*699cd480SApple OSS Distributions<dd>
21*699cd480SApple OSS Distributions[out io-done-queue send right] The port referencing the created
22*699cd480SApple OSS Distributionsio_done_queue.
23*699cd480SApple OSS Distributions</dl>
24*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
25*699cd480SApple OSS Distributions<p>
26*699cd480SApple OSS DistributionsThe io_done_queue_create function is called to create a new
27*699cd480SApple OSS Distributionsinstatiation of the kernel object supporting asynchronous read/write
28*699cd480SApple OSS Distributionsoperations on a device.
29*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
30*699cd480SApple OSS Distributions<dl>
31*699cd480SApple OSS Distributions<dt> <strong>KERN_INVALID_ARGUMENT</strong>
32*699cd480SApple OSS Distributions<dd>
33*699cd480SApple OSS Distributions     Invalid <var>host</var> parameter.
34*699cd480SApple OSS Distributions     <p>
35*699cd480SApple OSS Distributions     <dt> <strong>KERN_RESOURCE_SHORTAGE</strong>
36*699cd480SApple OSS Distributions<dd>
37*699cd480SApple OSS Distributions     Insufficient kernel resources to allocate kernel object.
38*699cd480SApple OSS Distributions</dl>
39*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
40*699cd480SApple OSS Distributions<p>
41*699cd480SApple OSS DistributionsFunctions:
42*699cd480SApple OSS Distributions<a href="io_done_queue_terminate.html"><strong>io_done_queue_terminate</strong></a>,
43*699cd480SApple OSS Distributions<a href="io_done_queue_wait.html"><strong>io_done_queue_wait</strong></a>,
44*699cd480SApple OSS Distributions<a href="device_read_async.html"><strong>device_read_async</strong></a>,
45*699cd480SApple OSS Distributions<a href="device_read_async_inband.html"><strong>device_read_async_inband</strong></a>,
46*699cd480SApple OSS Distributions<a href="DR_overwrite_async.html"><strong>device_read_overwrite_async</strong></a>,
47*699cd480SApple OSS Distributions<a href="device_write_async.html"><strong>device_write_async</strong></a>,
48*699cd480SApple OSS Distributions<a href="device_write_async_inband.html"><strong>device_write_async_inband</strong></a>.
49