xnu-792.6.76.tar.gz

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

diff --git a/osfmk/man/device_read_async_inband.html b/osfmk/man/device_read_async_inband.html
index 13b556b6b055af41c08c4b4b186a1c9f3ecd644d..9d26fec616da9e07c8bdcc5ea702986719a8ca9f 100755 (executable)
--- a/osfmk/man/device_read_async_inband.html
+++ b/osfmk/man/device_read_async_inband.html
@@ -1 +1,68 @@
-<h2>device_read_async_inband</h2>\r<hr>\r<p>\r<strong>System Trap</strong> - Read a sequence of bytes "inband" from a device object.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   device_read_async_inband</strong>\r                <strong>(mach_port_t</strong>                             <var>device</var>,\r                 <strong>mach_port_t</strong>                              <var>queue</var>,\r                 <strong>mach_port_t</strong>                         <var>request_id</var>,\r                 <strong>dev_mode_t</strong>                                <var>mode</var>,\r                 <strong>recnum_t</strong>                                <var>recnum</var>,\r                 <strong>io_buf_len_t</strong>                      <var>bytes_wanted</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>device</var>\r<dd>\r[in device send right] A device port to the device to be read.\r<p>\r<dt> <var>queue</var>\r<dd>\r[in io_done queue send right] The port returned from \r<strong>io_done_queue_create</strong>.\r<p>\r<dt> <var>request_id</var>\r<dd>\r[in send right] An unique request identifier that will be passed back as \rpart of the io_done_result structure.\r<p>\r<dt> <var>mode</var>\r<dd>\r[in scalar] I/O mode value. Meaningful options are:\r<p>\r     <dl>\r<dt> <strong>D_NOWAIT</strong>\r<dd>\rDo not wait if data is unavailable.\r     </dl>\r<p>\r<dt> <var>recnum</var>\r<dd>\r[in scalar] Record number to be read.\r<p>\r<dt> <var>bytes_wanted</var>\r<dd>\r[in scalar] Size of data transfer.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>device_read_async_inband</strong> function enqueues a read operation for a\rsequence of bytes from a device object. The meaning of <var>recnum</var> as\rwell as the specific operation performed is device dependent. This\rcall differs from <strong>device_read_async</strong> in that the returned bytes are\rreturned "inband" in the completion IPC message (in\r<strong>io_done_result.qd_inline</strong>).\r<h3>RETURN VALUES</h3>\r<p>\r<strong>device_read_async_inband</strong> returns only invalid parameter errors.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="device_read_async.html"><strong>device_read_async</strong></a>,\r<a href="DR_overwrite_async.html"><strong>device_read_overwrite_async</strong></a>,\r<a href="device_write_async.html"><strong>device_write_async</strong></a>,\r<a href="device_write_async_inband.html"><strong>device_write_async_inband</strong></a>,\r<a href="io_done_queue_create.html"><strong>io_done_queue_create</strong></a>.\r
\ No newline at end of file
+<h2>device_read_async_inband</h2>
+<hr>
+<p>
+<strong>System Trap</strong> - Read a sequence of bytes "inband" from a device object.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   device_read_async_inband</strong>
+                <strong>(mach_port_t</strong>                             <var>device</var>,
+                 <strong>mach_port_t</strong>                              <var>queue</var>,
+                 <strong>mach_port_t</strong>                         <var>request_id</var>,
+                 <strong>dev_mode_t</strong>                                <var>mode</var>,
+                 <strong>recnum_t</strong>                                <var>recnum</var>,
+                 <strong>io_buf_len_t</strong>                      <var>bytes_wanted</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>device</var>
+<dd>
+[in device send right] A device port to the device to be read.
+<p>
+<dt> <var>queue</var>
+<dd>
+[in io_done queue send right] The port returned from 
+<strong>io_done_queue_create</strong>.
+<p>
+<dt> <var>request_id</var>
+<dd>
+[in send right] An unique request identifier that will be passed back as 
+part of the io_done_result structure.
+<p>
+<dt> <var>mode</var>
+<dd>
+[in scalar] I/O mode value. Meaningful options are:
+<p>
+     <dl>
+<dt> <strong>D_NOWAIT</strong>
+<dd>
+Do not wait if data is unavailable.
+     </dl>
+<p>
+<dt> <var>recnum</var>
+<dd>
+[in scalar] Record number to be read.
+<p>
+<dt> <var>bytes_wanted</var>
+<dd>
+[in scalar] Size of data transfer.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>device_read_async_inband</strong> function enqueues a read operation for a
+sequence of bytes from a device object. The meaning of <var>recnum</var> as
+well as the specific operation performed is device dependent. This
+call differs from <strong>device_read_async</strong> in that the returned bytes are
+returned "inband" in the completion IPC message (in
+<strong>io_done_result.qd_inline</strong>).
+<h3>RETURN VALUES</h3>
+<p>
+<strong>device_read_async_inband</strong> returns only invalid parameter errors.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="device_read_async.html"><strong>device_read_async</strong></a>,
+<a href="DR_overwrite_async.html"><strong>device_read_overwrite_async</strong></a>,
+<a href="device_write_async.html"><strong>device_write_async</strong></a>,
+<a href="device_write_async_inband.html"><strong>device_write_async_inband</strong></a>,
+<a href="io_done_queue_create.html"><strong>io_done_queue_create</strong></a>.