Microchip® Advanced Software Framework

uhi_vendor_doc.h File Reference

USB host driver for Vendor interface.

Copyright (c) 2014-2018 Microchip Technology Inc. and its subsidiaries.

Macros

Interface with USB Host Core (UHC)

Definition and functions required by UHC.

#define UHI_VENDOR
 Global definition which contains standard UHI API for UHC It must be added in USB_HOST_UHI definition from conf_usb_host.h file. More...
 

Functions

Functions Required by UHC
uhc_enum_status_t uhi_vendor_install (uhc_device_t *dev)
 Install interface. More...
 
void uhi_vendor_enable (uhc_device_t *dev)
 Enable the interface. More...
 
void uhi_vendor_uninstall (uhc_device_t *dev)
 Uninstall the interface (if installed). More...
 
UHI for Vendor Class

Common APIs used by high level application to use this USB host class.

This Vendor Class implementation supports one endpoint for all endpoint types on all directions: Control IN, control OUT, interrupt IN, interrupt OUT, bulk IN, bulk OUT, isochronous IN, isochronous OUT.

This implementation is an example and can be a base to create another Vendor Class which supports more endpoint as two bulk IN endpoints.

bool uhi_vendor_control_in_run (uint8_t *buf, iram_size_t buf_size, uhd_callback_setup_end_t callback)
 Start a transfer on control IN. More...
 
bool uhi_vendor_control_out_run (uint8_t *buf, iram_size_t buf_size, uhd_callback_setup_end_t callback)
 Start a transfer on control OUT. More...
 
bool uhi_vendor_bulk_in_run (uint8_t *buf, iram_size_t buf_size, uhd_callback_trans_t callback)
 Start a transfer on bulk IN. More...
 
bool uhi_vendor_bulk_out_run (uint8_t *buf, iram_size_t buf_size, uhd_callback_trans_t callback)
 Start a transfer on bulk OUT. More...
 
bool uhi_vendor_int_in_run (uint8_t *buf, iram_size_t buf_size, uhd_callback_trans_t callback)
 Start a transfer on interrupt IN. More...
 
bool uhi_vendor_int_out_run (uint8_t *buf, iram_size_t buf_size, uhd_callback_trans_t callback)
 Start a transfer on interrupt OUT. More...
 
bool uhi_vendor_iso_in_run (uint8_t *buf, iram_size_t buf_size, uhd_callback_trans_t callback)
 Start a transfer on ISO IN. More...
 
bool uhi_vendor_iso_out_run (uint8_t *buf, iram_size_t buf_size, uhd_callback_trans_t callback)
 Start a transfer on ISO OUT. More...
 
bool uhi_vendor_bulk_is_available (void)
 Check if a transfer on BULK is possible. More...
 
bool uhi_vendor_int_is_available (void)
 Check if a transfer on INTERRUPT is possible. More...
 
bool uhi_vendor_iso_is_available (void)
 Check if a transfer on ISO is possible. More...