usbd.h

Go to the documentation of this file.

/**************************************************************************/
#ifndef __USBD_H__
#define __USBD_H__

#ifdef __cplusplus
extern "C"
{
#endif


typedef struct s_usbd_info
{
    uint8_t *gu8DevDesc;            
    uint8_t *gu8ConfigDesc;         
    uint8_t **gu8StringDesc;        
    uint8_t **gu8HidReportDesc;     
    uint8_t *gu8BosDesc;            
    uint32_t *gu32HidReportSize;    
    uint32_t *gu32ConfigHidDescIdx; 
} S_USBD_INFO_T;  
extern const S_USBD_INFO_T gsInfo;
 /* end of group USBD_EXPORTED_STRUCT */




#define USBD_BUF_BASE   (USBD_BASE+0x100ul)  
#define USBD_MAX_EP     12ul 
#define EP0     0ul       
#define EP1     1ul       
#define EP2     2ul       
#define EP3     3ul       
#define EP4     4ul       
#define EP5     5ul       
#define EP6     6ul       
#define EP7     7ul       
#define EP8     8ul       
#define EP9     9ul       
#define EP10    10ul      
#define EP11    11ul      
/* USB Request Type */
#define REQ_STANDARD        0x00ul
#define REQ_CLASS           0x20ul
#define REQ_VENDOR          0x40ul

/* USB Standard Request */
#define GET_STATUS          0x00ul
#define CLEAR_FEATURE       0x01ul
#define SET_FEATURE         0x03ul
#define SET_ADDRESS         0x05ul
#define GET_DESCRIPTOR      0x06ul
#define SET_DESCRIPTOR      0x07ul
#define GET_CONFIGURATION   0x08ul
#define SET_CONFIGURATION   0x09ul
#define GET_INTERFACE       0x0Aul
#define SET_INTERFACE       0x0Bul
#define SYNC_FRAME          0x0Cul

/* USB Descriptor Type */
#define DESC_DEVICE         0x01ul
#define DESC_CONFIG         0x02ul
#define DESC_STRING         0x03ul
#define DESC_INTERFACE      0x04ul
#define DESC_ENDPOINT       0x05ul
#define DESC_QUALIFIER      0x06ul
#define DESC_OTHERSPEED     0x07ul
#define DESC_IFPOWER        0x08ul
#define DESC_OTG            0x09ul
#define DESC_BOS            0x0Ful
#define DESC_CAPABILITY     0x10ul

/* USB Device Capability Type */
#define CAP_WIRELESS        0x01ul
#define CAP_USB20_EXT       0x02ul

/* USB HID Descriptor Type */
#define DESC_HID            0x21ul
#define DESC_HID_RPT        0x22ul

/* USB Descriptor Length */
#define LEN_DEVICE          18ul
#define LEN_QUALIFIER       10ul
#define LEN_CONFIG          9ul
#define LEN_INTERFACE       9ul
#define LEN_ENDPOINT        7ul
#define LEN_OTG             5ul
#define LEN_BOS             5ul
#define LEN_HID             9ul
#define LEN_CCID            0x36ul
#define LEN_BOSCAP          7ul

/* USB Endpoint Type */
#define EP_ISO              0x01
#define EP_BULK             0x02
#define EP_INT              0x03

#define EP_INPUT            0x80
#define EP_OUTPUT           0x00

/* USB Feature Selector */
#define FEATURE_DEVICE_REMOTE_WAKEUP    0x01ul
#define FEATURE_ENDPOINT_HALT           0x00ul

/******************************************************************************/
/*                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_INTSTS_EP8         USBD_INTSTS_EPEVT8_Msk      
#define USBD_INTSTS_EP9         USBD_INTSTS_EPEVT9_Msk      
#define USBD_INTSTS_EP10        USBD_INTSTS_EPEVT10_Msk     
#define USBD_INTSTS_EP11        USBD_INTSTS_EPEVT11_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 USBD_Maximum(a,b)        ((a)>(b) ? (a) : (b))


#define USBD_Minimum(a,b)        ((a)<(b) ? (a) : (b))


#define USBD_ENABLE_USB()           ((uint32_t)(USBD->ATTR |= 0x7D0))

#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[0ul].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[], uint32_t size)
{
    uint32_t volatile i=0ul;

    while(size--)
    {
        dest[i] = src[i];
        i++;
    }
}

__STATIC_INLINE void USBD_SetStall(uint8_t epnum)
{
    uint32_t u32CfgAddr;
    uint32_t u32Cfg;
    uint32_t i;

    for(i = 0ul; 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 & 0xful) == 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;
    uint32_t i;

    for(i = 0ul; 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 & 0xful) == 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;
    uint32_t i;

    for(i = 0ul; 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 & 0xful) == 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)(uint32_t u32AltInterface);    
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 */

#ifdef __cplusplus
}
#endif

#endif /*__USBD_H__*/

/*** (C) COPYRIGHT 2016 Nuvoton Technology Corp. ***/