Atmel Software Framework

usb_ids.h File Reference

Macros

#define USB_ENDPOINT_IN   0x80
 
#define USB_ENDPOINT_OUT   0x00
 
Vendor ID (VID)
#define ATMEL_VID   0x03EB
 
USB Product ID (PID)
#define HID_GENERIC_EXAMPLE_PID   0x2013
 
#define HID_QTOUCH_DEBUG_PID   0x211F
 
#define ENUM_EXAMPLE_PID   0x2300
 
#define MS_EXAMPLE_PID   0x2301
 
#define MS_SDRAM_LOADER_PID   0x2302
 
#define EVK1100_CTRL_PANEL_DEMO_PID   0x2303
 
#define HID_EXAMPLE_PID   0x2304
 
#define EVK1101_CTRL_PANEL_DEMO_HID_PID   0x2305
 
#define EVK1101_CTRL_PANEL_DEMO_HID_MS_PID   0x2306
 
#define CDC_EXAMPLE_PID   0x2307
 
#define AUDIO_MIC_EXAMPLE_PID   0x2308
 
#define EVK11xx_VIRTUAL_COM_PORT_PID   0x2310
 
#define AUDIO_SPEAKER_MICRO_EXAMPLE_PID   0x2311
 
#define CDC_MSC_EXAMPLE_PID   0x2312
 
#define ISP_UC3A_PID   0x2FF8
 
#define ISP_UC3A3_PID   0x2FF1
 
#define ISP_UC3B_PID   0x2FF6
 
Generic definitions (Class, subclass and protocol)
#define NO_CLASS   0x00
 
#define NO_SUBCLASS   0x00
 
#define NO_PROTOCOL   0x00
 
IAD Interface Association Descriptor constants
#define CLASS_IAD   0xEF
 
#define SUB_CLASS_IAD   0x02
 
#define PROTOCOL_IAD   0x01
 
Audio specific definitions (Class, subclass and protocol)
#define AUDIO_CLASS   0x01
 
#define AUDIOCONTROL_SUBCLASS   0x01
 
#define AUDIOSTREAMING_SUBCLASS   0x02
 
#define MIDISTREAMING_SUBCLASS   0x03
 
CDC specific definitions (Class, subclass and protocol)
#define CDC_COMM_DEVICE_CLASS   0x02
 
#define CDC_COMM_CLASS   0x02
 
#define CDC_COMM_DIRECT_LINE_CM_SUBCLASS   0x01
 
#define CDC_COMM_ABSTRACT_CM_SUBCLASS   0x02
 
#define CDC_COMM_TELEPHONE_CM_SUBCLASS   0x03
 
#define CDC_COMM_MULTICHANNEL_CM_SUBCLASS   0x04
 
#define CDC_COMM_CAPI_CM_SUBCLASS   0x05
 
#define CDC_COMM_ETHERNET_NETWORKING_CM_SUBCLASS   0x06
 
#define CDC_COMM_ATM_NETWORKING_CM_SUBCLASS   0x07
 
#define CDC_COMM_V25ter_PROTOCOL   0x01
 
#define CDC_DATA_CLASS   0x0A
 
#define CDC_DATA_SUBCLASS   0x00
 
#define CDC_DATA_PHYS_ISDN_BRI_PROTOCOL   0x30
 
#define CDC_DATA_HDLC_PROTOCOL   0x31
 
#define CDC_DATA_TRANSPARENT_PROTOCOL   0x32
 
HID specific definitions (Class, subclass and protocol)
#define HID_CLASS   0x03
 
#define BOOT_SUBCLASS   0x01
 
#define KEYBOARD_PROTOCOL   0x01
 
#define MOUSE_PROTOCOL   0x02
 
MS specific definitions (Class, subclass and protocol)
#define MS_CLASS   0x08
 
#define SFF8020I_MMC2_SUBCLASS   0x02
 
#define SFF8070I_SUBCLASS   0x05
 
#define SCSI_SUBCLASS   0x06
 
#define BULK_PROTOCOL   0x50
 
DFU specific definitions (Class, subclass and protocol)
#define APPLICATION_CLASS   0xFE
 
#define DFU_SUBCLASS   0x01
 
#define RUNTIME_PROTOCOL   0x01
 
#define DFU_MODE_PROTOCOL   0x02
 
HUB specific definitions (Class, subclass and protocol)
#define HUB_CLASS   0x09
 
Others specific definitions (Class, subclass and protocol)
#define VENDOR_CLASS   0xFF
 
Data transfer direction

bit 7, 0 = Host to device 1 = Device to host

#define USB_SETUP_DIR_HOST_TO_DEVICE   (0<<7)
 
#define USB_SETUP_DIR_DEVICE_TO_HOST   (1<<7)
 
Type

bit 6 to 5, 0 = Standard 1 = Class 2 = Vendor 3 = Reserved

#define USB_SETUP_TYPE_STANDARD   (0<<5)
 
#define USB_SETUP_TYPE_CLASS   (1<<5)
 
#define USB_SETUP_TYPE_VENDOR   (2<<5)
 
Recipient

bit 4 to 0, 0 = device 1 = Interface 2 = Endpoint 3 = Other 4...31 = Reserved

#define USB_SETUP_RECIPIENT_DEVICE   (0)
 
#define USB_SETUP_RECIPIENT_INTERFACE   (1)
 
#define USB_SETUP_RECIPIENT_ENDPOINT   (2)
 
#define USB_SETUP_RECIPIENT_OTHER   (3)
 
Request type used by standard setup request
#define USB_SETUP_SET_STAND_DEVICE   (USB_SETUP_DIR_HOST_TO_DEVICE |USB_SETUP_TYPE_STANDARD |USB_SETUP_RECIPIENT_DEVICE)
 
#define USB_SETUP_GET_STAND_DEVICE   (USB_SETUP_DIR_DEVICE_TO_HOST |USB_SETUP_TYPE_STANDARD |USB_SETUP_RECIPIENT_DEVICE)
 
#define USB_SETUP_SET_STAND_INTERFACE   (USB_SETUP_DIR_HOST_TO_DEVICE |USB_SETUP_TYPE_STANDARD |USB_SETUP_RECIPIENT_INTERFACE)
 
#define USB_SETUP_GET_STAND_INTERFACE   (USB_SETUP_DIR_DEVICE_TO_HOST |USB_SETUP_TYPE_STANDARD |USB_SETUP_RECIPIENT_INTERFACE)
 
#define USB_SETUP_SET_STAND_ENDPOINT   (USB_SETUP_DIR_HOST_TO_DEVICE |USB_SETUP_TYPE_STANDARD |USB_SETUP_RECIPIENT_ENDPOINT)
 
#define USB_SETUP_GET_STAND_ENDPOINT   (USB_SETUP_DIR_DEVICE_TO_HOST |USB_SETUP_TYPE_STANDARD |USB_SETUP_RECIPIENT_ENDPOINT)
 
Request type used by specific setup request from class driver
#define USB_SETUP_SET_CLASS_DEVICE   (USB_SETUP_DIR_HOST_TO_DEVICE |USB_SETUP_TYPE_CLASS |USB_SETUP_RECIPIENT_DEVICE)
 
#define USB_SETUP_GET_CLASS_DEVICE   (USB_SETUP_DIR_DEVICE_TO_HOST |USB_SETUP_TYPE_CLASS |USB_SETUP_RECIPIENT_DEVICE)
 
#define USB_SETUP_SET_CLASS_INTER   (USB_SETUP_DIR_HOST_TO_DEVICE |USB_SETUP_TYPE_CLASS |USB_SETUP_RECIPIENT_INTERFACE)
 
#define USB_SETUP_GET_CLASS_INTER   (USB_SETUP_DIR_DEVICE_TO_HOST |USB_SETUP_TYPE_CLASS |USB_SETUP_RECIPIENT_INTERFACE)
 
#define USB_SETUP_SET_CLASS_ENDPOINT   (USB_SETUP_DIR_HOST_TO_DEVICE |USB_SETUP_TYPE_CLASS |USB_SETUP_RECIPIENT_ENDPOINT)
 
#define USB_SETUP_GET_CLASS_ENDPOINT   (USB_SETUP_DIR_DEVICE_TO_HOST |USB_SETUP_TYPE_CLASS |USB_SETUP_RECIPIENT_ENDPOINT)
 
#define USB_SETUP_SET_CLASS_OTHER   (USB_SETUP_DIR_HOST_TO_DEVICE |USB_SETUP_TYPE_CLASS |USB_SETUP_RECIPIENT_OTHER)
 
#define USB_SETUP_GET_CLASS_OTHER   (USB_SETUP_DIR_DEVICE_TO_HOST |USB_SETUP_TYPE_CLASS |USB_SETUP_RECIPIENT_OTHER)
 
#define USB_SETUP_SET_VENDOR_DEVICE   (USB_SETUP_DIR_HOST_TO_DEVICE |USB_SETUP_TYPE_VENDOR |USB_SETUP_RECIPIENT_DEVICE)
 
#define USB_SETUP_GET_VENDOR_DEVICE   (USB_SETUP_DIR_DEVICE_TO_HOST |USB_SETUP_TYPE_VENDOR |USB_SETUP_RECIPIENT_DEVICE)
 
Standard Requests (bRequest)
#define SETUP_GET_STATUS   0x00
 
#define SETUP_GET_DEVICE   0x01
 
#define SETUP_CLEAR_FEATURE   0x01
 
#define SETUP_GET_STRING   0x03
 
#define SETUP_SET_FEATURE   0x03
 
#define SETUP_SET_ADDRESS   0x05
 
#define SETUP_GET_DESCRIPTOR   0x06
 
#define SETUP_SET_DESCRIPTOR   0x07
 
#define SETUP_GET_CONFIGURATION   0x08
 
#define SETUP_SET_CONFIGURATION   0x09
 
#define SETUP_GET_INTERFACE   0x0A
 
#define SETUP_SET_INTERFACE   0x0B
 
#define SETUP_SYNCH_FRAME   0x0C
 
Descriptor types used in several setup requests
#define DESCRIPTOR_DEVICE   0x01
 
#define DESCRIPTOR_CONFIGURATION   0x02
 
#define DESCRIPTOR_STRING   0x03
 
#define DESCRIPTOR_INTERFACE   0x04
 
#define DESCRIPTOR_ENDPOINT   0x05
 
#define DESCRIPTOR_DEVICE_QUALIFIER   0x06
 
#define DESCRIPTOR_CONF_OTHER_SPEED   0x07
 
#define DESCRIPTOR_OTG   0x09
 
#define DESCRIPTOR_IAD   0x0B
 
Feature types for SETUP_X_FEATURE standard request
#define FEATURE_DEVICE_REMOTE_WAKEUP   0x01
 
#define FEATURE_DEVICE_TEST   0x02
 
#define FEATURE_DEVICE_OTG_B_HNP_ENABLE   0x03
 
#define FEATURE_DEVICE_OTG_A_HNP_SUPPORT   0x04
 
#define FEATURE_DEVICE_OTG_A_ALT_HNP_SUPPORT   0x05
 
#define FEATURE_ENDPOINT_HALT   0x00
 
Feature types for SETUP_X_FEATURE standard test request
#define FEATURE_DEVICE_TEST_J   0x01
 
#define FEATURE_DEVICE_TEST_K   0x02
 
#define FEATURE_DEVICE_TEST_SEO_NAK   0x03
 
#define FEATURE_DEVICE_TEST_PACKET   0x04
 
#define FEATURE_DEVICE_TEST_FORCE_ENABLE   0x05
 

#define APPLICATION_CLASS   0xFE
#define ATMEL_VID   0x03EB
#define AUDIO_CLASS   0x01

Referenced by host_audio_task().

#define AUDIO_MIC_EXAMPLE_PID   0x2308
#define AUDIO_SPEAKER_MICRO_EXAMPLE_PID   0x2311
#define AUDIOCONTROL_SUBCLASS   0x01
#define AUDIOSTREAMING_SUBCLASS   0x02

Referenced by host_audio_task().

#define BOOT_SUBCLASS   0x01
#define BULK_PROTOCOL   0x50
#define CDC_COMM_ABSTRACT_CM_SUBCLASS   0x02
#define CDC_COMM_ATM_NETWORKING_CM_SUBCLASS   0x07
#define CDC_COMM_CAPI_CM_SUBCLASS   0x05
#define CDC_COMM_CLASS   0x02

Referenced by host_cdc_task().

#define CDC_COMM_DEVICE_CLASS   0x02
#define CDC_COMM_DIRECT_LINE_CM_SUBCLASS   0x01
#define CDC_COMM_ETHERNET_NETWORKING_CM_SUBCLASS   0x06
#define CDC_COMM_MULTICHANNEL_CM_SUBCLASS   0x04
#define CDC_COMM_TELEPHONE_CM_SUBCLASS   0x03
#define CDC_COMM_V25ter_PROTOCOL   0x01

Referenced by host_cdc_task().

#define CDC_DATA_CLASS   0x0A

Referenced by host_cdc_task().

#define CDC_DATA_HDLC_PROTOCOL   0x31
#define CDC_DATA_PHYS_ISDN_BRI_PROTOCOL   0x30
#define CDC_DATA_SUBCLASS   0x00
#define CDC_DATA_TRANSPARENT_PROTOCOL   0x32
#define CDC_EXAMPLE_PID   0x2307
#define CDC_MSC_EXAMPLE_PID   0x2312
#define CLASS_IAD   0xEF
#define DESCRIPTOR_CONF_OTHER_SPEED   0x07
#define DESCRIPTOR_CONFIGURATION   0x02
#define DESCRIPTOR_DEVICE   0x01
#define DESCRIPTOR_DEVICE_QUALIFIER   0x06
#define DESCRIPTOR_ENDPOINT   0x05
#define DESCRIPTOR_IAD   0x0B
#define DESCRIPTOR_INTERFACE   0x04
#define DESCRIPTOR_OTG   0x09
#define DESCRIPTOR_STRING   0x03
#define DFU_MODE_PROTOCOL   0x02
#define DFU_SUBCLASS   0x01
#define ENUM_EXAMPLE_PID   0x2300
#define EVK1100_CTRL_PANEL_DEMO_PID   0x2303
#define EVK1101_CTRL_PANEL_DEMO_HID_MS_PID   0x2306
#define EVK1101_CTRL_PANEL_DEMO_HID_PID   0x2305
#define EVK11xx_VIRTUAL_COM_PORT_PID   0x2310
#define FEATURE_DEVICE_OTG_A_ALT_HNP_SUPPORT   0x05
#define FEATURE_DEVICE_OTG_A_HNP_SUPPORT   0x04
#define FEATURE_DEVICE_OTG_B_HNP_ENABLE   0x03
#define FEATURE_DEVICE_REMOTE_WAKEUP   0x01
#define FEATURE_DEVICE_TEST   0x02
#define FEATURE_DEVICE_TEST_FORCE_ENABLE   0x05
#define FEATURE_DEVICE_TEST_J   0x01
#define FEATURE_DEVICE_TEST_K   0x02
#define FEATURE_DEVICE_TEST_PACKET   0x04
#define FEATURE_DEVICE_TEST_SEO_NAK   0x03
#define FEATURE_ENDPOINT_HALT   0x00
#define HID_CLASS   0x03
#define HID_EXAMPLE_PID   0x2304
#define HID_GENERIC_EXAMPLE_PID   0x2013
#define HID_QTOUCH_DEBUG_PID   0x211F
#define HUB_CLASS   0x09
#define ISP_UC3A3_PID   0x2FF1
#define ISP_UC3A_PID   0x2FF8
#define ISP_UC3B_PID   0x2FF6
#define KEYBOARD_PROTOCOL   0x01
#define MIDISTREAMING_SUBCLASS   0x03
#define MOUSE_PROTOCOL   0x02

Referenced by host_mouse_hid_task().

#define MS_CLASS   0x08

Referenced by host_mass_storage_task().

#define MS_EXAMPLE_PID   0x2301
#define MS_SDRAM_LOADER_PID   0x2302
#define NO_CLASS   0x00
#define NO_PROTOCOL   0x00

Referenced by host_cdc_task().

#define NO_SUBCLASS   0x00
#define PROTOCOL_IAD   0x01
#define RUNTIME_PROTOCOL   0x01
#define SCSI_SUBCLASS   0x06
#define SETUP_CLEAR_FEATURE   0x01
#define SETUP_GET_CONFIGURATION   0x08
#define SETUP_GET_DESCRIPTOR   0x06

Referenced by usb_user_read_request().

#define SETUP_GET_DEVICE   0x01
#define SETUP_GET_INTERFACE   0x0A
#define SETUP_GET_STATUS   0x00
#define SETUP_GET_STRING   0x03
#define SETUP_SET_ADDRESS   0x05
#define SETUP_SET_CONFIGURATION   0x09
#define SETUP_SET_DESCRIPTOR   0x07
#define SETUP_SET_FEATURE   0x03
#define SETUP_SET_INTERFACE   0x0B
#define SETUP_SYNCH_FRAME   0x0C
#define SFF8020I_MMC2_SUBCLASS   0x02
#define SFF8070I_SUBCLASS   0x05
#define SUB_CLASS_IAD   0x02
#define USB_ENDPOINT_IN   0x80
#define USB_ENDPOINT_OUT   0x00
#define USB_SETUP_DIR_DEVICE_TO_HOST   (1<<7)
#define USB_SETUP_DIR_HOST_TO_DEVICE   (0<<7)

Referenced by usb_user_read_request().

#define USB_SETUP_RECIPIENT_DEVICE   (0)
#define USB_SETUP_RECIPIENT_ENDPOINT   (2)
#define USB_SETUP_RECIPIENT_INTERFACE   (1)
#define USB_SETUP_RECIPIENT_OTHER   (3)

Referenced by usb_user_read_request().

Referenced by usb_clear_feature().

Referenced by usb_clear_feature().

#define USB_SETUP_TYPE_CLASS   (1<<5)
#define USB_SETUP_TYPE_STANDARD   (0<<5)
#define USB_SETUP_TYPE_VENDOR   (2<<5)
#define VENDOR_CLASS   0xFF