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