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