usbdPipeClear

Purpose

Clears halt condition and resume operation of a pipe.

Syntax

#include <usbdi.h>
USBstatus usbdPipeClear(handle, hpipe)
USBhandle handle;
USBhandle hpipe;

Parameter

Item Description
handle Handle of open USB logical device that is returned by the USBD_OPEN_DEVICE fp_ioctl.
hpipe Pipe handles returned by the usbdPipeConnect function.

Description

The USB client driver uses this function to resume a pipe from the perspective of the host. This command does not affect the reflected endpoint state (for example, pipe status from the perspective of the USB device). If the reflected endpoint state must be changed, a USB_CLEAR_FEATURE control message must be sent to the device that request halted condition of the end point to be cleared before calling the usbdPipeClear function. The usbdPipeClear function is not available for control and isochronous pipes because they do not halt. The usbdPipeClear function does not affect the data toggle synchronization bit.

Execution Environment

This function might be called from the interrupt (USBDINTRLEVEL priority or lower) or process environment.

Return Values

Value Description
USBD_SUCCESS Success
All others Failure