Merge commit '9276b3991ba20d5a5660887ba81b0bc7bed25a0c'
[unleashed.git] / share / man / man9f / usb_handle_remote_wakeup.9f
blob916ab45f77b94238db721106cb3314f48f584a80
1 '\" te
2 .\" Copyright (c) 2004, Sun Microsystems, Inc., All Rights Reserved
3 .\" 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.
4 .\" 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.
5 .\" 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]
6 .TH USB_HANDLE_REMOTE_WAKEUP 9F "Feb 5, 2004"
7 .SH NAME
8 usb_handle_remote_wakeup \- Enable or disable remote wakeup on USB devices
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <sys/usb/usba.h>
16 \fBint\fR \fBusb_handle_remote_wakeup\fR(\fBdev_info_t *\fR\fIdip\fR, \fBint\fR \fIcmd\fR);
17 .fi
19 .SH INTERFACE LEVEL
20 .sp
21 .LP
22 Solaris DDI specific (Solaris DDI)
23 .SH PARAMETERS
24 .sp
25 .ne 2
26 .na
27 \fB\fIdip\fR\fR
28 .ad
29 .RS 7n
30 Pointer to the device's \fBdev_info\fR structure.
31 .RE
33 .sp
34 .ne 2
35 .na
36 \fB\fIcmd\fR\fR
37 .ad
38 .RS 7n
39 Command. Either USB_REMOTE_WAKEUP_ENABLE or USB_REMOTE_WAKEUP_DISABLE.
40 .RE
42 .SH DESCRIPTION
43 .sp
44 .LP
45 The \fBusb_handle_remote_wakeup()\fR function enables or disables remote wakeup
46 on a USB device. This call can block.
47 .SH RETURN VALUES
48 .sp
49 .ne 2
50 .na
51 \fBUSB_SUCCESS\fR
52 .ad
53 .RS 15n
54 Remote wakeup is successfully enabled or disabled.
55 .RE
57 .sp
58 .ne 2
59 .na
60 \fBUSB_FAILURE\fR
61 .ad
62 .RS 15n
63 Remote wakeup is not supported by the device. An internal error occurred.
64 .RE
66 .SH CONTEXT
67 .sp
68 .LP
69 May be called from user or kernel context.
70 .SH EXAMPLES
71 .sp
72 .in +2
73 .nf
74     uint_t *pwrstates;
76     /* Hook into device's power management.  Enable remote wakeup. */
77     if (usb_create_pm_components(dip, pwrstates) == USB_SUCCESS) {
78             usb_handle_remote_wakeup(dip, USB_REMOTE_WAKEUP_ENABLE);
79     }
81 .fi
82 .in -2
84 .SH ATTRIBUTES
85 .sp
86 .LP
87 See \fBattributes\fR(5) for descriptions of the following attributes:
88 .sp
90 .sp
91 .TS
92 box;
93 c | c
94 l | l .
95 ATTRIBUTE TYPE  ATTRIBUTE VALUE
97 Architecture    PCI-based systems
99 Interface stability     Committed
102 .SH SEE ALSO
105 \fBattributes\fR(5), \fBpm_busy_component\fR(9F), \fBpm_idle_component\fR(9F),
106 \fBpm_lower_power\fR(9F), \fBpm_raise_power\fR(9F), \fBusb_clr_feature\fR(9F),
107 \fBusb_create_pm_components\fR(9F), \fBusb_get_cfg\fR(9F),
108 \fBusb_get_dev_data\fR(9F), \fBusb_register_hotplug_cbs\fR(9F),
109 \fBusb_cfg_descr\fR(9S)