usbdReqHCunregister

Purpose

Requests that the USBD close the communication channel to the host controller.

Syntax

#include <hcdi.h>
USBstatus usbdReqHCunregister(pHCDI)
PHCDI pHCDI; 

Parameter

Item Description
pHCDI Pointer to the HCDI structure.

Description

This function is a USBD supplied function that is called by the HCD when a host controller is unconfigured. This function causes the USBD to remove the host controller from its topology map. Any outstanding I/O is stopped and the appropriate client drivers are notified that the logical USB devices, which are connected to the controller, do not exists. A hcdUnregisterHC call is then made to the HCD and upon return, all system resources that are associated with the host controller are freed and control is returned to the HCD.

Execution Environment

This function can only be called from the process environment only.

Return Values

Value Description
USBD_SUCCESS Success
All others Failure