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