xref: /illumos-gate/usr/src/man/man9f/usb_handle_remote_wakeup.9f (revision 3184921aa9155f2314caa4909eba31a0be558b3d)
te
Copyright (c) 2004, Sun Microsystems, Inc., All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
USB_HANDLE_REMOTE_WAKEUP 9F "Feb 5, 2004"
NAME
usb_handle_remote_wakeup - Enable or disable remote wakeup on USB devices
SYNOPSIS
#include <sys/usb/usba.h>



int usb_handle_remote_wakeup(dev_info_t *dip, int cmd);
INTERFACE LEVEL
illumos DDI specific (illumos DDI)
PARAMETERS
dip

Pointer to the device's dev_info structure.

cmd

Command. Either USB_REMOTE_WAKEUP_ENABLE or USB_REMOTE_WAKEUP_DISABLE.

DESCRIPTION
The usb_handle_remote_wakeup() function enables or disables remote wakeup on a USB device. This call can block.
RETURN VALUES
USB_SUCCESS

Remote wakeup is successfully enabled or disabled.

USB_FAILURE

Remote wakeup is not supported by the device. An internal error occurred.

CONTEXT
May be called from user or kernel context.
EXAMPLES
 uint_t *pwrstates;

 /* Hook into device's power management. Enable remote wakeup. */
 if (usb_create_pm_components(dip, pwrstates) == USB_SUCCESS) {
 usb_handle_remote_wakeup(dip, USB_REMOTE_WAKEUP_ENABLE);
 }

ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Architecture PCI-based systems
Interface stability Committed
SEE ALSO
attributes(5), pm_busy_component(9F), pm_idle_component(9F), pm_lower_power(9F), pm_raise_power(9F), usb_clr_feature(9F), usb_create_pm_components(9F), usb_get_cfg(9F), usb_get_dev_data(9F), usb_register_hotplug_cbs(9F), usb_cfg_descr(9S)