USB Library
usb_host.h

This is file usb_host.h.

Functions
 
Name 
Description 
 
This is a typedef to use when defining the application level data events handler. 
 
This is a typedef to use when defining the application level events handler. 
 
This function handles the interrupts when the USB module is running in host mode. 
 
This function clears an endpoint's internal error condition. 
 
This function indicates if the specified device has explicit client driver support specified in the TPL. 
 
This function returns the current status of a device. 
 
This function initializes the variables of the USB host stack. 
 
This function initializes the isochronous data buffer information and allocates memory for each buffer. This function will not allocate memory if the buffer pointer is not NULL. 
 
This function releases all of the memory allocated for the isochronous data buffers. It also resets all other information about the buffers. 
 
This function resets all the isochronous data buffers. It does not do anything with the space allocated for the buffers. 
 
This function sends a standard device request to the attached device. 
 
This function initiates a read from the attached device. 
 
This function resets an attached device. 
 
This function issues a RESUME to the attached device. 
 
This function changes the device's configuration. 
 
This function specifies NAK timeout capability. 
 
This function turns off the USB module and frees all unnecessary memory. This routine can be called by the application layer to shut down all USB activity, which effectively detaches all devices. The event EVENT_DETACH will be sent to the client drivers for the attached device, and the event EVENT_VBUS_RELEASE_POWER will be sent to the application layer. 
 
This function suspends a device. 
 
This function executes the host tasks for USB host operation. 
 
This function terminates the current transfer for the given endpoint. 
 
This function initiates whether or not the last endpoint transaction is complete. 
 
This function handles Vbus events that are detected by the application. 
 
This function initiates a write to the attached device. 
Macros
 
Name 
Description 
 
DOM-IGNORE-END 
 
Set class support in the TPL (non-OTG only). 
 
Set VID/PID support in the TPL. 
 
Bitmask for Host Negotiation Protocol. 
 
Bitmask for class driver support. 
 
Bitmask to let a custom driver gain EP0 only and allow other interfaces to use standard drivers 
 
Bitmask for ignoring the class of a CL/SC/P driver 
 
Bitmask for ignoring the PID of a VID/PID driver 
 
Bitmask for ignoring the protocol of a CL/SC/P driver 
 
Bitmask for ignoring the subclass of a CL/SC/P driver 
 
Bitmask for setting the configuration. 
 
If the application does not provide an event handler, then we will assume that all events function without error. 
 
If the application does not provide an event handler, then we will assume that all events function without error. 
 
Define how many NAK's are allowed during a bulk transfer before erroring. 
 
During enumeration, define how many times each command will be tried before giving up and resetting the device. 
 
Define how many NAK's are allowed during a control transfer before erroring. 
 
Define how many times the host will try to enumerate the device before giving up and setting the state to DETACHED. 
 
Define how many NAK's are allowed during an interrupt OUT transfer before erroring. Interrupt IN transfers that are NAK'd are terminated without error. 
 
This function returns a pointer to the current configuration descriptor of the requested device. 
 
This function returns a pointer to the device descriptor of the requested device. 
 
This routine initiates a request to obtains the requested string descriptor. 
 
This function initiates a read from an isochronous endpoint on the attached device. 
 
This function initiates a write to an isochronous endpoint on the attached device. 
Module
Structures
 
Name 
Description 
 
Client Driver Table Structure
This structure is used to define an entry in the client-driver table. Each entry provides the information that the Host layer needs to manage a particular USB client driver, including pointers to the interface routines that the Client Driver must implement. 
 
Host Transfer Information
This structure is used when the event handler is used to notify the upper layer of transfer completion. 
 
Client Driver Table Structure
This structure is used to define an entry in the client-driver table. Each entry provides the information that the Host layer needs to manage a particular USB client driver, including pointers to the interface routines that the Client Driver must implement. 
 
Host Transfer Information
This structure is used when the event handler is used to notify the upper layer of transfer completion. 
Types
 
Name 
Description 
 
This is type TRANSFER_ATTRIBUTES. 
 
This is a typedef to use when defining a client driver event handler. 
 
This is a typedef to use when defining a client driver initialization handler. 
 
Targeted Peripheral List
This structure is used to define the devices that this host can support. If the host is a USB Embedded Host or Dual Role Device that does not support OTG, the TPL may contain both specific devices and generic classes. If the host supports OTG, then the TPL may contain ONLY specific devices. 
MLA - USB Library Help Version : 2.16
http://www.microchip.com/mla