[apple/xnu.git] / osfmk / man / device_reply_server.html

<h2>device_reply_server</h2>\r<hr>\r<p>\r<strong>Function</strong> - Handle incoming data from kernel device driver.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>boolean_t	device_reply_server</strong>\r		<strong>(mach_msg_header_t</strong>	<var>request_msg</var>,\r		<strong>mach_msg_header_t</strong>	<var>reply_msg</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>request_msg</var> \r<dd>\r[pointer to in structure]\rThe device driver message received from the \rkernel.\r<p>\r<dt> <var>reply_msg</var> \r<dd>\r[out structure]\rA reply message.  No messages from a device driver\rexpect a direct reply, so this field is not used.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>device_reply_server</strong> function is the MIG generated server handling\rfunction to handle messages from kernel device drivers.  Such\rmessages were sent in response to the various\r<strong>device_</strong>...<strong>_request</strong>...\rcalls.  It is assumed when using \rthose calls that some task is listening for reply messages on the port named as a \rreply port to those calls.  The <strong>device_reply_server</strong>\rfunction performs all\rnecessary argument handling for a kernel message and calls one\rof the device server functions to interpret the message.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>TRUE</strong>\r<dd>\rThe message was handled and the appropriate function was called.\r<p>\r<dt> <strong>FALSE</strong>\r<dd>\rThe message did not apply to this device handler interface and no other \raction was taken.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="device_open.html"><strong>ds_device_open_reply<strong></a>,\r<a href="device_write.html"><strong>ds_device_write_reply<strong></a>,\r<a href="device_write_inband.html"><strong>ds_device_write_reply_inband<strong></a>,\r<a href="device_read.html"><strong>ds_device_read_reply<strong></a>,\r<a href="device_read_inband.html"><strong>ds_device_read_reply_inband<strong></a>,\r<a href="device_read_overwrite.html"><strong>ds_device_read_reply_overwrite<strong></a>.\r