📄 usb_device_lib.h
字号:
#ifndef __USB_DEVICE_LIB_H__
#define __USB_DEVICE_LIB_H__
//*************************************************************************
// USB definitons [USB device register set]
//*************************************************************************
/* Power Management Register */
#define DISABLE_SUSPEND 0x00
#define ENABLE_SUSPEND 0x01
#define SUSPEND_MODE 0x02
#define MCU_RESUME 0x04
#define ISO_UPDATE (1<<7)
/* MAXP Register */
#define FIFO_SIZE_0 0x00 /* 0x00 * 8 = 0 */
#define FIFO_SIZE_8 0x01 /* 0x01 * 8 = 8 */
#define FIFO_SIZE_16 0x02 /* 0x02 * 8 = 16 */
#define FIFO_SIZE_32 0x04 /* 0x04 * 8 = 32 */
#define FIFO_SIZE_64 0x08 /* 0x08 * 8 = 64 */
/* ENDPOINT0 CSR (Control Status Register) : Mapped to IN CSR1 */
#define EP0_OUT_PKT_READY 0x01 /* USB sets, MCU clears by setting SERVICED_OUT_PKT_RDY */
#define EP0_IN_PKT_READY 0x02 /* MCU sets, USB clears after sending FIFO */
#define EP0_SENT_STALL 0x04 /* USB sets */
#define EP0_DATA_END 0x08 /* MCU sets */
#define EP0_SETUP_END 0x10 /* USB sets, MCU clears by setting SERVICED_SETUP_END */
#define EP0_SEND_STALL 0x20 /* MCU sets */
#define EP0_SERVICED_OUT_PKT_RDY 0x40 /* MCU writes 1 to clear OUT_PKT_READY */
#define EP0_SERVICED_SETUP_END 0x80 /* MCU writes 1 to clear SETUP_END */
#define EP0_WR_BITS 0xc0
//EP_INT_REG / EP_INT_EN_REG
#define EP0_INT 0x01 // Endpoint 0, Control
#define EP1_INT 0x02 // Endpoint 1, (Bulk-In)
#define EP2_INT 0x04 // Endpoint 2
#define EP3_INT 0x08 // Endpoint 3, (Bulk-Out)
#define EP4_INT 0x10 // Endpoint 4
//USB_INT_REG / USB_INT_EN_REG
#define SUSPEND_INT 0x01
#define RESUME_INT 0x02
#define RESET_INT 0x04
//IN_CSR1
#define EPI_IN_PKT_READY 0x01
#define EPI_UNDER_RUN 0x04
#define EPI_FIFO_FLUSH 0x08
#define EPI_SEND_STALL 0x10
#define EPI_SENT_STALL 0x20
#define EPI_CDT 0x40
#define EPI_WR_BITS (EPI_FIFO_FLUSH|EPI_IN_PKT_READY|EPI_CDT)
//(EPI_FIFO_FLUSH) is preferred (???)
//IN_CSR2
#define EPI_IN_DMA_INT_MASK (1<<4)
#define EPI_MODE_IN (1<<5)
#define EPI_MODE_OUT (0<<5)
#define EPI_ISO (1<<6)
#define EPI_BULK (0<<6)
#define EPI_AUTO_SET (1<<7)
//OUT_CSR1
#define EPO_OUT_PKT_READY 0x01
#define EPO_OVER_RUN 0x04
#define EPO_DATA_ERROR 0x08
#define EPO_FIFO_FLUSH 0x10
#define EPO_SEND_STALL 0x20
#define EPO_SENT_STALL 0x40
#define EPO_CDT 0x80
#define EPO_WR_BITS (EPO_FIFO_FLUSH|EPO_SEND_STALL|EPO_CDT)
//(EPO_FIFO_FLUSH) is preferred (???)
//OUT_CSR2
#define EPO_OUT_DMA_INT_MASK (1<<5)
#define EPO_ISO (1<<6)
#define EPO_BULK (0<<6)
#define EPO_AUTO_CLR (1<<7)
//USB DMA control register
#define UDMA_IN_RUN_OB (1<<7)
#define UDMA_IGNORE_TTC (1<<7)
#define UDMA_DEMAND_MODE (1<<3)
#define UDMA_OUT_RUN_OB (1<<2)
#define UDMA_OUT_DMA_RUN (1<<2)
#define UDMA_IN_DMA_RUN (1<<1)
#define UDMA_DMA_MODE_EN (1<<0)
#define rEP1_DMA_TTC (rEP1_DMA_TTC_L+(rEP1_DMA_TTC_M<<8)+(rEP1_DMA_TTC_H<<16))
#define rEP2_DMA_TTC (rEP2_DMA_TTC_L+(rEP2_DMA_TTC_M<<8)+(rEP2_DMA_TTC_H<<16))
#define rEP3_DMA_TTC (rEP3_DMA_TTC_L+(rEP3_DMA_TTC_M<<8)+(rEP3_DMA_TTC_H<<16))
#define rEP4_DMA_TTC (rEP4_DMA_TTC_L+(rEP4_DMA_TTC_M<<8)+(rEP4_DMA_TTC_H<<16))
#define ADDR_EP0_FIFO (0x520001c0) //Endpoint 0 FIFO
#define ADDR_EP1_FIFO (0x520001c4) //Endpoint 1 FIFO
#define ADDR_EP2_FIFO (0x520001c8) //Endpoint 2 FIFO
#define ADDR_EP3_FIFO (0x520001cc) //Endpoint 3 FIFO
#define ADDR_EP4_FIFO (0x520001d0) //Endpoint 4 FIFO
//If you chane the packet size, the source code should be changed!!!
#define EP0_PKT_SIZE 8
#define EP1_PKT_SIZE BULK_PKT_SIZE
#define EP3_PKT_SIZE BULK_PKT_SIZE
#define PWR_REG_DEFAULT_VALUE (DISABLE_SUSPEND)
//====================================================================================
//************************
// Endpoint 0
//************************
//=======================[bmRequestTyje]=============================
// Standard bmRequestTyje (Direction)
#define HOST_TO_DEVICE (0x00)
#define DEVICE_TO_HOST (0x80)
// Standard bmRequestType (Type)
#define STANDARD_TYPE (0x00)
#define CLASS_TYPE (0x20)
#define VENDOR_TYPE (0x40) //
#define RESERVED_TYPE (0x60) //11
// Standard bmRequestType (Recipient)
#define DEVICE_RECIPIENT (0)
#define INTERFACE_RECIPIENT (1)
#define ENDPOINT_RECIPIENT (2)
#define OTHER_RECIPIENT (3)
//==============================[bRequest]=============================
// Standard Request Codes
#define GET_STATUS (0)
#define CLEAR_FEATURE (1)
#define SET_FEATURE (3)
#define SET_ADDRESS (5)
#define GET_DESCRIPTOR (6)
#define SET_DESCRIPTOR (7)
#define GET_CONFIGURATION (8)
#define SET_CONFIGURATION (9)
#define GET_INTERFACE (10)
#define SET_INTERFACE (11)
#define SYNCH_FRAME (12)
/* class specific Request codes from section 7.2 Class Specific R ests */
#define HID_GET_REPORT (0x01)
#define HID_GET_IDLE (0x02)
#define HID_GET_PROTOCOL (0x03)
#define HID_SET_REPORT (0x09)
#define HID_SET_IDLE (0x0A)
#define HID_SET_PROTOCOL (0x0B)
// Descriptor Types[wValue 高字节 ]
#define DEVICE_TYPE (1)
#define CONFIGURATION_TYPE (2)
#define STRING_TYPE (3)
#define INTERFACE_TYPE (4)
#define ENDPOINT_TYPE (5)
//HID Descriptor
#define HID_TYPE (0x21)
#define REPORT_TYPE (0x22)
#define PHYSICAL_TYPE (0x23)
// Feature Selectors
#define DEVICE_REMOTE_WAKEUP (1)
#define EP_STALL (0)
// Class-specific Request Codes
#define GET_DEVICE_ID (0)
#define GET_PORT_STATUS (1)
#define SOFT_RESET (2)
//configuration descriptor: bmAttributes
#define CONF_ATTR_DEFAULT (0x80) //Spec 1.0 it was BUSPOWERED bit.
#define CONF_ATTR_REMOTE_WAKEUP (0x20)
#define CONF_ATTR_SELFPOWERED (0x40)
//endpoint descriptor
#define EP_ADDR_IN (0x80)
#define EP_ADDR_OUT (0x00)
#define EP_ATTR_CONTROL (0x0)
#define EP_ATTR_ISOCHRONOUS (0x1)
#define EP_ATTR_BULK (0x2)
#define EP_ATTR_INTERRUPT (0x3)
//string descriptor
#define LANGID_US_L (0x09)
#define LANGID_US_H (0x04)
struct USB_SETUP_DATA{
U8 bmRequestType;
U8 bRequest;
U8 bValueL;
U8 bValueH;
U8 bIndexL;
U8 bIndexH;
U8 bLengthL;
U8 bLengthH;
};
struct USB_DEVICE_DESCRIPTOR{
U8 bLength;
U8 bDescriptorType;
U8 bcdUSBL;
U8 bcdUSBH;
U8 bDeviceClass;
U8 bDeviceSubClass;
U8 bDeviceProtocol;
U8 bMaxPacketSize0;
U8 idVendorL;
U8 idVendorH;
U8 idProductL;
U8 idProductH;
U8 bcdDeviceL;
U8 bcdDeviceH;
U8 iManufacturer;
U8 iProduct;
U8 iSerialNumber;
U8 bNumConfigurations;
};
struct USB_CONFIGURATION_DESCRIPTOR{
U8 bLength;
U8 bDescriptorType;
U8 wTotalLengthL;
U8 wTotalLengthH;
U8 bNumInterfaces;
U8 bConfigurationValue;
U8 iConfiguration;
U8 bmAttributes;
U8 maxPower;
};
struct USB_INTERFACE_DESCRIPTOR{
U8 bLength;
U8 bDescriptorType;
U8 bInterfaceNumber;
U8 bAlternateSetting;
U8 bNumEndpoints;
U8 bInterfaceClass;
U8 bInterfaceSubClass;
U8 bInterfaceProtocol;
U8 iInterface;
};
struct USB_ENDPOINT_DESCRIPTOR{
U8 bLength;
U8 bDescriptorType;
U8 bEndpointAddress;
U8 bmAttributes;
U8 wMaxPacketSizeL;
U8 wMaxPacketSizeH;
U8 bInterval;
};
//=================[HID]====================================================================
//====Main
#define Input 0x81
#define Ouput 0x91
#define Feature 0xb1
#define Collection 0xa1
#define End 0xc0
//====Gloabl
#define Usage_Page 0x05
#define Logical_Min 0x15
#define Logical_Max 0x25
#define Physical_Min 0x35
#define Physical_Max 0x45
#define Exponent 0x55
#define Unit 0x65 //need change
#define Report_Size 0x75
#define Report_ID 0x85
#define Report_Count 0x95
#define Push 0xa5
#define Pop 0xb5
//Local
#define Usage 0x09
#define Usage_Min 0x19
#define Usage_Max 0x29
#define Designator_Index 0x39
#define Designator_Min 0x49
#define Designator_Max 0x59
#define String_Index 0x79
#define String_Min 0x89
#define String_Max 0x99
#define Delimiter 0xa9
//******************************
//*
//******************************
#define CLR_EP0_OUT_PKT_RDY() rEP0_CSR=( rEP0_CSR & (~EP0_WR_BITS)| EP0_SERVICED_OUT_PKT_RDY)
#define CLR_EP0_OUTPKTRDY_DATAEND() rEP0_CSR=( rEP0_CSR & (~EP0_WR_BITS)|(EP0_SERVICED_OUT_PKT_RDY|EP0_DATA_END)) //
#define SET_EP0_IN_PKT_RDY() rEP0_CSR=( rEP0_CSR & (~EP0_WR_BITS)|(EP0_IN_PKT_READY))
#define SET_EP0_INPKTRDY_DATAEND() rEP0_CSR=( rEP0_CSR & (~EP0_WR_BITS)|(EP0_IN_PKT_READY|EP0_DATA_END)) //DATA ALREADY INTO FIFO
#define CLR_EP0_SETUP_END() rEP0_CSR=( rEP0_CSR & (~EP0_WR_BITS)|(EP0_SERVICED_SETUP_END))
#define CLR_EP0_SENT_STALL() rEP0_CSR=( rEP0_CSR & (~EP0_WR_BITS)&(~EP0_SENT_STALL)) // WRITE '0' CLEAR
#define FLUSH_EP0_FIFO() {register i;while(rOUT_FIFO_CNT1_REG)i=rEP0_FIFO;}
#define CLR_EP0_OUTPKTRDY_SEND_STALL() rEP0_CSR=( rEP0_CSR & (~EP0_WR_BITS)|(EP0_SERVICED_OUT_PKT_RDY|EP0_SEND_STALL))
void RdPktEp0(U8 *buf,int num);
void WrPktEp0(U8 *buf,int num);
void WrPktEp1(U8 *buf,int num);
void WrPktEp2(U8 *buf,int num);
void RdPktEp3(U8 *buf,int num);
void RdPktEp4(U8 *buf,int num);
void Print_USB_SETUP_DATA(struct USB_SETUP_DATA descSetup0);
void Ep0_Interrupt_Identify(void);
#endif //__USB_DEVICE_LIB_H__
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -