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_pipe_reset - Abort queued requests from a USB pipe and reset the pipe

#include <sys/usb/usba.h>

void usb_pipe_reset(dev_info_t *dip,
 usb_pipe_handle_t pipe_handle, usb_flags_t usb_flags,
 void (*callback)(usb_pipe_handle_t cb_pipe_handle,
 usb_opaque_t arg, int rval, usb_cb_flags_t flags),
 usb_opaque_t callback_arg);

illumos DDI specific (illumos DDI) dip pipe_handle usb_flags callback callback_arg Call usb_pipe_reset() to reset a pipe which is in an error state, or to abort a current request and clear the pipe. The usb_pipe_reset() function can be called on any pipe other than the default control pipe.

A pipe can be reset automatically when requests sent to the pipe have the USB_ATTRS_AUTOCLEARING attribute specified. Client drivers see an exception callback with the USB_CB_STALL_CLEARED callback flag set in such cases.

Stalls on pipes executing requests without the USB_ATTRS_AUTOCLEARING attribute set must be cleared by the client driver. The client driver is notified of the stall via an exception callback. The client driver must then call usb_pipe_reset() to clear the stall.

The usb_pipe_reset() function resets a pipe as follows:

1. Any polling activity is stopped if the pipe being reset is an interrupt or isochronous pipe.

2. All pending requests are removed from the pipe. An exception callback, if specified beforehand, is executed for each aborted request.

3. The pipe is reset to the idle state.

Requests to reset the default control pipe are not allowed. No action is taken on a pipe which is closing.

If USB_FLAGS_SLEEP is specified in flags, this function waits for the action to complete before calling the callback handler and returning. If not specified, this function queues the request and returns immediately, and the specified callback is called upon completion.

callback is the callback handler. It takes the following arguments: usb_pipe_handle_t cb_pipe_handle

usb_opaque_t callback_arg int rval usb_cb_flags_t callback_flags Status is returned to the caller via the callback handler's rval argument. Possible callback handler rval argument values are: USB_SUCCESS USB_INVALID_PIPE USB_INVALID_ARGS USB_INVALID_CONTEXT USB_INVALID_PERM USB_FAILURE

Exception callback handlers of interrupt-IN and isochronous-IN requests which are terminated by these commands are called with a completion reason of USB_CR_STOPPED_POLLING.

Exception handlers of incomplete bulk requests are called with a completion reason of USB_CR_FLUSHED.

Exception handlers of unstarted requests are called with USB_CR_PIPE_RESET.

Note that messages mirroring the above errors are logged to the console logfile on error. This provides status for calls which could not otherwise provide status.

May be called from user or kernel context regardless of arguments. May be called from any callback with the USB_FLAGS_SLEEP clear. May not be called from a callback executing in interrupt context if the USB_FLAGS_SLEEP flag is set.

If the USB_CB_ASYNC_REQ_FAILED bit is clear in usb_cb_flags_t, the callback, if supplied, can block because it is executing in kernel context. Otherwise the callback cannot block. Please see usb_callback_flags(9S) for more information on callbacks.

void post_reset_handler(
 usb_pipe_handle_t, usb_opaque_t, int, usb_cb_flags_t);

/*
 * Do an asynchronous reset on bulk_pipe.
 * Execute post_reset_handler when done.
 */
usb_pipe_reset(dip, bulk_pipe, 0, post_reset_handler, arg);

/* Do a synchronous reset on bulk_pipe. */
usb_pipe_reset(dip, bulk_pipe, USB_FLAGS_SLEEP, NULL, NULL);

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

Architecture PCI-based systems

Interface stability Committed

attributes (7), usb_get_cfg (9F), usb_get_status (9F), usb_pipe_bulk_xfer (9F), usb_pipe_close (9F), usb_pipe_ctrl_xfer (9F), usb_pipe_drain_reqs (9F), usb_pipe_get_state (9F), usb_pipe_intr_xfer (9F), usb_pipe_isoc_xfer (9F), usb_pipe_stop_intr_polling (9F), usb_pipe_stop_isoc_polling (9F), usb_pipe_xopen (9F), usb_callback_flags (9S)