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