| NANO100_BSP V3.05.000 The Board Support Package for Nano100BN Series

usbd.h
Go to the documentation of this file.
1/**************************************************************************/
11#ifndef __USBD_H__
12#define __USBD_H__
13
14
26 typedef struct s_usbd_info
27{
28 uint8_t *gu8DevDesc;
29 uint8_t *gu8ConfigDesc;
30 uint8_t **gu8StringDesc;
31 uint8_t **gu8HidReportDesc;
32 uint32_t *gu32HidReportSize;
33 uint32_t *gu32ConfigHidDescIdx;
34} S_USBD_INFO_T;
35
37 extern S_USBD_INFO_T gsInfo;
39 /* end of group NANO100_USBD_EXPORTED_STRUCTS */
41
45#define USBD_BUF_BASE (USBD_BASE+0x100)
46
47#define USBD_MAX_EP 8
48
49#define EP0 0
50#define EP1 1
51#define EP2 2
52#define EP3 3
53#define EP4 4
54#define EP5 5
55#define EP6 6
56#define EP7 7
59 extern volatile uint32_t g_usbd_UsbConfig;
60
62#define REQ_STANDARD 0x00
63#define REQ_CLASS 0x20
64#define REQ_VENDOR 0x40
65
67#define GET_STATUS 0x00
68#define CLEAR_FEATURE 0x01
69#define SET_FEATURE 0x03
70#define SET_ADDRESS 0x05
71#define GET_DESCRIPTOR 0x06
72#define SET_DESCRIPTOR 0x07
73#define GET_CONFIGURATION 0x08
74#define SET_CONFIGURATION 0x09
75#define GET_INTERFACE 0x0A
76#define SET_INTERFACE 0x0B
77#define SYNC_FRAME 0x0C
78
80#define DESC_DEVICE 0x01
81#define DESC_CONFIG 0x02
82#define DESC_STRING 0x03
83#define DESC_INTERFACE 0x04
84#define DESC_ENDPOINT 0x05
85#define DESC_QUALIFIER 0x06
86#define DESC_OTHERSPEED 0x07
87
89#define DESC_HID 0x21
90#define DESC_HID_RPT 0x22
91
93#define LEN_DEVICE 18
94#define LEN_CONFIG 9
95#define LEN_INTERFACE 9
96#define LEN_ENDPOINT 7
97#define LEN_HID 9
98#define LEN_CCID 0x36
99
101#define EP_ISO 0x01
102#define EP_BULK 0x02
103#define EP_INT 0x03
104
105#define EP_INPUT 0x80
106#define EP_OUTPUT 0x00
107
109#define FEATURE_DEVICE_REMOTE_WAKEUP 0x01
110#define FEATURE_ENDPOINT_HALT 0x00
111
113
114#define USBD_WAKEUP_EN USBD_CTL_WAKEUP_EN_Msk
115#define USBD_DRVSE0 USBD_CTL_DRVSE0_Msk
117#define USBD_DPPU_EN USBD_CTL_DPPU_EN_Msk
118#define USBD_PWRDN USBD_CTL_PWRDB_Msk
119#define USBD_PHY_EN USBD_CTL_PHY_EN_Msk
120#define USBD_USB_EN USBD_CTL_USB_EN_Msk
122#define USBD_INT_BUS USBD_INTEN_BUSEVT_IE_Msk
123#define USBD_INT_USB USBD_INTEN_USBEVT_IE_Msk
124#define USBD_INT_FLDET USBD_INTEN_FLDET_IE_Msk
125#define USBD_INT_WAKEUP USBD_INTEN_WAKEUP_IE_Msk
127#define USBD_INTSTS_WAKEUP USBD_INTSTS_WKEUP_STS_Msk
128#define USBD_INTSTS_FLDET USBD_INTSTS_FLD_STS_Msk
129#define USBD_INTSTS_BUS USBD_INTSTS_BUS_STS_Msk
130#define USBD_INTSTS_USB USBD_INTSTS_USB_STS_Msk
131#define USBD_INTSTS_SETUP USBD_INTSTS_SETUP_Msk
132#define USBD_INTSTS_EP0 USBD_INTSTS_EPEVT0_Msk
133#define USBD_INTSTS_EP1 USBD_INTSTS_EPEVT1_Msk
134#define USBD_INTSTS_EP2 USBD_INTSTS_EPEVT2_Msk
135#define USBD_INTSTS_EP3 USBD_INTSTS_EPEVT3_Msk
136#define USBD_INTSTS_EP4 USBD_INTSTS_EPEVT4_Msk
137#define USBD_INTSTS_EP5 USBD_INTSTS_EPEVT5_Msk
138#define USBD_INTSTS_EP6 USBD_INTSTS_EPEVT6_Msk
139#define USBD_INTSTS_EP7 USBD_INTSTS_EPEVT7_Msk
141#define USBD_STATE_USBRST USBD_BUSSTS_USBRST_Msk
142#define USBD_STATE_SUSPEND USBD_BUSSTS_SUSPEND_Msk
143#define USBD_STATE_RESUME USBD_BUSSTS_RESUME_Msk
144#define USBD_STATE_TIMEOUT USBD_BUSSTS_TIMEOUT_Msk
146#define USBD_CFG_SSTALL USBD_CFG_SSTALL_Msk
147#define USBD_CFG_CSTALL USBD_CFG_CSTALL_Msk
149#define USBD_CFG_EPMODE_DISABLE (0ul << USBD_CFG_EPMODE_Pos)
150#define USBD_CFG_EPMODE_OUT (1ul << USBD_CFG_EPMODE_Pos)
151#define USBD_CFG_EPMODE_IN (2ul << USBD_CFG_EPMODE_Pos)
152#define USBD_CFG_TYPE_ISO (1ul << USBD_CFG_ISOCH_Pos) /* end of group NANO100_USBD_EXPORTED_CONSTANTS */
156
157
172#define Maximum(a,b) ((a)>(b) ? (a) : (b))
173
174
185#define Minimum(a,b) ((a)<(b) ? (a) : (b))
186
192#define USBD_ENABLE_USB() ((uint32_t)(USBD->CTL |= 0xF))
193
199#define USBD_DISABLE_USB() ((uint32_t)(USBD->CTL &= ~USBD_USB_EN))
200
206#define USBD_ENABLE_PHY() ((uint32_t)(USBD->CTL |= USBD_PHY_EN))
207
213#define USBD_DISABLE_PHY() ((uint32_t)(USBD->CTL &= ~USBD_PHY_EN))
214
220#define USBD_SET_SE0() ((uint32_t)(USBD->CTL |= USBD_DRVSE0))
221
227#define USBD_CLR_SE0() ((uint32_t)(USBD->CTL &= ~USBD_DRVSE0))
228
234#define USBD_SET_ADDR(addr) (USBD->FADDR = (addr))
235
241#define USBD_GET_ADDR() ((uint32_t)(USBD->FADDR))
242
248#define USBD_ENABLE_INT(intr) (USBD->INTEN |= (intr))
249
255#define USBD_GET_INT_FLAG() ((uint32_t)(USBD->INTSTS))
256
262#define USBD_CLR_INT_FLAG(flag) (USBD->INTSTS = flag)
263
269#define USBD_GET_EP_FLAG() ((uint32_t)(USBD->EPSTS))
270
276#define USBD_GET_BUS_STATE() ((uint32_t)(USBD->BUSSTS & 0xf))
277
283#define USBD_IS_ATTACHED() ((uint32_t)(USBD->BUSSTS & USBD_BUSSTS_FLDET_Msk))
284
290#define USBD_STOP_TRANSACTION(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) |= USBD_CFG_CLRRDY_Msk)
291
297#define USBD_SET_DATA1(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) |= USBD_CFG_DSQ_SYNC_Msk)
298
304#define USBD_SET_DATA0(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) &= (~USBD_CFG_DSQ_SYNC_Msk))
305
312#define USBD_SET_PAYLOAD_LEN(ep, size) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4))) = (size))
313
319#define USBD_GET_PAYLOAD_LEN(ep) ((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4))))
320
327#define USBD_CONFIG_EP(ep, config) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) = (config))
328
335#define USBD_SET_EP_BUF_ADDR(ep, offset) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4))) = (offset))
336
342#define USBD_GET_EP_BUF_ADDR(ep) ((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4))))
343
354#define USBD_SET_EP_STALL(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) |= USBD_CFG_SSTALL_Msk)
355
365#define USBD_CLR_EP_STALL(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) &= ~USBD_CFG_SSTALL_Msk)
366
378#define USBD_GET_EP_STALL(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) & USBD_CFG_SSTALL_Msk)
379
394 static __INLINE void USBD_MemCopy(uint8_t *dest, uint8_t *src, int32_t size)
395{
396 while (size--) *dest++ = *src++;
397}
398
399
408 static __INLINE void USBD_SetStall(uint8_t epnum)
409{
410 uint32_t u32CfgAddr;
411 uint32_t u32Cfg;
412 int i;
413
414 for (i=0; i<USBD_MAX_EP; i++)
415 {
416 u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&USBD->EP[0].CFG; /* USBD_CFG0 */
417 u32Cfg = *((__IO uint32_t *) (u32CfgAddr));
418
419 if((u32Cfg & 0xf) == epnum)
420 {
421 *((__IO uint32_t *) (u32CfgAddr)) = (u32Cfg | USBD_CFG_SSTALL);
422 break;
423 }
424 }
425}
426
435 static __INLINE void USBD_ClearStall(uint8_t epnum)
436{
437 uint32_t u32CfgAddr;
438 uint32_t u32Cfg;
439 int i;
440
441 for (i=0; i<USBD_MAX_EP; i++)
442 {
443 u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&USBD->EP[0].CFG; /* USBD_CFG0 */
444 u32Cfg = *((__IO uint32_t *) (u32CfgAddr));
445
446 if((u32Cfg & 0xf) == epnum)
447 {
448 *((__IO uint32_t *) (u32CfgAddr)) = (u32Cfg & ~USBD_CFG_SSTALL);
449 break;
450 }
451 }
452}
453
463 static __INLINE uint32_t USBD_GetStall(uint8_t epnum)
464{
465 uint32_t u32CfgAddr;
466 uint32_t u32Cfg;
467 int i;
468
469 for (i=0; i<USBD_MAX_EP; i++)
470 {
471 u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&USBD->EP[0].CFG; /* USBD_CFG0 */
472 u32Cfg = *((__IO uint32_t *) (u32CfgAddr));
473
474 if((u32Cfg & 0xf) == epnum)
475 break;
476 }
477 return (u32Cfg & USBD_CFG_SSTALL);
478}
479
480
481/*--------------------------------------------------------------------*/
482 extern volatile uint8_t g_usbd_RemoteWakeupEn;
483
484 typedef void (*VENDOR_REQ)(void);
486 typedef void (*CLASS_REQ)(void);
488 typedef void (*SET_INTERFACE_REQ)(uint32_t u32AltInterface);
489 typedef void (*SET_CONFIG_CB)(void);
491/*--------------------------------------------------------------------*/
492 void USBD_Open(S_USBD_INFO_T *param, CLASS_REQ pfnClassReq, SET_INTERFACE_REQ pfnSetInterface);
493 void USBD_Start(void);
494 void USBD_GetSetupPacket(uint8_t *buf);
495 void USBD_ProcessSetupPacket(void);
496 void USBD_StandardRequest(void);
497 void USBD_PrepareCtrlIn(uint8_t *pu8Buf, uint32_t u32Size);
498 void USBD_CtrlIn(void);
499 void USBD_PrepareCtrlOut(uint8_t *pu8Buf, uint32_t u32Size);
500 void USBD_CtrlOut(void);
501 void USBD_SwReset(void);
502 void USBD_SetVendorRequest(VENDOR_REQ pfnVendorReq);
503 void USBD_SetConfigCallback(SET_CONFIG_CB pfnSetConfigCallback);
504 void USBD_LockEpStall(uint32_t u32EpBitmap);
505
506 /* end of group NANO100_USBD_EXPORTED_FUNCTIONS */
508 /* end of group NANO100_USBD_Driver */
510 /* end of group NANO100_Device_Driver */
512
513
514#endif //__USBD_H__
515
516/*** (C) COPYRIGHT 2013~2014 Nuvoton Technology Corp. ***/
USBD
#define USBD
Pointer to USBD register structure.
Definition: Nano100Series.h:11688
USBD_CFG_SSTALL
#define USBD_CFG_SSTALL
Definition: usbd.h:146
USBD_MAX_EP
#define USBD_MAX_EP
Definition: usbd.h:47
USBD_LockEpStall
void USBD_LockEpStall(uint32_t u32EpBitmap)
Definition: usbd.c:631
USBD_StandardRequest
void USBD_StandardRequest(void)
Process USB standard request.
Definition: usbd.c:267
s_usbd_info::gu32ConfigHidDescIdx
uint32_t * gu32ConfigHidDescIdx
Definition: usbd.h:33
VENDOR_REQ
void(* VENDOR_REQ)(void)
Definition: usbd.h:484
g_usbd_RemoteWakeupEn
volatile uint8_t g_usbd_RemoteWakeupEn
Definition: usbd.c:19
USBD_PrepareCtrlOut
void USBD_PrepareCtrlOut(uint8_t *pu8Buf, uint32_t u32Size)
Prepare Control OUT transaction.
Definition: usbd.c:536
USBD_SetStall
static __INLINE void USBD_SetStall(uint8_t epnum)
Set USB endpoint stall state.
Definition: usbd.h:408
s_usbd_info::gu8StringDesc
uint8_t ** gu8StringDesc
Definition: usbd.h:30
s_usbd_info::gu8HidReportDesc
uint8_t ** gu8HidReportDesc
Definition: usbd.h:31
s_usbd_info::gu32HidReportSize
uint32_t * gu32HidReportSize
Definition: usbd.h:32
USBD_GetStall
static __INLINE uint32_t USBD_GetStall(uint8_t epnum)
Get USB endpoint stall state.
Definition: usbd.h:463
USBD_GetSetupPacket
void USBD_GetSetupPacket(uint8_t *buf)
Get Setup Packet.
Definition: usbd.c:96
CLASS_REQ
void(* CLASS_REQ)(void)
Definition: usbd.h:486
USBD_ClearStall
static __INLINE void USBD_ClearStall(uint8_t epnum)
Clear USB endpoint stall state.
Definition: usbd.h:435
USBD_Start
void USBD_Start(void)
USBD Start.
Definition: usbd.c:79
USBD_SwReset
void USBD_SwReset(void)
Clear all software flags.
Definition: usbd.c:583
USBD_PrepareCtrlIn
void USBD_PrepareCtrlIn(uint8_t *pu8Buf, uint32_t u32Size)
Prepare Control IN transaction.
Definition: usbd.c:453
s_usbd_info::gu8ConfigDesc
uint8_t * gu8ConfigDesc
Definition: usbd.h:29
USBD_CtrlIn
void USBD_CtrlIn(void)
Start Control IN transfer.
Definition: usbd.c:484
USBD_SetConfigCallback
void USBD_SetConfigCallback(SET_CONFIG_CB pfnSetConfigCallback)
The callback function which called when get SET CONFIGURATION request.
Definition: usbd.c:626
USBD_MemCopy
static __INLINE void USBD_MemCopy(uint8_t *dest, uint8_t *src, int32_t size)
To support byte access between USB SRAM and system SRAM.
Definition: usbd.h:394
USBD_SetVendorRequest
void USBD_SetVendorRequest(VENDOR_REQ pfnVendorReq)
USBD Set Vendor Request.
Definition: usbd.c:613
s_usbd_info::gu8DevDesc
uint8_t * gu8DevDesc
Definition: usbd.h:28
USBD_ProcessSetupPacket
void USBD_ProcessSetupPacket(void)
Process Setup Packet.
Definition: usbd.c:110
USBD_Open
void USBD_Open(S_USBD_INFO_T *param, CLASS_REQ pfnClassReq, SET_INTERFACE_REQ pfnSetInterface)
USBD Initial, Enable clock and reset USB.
Definition: usbd.c:54
SET_CONFIG_CB
void(* SET_CONFIG_CB)(void)
Definition: usbd.h:489
SET_INTERFACE_REQ
void(* SET_INTERFACE_REQ)(uint32_t u32AltInterface)
Definition: usbd.h:488
USBD_CtrlOut
void USBD_CtrlOut(void)
Start Control OUT transfer.
Definition: usbd.c:553
S_USBD_INFO_T
struct s_usbd_info S_USBD_INFO_T
s_usbd_info
Definition: usbd.h:27