Release Information
Release Contents
USB Libraries Help
USB Device Libraries
USB Device Library - Getting Started
Introduction
USB Device Library Architecture
USB Device Library - Application Interaction
Creating Your Own USB Device
USB Device Layer Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
Library Initialization
Master Descriptor Table
Function Driver Registration Table
Initializing the Device Layer
Device Layer Task Routines
Application Client Interaction
Event Handling
Device Layer Control Transfers
String Descriptor Table
BOS Descriptor Support
Microsoft OS Descriptor Support
Configuring the Library
USB_DEVICE_INSTANCES_NUMBER Macro
USB_DEVICE_ENDPOINT_QUEUE_DEPTH_COMBINED Macro
USB_DEVICE_SET_DESCRIPTOR_EVENT_ENABLE Macro
USB_DEVICE_SOF_EVENT_ENABLE Macro
USB_DEVICE_SYNCH_FRAME_EVENT_ENABLE Macro
USB_DEVICE_BOS_DESCRIPTOR_SUPPORT_ENABLE Macro
USB_DEVICE_DRIVER_INITIALIZE_EXPLICIT Macro
USB_DEVICE_EP0_BUFFER_SIZE Macro
USB_DEVICE_STRING_DESCRIPTOR_TABLE_ADVANCED_ENABLE Macro
USB_DEVICE_TRANSFER_HANDLE_INVALID Macro
_USB_DEVICE_CONFIG_TEMPLATE_H_ Macro
Building the Library
Library Interface
a) System Interaction Functions
USB_DEVICE_Initialize Function
USB_DEVICE_Deinitialize Function
USB_DEVICE_Status Function
USB_DEVICE_Tasks Function
b) Client Core Functions
USB_DEVICE_Open Function
USB_DEVICE_Close Function
USB_DEVICE_ClientStatusGet Function
USB_DEVICE_EventHandlerSet Function
c) Device Power State Management Functions
USB_DEVICE_PowerStateSet Function
USB_DEVICE_RemoteWakeupStatusGet Function
USB_DEVICE_IsSuspended Function
USB_DEVICE_RemoteWakeupStart Function
USB_DEVICE_RemoteWakeupStartTimed Function
USB_DEVICE_RemoteWakeupStop Function
d) Device Management Functions
USB_DEVICE_StateGet Function
USB_DEVICE_Attach Function
USB_DEVICE_Detach Function
USB_DEVICE_ActiveConfigurationGet Function
USB_DEVICE_ActiveSpeedGet Function
e) Endpoint Management Functions
USB_DEVICE_EndpointIsStalled Function
USB_DEVICE_EndpointStall Function
USB_DEVICE_EndpointStallClear Function
USB_DEVICE_EndpointDisable Function
USB_DEVICE_EndpointEnable Function
USB_DEVICE_EndpointIsEnabled Function
USB_DEVICE_EndpointRead Function
USB_DEVICE_EndpointTransferCancel Function
USB_DEVICE_EndpointWrite Function
f) Control Transfer Functions
USB_DEVICE_ControlReceive Function
USB_DEVICE_ControlSend Function
USB_DEVICE_ControlStatus Function
g) Data Types and Constants
USB_DEVICE_EVENT Enumeration
USB_DEVICE_HANDLE Type
USB_DEVICE_CONTROL_STATUS Enumeration
USB_DEVICE_CONTROL_TRANSFER_RESULT Enumeration
USB_DEVICE_INIT Structure
USB_DEVICE_POWER_STATE Enumeration
USB_DEVICE_REMOTE_WAKEUP_STATUS Enumeration
USB_DEVICE_HANDLE_INVALID Macro
USB_DEVICE_INDEX_0 Macro
USB_DEVICE_INDEX_1 Macro
USB_DEVICE_INDEX_2 Macro
USB_DEVICE_INDEX_3 Macro
USB_DEVICE_INDEX_4 Macro
USB_DEVICE_INDEX_5 Macro
USB_DEVICE_CLIENT_STATUS Enumeration
USB_DEVICE_CONFIGURATION_DESCRIPTORS_TABLE Type
USB_DEVICE_EVENT_DATA_CONFIGURED Structure
USB_DEVICE_EVENT_HANDLER Type
USB_DEVICE_EVENT_RESPONSE Type
USB_DEVICE_FUNCTION_REGISTRATION_TABLE Structure
USB_DEVICE_MASTER_DESCRIPTOR Structure
USB_DEVICE_STRING_DESCRIPTORS_TABLE Type
USB_DEVICE_EVENT_RESPONSE_NONE Macro
USB_DEVICE_EVENT_DATA_ENDPOINT_READ_COMPLETE Structure
USB_DEVICE_EVENT_DATA_ENDPOINT_WRITE_COMPLETE Structure
USB_DEVICE_EVENT_DATA_SOF Structure
USB_DEVICE_EVENT_DATA_SYNCH_FRAME Structure
USB_DEVICE_RESULT Enumeration
USB_DEVICE_TRANSFER_FLAGS Enumeration
USB_DEVICE_TRANSFER_HANDLE Type
_USB_DEVICE_H Macro
USB_DEVICE_MICROSOFT_OS_DESCRIPTOR_SUPPORT_ENABLE Macro
Files
usb_device.h
usb_device_config_template.h
USB Audio 1.0 Device Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
Initializing the Library
Event Handling
Transferring Data
Configuring the Library
USB_DEVICE_AUDIO_INSTANCES_NUMBER Macro
USB_DEVICE_AUDIO_MAX_ALTERNATE_SETTING Macro
USB_DEVICE_AUDIO_MAX_STREAMING_INTERFACES Macro
USB_DEVICE_AUDIO_QUEUE_DEPTH_COMBINED Macro
USB_DEVICE_AUDIO_TRANSFER_ABORT_NOTIFY Macro
_USB_DEVICE_AUDIO_V1_0_CONFIG_TEMPLATE_H_ Macro
Building the Library
Library Interface
a) Functions
USB_DEVICE_AUDIO_EventHandlerSet Function
USB_DEVICE_AUDIO_Read Function
USB_DEVICE_AUDIO_TransferCancel Function
USB_DEVICE_AUDIO_Write Function
USB_DEVICE_AUDIO_StatusSend Function
b) Data Types and Constants
USB_DEVICE_AUDIO_INDEX Type
USB_DEVICE_AUDIO_TRANSFER_HANDLE Type
USB_DEVICE_AUDIO_EVENT Enumeration
USB_DEVICE_AUDIO_RESULT Enumeration
USB_DEVICE_AUDIO_TRANSFER_HANDLE_INVALID Macro
USB_DEVICE_AUDIO_EVENT_DATA_READ_COMPLETE Structure
USB_DEVICE_AUDIO_EVENT_DATA_WRITE_COMPLETE Structure
USB_DEVICE_AUDIO_EVENT_HANDLER Type
USB_DEVICE_AUDIO_EVENT_RESPONSE Type
USB_DEVICE_AUDIO_EVENT_RESPONSE_NONE Macro
USB_DEVICE_AUDIO_FUNCTION_DRIVER Macro
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_CUR Type
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MAX Type
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MEM Type
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MIN Type
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_RES Type
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_CUR Type
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MAX Type
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MEM Type
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MIN Type
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_RES Type
USB_DEVICE_AUDIO_EVENT_DATA_ENTITY_GET_STAT Type
USB_DEVICE_AUDIO_EVENT_DATA_INTERFACE_SETTING_CHANGED Structure
USB_DEVICE_AUDIO_INIT Structure
USB_DEVICE_AUDIO_EVENT_DATA_STATUS_SEND_COMPLETE Structure
_USB_DEVICE_AUDIO_H Macro
Files
usb_device_audio_v1_0.h
usb_device_audio_v1_0_config_template.h
USB Audio 2.0 Device Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
Initializing the Library
Event Handling
Transferring Data
Configuring the Library
USB_DEVICE_AUDIO_V2_INSTANCES_NUMBER Macro
USB_DEVICE_AUDIO_V2_MAX_ALTERNATE_SETTING Macro
USB_DEVICE_AUDIO_V2_MAX_STREAMING_INTERFACES Macro
USB_DEVICE_AUDIO_V2_QUEUE_DEPTH_COMBINED Macro
_USB_DEVICE_AUDIO_V2_0_CONFIG_TEMPLATE_H_ Macro
Building the Library
Library Interface
a) Functions
USB_DEVICE_AUDIO_V2_EventHandlerSet Function
USB_DEVICE_AUDIO_V2_Read Function
USB_DEVICE_AUDIO_V2_TransferCancel Function
USB_DEVICE_AUDIO_V2_Write Function
b) Data Types and Constants
USB_DEVICE_AUDIO_V2_EVENT Enumeration
USB_DEVICE_AUDIO_V2_EVENT_DATA_READ_COMPLETE Structure
USB_DEVICE_AUDIO_V2_EVENT_DATA_SET_ALTERNATE_INTERFACE Structure
USB_DEVICE_AUDIO_V2_EVENT_DATA_WRITE_COMPLETE Structure
USB_DEVICE_AUDIO_V2_EVENT_HANDLER Type
USB_DEVICE_AUDIO_V2_EVENT_RESPONSE Type
USB_DEVICE_AUDIO_V2_INDEX Type
USB_DEVICE_AUDIO_V2_INIT Structure
USB_DEVICE_AUDIO_V2_RESULT Enumeration
USB_DEVICE_AUDIO_V2_TRANSFER_HANDLE Type
USB_DEVICE_AUDIO_V2_EVENT_RESPONSE_NONE Macro
USB_DEVICE_AUDIO_V2_FUNCTION_DRIVER Macro
USB_DEVICE_AUDIO_V2_TRANSFER_HANDLE_INVALID Macro
_USB_DEVICE_AUDIO_V2_H Macro
Files
usb_device_audio_v2_0.h
usb_device_audio_v2_0_config_template.h
USB CDC Device Library
Introduction
Using the Library
Abstraction Model
Abstract Control Model (ACM)
Library Overview
How the Library Works
Library Initialization
Event Handling
Sending Data
Receiving Data
Configuring the Library
_USB_CDC_H Macro
_USB_DEVICE_CDC_CONFIG_TEMPLATE_H_ Macro
_USB_DEVICE_CDC_H Macro
USB_DEVICE_CDC_INSTANCES_NUMBER Macro
USB_DEVICE_CDC_QUEUE_DEPTH_COMBINED Macro
Building the Library
Library Interface
a) Functions
USB_DEVICE_CDC_EventHandlerSet Function
USB_DEVICE_CDC_Read Function
USB_DEVICE_CDC_Write Function
USB_DEVICE_CDC_SerialStateNotificationSend Function
b) Data Types and Constants
USB_DEVICE_CDC_EVENT_DATA_READ_COMPLETE Structure
USB_DEVICE_CDC_EVENT_DATA_SERIAL_STATE_NOTIFICATION_COMPLETE Structure
USB_DEVICE_CDC_EVENT_DATA_WRITE_COMPLETE Structure
USB_DEVICE_CDC_INIT Structure
USB_DEVICE_CDC_EVENT_DATA_SEND_BREAK Structure
USB_DEVICE_CDC_EVENT Enumeration
USB_DEVICE_CDC_EVENT_HANDLER Type
USB_DEVICE_CDC_EVENT_RESPONSE Type
USB_DEVICE_CDC_INDEX Type
USB_DEVICE_CDC_RESULT Enumeration
USB_DEVICE_CDC_TRANSFER_FLAGS Enumeration
USB_DEVICE_CDC_TRANSFER_HANDLE Type
USB_DEVICE_CDC_EVENT_RESPONSE_NONE Macro
USB_DEVICE_CDC_TRANSFER_HANDLE_INVALID Macro
USB_DEVICE_CDC_FUNCTION_DRIVER Macro
USB_CDC_LINESTATE_CARRIER Macro
USB_CDC_LINESTATE_DTR Macro
USB_CDC_DESCRIPTOR_TYPE Enumeration
USB_CDC_INF_PROTOCOL Enumeration
USB_CDC_INTERFACE_TYPE Enumeration
USB_CDC_NOTIFICATION Enumeration
USB_CDC_REQUEST Enumeration
USB_CDC_FUNCTIONAL_DESCRIPTOR Enumeration
USB_CDC_SUBCLASS Enumeration
USB_CDC_UNION_FUNCTIONAL_DESCRIPTOR_SUBORDINATE Type
CS_INTERFACE Macro
USB_CDC_ACM_SUPPORT_BREAK Macro
USB_CDC_ACM_SUPPORT_COMM_FEATURE Macro
USB_CDC_ACM_SUPPORT_LINE_CODING_LINE_STATE_AND_NOTIFICATION Macro
USB_CDC_ACM_SUPPORT_NETWORK_NOTIFICATION Macro
USB_CDC_ACM_SUPPORT_NONE Macro
USB_CDC_CLASS_CODE Macro
USB_CDC_COMMUNICATIONS_INTERFACE_CLASS_CODE Macro
USB_CDC_DATA_INTERFACE_CLASS_CODE Macro
USB_CDC_DATA_INTERFACE_PROTOCOL Macro
USB_CDC_DATA_INTERFACE_SUBCLASS_CODE Macro
USB_CDC_REQUEST_CLASS_SPECIFIC Macro
USB_CDC_SUBCLASS_CODE Macro
USB_DEVICE_CDC_INDEX_0 Macro
USB_DEVICE_CDC_INDEX_1 Macro
USB_DEVICE_CDC_INDEX_2 Macro
USB_DEVICE_CDC_INDEX_3 Macro
USB_DEVICE_CDC_INDEX_4 Macro
USB_DEVICE_CDC_INDEX_5 Macro
USB_DEVICE_CDC_INDEX_6 Macro
USB_DEVICE_CDC_INDEX_7 Macro
Files
usb_device_cdc.h
usb_cdc.h
usb_device_cdc_config_template.h
USB HID Device Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
Library Initialization
Event Handling
Sending a Report
Receiving a Report
Configuring the Library
USB_DEVICE_HID_INSTANCES_NUMBER Macro
USB_DEVICE_HID_QUEUE_DEPTH_COMINED Macro
Building the Library
Library Interface
a) Functions
USB_DEVICE_HID_EventHandlerSet Function
USB_DEVICE_HID_ReportReceive Function
USB_DEVICE_HID_ReportSend Function
USB_DEVICE_HID_TransferCancel Function
b) Data Types and Constants
USB_DEVICE_HID_EVENT Enumeration
USB_DEVICE_HID_EVENT_DATA_GET_IDLE Structure
USB_DEVICE_HID_EVENT_DATA_GET_REPORT Structure
USB_DEVICE_HID_EVENT_DATA_REPORT_RECEIVED Structure
USB_DEVICE_HID_EVENT_DATA_REPORT_SENT Structure
USB_DEVICE_HID_EVENT_DATA_SET_IDLE Structure
USB_DEVICE_HID_EVENT_DATA_SET_REPORT Structure
USB_DEVICE_HID_EVENT_DATA_SET_PROTOCOL Structure
USB_DEVICE_HID_INDEX Type
USB_DEVICE_HID_TRANSFER_HANDLE Type
USB_DEVICE_HID_EVENT_HANDLER Type
USB_DEVICE_HID_EVENT_RESPONSE Type
USB_DEVICE_HID_RESULT Enumeration
USB_DEVICE_HID_EVENT_RESPONSE_NONE Macro
USB_DEVICE_HID_TRANSFER_HANDLE_INVALID Macro
USB_DEVICE_HID_INIT Structure
USB_DEVICE_HID_FUNCTION_DRIVER Macro
USB_DEVICE_HID_INDEX_0 Macro
USB_DEVICE_HID_INDEX_1 Macro
USB_DEVICE_HID_INDEX_2 Macro
USB_DEVICE_HID_INDEX_3 Macro
USB_DEVICE_HID_INDEX_4 Macro
USB_DEVICE_HID_INDEX_5 Macro
USB_DEVICE_HID_INDEX_6 Macro
USB_DEVICE_HID_INDEX_7 Macro
Files
usb_device_hid.h
usb_device_hid_config_template.h
Generic USB Device Library
Introduction
Using the Library
Library Overview
Abstraction Model
How the Library Works
Library Initialization
Event Handling
Control Transfer Events
Endpoint Data Transfer Events
Endpoint Management
Endpoint Data Transfer
Configuring the Library
Building the Library
Library Interface
USB MSD Device Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
Library Initialization
Data Transfer
Configuring the Library
USB_DEVICE_MSD_INSTANCES_NUMBER Macro
USB_DEVICE_MSD_LUNS_NUMBER Macro
_USB_DEVICE_MSD_CONFIG_TEMPLATE_H_ Macro
Building the Library
Library Interface
a) System Configuration Functions
Data Types and Constants
USB_DEVICE_MSD_INIT Structure
USB_DEVICE_MSD_MEDIA_FUNCTIONS Structure
USB_DEVICE_MSD_MEDIA_INIT_DATA Structure
USB_DEVICE_MSD_FUNCTION_DRIVER Macro
_USB_DEVICE_MSD_H Macro
Files
usb_device_msd.h
usb_device_msd_config_template.h
USB Device Printer Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
Library Initialization
Event Handling
Sending Data
Receiving Data
Configuring the Library
_USB_PRINTER_H Macro
_USB_DEVICE_PRINTER_H Macro
USB_DEVICE_PRINTER_INSTANCES_NUMBER Macro
USB_DEVICE_PRINTER_QUEUE_DEPTH_COMBINED Macro
Building the Library
Library Interface
a) Functions
USB_DEVICE_PRINTER_EventHandlerSet Function
USB_DEVICE_PRINTER_Read Function
USB_DEVICE_PRINTER_Write Function
b) Data Types and Constants
USB_DEVICE_PRINTER_EVENT Enumeration
USB_DEVICE_PRINTER_EVENT_DATA_READ_COMPLETE Structure
USB_DEVICE_PRINTER_EVENT_DATA_WRITE_COMPLETE Structure
USB_DEVICE_PRINTER_EVENT_HANDLER Type
USB_DEVICE_PRINTER_EVENT_RESPONSE Type
USB_DEVICE_PRINTER_INDEX Type
USB_DEVICE_PRINTER_INIT Structure
USB_DEVICE_PRINTER_PORT_STATUS Structure
USB_DEVICE_PRINTER_RESULT Enumeration
USB_DEVICE_PRINTER_TRANSFER_FLAGS Enumeration
USB_DEVICE_PRINTER_TRANSFER_HANDLE Type
USB_PRINTER_COMMAND Enumeration
USB_PRINTER_INTERFACE_CLASS_CODE Macro
USB_PRINTER_INTERFACE_PROTOCOL Macro
USB_PRINTER_INTERFACE_SUBCLASS_CODE Macro
USB_PRINTER_REQUEST_CLASS_SPECIFIC Macro
USB_DEVICE_PRINTER_EVENT_RESPONSE_NONE Macro
USB_DEVICE_PRINTER_FUNCTION_DRIVER Macro
USB_DEVICE_PRINTER_INDEX_0 Macro
USB_DEVICE_PRINTER_TRANSFER_HANDLE_INVALID Macro
Files
usb_device_printer.h
usb_printer.h
usb_device_printer_config_template.h
USB Host Libraries
USB Host Library - Getting Started
Introduction
USB Host Library Architecture
USB Host Library - Application Interaction
USB Host Layer Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
Host Layer Initialization
Host Layer - Application Interaction
Event Handling
Configuring the Library
_USB_HOST_CONFIG_TEMPLATE_H_ Macro
USB_HOST_CONTROLLERS_NUMBER Macro
USB_HOST_DEVICE_INTERFACES_NUMBER Macro
USB_HOST_DEVICES_NUMBER Macro
USB_HOST_HUB_SUPPORT_ENABLE Macro
USB_HOST_HUB_TIER_LEVEL Macro
USB_HOST_PIPES_NUMBER Macro
USB_HOST_TRANSFERS_NUMBER Macro
Building the Library
Library Interface
a) Functions
USB_HOST_Deinitialize Function
USB_HOST_Status Function
USB_HOST_Tasks Function
USB_HOST_BusEnable Function
USB_HOST_BusIsEnabled Function
USB_HOST_BusIsSuspended Function
USB_HOST_BusResume Function
USB_HOST_BusSuspend Function
USB_HOST_DeviceGetFirst Function
USB_HOST_DeviceGetNext Function
USB_HOST_DeviceIsSuspended Function
USB_HOST_DeviceResume Function
USB_HOST_DeviceSpeedGet Function
USB_HOST_DeviceStringDescriptorGet Function
USB_HOST_DeviceSuspend Function
USB_HOST_EventHandlerSet Function
USB_HOST_Initialize Function
b) Data Types and Constants
USB_HOST_INIT Structure
USB_HOST_EVENT_RESPONSE Enumeration
\ .tplFlags.driverType = (TPL_FLAG_CLASS_SUBCLASS_PROTOCOL) Enumeration
\ .tplFlags.driverType = (TPL_FLAG_VID_PID) Enumeration
0 Enumeration
0x0000 Enumeration
0xFF Enumeration
0xFF } Enumeration
0xFFFF Enumeration
0xFFFF } Enumeration
1 Enumeration
classCode Enumeration
false Enumeration
initData Enumeration
mask Enumeration
pid Enumeration
pid } Enumeration
subClassCode Enumeration
true Enumeration
USB_HOST_BUS Type
USB_HOST_DEVICE_INFO Structure
USB_HOST_DEVICE_OBJ_HANDLE Type
USB_HOST_DEVICE_STRING Enumeration
USB_HOST_EVENT Enumeration
USB_HOST_EVENT_HANDLER Type
USB_HOST_HCD Structure
USB_HOST_REQUEST_HANDLE Type
USB_HOST_RESULT Enumeration
USB_HOST_STRING_REQUEST_COMPLETE_CALLBACK Type
USB_HOST_TARGET_PERIPHERAL_LIST_ENTRY Enumeration
USB_HOST_TPL_ENTRY Enumeration
vid Enumeration
USB_HOST_BUS_ALL Macro
USB_HOST_DEVICE_OBJ_HANDLE_INVALID Macro
USB_HOST_DEVICE_STRING_LANG_ID_DEFAULT Macro
USB_HOST_REQUEST_HANDLE_INVALID Macro
USB_HOST_RESULT_MIN Macro
Files
usb_host.h
usb_host_config_template.h
USB Audio v1.0 Host Client Driver Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
TPL Table Configuration for Audio v1.0 Devices
Detecting Device Attach
Obtaining Audio v1.0 Device Audio Stream Details
Obtaining an Audio Stream
Audio Stream Event Handling
Enabling Audio Stream
Setting the Desired Audio Stream Sampling Rate
Audio Data Streaming
Sending Class Specific Control Transfers
Configuring the Library
USB_HOST_AUDIO_V1_ATTACH_LISTENERS_NUMBER Macro
USB_HOST_HUB_INSTANCES_NUMBER Macro
USB_HOST_AUDIO_V1_INSTANCES_NUMBER Macro
USB_HOST_HUB_PORTS_NUMBER Macro
_USB_HOST_HUB_CONFIG_TEMPLATE_H_ Macro
USB_HOST_AUDIO_V1_STREAMING_INTERFACE_ALTERNATE_SETTINGS_NUMBER Macro
USB_HOST_AUDIO_V1_STREAMING_INTERFACES_NUMBER Macro
_USB_HOST_AUDIO_V1_CONFIG_TEMPLATE_H_ Macro
Building the Library
Library Interface
a) Audio Device Access Functions
USB_HOST_AUDIO_V1_0_ControlRequest Function
USB_HOST_AUDIO_V1_0_StreamGetNext Function
USB_HOST_AUDIO_V1_0_StreamRead Function
USB_HOST_AUDIO_V1_0_StreamSamplingRateSet Function
USB_HOST_AUDIO_V1_0_StreamWrite Function
USB_HOST_AUDIO_V1_AttachEventHandlerSet Function
USB_HOST_AUDIO_V1_ControlEntityGetFirst Function
USB_HOST_AUDIO_V1_ControlEntityGetNext Function
USB_HOST_AUDIO_V1_DeviceObjHandleGet Function
USB_HOST_AUDIO_V1_EntityObjectGet Function
USB_HOST_AUDIO_V1_EntityRequestCallbackSet Function
USB_HOST_AUDIO_V1_EntityTypeGet Function
USB_HOST_AUDIO_V1_FeatureUnitChannelMuteExists Function
USB_HOST_AUDIO_V1_FeatureUnitChannelMuteGet Function
USB_HOST_AUDIO_V1_FeatureUnitChannelMuteSet Function
USB_HOST_AUDIO_V1_FeatureUnitChannelNumbersGet Function
USB_HOST_AUDIO_V1_FeatureUnitChannelVolumeExists Function
USB_HOST_AUDIO_V1_FeatureUnitChannelVolumeGet Function
USB_HOST_AUDIO_V1_FeatureUnitChannelVolumeRangeGet Function
USB_HOST_AUDIO_V1_FeatureUnitChannelVolumeSet Function
USB_HOST_AUDIO_V1_FeatureUnitIDGet Function
USB_HOST_AUDIO_V1_FeatureUnitSourceIDGet Function
USB_HOST_AUDIO_V1_TerminalAssociationGet Function
USB_HOST_AUDIO_V1_TerminalIDGet Function
USB_HOST_AUDIO_V1_TerminalInputChannelNumbersGet Function
USB_HOST_AUDIO_V1_TerminalSourceIDGet Function
USB_HOST_AUDIO_V1_TerminalTypeGet Function
b) Audio Stream Access Functions
USB_HOST_AUDIO_V1_0_StreamDisable Function
USB_HOST_AUDIO_V1_0_StreamEnable Function
USB_HOST_AUDIO_V1_0_StreamEventHandlerSet Function
USB_HOST_AUDIO_V1_0_StreamGetFirst Function
USB_HOST_AUDIO_V1_0_NumberOfStreamGroupsGet Function
USB_HOST_AUDIO_V1_StreamClose Function
USB_HOST_AUDIO_V1_StreamEventHandlerSet Function
USB_HOST_AUDIO_V1_StreamingInterfaceBitResolutionGet Function
USB_HOST_AUDIO_V1_StreamingInterfaceChannelNumbersGet Function
USB_HOST_AUDIO_V1_StreamingInterfaceDirectionGet Function
USB_HOST_AUDIO_V1_StreamingInterfaceFormatTagGet Function
USB_HOST_AUDIO_V1_StreamingInterfaceGetFirst Function
USB_HOST_AUDIO_V1_StreamingInterfaceGetNext Function
USB_HOST_AUDIO_V1_StreamingInterfaceSamplingFrequenciesGet Function
USB_HOST_AUDIO_V1_StreamingInterfaceSamplingFrequencyTypeGet Function
USB_HOST_AUDIO_V1_StreamingInterfaceSet Function
USB_HOST_AUDIO_V1_StreamingInterfaceSettingGetFirst Function
USB_HOST_AUDIO_V1_StreamingInterfaceSettingGetNext Function
USB_HOST_AUDIO_V1_StreamingInterfaceSubFrameSizeGet Function
USB_HOST_AUDIO_V1_StreamingInterfaceTerminalLinkGet Function
USB_HOST_AUDIO_V1_StreamOpen Function
USB_HOST_AUDIO_V1_StreamRead Function
USB_HOST_AUDIO_V1_StreamSamplingFrequencyGet Function
USB_HOST_AUDIO_V1_StreamSamplingFrequencySet Function
USB_HOST_AUDIO_V1_StreamWrite Function
c) Other Functions
USB_HOST_AUDIO_V1_FeatureUnitChannelVolumeSubRangeNumbersGet Function
USB_HOST_AUDIO_V1_TerminalInputChannelConfigGet Function
d) Data Types and Constants
USB_HOST_AUDIO_V1_0_ATTACH_EVENT_HANDLER Type
USB_HOST_AUDIO_V1_0_CONTROL_CALLBACK Type
USB_HOST_AUDIO_V1_0_EVENT Macro
USB_HOST_AUDIO_V1_0_OBJ Macro
USB_HOST_AUDIO_V1_0_REQUEST_HANDLE Macro
USB_HOST_AUDIO_V1_0_RESULT Enumeration
USB_HOST_AUDIO_V1_0_STREAM_DIRECTION Macro
USB_HOST_AUDIO_V1_0_STREAM_EVENT Enumeration
USB_HOST_CDC_EVENT Enumeration
USB_HOST_AUDIO_V1_0_STREAM_EVENT_DISABLE_COMPLETE_DATA Structure
USB_HOST_AUDIO_V1_0_STREAM_EVENT_ENABLE_COMPLETE_DATA Structure
USB_HOST_CDC_HANDLE Type
USB_HOST_AUDIO_V1_0_STREAM_EVENT_HANDLER Type
USB_HOST_AUDIO_V1_0_STREAM_EVENT_READ_COMPLETE_DATA Macro
USB_HOST_AUDIO_V1_0_STREAM_EVENT_RESPONSE Macro
USB_HOST_CDC_RESULT Enumeration
USB_HOST_AUDIO_V1_0_STREAM_EVENT_WRITE_COMPLETE_DATA Macro
USB_HOST_AUDIO_V1_0_STREAM_HANDLE Macro
USB_HOST_AUDIO_V1_0_STREAM_INFO Structure
USB_HOST_CDC_TRANSFER_HANDLE Type
USB_HOST_AUDIO_V1_0_STREAM_OBJ Type
USB_HOST_AUDIO_V1_0_STREAM_RESULT Enumeration
USB_HOST_AUDIO_V1_0_STREAM_TRANSFER_HANDLE Macro
USB_HOST_AUDIO_V1_0_INTERFACE Macro
USB_HOST_AUDIO_V1_0_REQUEST_HANDLE_INVALID Macro
USB_HOST_AUDIO_V1_0_STREAM_HANDLE_INVALID Macro
USB_HOST_AUDIO_V1_0_STREAM_TRANSFER_HANDLE_INVALID Macro
USB_HOST_AUDIO_V1_ATTACH_EVENT_HANDLER Type
USB_HOST_AUDIO_V1_CONTROL_ENTITY_OBJ Type
USB_HOST_AUDIO_V1_ENTITY_REQUEST_CALLBACK Type
USB_HOST_AUDIO_V1_EVENT Enumeration
USB_HOST_AUDIO_V1_OBJ Type
USB_HOST_AUDIO_V1_REQUEST_HANDLE Type
USB_HOST_AUDIO_V1_RESULT Enumeration
USB_HOST_AUDIO_V1_STREAM_DIRECTION Enumeration
USB_HOST_AUDIO_V1_STREAM_EVENT Enumeration
USB_HOST_AUDIO_V1_STREAM_EVENT_HANDLER Type
USB_HOST_AUDIO_V1_STREAM_EVENT_INTERFACE_SET_COMPLETE_DATA Structure
USB_HOST_AUDIO_V1_STREAM_EVENT_READ_COMPLETE_DATA Structure
USB_HOST_AUDIO_V1_STREAM_EVENT_RESPONSE Enumeration
USB_HOST_AUDIO_V1_STREAM_EVENT_SAMPLING_RATE_SET_COMPLETE_DATA Structure
USB_HOST_AUDIO_V1_STREAM_EVENT_WRITE_COMPLETE_DATA Structure
USB_HOST_AUDIO_V1_STREAM_HANDLE Type
USB_HOST_AUDIO_V1_STREAM_TRANSFER_HANDLE Type
USB_HOST_AUDIO_V1_STREAMING_INTERFACE_OBJ Type
USB_HOST_AUDIO_V1_STREAMING_INTERFACE_SETTING_OBJ Type
USB_HOST_AUDIO_V1_0_AttachEventHandlerSet Macro
USB_HOST_AUDIO_V1_0_DeviceObjHandleGet Macro
USB_HOST_AUDIO_V1_0_DIRECTION_IN Macro
USB_HOST_AUDIO_V1_0_DIRECTION_OUT Macro
USB_HOST_AUDIO_V1_0_EVENT_ATTACH Macro
USB_HOST_AUDIO_V1_0_EVENT_DETACH Macro
USB_HOST_AUDIO_V1_0_STREAM_EVENT_RESPONSE_NONE Macro
USB_HOST_AUDIO_V1_0_StreamClose Macro
USB_HOST_AUDIO_V1_0_StreamOpen Macro
USB_HOST_AUDIO_V1_INTERFACE Macro
USB_HOST_AUDIO_V1_REQUEST_HANDLE_INVALID Macro
USB_HOST_AUDIO_V1_SAMPLING_FREQUENCIES_NUMBER Macro
USB_HOST_AUDIO_V1_STREAM_HANDLE_INVALID Macro
USB_HOST_AUDIO_V1_STREAM_TRANSFER_HANDLE_INVALID Macro
USB_HOST_AUDIO_V1_STREAM_EVENT_SAMPLING_RATE_GET_COMPLETE_DATA Structure
Files
usb_host_audio_v1_0.h
usb_host_cdc.h
usb_host_hub_config_template.h
usb_host_audio_v1_0_config_template.h
USB CDC Host Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
TPL Table Configuration for CDC Devices
Detecting Device Attach
Opening the CDC Host Client Driver
Sending Class-specific Control Transfers
Reading and Writing Data
Event Handling
Configuring the Library
_USB_HOST_CDC_CONFIG_TEMPLATE_H_ Macro
USB_HOST_CDC_ATTACH_LISTENERS_NUMBER Macro
USB_HOST_CDC_INSTANCES_NUMBER Macro
Building the Library
Library Interface
a) Client Access Functions
USB_HOST_CDC_Open Function
USB_HOST_CDC_Close Function
USB_HOST_CDC_AttachEventHandlerSet Function
USB_HOST_CDC_EventHandlerSet Function
USB_HOST_CDC_DeviceObjHandleGet Function
b) Data Transfer Functions
USB_HOST_CDC_Read Function
USB_HOST_CDC_Write Function
USB_HOST_CDC_SerialStateNotificationGet Function
c) CDC Class-specific Functions
USB_HOST_CDC_ACM_ControlLineStateSet Function
USB_HOST_CDC_ACM_LineCodingSet Function
d) Data Types and Constants
USB_HOST_CDC_EVENT_HANDLER Type
USB_HOST_CDC_EVENT_RESPONSE Enumeration
USB_HOST_CDC_TRANSFER_HANDLE_INVALID Macro
USB_HOST_CDC_ATTACH_EVENT_HANDLER Type
USB_HOST_CDC_EVENT_ACM_GET_LINE_CODING_COMPLETE_DATA Structure
USB_HOST_CDC_EVENT_ACM_SEND_BREAK_COMPLETE_DATA Structure
USB_HOST_CDC_EVENT_ACM_SET_CONTROL_LINE_STATE_COMPLETE_DATA Structure
USB_HOST_CDC_EVENT_ACM_SET_LINE_CODING_COMPLETE_DATA Structure
USB_HOST_CDC_EVENT_READ_COMPLETE_DATA Structure
USB_HOST_CDC_EVENT_SERIAL_STATE_NOTIFICATION_RECEIVED_DATA Structure
USB_HOST_CDC_EVENT_WRITE_COMPLETE_DATA Structure
USB_HOST_CDC_OBJ Type
USB_HOST_CDC_REQUEST_HANDLE Type
USB_HOST_CDC_HANDLE_INVALID Macro
USB_HOST_CDC_INTERFACE Macro
USB_HOST_CDC_REQUEST_HANDLE_INVALID Macro
Files
usb_host_cdc_config_template.h
USB HID Host Mouse Driver Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
HID Device TPL Table Configuration
Detecting Device Attach
Mouse Data Event Handling
Configuring the Library
_USB_HOST_HID_CONFIG_TEMPLATE_H_ Macro
USB_HID_GLOBAL_PUSH_POP_STACK_SIZE Macro
USB_HOST_HID_INSTANCES_NUMBER Macro
USB_HOST_HID_INTERRUPT_IN_ENDPOINTS_NUMBER Macro
USB_HOST_HID_MOUSE_BUTTONS_NUMBER Macro
USB_HOST_HID_USAGE_DRIVER_SUPPORT_NUMBER Macro
Building the Library
Library Interface
a) Mouse Access Functions
USB_HOST_HID_MOUSE_EventHandlerSet Function
_USB_HOST_HID_MOUSE_EventHandler Function
_USB_HOST_HID_MOUSE_Task Function
b) Data Types and Constants
USB_HOST_HID_MOUSE_DATA Structure
USB_HOST_HID_MOUSE_EVENT Enumeration
USB_HOST_HID_MOUSE_EVENT_HANDLER Type
USB_HOST_HID_MOUSE_HANDLE Type
USB_HOST_HID_MOUSE_RESULT Enumeration
USB_HOST_HID_MOUSE_RESULT_MIN Macro
USB_HOST_HID_MOUSE_HANDLE_INVALID Macro
Files
usb_host_hid_mouse.h
usb_host_hid_config_template.h
usb_hid.h
USB Hub Host Client Driver Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
Hub TPL Table Configuration
USB Hub Host Client Driver Test Results
Configuring the Library
Building the Library
Library Interface
Data Types and Constants
USB_HOST_HUB_INTERFACE Macro
Files
usb_host_hub.h
USB MSD Host Client Driver Library
Introduction
Using the Library
Abstraction Model
Library Overview
How the Library Works
MSD TPL Table Configuration
Data Transfer
Configuring the Library
USB_HOST_MSD_INSTANCES_NUMBER Macro
USB_HOST_MSD_LUNS_NUMBER Macro
_USB_HOST_MSD_CONFIG_TEMPLATE_H_ Macro
Building the Library
Library Interface
a) Data Transfer Functions
USB_HOST_MSD_Transfer Function
USB_HOST_MSD_TransferErrorTasks Function
b) Data Types and Constants
USB_HOST_MSD_RESULT Enumeration
USB_HOST_MSD_TRANSFER_CALLBACK Type
USB_HOST_MSD_TRANSFER_DIRECTION Enumeration
USB_HOST_MSD_TRANSFER_HANDLE Type
USB_HOST_MSD_INTERFACE Macro
USB_HOST_MSD_TRANSFER_HANDLE_INVALID Macro
USB_HOST_MSD_LUN_HANDLE Type
USB_HOST_MSD_LUN_HANDLE_INVALID Macro
USB_HOST_MSD_ERROR_CODE Enumeration
Files
usb_host_msd.h
usb_host_msd_config_template.h
usb_msd.h
USB Common Driver Interface
Common Interface
Driver Host Mode Client Functions
Driver Host Root Hub Interface
Driver Host USB Root Hub Port Interface
Driver Device Mode Client Functions
Driver General Client Functions
Opening the Driver
USB Driver Host Mode Operation
USB Driver Device Mode Operation
General Device Mode Operations
Device Endpoint Operations
Transferring Data to the Host
Driver Signing and Windows 8 (for v1.08)
What are "Signed" Drivers?
Minimum Driver Signature Requirements
Using Older Drivers With Windows 8
USB Application Project Driver Signatures
Obtaining a Microsoft Authenticode Code Signing Certificate
Code Signing Certificates (Other Uses)
Using a Code Signing Certificate to Sign Driver Packages
Support
Using the Help
Trademarks
Typographic Conventions
Recommended Reading
Documentation Feedback
Help Features
CHM Help Features
HTML Help Features
PDF Help Features
Microchip Website
Microchip Forums
Customer Support
Contact Microchip Technology
Glossary