xref: /xnu-12377.41.6/osfmk/man/device_write_async.html (revision bbb1b6f9e71b8cdde6e5cd6f4841f207dee3d828)
1*bbb1b6f9SApple OSS Distributions<h2>device_write_async</h2>
2*bbb1b6f9SApple OSS Distributions<hr>
3*bbb1b6f9SApple OSS Distributions<p>
4*bbb1b6f9SApple OSS Distributions<strong>System Trap</strong> - Write a sequence of bytes to a device object.
5*bbb1b6f9SApple OSS Distributions<h3>SYNOPSIS</h3>
6*bbb1b6f9SApple OSS Distributions<pre>
7*bbb1b6f9SApple OSS Distributions<strong>kern_return_t   device_write_async</strong>
8*bbb1b6f9SApple OSS Distributions                <strong>(mach_port_t</strong>                             <var>device</var>,
9*bbb1b6f9SApple OSS Distributions                 <strong>mach_port_t</strong>                              <var>queue</var>,
10*bbb1b6f9SApple OSS Distributions                 <strong>mach_port_t</strong>                         <var>request_id</var>,
11*bbb1b6f9SApple OSS Distributions                 <strong>dev_mode_t</strong>                                <var>mode</var>,
12*bbb1b6f9SApple OSS Distributions                 <strong>recnum_t</strong>                                <var>recnum</var>,
13*bbb1b6f9SApple OSS Distributions                 <strong>io_buf_ptr_t</strong>                              <var>data</var>,
14*bbb1b6f9SApple OSS Distributions                 <strong>io_buf_len_t</strong>                      <var>bytes_wanted</var><strong>);</strong>
15*bbb1b6f9SApple OSS Distributions</pre>
16*bbb1b6f9SApple OSS Distributions<h3>PARAMETERS</h3>
17*bbb1b6f9SApple OSS Distributions<dl>
18*bbb1b6f9SApple OSS Distributions<p>
19*bbb1b6f9SApple OSS Distributions<dt> <var>device</var>
20*bbb1b6f9SApple OSS Distributions<dd>
21*bbb1b6f9SApple OSS Distributions[in device send right] A device port to the device to be read.
22*bbb1b6f9SApple OSS Distributions<p>
23*bbb1b6f9SApple OSS Distributions<dt> <var>queue</var>
24*bbb1b6f9SApple OSS Distributions<dd>
25*bbb1b6f9SApple OSS Distributions[in io_done queue send right] The port returned from
26*bbb1b6f9SApple OSS Distributionsio_done_queue_create.
27*bbb1b6f9SApple OSS Distributions<p>
28*bbb1b6f9SApple OSS Distributions<dt> <var>request_id</var>
29*bbb1b6f9SApple OSS Distributions<dd>
30*bbb1b6f9SApple OSS Distributions[in send right] An unique request identifier that will be passed back as
31*bbb1b6f9SApple OSS Distributionspart of the io_done_result structure.
32*bbb1b6f9SApple OSS Distributions<p>
33*bbb1b6f9SApple OSS Distributions<dt> <var>mode</var>
34*bbb1b6f9SApple OSS Distributions<dd>
35*bbb1b6f9SApple OSS Distributions[in scalar] I/O mode value. Meaningful options are:
36*bbb1b6f9SApple OSS Distributions<p>
37*bbb1b6f9SApple OSS Distributions     <dl>
38*bbb1b6f9SApple OSS Distributions<dt> <strong>D_NOWAIT</strong>
39*bbb1b6f9SApple OSS Distributions<dd>
40*bbb1b6f9SApple OSS DistributionsDo not wait if data is unavailable.
41*bbb1b6f9SApple OSS Distributions     </dl>
42*bbb1b6f9SApple OSS Distributions<p>
43*bbb1b6f9SApple OSS Distributions<dt> <var>recnum</var>
44*bbb1b6f9SApple OSS Distributions<dd>
45*bbb1b6f9SApple OSS Distributions[in scalar] Record number to be read.
46*bbb1b6f9SApple OSS Distributions<p>
47*bbb1b6f9SApple OSS Distributions<dt> <var>data</var>
48*bbb1b6f9SApple OSS Distributions<dd>
49*bbb1b6f9SApple OSS Distributions[pointer to in array of bytes] Data bytes to be written.
50*bbb1b6f9SApple OSS Distributions<p>
51*bbb1b6f9SApple OSS Distributions<dt> <var>bytes_wanted</var>
52*bbb1b6f9SApple OSS Distributions<dd>
53*bbb1b6f9SApple OSS Distributions[in scalar] Size of data transfer.
54*bbb1b6f9SApple OSS Distributions</dl>
55*bbb1b6f9SApple OSS Distributions<h3>DESCRIPTION</h3>
56*bbb1b6f9SApple OSS Distributions<p>
57*bbb1b6f9SApple OSS DistributionsThe <strong>device_write_async</strong> function enqueues a write operation for a
58*bbb1b6f9SApple OSS Distributionssequence of bytes to a device object. The meaning of recnum as well as
59*bbb1b6f9SApple OSS Distributionsthe specific operation performed is device dependent.
60*bbb1b6f9SApple OSS Distributions<h3>RETURN VALUES</h3>
61*bbb1b6f9SApple OSS Distributions<p>
62*bbb1b6f9SApple OSS Distributions<strong>device_write_async</strong> returns only invalid parameter errors.
63*bbb1b6f9SApple OSS Distributions<h3>RELATED INFORMATION</h3>
64*bbb1b6f9SApple OSS Distributions<p>
65*bbb1b6f9SApple OSS DistributionsFunctions:
66*bbb1b6f9SApple OSS Distributions<a href="device_read_async_inband.html"><strong>device_read_async_inband</strong></a>,
67*bbb1b6f9SApple OSS Distributions<a href="DR_overwrite_async.html"><strong>device_read_overwrite_async</strong></a>,
68*bbb1b6f9SApple OSS Distributions<a href="device_write_async_inband.html"><strong>device_write_async_inband</strong></a>,
69*bbb1b6f9SApple OSS Distributions<a href="io_done_queue_create.html"><strong>io_done_queue_create</strong></a>.
70