X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/9bccf70c0258c7cac2dcb80011b2a964d884c552..440d4c6cfad24426bfddca7518f16c17f4e443f7:/osfmk/man/device_get_status.html diff --git a/osfmk/man/device_get_status.html b/osfmk/man/device_get_status.html index 6d69a8ab4..e7b9bcf5a 100755 --- a/osfmk/man/device_get_status.html +++ b/osfmk/man/device_get_status.html @@ -1 +1,62 @@ -

device_get_status


Function - Return the current device status.

SYNOPSIS

#include< device/device.h>

kern_return_t   device_get_status
                (mach_port_t                             device,
                 dev_flavor_t                            flavor,
                 dev_status_t                            status,
                 mach_msg_type_number_t           *status_count);

PARAMETERS

device
[in device send right] A device port to the device to be interrogated.

flavor
[in scalar] The type of status information requested.

status
[out array of natural-sized units] The returned device status.

status_count
[pointer to in/out scalar] On input, the reserved size of status; on output, the size of the returned device status (in natural-sized units).

DESCRIPTION

The device_get_status function returns status information pertaining to an open device. The possible values for flavor as well as the meaning of the returned status information is device dependent.

RETURN VALUES

D_DEVICE_DOWN
Device has been shut down

D_NO_SUCH_DEVICE
No device with that name, or the device is not operational.

D_OUT_OF_BAND
Out-of-band condition occurred on device (such as typing \*L-C\*O)

RELATED INFORMATION

Functions: device_set_status. \ No newline at end of file +

device_get_status

+
+

+Function - Return the current device status. +

SYNOPSIS

+
+#include< device/device.h>
+
+kern_return_t   device_get_status
+                (mach_port_t                             device,
+                 dev_flavor_t                            flavor,
+                 dev_status_t                            status,
+                 mach_msg_type_number_t           *status_count);
+
+

PARAMETERS

+
+

+

device +
+[in device send right] +A device port to the device to be interrogated. +

+

flavor +
+[in scalar] +The type of status information requested. +

+

status +
+[out array of natural-sized units] +The returned device status. +

+

status_count +
+[pointer to in/out scalar] +On input, the reserved size of status; on +output, the size of the returned device status (in natural-sized units). +
+

DESCRIPTION

+

+The device_get_status function returns status information +pertaining to an open device. The possible values for flavor as well +as the meaning of the returned status information is device dependent. +

RETURN VALUES

+
+

+

D_DEVICE_DOWN +
+Device has been shut down +

+

D_NO_SUCH_DEVICE +
+No device with that name, or the device is not operational. +

+

D_OUT_OF_BAND +
+Out-of-band condition occurred on device (such as typing \*L-C\*O) +
+

RELATED INFORMATION

+

+Functions: +device_set_status.