xref: /xnu-8792.81.2/osfmk/man/device_reply_server.html (revision 19c3b8c28c31cb8130e034cfb5df6bf9ba342d90)
1*19c3b8c2SApple OSS Distributions<h2>device_reply_server</h2>
2*19c3b8c2SApple OSS Distributions<hr>
3*19c3b8c2SApple OSS Distributions<p>
4*19c3b8c2SApple OSS Distributions<strong>Function</strong> - Handle incoming data from kernel device driver.
5*19c3b8c2SApple OSS Distributions<h3>SYNOPSIS</h3>
6*19c3b8c2SApple OSS Distributions<pre>
7*19c3b8c2SApple OSS Distributions<strong>boolean_t	device_reply_server</strong>
8*19c3b8c2SApple OSS Distributions		<strong>(mach_msg_header_t</strong>	<var>request_msg</var>,
9*19c3b8c2SApple OSS Distributions		<strong>mach_msg_header_t</strong>	<var>reply_msg</var><strong>);</strong>
10*19c3b8c2SApple OSS Distributions</pre>
11*19c3b8c2SApple OSS Distributions<h3>PARAMETERS</h3>
12*19c3b8c2SApple OSS Distributions<dl>
13*19c3b8c2SApple OSS Distributions<p>
14*19c3b8c2SApple OSS Distributions<dt> <var>request_msg</var>
15*19c3b8c2SApple OSS Distributions<dd>
16*19c3b8c2SApple OSS Distributions[pointer to in structure]
17*19c3b8c2SApple OSS DistributionsThe device driver message received from the
18*19c3b8c2SApple OSS Distributionskernel.
19*19c3b8c2SApple OSS Distributions<p>
20*19c3b8c2SApple OSS Distributions<dt> <var>reply_msg</var>
21*19c3b8c2SApple OSS Distributions<dd>
22*19c3b8c2SApple OSS Distributions[out structure]
23*19c3b8c2SApple OSS DistributionsA reply message.  No messages from a device driver
24*19c3b8c2SApple OSS Distributionsexpect a direct reply, so this field is not used.
25*19c3b8c2SApple OSS Distributions</dl>
26*19c3b8c2SApple OSS Distributions<h3>DESCRIPTION</h3>
27*19c3b8c2SApple OSS Distributions<p>
28*19c3b8c2SApple OSS DistributionsThe <strong>device_reply_server</strong> function is the MIG generated server handling
29*19c3b8c2SApple OSS Distributionsfunction to handle messages from kernel device drivers.  Such
30*19c3b8c2SApple OSS Distributionsmessages were sent in response to the various
31*19c3b8c2SApple OSS Distributions<strong>device_</strong>...<strong>_request</strong>...
32*19c3b8c2SApple OSS Distributionscalls.  It is assumed when using
33*19c3b8c2SApple OSS Distributionsthose calls that some task is listening for reply messages on the port named as a
34*19c3b8c2SApple OSS Distributionsreply port to those calls.  The <strong>device_reply_server</strong>
35*19c3b8c2SApple OSS Distributionsfunction performs all
36*19c3b8c2SApple OSS Distributionsnecessary argument handling for a kernel message and calls one
37*19c3b8c2SApple OSS Distributionsof the device server functions to interpret the message.
38*19c3b8c2SApple OSS Distributions<h3>RETURN VALUES</h3>
39*19c3b8c2SApple OSS Distributions<dl>
40*19c3b8c2SApple OSS Distributions<p>
41*19c3b8c2SApple OSS Distributions<dt> <strong>TRUE</strong>
42*19c3b8c2SApple OSS Distributions<dd>
43*19c3b8c2SApple OSS DistributionsThe message was handled and the appropriate function was called.
44*19c3b8c2SApple OSS Distributions<p>
45*19c3b8c2SApple OSS Distributions<dt> <strong>FALSE</strong>
46*19c3b8c2SApple OSS Distributions<dd>
47*19c3b8c2SApple OSS DistributionsThe message did not apply to this device handler interface and no other
48*19c3b8c2SApple OSS Distributionsaction was taken.
49*19c3b8c2SApple OSS Distributions</dl>
50*19c3b8c2SApple OSS Distributions<h3>RELATED INFORMATION</h3>
51*19c3b8c2SApple OSS Distributions<p>
52*19c3b8c2SApple OSS DistributionsFunctions:
53*19c3b8c2SApple OSS Distributions<a href="device_open.html"><strong>ds_device_open_reply<strong></a>,
54*19c3b8c2SApple OSS Distributions<a href="device_write.html"><strong>ds_device_write_reply<strong></a>,
55*19c3b8c2SApple OSS Distributions<a href="device_write_inband.html"><strong>ds_device_write_reply_inband<strong></a>,
56*19c3b8c2SApple OSS Distributions<a href="device_read.html"><strong>ds_device_read_reply<strong></a>,
57*19c3b8c2SApple OSS Distributions<a href="device_read_inband.html"><strong>ds_device_read_reply_inband<strong></a>,
58*19c3b8c2SApple OSS Distributions<a href="device_read_overwrite.html"><strong>ds_device_read_reply_overwrite<strong></a>.
59