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