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]
#include <sys/usb/usba.h> int usb_pipe_get_state(usb_pipe_handle_t pipe_handle, usb_pipe_state_t *pipe_state, usb_flags_t usb_flags);
Solaris DDI specific (Solaris DDI)
pipe_handle
Handle of the pipe to retrieve the state.
pipe_state
Pointer to where pipe state is returned.
usb_flags
No flags are recognized. Reserved for future expansion.
The usb_pipe_get_state() function retrieves the state of the pipe referred to by pipe_handle into the location pointed to by pipe_state.
Possible pipe states are:
USB_PIPE_STATE_CLOSED
Pipe is closed.
USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_IDLE
Polling is stopped for isochronous and interrupt-IN pipes.
USB_PIPE_STATE_ERROR
An error occurred. Client must call usb_pipe_reset(). Note that this status is not seen by a client driver if USB_ATTRS_AUTOCLEARING is set in the request attributes.
USB_PIPE_STATE_CLOSING
Pipe is being closed. Requests are being drained from the pipe and other cleanup is in progress.
USB_SUCCESS
Pipe state returned in second argument.
USB_INVALID_ARGS
Pipe_state argument is NULL.
USB_INVALID_PIPE
Pipe_handle argument is NULL.
May be called from user, kernel or interrupt context.
usb_pipe_handle_t pipe;
usb_pipe_state_t state;
/* Recover if the pipe is in an error state. */
if ((usb_pipe_get_state(pipe, &state, 0) == USB_SUCCESS) &&
(state == USB_PIPE_STATE_ERROR)) {
cmn_err (CE_WARN, "%s%d: USB Pipe error.",
ddi_driver_name(dip), ddi_get_instance(dip));
do_recovery();
}
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
| Architecture | PCI-based systems |
| Interface stability | Committed |
attributes(5), usb_clr_feature(9F), usb_get_cfg(9F). usb_get_status(9F), usb_pipe_close(9F), usb_pipe_ctrl_xfer(9F), usb_pipe_open(9F). usb_pipe_reset(9F)