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