/**************************************** Copyright (c) **************************************************
**                               Guangzhou ZLG-MCU Development Co.,LTD.
**                                      graduate school
**                                 http://www.zlgmcu.com
**
** File name:			Descriptor.h
** Last modified Date:	2004-12-10
** Last Version:		V1.0
** Descriptions:		USB驅動程序軟件包: ISP1181B(D13) 設備端驅動程序 USB協議層有關描述符結構體定義及取值
**						Soft Packet of USB Driver: the Driver of Device of ISP1181B(D13)
**												   the Constructure Define and Value of USB Protocol Layer
**********************************************************************************************************/

/*
*********************************************************************************************
*        					USB 描述符結構體及其成員取值宏定義
*********************************************************************************************
*/
/***********  USB  設備描述符結構體  ****************/
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  配置描述符結構體  ****************/
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  接口描述符結構體  ****************/
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  端點描述符結構體  ****************/
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 字符串描述符結構體  ****************/
typedef struct _USB_STRING_DESCRIPTOR {
    INT8U bLength;
    INT8U bDescriptorType;
    INT8U bString[1];
} USB_STRING_DESCRIPTOR, *PUSB_STRING_DESCRIPTOR;

//USB最大字符長度
#define MAXIMUM_USB_STRING_LENGTH 255

/***********  USB 電源描述符結構體  ****************/
typedef 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 供電描述符取值
#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 通用描述符結構體  ****************/
typedef struct _USB_COMMON_DESCRIPTOR {
    INT8U bLength;
    INT8U bDescriptorType;
} USB_COMMON_DESCRIPTOR, *PUSB_COMMON_DESCRIPTOR;


/***********  USB HUB 描述符結構體  ***************/
typedef 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;    // port power on till power 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;

/*
*********************************************************************************************
*                  	 通用 描述符結構體成員取值宏定義
*********************************************************************************************
*/
	//*******************************************************
	// USB 設備請求類型掩碼 masks 
	//*******************************************************
//(1) 接收方: 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) 類型: 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) 數據傳輸方向: D7
#define DEVICE_ADDRESS_MASK      0x7F

//(4) USB 請求