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