hcdPipeAbort

Purpose

Aborts previously initiated device I/O operations.

Syntax

#include <hcdi.h>
USBstatus hcdPipeAbort(pHCDI, pIOB)
PHCDI pHCDI;
PIOB pIOB;

Parameter

Item Description
pHCDI Pointer to the HCDI structure.
pIOB Pointer to first IOB of the transaction to be aborted.

Description

This function is an HCD supplied function that the USBD calls to cancel the processing of an IOB. The pipe specified by the IOB is already halted before the hcdPipeAbort function is called. The HCD must remove only the specified IOB from the pipe, set the status field in the IOB to USBD_ABORTED, set the length field in the IOB to zero, and call the usbdPostIOB function. If the specified IOB has already processed by the pipe, the HCD must exit with a return code of USBD_SUCCESS because this is not an error.

Execution Environment

This function can be called from the interrupt (HCD_OFFLEVEL priority or lower) or process environment. This function can also be called from the usbdPostIOB routine.

Return Values

Value Description
USBD_SUCCESS Success
All others Failure