usbd.h

Go to the documentation of this file.

/**************************************************************************/
#ifndef __USBD_H__
#define __USBD_H__
 
 
typedef struct s_usbd_info
{
    const uint8_t *gu8DevDesc;            
    const uint8_t *gu8ConfigDesc;         
    const uint8_t **gu8StringDesc;        
    const uint8_t **gu8HidReportDesc;     
    const uint32_t *gu32HidReportSize;    
    const uint32_t *gu32ConfigHidDescIdx; 
} S_USBD_INFO_T;
 
extern const S_USBD_INFO_T gsInfo;
 /* end of group USBD_EXPORTED_STRUCTS */
 
 
 
 
#define USBD_BUF_BASE   (USBD_BASE+0x100)
#define USBD_MAX_EP     8
 
#define EP0     0       
#define EP1     1       
#define EP2     2       
#define EP3     3       
#define EP4     4       
#define EP5     5       
#define EP6     6       
#define EP7     7       
#define REQ_STANDARD        0x00
#define REQ_CLASS           0x20
#define REQ_VENDOR          0x40
 
#define GET_STATUS          0x00
#define CLEAR_FEATURE       0x01
#define SET_FEATURE         0x03
#define SET_ADDRESS         0x05
#define GET_DESCRIPTOR      0x06
#define SET_DESCRIPTOR      0x07
#define GET_CONFIGURATION   0x08
#define SET_CONFIGURATION   0x09
#define GET_INTERFACE       0x0A
#define SET_INTERFACE       0x0B
#define SYNC_FRAME          0x0C
 
#define DESC_DEVICE         0x01
#define DESC_CONFIG         0x02
#define DESC_STRING         0x03
#define DESC_INTERFACE      0x04
#define DESC_ENDPOINT       0x05
#define DESC_QUALIFIER      0x06
#define DESC_OTHERSPEED     0x07
 
#define DESC_HID            0x21
#define DESC_HID_RPT        0x22
 
#define LEN_DEVICE          18
#define LEN_CONFIG          9
#define LEN_INTERFACE       9
#define LEN_ENDPOINT        7
#define LEN_HID             9
#define LEN_CCID            0x36
 
#define EP_ISO              0x01
#define EP_BULK             0x02
#define EP_INT              0x03
 
#define EP_INPUT            0x80
#define EP_OUTPUT           0x00
 
#define FEATURE_DEVICE_REMOTE_WAKEUP    0x01
#define FEATURE_ENDPOINT_HALT           0x00
 
/******************************************************************************/
/*                USB Specific Macros                                         */
/******************************************************************************/
 
#define USBD_WAKEUP_EN          USBD_INTEN_WKEN_Msk         
#define USBD_DRVSE0             USBD_SE0_SE0_Msk            
#define USBD_DPPU_EN            USBD_ATTR_DPPUEN_Msk        
#define USBD_PWRDN              USBD_ATTR_PWRDN_Msk         
#define USBD_PHY_EN             USBD_ATTR_PHYEN_Msk         
#define USBD_USB_EN             USBD_ATTR_USBEN_Msk         
#define USBD_INT_BUS            USBD_INTEN_BUSIEN_Msk       
#define USBD_INT_USB            USBD_INTEN_USBIEN_Msk       
#define USBD_INT_FLDET          USBD_INTEN_VBDETIEN_Msk     
#define USBD_INT_WAKEUP         (USBD_INTEN_NEVWKIEN_Msk | USBD_INTEN_WKEN_Msk)     
#define USBD_INTSTS_WAKEUP      USBD_INTSTS_NEVWKIF_Msk     
#define USBD_INTSTS_FLDET       USBD_INTSTS_VBDETIF_Msk     
#define USBD_INTSTS_BUS         USBD_INTSTS_BUSIF_Msk       
#define USBD_INTSTS_USB         USBD_INTSTS_USBIF_Msk       
#define USBD_INTSTS_SETUP       USBD_INTSTS_SETUP_Msk       
#define USBD_INTSTS_EP0         USBD_INTSTS_EPEVT0_Msk      
#define USBD_INTSTS_EP1         USBD_INTSTS_EPEVT1_Msk      
#define USBD_INTSTS_EP2         USBD_INTSTS_EPEVT2_Msk      
#define USBD_INTSTS_EP3         USBD_INTSTS_EPEVT3_Msk      
#define USBD_INTSTS_EP4         USBD_INTSTS_EPEVT4_Msk      
#define USBD_INTSTS_EP5         USBD_INTSTS_EPEVT5_Msk      
#define USBD_INTSTS_EP6         USBD_INTSTS_EPEVT6_Msk      
#define USBD_INTSTS_EP7         USBD_INTSTS_EPEVT7_Msk      
#define USBD_STATE_USBRST       USBD_ATTR_USBRST_Msk        
#define USBD_STATE_SUSPEND      USBD_ATTR_SUSPEND_Msk       
#define USBD_STATE_RESUME       USBD_ATTR_RESUME_Msk        
#define USBD_STATE_TIMEOUT      USBD_ATTR_TOUT_Msk          
#define USBD_CFGP_SSTALL        USBD_CFGP_SSTALL_Msk        
#define USBD_CFG_CSTALL         USBD_CFG_CSTALL_Msk         
#define USBD_CFG_EPMODE_DISABLE (0ul << USBD_CFG_STATE_Pos)
#define USBD_CFG_EPMODE_OUT     (1ul << USBD_CFG_STATE_Pos)
#define USBD_CFG_EPMODE_IN      (2ul << USBD_CFG_STATE_Pos)
#define USBD_CFG_TYPE_ISO       (1ul << USBD_CFG_ISOCH_Pos)  /* end of group USBD_EXPORTED_CONSTANTS */
 
 
#define Maximum(a,b)        ((a)>(b) ? (a) : (b))
 
 
#define Minimum(a,b)        ((a)<(b) ? (a) : (b))
 
 
#define USBD_ENABLE_USB()           ((uint32_t)(USBD->ATTR |= (USBD_USB_EN|USBD_PHY_EN)))
 
#define USBD_DISABLE_USB()          ((uint32_t)(USBD->ATTR &= ~USBD_USB_EN))
 
#define USBD_ENABLE_PHY()           ((uint32_t)(USBD->ATTR |= USBD_PHY_EN))
 
#define USBD_DISABLE_PHY()          ((uint32_t)(USBD->ATTR &= ~USBD_PHY_EN))
 
#define USBD_SET_SE0()              ((uint32_t)(USBD->SE0 |= USBD_DRVSE0))
 
#define USBD_CLR_SE0()              ((uint32_t)(USBD->SE0 &= ~USBD_DRVSE0))
 
#define USBD_SET_ADDR(addr)         (USBD->FADDR = (addr))
 
#define USBD_GET_ADDR()             ((uint32_t)(USBD->FADDR))
 
#define USBD_ENABLE_INT(intr)       (USBD->INTEN |= (intr))
 
#define USBD_GET_INT_FLAG()         ((uint32_t)(USBD->INTSTS))
 
#define USBD_CLR_INT_FLAG(flag)     (USBD->INTSTS = (flag))
 
#define USBD_GET_EP_FLAG()          ((uint32_t)(USBD->EPSTS))
 
#define USBD_GET_BUS_STATE()        ((uint32_t)(USBD->ATTR & 0xf))
 
#define USBD_IS_ATTACHED()          ((uint32_t)(USBD->VBUSDET & USBD_VBUSDET_VBUSDET_Msk))
 
#define USBD_STOP_TRANSACTION(ep)   (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) |= USBD_CFGP_CLRRDY_Msk)
 
#define USBD_SET_DATA1(ep)          (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) |= USBD_CFG_DSQSYNC_Msk)
 
#define USBD_SET_DATA0(ep)          (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) &= (~USBD_CFG_DSQSYNC_Msk))
 
#define USBD_SET_PAYLOAD_LEN(ep, size)  (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4))) = (size))
 
#define USBD_GET_PAYLOAD_LEN(ep)        ((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4))))
 
#define USBD_CONFIG_EP(ep, config)      (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) = (config))
 
#define USBD_SET_EP_BUF_ADDR(ep, offset)    (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4))) = (offset))
 
#define USBD_GET_EP_BUF_ADDR(ep)        ((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4))))
 
#define USBD_SET_EP_STALL(ep)        (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) |= USBD_CFGP_SSTALL_Msk)
 
#define USBD_CLR_EP_STALL(ep)        (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) &= ~USBD_CFGP_SSTALL_Msk)
 
#define USBD_GET_EP_STALL(ep)        (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) & USBD_CFGP_SSTALL_Msk)
 
static __INLINE void USBD_MemCopy(uint8_t *dest, uint8_t *src, int32_t size)
{
    while(size--) *dest++ = *src++;
}
 
 
static __INLINE void USBD_SetStall(uint8_t epnum)
{
    uint32_t u32CfgAddr;
    uint32_t u32Cfg;
    int i;
 
    for(i = 0; i < USBD_MAX_EP; i++)
    {
        u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&USBD->EP[0].CFG; /* USBD_CFG0 */
        u32Cfg = *((__IO uint32_t *)(u32CfgAddr));
 
        if((u32Cfg & 0xf) == epnum)
        {
            u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&USBD->EP[0].CFGP; /* USBD_CFGP0 */
            u32Cfg = *((__IO uint32_t *)(u32CfgAddr));
 
            *((__IO uint32_t *)(u32CfgAddr)) = (u32Cfg | USBD_CFGP_SSTALL);
            break;
        }
    }
}
 
static __INLINE void USBD_ClearStall(uint8_t epnum)
{
    uint32_t u32CfgAddr;
    uint32_t u32Cfg;
    int i;
 
    for(i = 0; i < USBD_MAX_EP; i++)
    {
        u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&USBD->EP[0].CFG; /* USBD_CFG0 */
        u32Cfg = *((__IO uint32_t *)(u32CfgAddr));
 
        if((u32Cfg & 0xf) == epnum)
        {
            u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&USBD->EP[0].CFGP; /* USBD_CFGP0 */
            u32Cfg = *((__IO uint32_t *)(u32CfgAddr));
 
            *((__IO uint32_t *)(u32CfgAddr)) = (u32Cfg & ~USBD_CFGP_SSTALL);
            break;
        }
    }
}
 
static __INLINE uint32_t USBD_GetStall(uint8_t epnum)
{
    uint32_t u32CfgAddr;
    uint32_t u32Cfg;
    int i;
 
    for(i = 0; i < USBD_MAX_EP; i++)
    {
        u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&USBD->EP[0].CFG; /* USBD_CFG0 */
        u32Cfg = *((__IO uint32_t *)(u32CfgAddr));
 
        if((u32Cfg & 0xf) == epnum)
        {
            u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&USBD->EP[0].CFGP; /* USBD_CFGP0 */
            break;
        }
    }
 
    return ((*((__IO uint32_t *)(u32CfgAddr))) & USBD_CFGP_SSTALL);
}
 
 
extern volatile uint8_t g_usbd_RemoteWakeupEn;
 
 
typedef void (*VENDOR_REQ)(void);           
typedef void (*CLASS_REQ)(void);            
typedef void (*SET_INTERFACE_REQ)(void);    
typedef void (*SET_CONFIG_CB)(void);       
/*--------------------------------------------------------------------*/
void USBD_Open(const S_USBD_INFO_T *param, CLASS_REQ pfnClassReq, SET_INTERFACE_REQ pfnSetInterface);
void USBD_Start(void);
void USBD_GetSetupPacket(uint8_t *buf);
void USBD_ProcessSetupPacket(void);
void USBD_StandardRequest(void);
void USBD_PrepareCtrlIn(uint8_t *pu8Buf, uint32_t u32Size);
void USBD_CtrlIn(void);
void USBD_PrepareCtrlOut(uint8_t *pu8Buf, uint32_t u32Size);
void USBD_CtrlOut(void);
void USBD_SwReset(void);
void USBD_SetVendorRequest(VENDOR_REQ pfnVendorReq);
void USBD_SetConfigCallback(SET_CONFIG_CB pfnSetConfigCallback);
void USBD_LockEpStall(uint32_t u32EpBitmap);
 /* end of group USBD_EXPORTED_FUNCTIONS */
 /* end of group USBD_Driver */
 /* end of group Standard_Driver */
 
 
#endif //__USBD_H__