📄 descriptor.h
字号:
/****************************************Copyright (c)**************************************************
** 广州周立功单片机发展有限公司
** 研 究 所
** 产品一部
**
** http://www.zlgmcu.com
**
** 文 件 名: Descriptor.h
** 最后修改日期: 2004年11月15日
** 描 述: USB驱动程序软件包: PDIUSBD12 设备端驱动程序 USB协议层有关描述符结构体定义及取值
** 版 本: V5.0
**********************************************************************************************************/
#ifndef __DESCRIPTOR_H__
#define __DESCRIPTOR_H__
/*
*********************************************************************************************
* 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 请求
#define USB_REQUEST_MASK (INT8U)0x0F
//(5) USB端点方向掩码
#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 设备请求类型
//*******************************************************
#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
//*******************************************************
// 下面为基于USB 1.0规范的正确值
//*******************************************************
#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 特性选择符
********************************************************/
#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 配置描述符
********************************************************/
#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 端点描述符结构体: 端点属性
********************************************************/
#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 设备类
********************************************************/
#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
/*
*********************************************************************************************
* D12 专用 各种描述符结构体 描述符结构体成员取值宏定义
*********************************************************************************************
*/
/*********** D12 USB 各种描述符结构体 *********************/
typedef struct _USB_DESCRIPTOR {
USB_CONFIGURATION_DESCRIPTOR ConfigDescr; //配置描述符
USB_INTERFACE_DESCRIPTOR InterfaceDescr; //接口描述符
USB_ENDPOINT_DESCRIPTOR EP1_TXDescr; //端点1输入描述符
USB_ENDPOINT_DESCRIPTOR EP1_RXDescr; //端点1输出描述符
USB_ENDPOINT_DESCRIPTOR EP2_TXDescr; //端点2输入描述符
USB_ENDPOINT_DESCRIPTOR EP2_RXDescr; //端点2输出描述符
} USB_DESCRIPTOR, *PUSB_DESCRIPTOR;
/***** D12 接口描述符中: 除端点0的端点索引数目 ******/
#define NUM_ENDPOINTS 4
/***** D12 配置描述符长度 ******/
#define CONFIG_DESCRIPTOR_LENGTH sizeof(USB_CONFIGURATION_DESCRIPTOR) \
+ sizeof(USB_INTERFACE_DESCRIPTOR) \
+ (NUM_ENDPOINTS * sizeof(USB_ENDPOINT_DESCRIPTOR))
//(1) 端点0最大分组大小
#define EP0_TX_FIFO_SIZE 16
#define EP0_RX_FIFO_SIZE 16
#define EP0_PACKET_SIZE 16
//(2) 端点1 接收或发送的最大信息包大小
#define EP1_TX_FIFO_SIZE 16
#define EP1_RX_FIFO_SIZE 16
#define EP1_PACKET_SIZE 16
//(3) 端点1 接收或发送的最大信息包大小
#define EP2_TX_FIFO_SIZE 64
#define EP2_RX_FIFO_SIZE 64
#define EP2_PACKET_SIZE 64
extern code USB_DEVICE_DESCRIPTOR DeviceDescr;
extern code USB_DESCRIPTOR usb_descr;
#endif
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -