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