usb100.h

msp430单片机与pdiusbd12接口的固件程序

/***************************************************************
描述: USB常用常量定义
创建: Philips
修改: Miracle G.
日期: 2006-06-08
*****************************************************************/
#ifndef   __USB100_H__
#define   __USB100_H__

#define MAXIMUM_USB_STRING_LENGTH 255


//描述符类型
#define USB_DEVICE_DESCRIPTOR_TYPE                0x01 	//设备
#define USB_CONFIGURATION_DESCRIPTOR_TYPE         0x02	//配置
#define USB_STRING_DESCRIPTOR_TYPE                0x03	//字符串
#define USB_INTERFACE_DESCRIPTOR_TYPE             0x04	//接口
#define USB_ENDPOINT_DESCRIPTOR_TYPE              0x05	//端点
#define USB_POWER_DESCRIPTOR_TYPE                 0x06	//电源

#define USB_DESCRIPTOR_MAKE_TYPE_AND_INDEX(d, i) ((unsigned int)((unsigned int)d<<8 | i))

//GET_STATUS标准请求的返回数据
#define USB_GETSTATUS_SELF_POWERED                0x01
#define USB_GETSTATUS_REMOTE_WAKEUP_ENABLED       0x02

//
// Values for bmAttributes field of an
// endpoint descriptor
//
#define USB_ENDPOINT_TYPE_MASK                    0x03

#define USB_ENDPOINT_TYPE_CONTROL                 0x00  //控制
#define USB_ENDPOINT_TYPE_ISOCHRONOUS             0x01	//同步
#define USB_ENDPOINT_TYPE_BULK                    0x02	//批量
#define USB_ENDPOINT_TYPE_INTERRUPT               0x03	//中断


//
// definitions for bits in the bmAttributes field of a 
// configuration descriptor.
//
#define USB_CONFIG_POWERED_MASK                   0xE0

#define USB_CONFIG_BUS_POWERED                    0x80 	//总线供电
#define USB_CONFIG_SELF_POWERED                   0x40	//自供电
#define USB_CONFIG_REMOTE_WAKEUP                  0x20	//远程唤醒

//
// Endpoint direction bit, stored in bEndpointAddress field
// of an endpoint descriptor
#define USB_ENDPOINT_DIRECTION_MASK               0x80
// test direction bit in the bEndpointAddress field of
// an endpoint descriptor.
#define USB_ENDPOINT_DIRECTION_OUT(addr)          (!((addr) & USB_ENDPOINT_DIRECTION_MASK))
#define USB_ENDPOINT_DIRECTION_IN(addr)           ((addr) & USB_ENDPOINT_DIRECTION_MASK)

//******************************
// USB defined request codes
// see chapter 9 of the USB 1.0 specifcation for
// more information.
// These are the correct values based on the USB 1.0
// specification
//	USB标准设备请求
#define USB_REQUEST_GET_STATUS                    0x00 	//
#define USB_REQUEST_CLEAR_FEATURE                 0x01	//
#define USB_REQUEST_SET_FEATURE                   0x03	//
#define USB_REQUEST_SET_ADDRESS                   0x05	//
#define USB_REQUEST_GET_DESCRIPTOR                0x06	//
#define USB_REQUEST_SET_DESCRIPTOR                0x07	//
#define USB_REQUEST_GET_CONFIGURATION             0x08	//
#define USB_REQUEST_SET_CONFIGURATION             0x09	//
#define USB_REQUEST_GET_INTERFACE                 0x0A	//
#define USB_REQUEST_SET_INTERFACE                 0x0B	//
#define USB_REQUEST_SYNC_FRAME                    0x0C	//
//***************************************
// defined USB device classes
//***************************************
#define USB_DEVICE_CLASS_RESERVED           0x00
#define USB_DEVICE_CLASS_AUDIO              0x01
#define USB_DEVICE_CLASS_COMMUNICATIONS     0x02
#define USB_DEVICE_CLASS_HUMAN_INTERFACE    0x03
#define USB_DEVICE_CLASS_MONITOR            0x04
#define USB_DEVICE_CLASS_PHYSICAL_INTERFACE 0x05
#define USB_DEVICE_CLASS_POWER              0x06
#define USB_DEVICE_CLASS_PRINTER            0x07
#define USB_DEVICE_CLASS_STORAGE            0x08
#define USB_DEVICE_CLASS_HUB                0x09
#define USB_DEVICE_CLASS_VENDOR_SPECIFIC    0xFF
//******************************************
// USB defined Feature selectors
//******************************************
#define USB_FEATURE_ENDPOINT_STALL          0x0000
#define USB_FEATURE_REMOTE_WAKEUP           0x0001
#define USB_FEATURE_POWER_D0                0x0002
#define USB_FEATURE_POWER_D1                0x0003
#define USB_FEATURE_POWER_D2                0x0004
#define USB_FEATURE_POWER_D3                0x0005
//******************************************
// 定义设备描述符结构 //1st
//******************************************
typedef struct _USB_DEVICE_DESCRIPTOR {
	unsigned char bLength;
    unsigned char bDescriptorType;
    unsigned int bcdUSB;
    unsigned char bDeviceClass;
    unsigned char bDeviceSubClass;
    unsigned char bDeviceProtocol;
    unsigned char bMaxPacketSize0;
    unsigned int idVendor;
    unsigned int idProduct;
    unsigned int bcdDevice;
    unsigned char iManufacturer;
    unsigned char iProduct;
    unsigned char iSerialNumber;
    unsigned char bNumConfigurations;
} USB_DEVICE_DESCRIPTOR, *PUSB_DEVICE_DESCRIPTOR;
//******************************************
// 定义端点描述符结构  //5th
//******************************************
//这个结构在MSP430 C编译器会在结构后补一个字节0,成为7个字节的结构,使其字对齐
typedef struct _USB_ENDPOINT_DESCRIPTOR {
    unsigned char bLength;
    unsigned char bDescriptorType;
    unsigned char bEndpointAddress;
    unsigned char bmAttributes;
    unsigned int wMaxPacketSize;
    unsigned char bInterval;
} USB_ENDPOINT_DESCRIPTOR, *PUSB_ENDPOINT_DESCRIPTOR;
//******************************************
// 定义接口描述符结构   //4th
//******************************************
//这个结构在MSP430 C编译器会在结构后补一个字节0,成为10个字节的结构,使其字对齐
typedef struct _USB_INTERFACE_DESCRIPTOR {
    unsigned char bLength;
    unsigned char bDescriptorType;
    unsigned char bInterfaceNumber;
    unsigned char bAlternateSetting;
    unsigned char bNumEndpoints;
    unsigned char bInterfaceClass;
    unsigned char bInterfaceSubClass;
    unsigned char bInterfaceProtocol;
    unsigned char iInterface;
} USB_INTERFACE_DESCRIPTOR, *PUSB_INTERFACE_DESCRIPTOR;
//******************************************
// 定义配置描述符结构    //2nd
//******************************************
//这个结构在MSP430 C编译器会在结构后补一个字节0,成为10个字节的结构,使其字对齐
typedef struct _USB_CONFIGURATION_DESCRIPTOR {
    unsigned char bLength_cfg;
    unsigned char bDescriptorType_cfg;
    unsigned int wTotalLength;
    unsigned char bNumInterfaces;
    unsigned char bConfigurationValue;
    unsigned char iConfiguration;
    unsigned char bmAttributes_cfg;
    unsigned char MaxPower;    
} USB_CONFIGURATION_DESCRIPTOR, *PUSB_CONFIGURATION_DESCRIPTOR;

//******************************************
// 定义字符串描述符结构    //3th
//******************************************
typedef struct _USB_STRING_DESCRIPTOR {
    unsigned char bLength;
    unsigned char bDescriptorType;
    unsigned char bString[1];
} USB_STRING_DESCRIPTOR, *PUSB_STRING_DESCRIPTOR;

//
// USB power descriptor added to core specification
//

#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
//******************************************
// 定义电源描述符结构    新增
//******************************************
typedef struct _USB_POWER_DESCRIPTOR {
    unsigned char bLength;
    unsigned char bDescriptorType;
    unsigned char bCapabilitiesFlags;
    unsigned int EventNotification;
    unsigned int D1LatencyTime;
    unsigned int D2LatencyTime;
    unsigned int D3LatencyTime;
    unsigned char PowerUnit;
    unsigned int D0PowerConsumption;
    unsigned int D1PowerConsumption;
    unsigned int D2PowerConsumption;
} USB_POWER_DESCRIPTOR, *PUSB_POWER_DESCRIPTOR;
//******************************************
// 定义COMMON描述符结构    新增
//******************************************
typedef struct _USB_COMMON_DESCRIPTOR {
    unsigned char bLength;
    unsigned char bDescriptorType;
} USB_COMMON_DESCRIPTOR, *PUSB_COMMON_DESCRIPTOR;

//******************************************
// 定义标准HUB描述符结构    新增
//******************************************
// Standard USB HUB definitions See Chapter 11
typedef struct _USB_HUB_DESCRIPTOR {
    unsigned char        bDescriptorLength;      // Length of this descriptor
    unsigned char        bDescriptorType;        // Hub configuration type
    unsigned char        bNumberOfPorts;         // number of ports on this hub
    unsigned int         wHubCharacteristics;    // Hub Charateristics
    unsigned char        bPowerOnToPowerGood;    // port power on till power good in 2ms
    unsigned char        bHubControlCurrent;     // max current in mA
    // room for 255 ports power control and removable bitmask
    unsigned char        bRemoveAndPowerMask[64];
} USB_HUB_DESCRIPTOR, *PUSB_HUB_DESCRIPTOR;
#endif   /* __USB100_H__ */