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