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