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