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