usbdevdescriptor.h

smartARM2400 USB device例程

*********************************************************************************************************/
typedef struct _USB_HID_DESCRIPTOR{
	INT8U	bLength;						// HID类描述符长度
	INT8U	bDescriptorType;				// HID类描述符类型21H
	INT8U	bcdHID0;						// HID类规范版本号(低字节)
	INT8U	bcdHID1;						// HID类规范版本号(高字节)
	INT8U	bCountryCode;					// 国家代码
	INT8U	bNumDescriptors;				// 所支持其他类描述符个数
	INT8U	bDescriptorType1;				// 从属类描述符的类型
	INT8U	bDescriptorLength0;				// 从属类描述符长度(低字节)
	INT8U	bDescriptorLength1;				// 从属类描述符长度(高字节)
}USB_HID_DESCRIPTOR,*PUSB_HID_DESCRIPTOR;

/*********************************************************************************************************
  Common descriptor struture member value 
*********************************************************************************************************/

/*********************************************************************************************************
  USB device request type mask
*********************************************************************************************************/
	
//(1) Receiver: D4...D0 
#define USB_RECIPIENT            (INT8U)0x1F
#define USB_RECIPIENT_DEVICE     (INT8U)0x00
#define USB_RECIPIENT_INTERFACE  (INT8U)0x01
#define USB_RECIPIENT_ENDPOINT   (INT8U)0x02

//(2) Type: D6...D5
#define USB_REQUEST_TYPE_MASK    (INT8U)0x60
#define USB_STANDARD_REQUEST     (INT8U)0x00
#define USB_CLASS_REQUEST        (INT8U)0x20
#define USB_VENDOR_REQUEST       (INT8U)0x40

//(3) data direction: D7
#define DEVICE_ADDRESS_MASK      0x7F

//(4) USB request mask
#define USB_REQUEST_MASK         (INT8U)0x0F

//(5) USB endpoint direction mask
#define USB_ENDPOINT_DIRECTION_MASK               0x80
#define USB_ENDPOINT_DIRECTION_OUT(addr)          (!((addr) & USB_ENDPOINT_DIRECTION_MASK))
#define USB_ENDPOINT_DIRECTION_IN(addr)           ((addr) & USB_ENDPOINT_DIRECTION_MASK)

/*********************************************************************************************************
  USB device request type
*********************************************************************************************************/	
#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

/*********************************************************************************************************
  Correct value based on USB1.0 specification
*********************************************************************************************************/		
#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

/*********************************************************************************************************
  USB feather select
*********************************************************************************************************/		
#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

#define USB_DESCRIPTOR_MAKE_TYPE_AND_INDEX(d, i) ((INT16U)((INT16U)d<<8 | i))

/*********************************************************************************************************
  USB configuration descriptor
*********************************************************************************************************/		
#define USB_CONFIG_POWERED_MASK                   0xc0

#define USB_CONFIG_BUS_POWERED                    0x80
#define USB_CONFIG_SELF_POWERED                   0x40
#define USB_CONFIG_REMOTE_WAKEUP                  0x20

#define BUS_POWERED                          	  0x80
#define SELF_POWERED                         	  0x40
#define REMOTE_WAKEUP                       	  0x20

/*********************************************************************************************************
  USB endpoint descriptor structure: endpoint attribute
*********************************************************************************************************/	
#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

/*********************************************************************************************************
  USB  device class
*********************************************************************************************************/	
#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

/*********************************************************************************************************
  LPC2400 USB various descriptor structure collect
*********************************************************************************************************/
typedef struct _USB_DESCRIPTOR {
	USB_CONFIGURATION_DESCRIPTOR ConfigDescr;		//configuration descriptor 
	USB_INTERFACE_DESCRIPTOR InterfaceDescr;		//interface descriptor
	
	//增加HID类描述符
	USB_HID_DESCRIPTOR		HidDesr;				// HID类描述符
	USB_ENDPOINT_DESCRIPTOR EP1_TXDescr;			//logic endpoint 1 IN  descriptor
	
} USB_DESCRIPTOR, *PUSB_DESCRIPTOR;

/*********************************************************************************************************
  In LPC2400 USB descriptor, the physical endpoint number except for logic enpoint 0
*********************************************************************************************************/
#define NUM_ENDPOINTS	   1

/*********************************************************************************************************
  LPC2400 USB descriptor collect length
*********************************************************************************************************/
#define CONFIG_DESCRIPTOR_LENGTH    sizeof(USB_CONFIGURATION_DESCRIPTOR) \
									+ sizeof(USB_INTERFACE_DESCRIPTOR) \
									+sizeof(USB_HID_DESCRIPTOR) + (NUM_ENDPOINTS * sizeof(USB_ENDPOINT_DESCRIPTOR))

//(1) logic endpoint 0 MaxPacketSize
#define EP0_TX_FIFO_SIZE   64
#define EP0_RX_FIFO_SIZE   64
#define EP0_PACKET_SIZE    64

//(2) logic endpoint 1 MaxPacketSize
#define EP1_TX_FIFO_SIZE   16
#define EP1_RX_FIFO_SIZE   16
#define EP1_PACKET_SIZE    16

//(3) logic endpoint 2 MaxPacketSize
#define EP2_TX_FIFO_SIZE   64
#define EP2_RX_FIFO_SIZE   64
#define EP2_PACKET_SIZE    64

extern const USB_DEVICE_DESCRIPTOR DeviceDescr;
extern const USB_DESCRIPTOR usb_descr;

extern const INT8U Mouse_Descr[];

#endif																	/*  __USBDEVDESCRIPTOR_H		*/

/*********************************************************************************************************
  END FILE
*********************************************************************************************************/