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