hcdPipeStatus
Purpose
Obtains the pipe status.
Syntax
#include <hcdi.h>
USBstatus hcdPipeStatus(pHCDI, hpipe);
PHCDI pHCDI;
USBhandle hpipe; Parameter
| Item | Description |
|---|---|
| pHCDI | Pointer to the HCDI structure. |
| hpipe | Pipe handles returned by the hcdPipeConnect function. |
Description
This function is an HCD supplied function that the USBD calls to obtain the status of the pipe from the host perspective. The function returns USBD_ACTIVE if the pipe is active and ready to receive I/O requests. The function returns USBD_HALTED if the pipe is halted.
Execution Environment
This function can be called from the interrupt (HCD_OFFLEVEL priority or lower) or process environment.
Return Values
| Value | Description |
|---|---|
| USBD_SUCCESS | Success |
| All others | Failure |