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