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