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