usbdevdescriptor.h

smartARM2400 USB device例程

/****************************************Copyright (c)****************************************************
**                            Guangzhou ZHIYUAN electronics Co.,LTD.
**                                      
**                                 http://www.embedtools.com
**
**--------------File Info---------------------------------------------------------------------------------
** File name:               usbDevDescriptor.h
** Latest modified Date:    2008-05-10
** Latest Version:          1.1
** Descriptions:            usbDevLPC2400 固件程序 描述符层头文件
**
**--------------------------------------------------------------------------------------------------------
** Created by:              ZhengMingyuan
** Created date:            2005-08-08
** Version:                 1.0
** Descriptions:            The original version
**
**--------------------------------------------------------------------------------------------------------
** Modified by:   			LingGuilin          
** Modified date:    		2008-05-10       
** Version:          		1.1       
** Descriptions:      		修改部分代码以符合代码规范v1.2
**
*********************************************************************************************************/

#ifndef __USBDEVDESCRIPTOR_H
#define __USBDEVDESCRIPTOR_H

/*********************************************************************************************************
  USB Descriptor structure and their member value
*********************************************************************************************************/

#define USB_IDVENDOR_LOW    	0x71            						/*  USB设备的厂商ID号 			*/
#define USB_IDVENDOR_HIGH       0x04

#define USB_IDPRODUCT_LOW		0x01           	 						/*  USB设备的产品ID号 			*/
#define USB_IDPRODUCT_HIGH		0x00

/*********************************************************************************************************
  USB  device descriptor structure
*********************************************************************************************************/

typedef struct _USB_DEVICE_DESCRIPTOR {
    INT8U bLength;
    INT8U bDescriptorType;
    INT8U bcdUSB0;
    INT8U bcdUSB1;
    INT8U bDeviceClass;
    INT8U bDeviceSubClass;
    INT8U bDeviceProtocol;
    INT8U bMaxPacketSize0;
    INT8U idVendor0;
    INT8U idVendor1;
    INT8U idProduct0;
    INT8U idProduct1;
    INT8U bcdDevice0;
    INT8U bcdDevice1;
    INT8U iManufacturer;
    INT8U iProduct;
    INT8U iSerialNumber;
    INT8U bNumConfigurations;
} USB_DEVICE_DESCRIPTOR, *PUSB_DEVICE_DESCRIPTOR;

/*********************************************************************************************************
  USB  configuration descriptor structure
*********************************************************************************************************/

typedef struct _USB_CONFIGURATION_DESCRIPTOR {
    INT8U bLength;
    INT8U bDescriptorType;
    INT8U wTotalLength0;
    INT8U wTotalLength1;
    INT8U bNumInterfaces;
    INT8U bConfigurationValue;
    INT8U iConfiguration;
    INT8U bmAttributes;
    INT8U MaxPower;
} USB_CONFIGURATION_DESCRIPTOR, *PUSB_CONFIGURATION_DESCRIPTOR;

/*********************************************************************************************************
  USB  interface descriptor structure
*********************************************************************************************************/
typedef struct _USB_INTERFACE_DESCRIPTOR {
    INT8U bLength;
    INT8U bDescriptorType;
    INT8U bInterfaceNumber;
    INT8U bAlternateSetting;
    INT8U bNumEndpoints;
    INT8U bInterfaceClass;
    INT8U bInterfaceSubClass;
    INT8U bInterfaceProtocol;
    INT8U iInterface;
} USB_INTERFACE_DESCRIPTOR, *PUSB_INTERFACE_DESCRIPTOR;

/*********************************************************************************************************
  USB  endpoint descriptor structure
*********************************************************************************************************/
typedef struct _USB_ENDPOINT_DESCRIPTOR {
    INT8U bLength;
    INT8U bDescriptorType;
    INT8U bEndpointAddress;
    INT8U bmAttributes;
    INT8U wMaxPacketSize0;
    INT8U wMaxPacketSize1;
    INT8U bInterval;
} USB_ENDPOINT_DESCRIPTOR, *PUSB_ENDPOINT_DESCRIPTOR;

/*********************************************************************************************************
  USB string descriptor structure
*********************************************************************************************************/
typedef struct _USB_STRING_DESCRIPTOR {
    INT8U bLength;
    INT8U bDescriptorType;
    INT8U bString[1];
} USB_STRING_DESCRIPTOR, *PUSB_STRING_DESCRIPTOR;

#define MAXIMUM_USB_STRING_LENGTH     255								/*  USB max string length 		*/

/*********************************************************************************************************
  USB power descriptor structure
*********************************************************************************************************/
typedef __packed struct _USB_POWER_DESCRIPTOR {
    INT8U  bLength;
    INT8U  bDescriptorType;
    INT8U  bCapabilitiesFlags;
    INT16U EventNotification;
    INT16U D1LatencyTime;
    INT16U D2LatencyTime;
    INT16U D3LatencyTime;
    INT8U  PowerUnit;
    INT16U D0PowerConsumption;
    INT16U D1PowerConsumption;
    INT16U D2PowerConsumption;
} USB_POWER_DESCRIPTOR, *PUSB_POWER_DESCRIPTOR;

/*********************************************************************************************************
  USB power descriptor value
*********************************************************************************************************/
#define USB_SUPPORT_D0_COMMAND      0x01
#define USB_SUPPORT_D1_COMMAND      0x02
#define USB_SUPPORT_D2_COMMAND      0x04
#define USB_SUPPORT_D3_COMMAND      0x08

#define USB_SUPPORT_D1_WAKEUP       0x10
#define USB_SUPPORT_D2_WAKEUP       0x20

/*********************************************************************************************************
  USB common descriptor structure
*********************************************************************************************************/
typedef struct _USB_COMMON_DESCRIPTOR {
    INT8U bLength;
    INT8U bDescriptorType;
} USB_COMMON_DESCRIPTOR, *PUSB_COMMON_DESCRIPTOR;

/*********************************************************************************************************
  USB HUB descriptor structure
*********************************************************************************************************/
typedef __packed struct _USB_HUB_DESCRIPTOR {
    INT8U        bDescriptorLength;      								/*  Length of this descriptor	*/
    INT8U        bDescriptorType;        								/*  Hub configuration type		*/
    INT8U        bNumberOfPorts;        								/*  number of ports on this hub	*/
    INT16U       wHubCharacteristics;    								/*  Hub Charateristics			*/
    INT8U        bPowerOnToPowerGood;    								/*  power on to good in 2ms		*/
    INT8U        bHubControlCurrent;     								/*  max current in mA			*/
    //
    // room for 255 ports power control and removable bitmask
    INT8U        bRemoveAndPowerMask[64];
} USB_HUB_DESCRIPTOR, *PUSB_HUB_DESCRIPTOR;

/*********************************************************************************************************
  增加HID类描述符