USB Libraries Help > USB Host Libraries > USB Host Layer Library > Library Interface
MPLAB Harmony USB Stack
Library Interface

This section describes the Application Programming Interface (API) functions of the USB Host Layer Library. 

Refer to each section for a detailed description.

a) Functions
 
Name 
Description 
 
Deinitializes the specified instance of the USB Host Layer. 
 
Gets the current status of the USB Host Layer. 
 
Maintains the USB Host Layer state machine. 
 
Starts host operations. 
 
Checks if the bus is enabled. 
 
Returns the suspend status of the bus. 
 
Resumes the bus. 
 
Suspends the bus. 
 
Returns information about the first attached device on the bus. 
 
Returns information about the next device on the bus. 
 
Returns the suspend state of the device is suspended. 
 
Resumes the selected device 
 
Returns the speed at which this device is operating. 
 
Retrieves specified string descriptor from the device 
 
Suspends the specified device. 
 
USB Host Layer Event Handler Callback Function set function. 
 
Initializes the USB Host layer instance specified by the index. 
b) Data Types and Constants
 
Name 
Description 
 
Defines the data required to initialize a USB Host Layer instance. 
 
Host Layer Events Handler Function Response Type. 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
0 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
0xFF 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
1 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
mask 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
pid 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
true 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
Defines a USB Bus Data Type. 
 
Defines the data type that is used by the USB_HOST_DeviceGetFirst() and USB_HOST_DeviceGetNext() functions. 
 
Handle to an attached USB Device. 
 
Defines a defines types of strings that can be request through the USB_HOST_DeviceStringDescriptorGet() function. 
 
Defines the different events that the USB Host Layer can generate. 
 
USB Host Layer Event Handler Function Pointer Type 
 
Defines the USB Host HCD Information object that is provided to the host layer. 
 
USB Host Request Handle Type 
 
USB Host Results. 
 
USB Host Device String Descriptor Request Complete Callback Function Type 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
vid 
USB Host Layer TPL Table Entry Matching Criteria flag 
 
USB Host Bus All 
 
Defines an invalid USB Device Object Handle. 
 
Defines the default Lang ID to be used while obtaining the string. 
 
USB Host Request Invalid Handle 
 
USB Host Result Minimum Constant.