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

<h2>device_set_status</h2>\r<hr>\r<p>\r<strong>Function</strong> - Set device status.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>#include&lt device/device.h&gt</strong>\r\r<strong>kern_return_t   device_set_status</strong>\r                <strong>(mach_port_t</strong>                             <var>device</var>,\r                 <strong>dev_flavor_t</strong>                            <var>flavor</var>,\r                 <strong>dev_status_t</strong>                            <var>status</var>,\r                 <strong>mach_msg_type_number_t</strong>            <var>status_count</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]\rA device port to the device to be manipulated.\r<p>\r<dt> <var>flavor</var> \r<dd>\r[in scalar]\rThe type of status information to set.\r<p>\r<dt> <var>status</var> \r<dd>\r[pointer to in array of natural-sized units]\rThe status information to set.\r<p>\r<dt> <var>status_count</var> \r<dd>\r[in scalar]\rThe size of the status information (in natural-sized units).\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>device_set_status</strong> function sets device status.\rThe possible values of <var>flavor</var> \ras well as the corresponding meanings are device dependent.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>D_DEVICE_DOWN</strong>\r<dd>\rDevice has been shut down\r<p>\r<dt> <strong>D_IO_ERROR</strong>\r<dd>\rHardware I/O error\r<p>\r<dt> <strong>D_NO_SUCH_DEVICE</strong>\r<dd>\rNo device with that name, or the device is not operational.\r<p>\r<dt> <strong>D_OUT_OF_BAND</strong>\r<dd>\rOut-of-band condition occurred on device (such as typing\r     <strong>&ltCtrl&gt-C</strong>).\r<p>\r<dt> <strong>D_READ_ONLY</strong>\r<dd>\rData cannot be written to this device.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="device_get_status.html"><strong>device_get_status</strong></a>.\r