This is the quick start guide for the USB host vendor module (UHI vendor) with step-by-step instructions on how to configure and use the modules in a selection of use cases.
The use cases contain several code fragments. The code fragments in the steps for setup can be copied into a custom initialization function, while the steps for usage can be copied into, e.g., the main application function.
Basic use case
In this basic use case, the "USB Vendor (Single Class support)" module is used.
The "USB Vendor (Composite)" module usage is described in Advanced use cases.
Setup steps
Prerequisites
Example code
Workflow
Usage steps
Example code
Content of conf_usb_host.h:
#define USB_HOST_UHI UHI_VENDOR
#define UHI_VENDOR_CHANGE(dev, b_plug) my_callback_vendor_change(dev, b_plug)
extern void my_callback_vendor_change(uhc_device_t*
dev,
bool b_plug);
#define UHI_VENDOR_VID_PID_LIST {USB_VID_ATMEL, USB_PID_ATMEL_ASF_VENDOR_CLASS}
#include "uhi_vendor.h" // At the end of conf_usb_host.h file
Add to application C-file:
static bool my_flag_vendor_test_start = false;
void my_callback_vendor_change(uhc_device_t*
dev,
bool b_plug)
{
my_flag_vendor_test_start = b_plug;
}
static void my_callback_bulk_in_done (
usb_add_t add,
{
return;
}
my_flag_vendor_test_start = true;
}
#define MESSAGE "Hello bulk"
#define HELLO_SIZE 5
#define HELLO_BULK_SIZE 10
uint8_t my_out_buffer[MESSAGE_SIZE+1] = MESSAGE;
uint8_t my_in_buffer[MESSAGE_SIZE+1];
void my_task(void)
{
if (!my_flag_vendor_test_start) {
return;
}
my_flag_vendor_test_start = false;
my_callback_bulk_in_done);
}
}
Workflow
- Ensure that conf_usb_host.h is available and contains the following configuration which is the USB host vendor configuration:
#define USB_HOST_UHI UHI_HID_VENDOR
- Note
- It defines the list of UHI supported by USB host.
#define UHI_VENDOR_CHANGE(dev, b_plug) my_callback_vendor_change(dev, b_plug)
extern bool my_callback_vendor_change(uhc_device_t* dev, bool b_plug);
- Note
- This callback is called when a USB device vendor is plugged or unplugged.
#define UHI_VENDOR_VID_PID_LIST {USB_VID_ATMEL, USB_PID_ATMEL_ASF_VENDOR_CLASS}
- Note
- It defines the list of devices supported by USB host (defined by VID and PID).
- The Vendor data transfert functions are described in UHI for Vendor Class.
Advanced use cases
- uhc_use_case_1
- uhc_use_case_2
- uhc_use_case_3