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