Collaboration diagram for USBD Exported Functions:

Macros
#define	Maximum(a, b) ((a)>(b) ? (a) : (b))
	Compare two input numbers and return maximum one. More...

#define	Minimum(a, b) ((a)<(b) ? (a) : (b))
	Compare two input numbers and return minimum one. More...

#define	USBD_ENABLE_USB() ((uint32_t)(USBD->ATTR \|= (USBD_USB_EN\|USBD_PHY_EN)))
	Enable USB. More...

#define	USBD_DISABLE_USB() ((uint32_t)(USBD->ATTR &= ~USBD_USB_EN))
	Disable USB. More...

#define	USBD_ENABLE_PHY() ((uint32_t)(USBD->ATTR \|= USBD_PHY_EN))
	Enable USB PHY. More...

#define	USBD_DISABLE_PHY() ((uint32_t)(USBD->ATTR &= ~USBD_PHY_EN))
	Disable USB PHY. More...

#define	USBD_SET_SE0() ((uint32_t)(USBD->SE0 \|= USBD_DRVSE0))
	Enable SE0. Force USB PHY transceiver to drive SE0. More...

#define	USBD_CLR_SE0() ((uint32_t)(USBD->SE0 &= ~USBD_DRVSE0))
	Disable SE0. More...

#define	USBD_SET_ADDR(addr) (USBD->FADDR = (addr))
	Set USB device address. More...

#define	USBD_GET_ADDR() ((uint32_t)(USBD->FADDR))
	Get USB device address. More...

#define	USBD_ENABLE_INT(intr) (USBD->INTEN \|= (intr))
	Enable USB interrupt function. More...

#define	USBD_GET_INT_FLAG() ((uint32_t)(USBD->INTSTS))
	Get interrupt status. More...

#define	USBD_CLR_INT_FLAG(flag) (USBD->INTSTS = (flag))
	Clear USB interrupt flag. More...

#define	USBD_GET_EP_FLAG() ((uint32_t)(USBD->EPSTS))
	Get endpoint status. More...

#define	USBD_GET_BUS_STATE() ((uint32_t)(USBD->ATTR & 0xf))
	Get USB bus state. More...

#define	USBD_IS_ATTACHED() ((uint32_t)(USBD->VBUSDET & USBD_VBUSDET_VBUSDET_Msk))
	Check cable connection state. More...

#define	USBD_STOP_TRANSACTION(ep) (((__IO uint32_t ) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) \|= USBD_CFGP_CLRRDY_Msk)
	Stop USB transaction of the specified endpoint ID. More...

#define	USBD_SET_DATA1(ep) (((__IO uint32_t ) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) \|= USBD_CFG_DSQSYNC_Msk)
	Set USB DATA1 PID for the specified endpoint ID. More...

#define	USBD_SET_DATA0(ep) (((__IO uint32_t ) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) &= (~USBD_CFG_DSQSYNC_Msk))
	Set USB DATA0 PID for the specified endpoint ID. More...

#define	USBD_SET_PAYLOAD_LEN(ep, size) (((__IO uint32_t ) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4))) = (size))
	Set USB payload size (IN data) More...

#define	USBD_GET_PAYLOAD_LEN(ep) ((uint32_t)((__IO uint32_t ) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4))))
	Get USB payload size (OUT data) More...

#define	USBD_CONFIG_EP(ep, config) (((__IO uint32_t ) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) = (config))
	Configure endpoint. More...

#define	USBD_SET_EP_BUF_ADDR(ep, offset) (((__IO uint32_t ) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4))) = (offset))
	Set USB endpoint buffer. More...

#define	USBD_GET_EP_BUF_ADDR(ep) ((uint32_t)((__IO uint32_t ) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4))))
	Get the offset of the specified USB endpoint buffer. More...

#define	USBD_SET_EP_STALL(ep) (((__IO uint32_t ) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) \|= USBD_CFGP_SSTALL_Msk)
	Set USB endpoint stall state. More...

#define	USBD_CLR_EP_STALL(ep) (((__IO uint32_t ) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) &= ~USBD_CFGP_SSTALL_Msk)
	Clear USB endpoint stall state. More...

#define	USBD_GET_EP_STALL(ep) (((__IO uint32_t ) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) & USBD_CFGP_SSTALL_Msk)
	Get USB endpoint stall state. More...

Typedefs
typedef void(*	VENDOR_REQ) (void)

typedef void(*	CLASS_REQ) (void)

typedef void(*	SET_INTERFACE_REQ) (void)

typedef void(*	SET_CONFIG_CB) (void)

Functions
static __INLINE void	USBD_MemCopy (uint8_t dest, uint8_t src, int32_t size)
	To support byte access between USB SRAM and system SRAM. More...

static __INLINE void	USBD_SetStall (uint8_t epnum)
	Set USB endpoint stall state. More...

static __INLINE void	USBD_ClearStall (uint8_t epnum)
	Clear USB endpoint stall state. More...

static __INLINE uint32_t	USBD_GetStall (uint8_t epnum)
	Get USB endpoint stall state. More...

void	USBD_Open (const S_USBD_INFO_T *param, CLASS_REQ pfnClassReq, SET_INTERFACE_REQ pfnSetInterface)
	This function makes USBD module to be ready to use. More...

void	USBD_Start (void)
	This function makes USB host to recognize the device. More...

void	USBD_GetSetupPacket (uint8_t *buf)
	Get the received SETUP packet. More...

void	USBD_ProcessSetupPacket (void)
	Process SETUP packet. More...

void	USBD_StandardRequest (void)
	Process standard request. More...

void	USBD_PrepareCtrlIn (uint8_t *pu8Buf, uint32_t u32Size)
	Prepare the first Control IN pipe. More...

void	USBD_CtrlIn (void)
	Repeat Control IN pipe. More...

void	USBD_PrepareCtrlOut (uint8_t *pu8Buf, uint32_t u32Size)
	Prepare the first Control OUT pipe. More...

void	USBD_CtrlOut (void)
	Repeat Control OUT pipe. More...

void	USBD_SwReset (void)
	Reset software flags. More...

void	USBD_SetVendorRequest (VENDOR_REQ pfnVendorReq)
	USBD Set Vendor Request. More...

void	USBD_SetConfigCallback (SET_CONFIG_CB pfnSetConfigCallback)
	The callback function which called when get SET CONFIGURATION request. More...

void	USBD_LockEpStall (uint32_t u32EpBitmap)
	EP stall lock function to avoid stall clear by USB SET FEATURE request. More...

void	USBD_GetDescriptor (void)
	Process GetDescriptor request. More...

Variables
const uint8_t *	s_usbd_info::gu8DevDesc

const uint8_t *	s_usbd_info::gu8ConfigDesc

const uint8_t **	s_usbd_info::gu8StringDesc

const uint8_t **	s_usbd_info::gu8HidReportDesc

const uint32_t *	s_usbd_info::gu32HidReportSize

const uint32_t *	s_usbd_info::gu32ConfigHidDescIdx

volatile uint8_t	g_usbd_RemoteWakeupEn

uint8_t	g_usbd_SetupPacket [8] = {0}

volatile uint8_t	g_usbd_RemoteWakeupEn = 0

const S_USBD_INFO_T *	g_usbd_sInfo

VENDOR_REQ	g_usbd_pfnVendorRequest = NULL

CLASS_REQ	g_usbd_pfnClassRequest = NULL

SET_INTERFACE_REQ	g_usbd_pfnSetInterface = NULL

SET_CONFIG_CB	g_usbd_pfnSetConfigCallback = NULL

uint32_t	g_u32EpStallLock = 0

Detailed Description

Macro Definition Documentation

◆ Maximum

#define Maximum	(	a,
		b
	)	((a)>(b) ? (a) : (b))

Compare two input numbers and return maximum one.

Parameters

[in]	a	First number to be compared.
[in]	b	Second number to be compared.

Returns: Maximum value between a and b.

If a > b, then return a. Otherwise, return b.

Definition at line 174 of file usbd.h.

◆ Minimum

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

Compare two input numbers and return minimum one.

Parameters

[in]	a	First number to be compared
[in]	b	Second number to be compared

Returns: Minimum value between a and b

If a < b, then return a. Otherwise, return b.

Definition at line 187 of file usbd.h.

◆ USBD_CLR_EP_STALL

#define USBD_CLR_EP_STALL ( ep ) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) &= ~USBD_CFGP_SSTALL_Msk)

Clear USB endpoint stall state.

Parameters

[in] ep The USB endpoint ID. M4521 supports 8 hardware endpoint ID. This parameter could be 0 ~ 7.

Returns: None

Clear USB endpoint stall state for the specified endpoint ID. Endpoint will respond ACK/NAK token.

Definition at line 494 of file usbd.h.

◆ USBD_CLR_INT_FLAG

#define USBD_CLR_INT_FLAG ( flag ) (USBD->INTSTS = (flag))

Clear USB interrupt flag.

Parameters

[in] flag The combination of the specified interrupt flags. Each bit corresponds to a interrupt source. This parameter decides which interrupt flags will be cleared. (USBD_INTSTS_WAKEUP, USBD_INTSTS_FLDET, USBD_INTSTS_BUS, USBD_INTSTS_USB)

Returns: None

Clear USB related interrupt flags specified by flag parameter.

Definition at line 326 of file usbd.h.

◆ USBD_CLR_SE0

#define USBD_CLR_SE0 ( ) ((uint32_t)(USBD->SE0 &= ~USBD_DRVSE0))

Disable SE0.

Parameters

None

Returns: None

Clear DRVSE0 bit of USB_DRVSE0 register to disable software-disconnect function.

Definition at line 260 of file usbd.h.

◆ USBD_CONFIG_EP

#define USBD_CONFIG_EP	(	ep,
		config
	)	(((__IO uint32_t ) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) = (config))

Configure endpoint.

Parameters

[in]	ep	The USB endpoint ID. M4521 supports 8 hardware endpoint ID. This parameter could be 0 ~ 7.
[in]	config	The USB configuration.

Returns: None

This macro will write config parameter to USB_CFGx register of specified endpoint ID.

Definition at line 445 of file usbd.h.

◆ USBD_DISABLE_PHY

#define USBD_DISABLE_PHY ( ) ((uint32_t)(USBD->ATTR &= ~USBD_PHY_EN))

Disable USB PHY.

Parameters

None

Returns: None

To set USB ATTR control register to disable USB PHY.

Definition at line 236 of file usbd.h.

◆ USBD_DISABLE_USB

#define USBD_DISABLE_USB ( ) ((uint32_t)(USBD->ATTR &= ~USBD_USB_EN))

Disable USB.

Parameters

None

Returns: None

To set USB ATTR control register to disable USB.

Definition at line 212 of file usbd.h.

◆ USBD_ENABLE_INT

#define USBD_ENABLE_INT ( intr ) (USBD->INTEN |= (intr))

Enable USB interrupt function.

Parameters

[in] intr The combination of the specified interrupt enable bits. Each bit corresponds to a interrupt enable bit. This parameter decides which interrupts will be enabled. (USBD_INT_WAKEUP, USBD_INT_FLDET, USBD_INT_USB, USBD_INT_BUS)

Returns: None

Enable USB related interrupt functions specified by intr parameter.

Definition at line 299 of file usbd.h.

◆ USBD_ENABLE_PHY

#define USBD_ENABLE_PHY ( ) ((uint32_t)(USBD->ATTR |= USBD_PHY_EN))

Enable USB PHY.

Parameters

None

Returns: None

To set USB ATTR control register to enable USB PHY.

Definition at line 224 of file usbd.h.

◆ USBD_ENABLE_USB

#define USBD_ENABLE_USB ( ) ((uint32_t)(USBD->ATTR |= (USBD_USB_EN|USBD_PHY_EN)))

Enable USB.

Parameters

None

Returns: None

To set USB ATTR control register to enable USB and PHY.

Definition at line 200 of file usbd.h.

◆ USBD_GET_ADDR

#define USBD_GET_ADDR ( ) ((uint32_t)(USBD->FADDR))

Get USB device address.

Parameters

None

Returns: USB device address

Read USB_FADDR register to get USB device address.

Definition at line 284 of file usbd.h.

◆ USBD_GET_BUS_STATE

#define USBD_GET_BUS_STATE ( ) ((uint32_t)(USBD->ATTR & 0xf))

Get USB bus state.

Parameters

None

Returns: The value of USB_ATTR[3:0]. Bit 0 indicates USB bus reset status. Bit 1 indicates USB bus suspend status. Bit 2 indicates USB bus resume status. Bit 3 indicates USB bus time-out status.

Return USB_ATTR[3:0] for USB bus events.

Definition at line 354 of file usbd.h.

◆ USBD_GET_EP_BUF_ADDR

#define USBD_GET_EP_BUF_ADDR ( ep ) ((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4))))

Get the offset of the specified USB endpoint buffer.

Parameters

[in] ep The USB endpoint ID. M4521 supports 8 hardware endpoint ID. This parameter could be 0 ~ 7.

Returns: The offset of the specified endpoint buffer.

This macro will return the SRAM offset of the specified endpoint ID.

Definition at line 471 of file usbd.h.

◆ USBD_GET_EP_FLAG

#define USBD_GET_EP_FLAG ( ) ((uint32_t)(USBD->EPSTS))

Get endpoint status.

Parameters

None

Returns: The value of USB_EPSTS register.

Return all endpoint status.

Definition at line 338 of file usbd.h.

◆ USBD_GET_EP_STALL

#define USBD_GET_EP_STALL ( ep ) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) & USBD_CFGP_SSTALL_Msk)

Get USB endpoint stall state.

Parameters

[in] ep The USB endpoint ID. M4521 supports 8 hardware endpoint ID. This parameter could be 0 ~ 7.

Return values

0	USB endpoint is not stalled.
Others	USB endpoint is stalled.

Get USB endpoint stall state of the specified endpoint ID.

Definition at line 507 of file usbd.h.

◆ USBD_GET_INT_FLAG

#define USBD_GET_INT_FLAG ( ) ((uint32_t)(USBD->INTSTS))

Get interrupt status.

Parameters

None

Returns: The value of USB_INTSTS register

Return all interrupt flags of USB_INTSTS register.

Definition at line 311 of file usbd.h.

◆ USBD_GET_PAYLOAD_LEN

#define USBD_GET_PAYLOAD_LEN ( ep ) ((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4))))

Get USB payload size (OUT data)

Parameters

[in] ep The USB endpoint ID. M4521 supports 8 endpoint ID. This parameter could be 0 ~ 7.

Returns: The value of USB_MXPLDx register.

Get the data length of OUT data transaction by reading USB_MXPLDx register.

Definition at line 431 of file usbd.h.

◆ USBD_IS_ATTACHED

#define USBD_IS_ATTACHED ( ) ((uint32_t)(USBD->VBUSDET & USBD_VBUSDET_VBUSDET_Msk))

Check cable connection state.

Parameters

None

Return values

0	USB cable is not attached.
1	USB cable is attached.

Check the connection state by FLDET bit of USB_FLDET register.

Definition at line 367 of file usbd.h.

◆ USBD_SET_ADDR

#define USBD_SET_ADDR ( addr ) (USBD->FADDR = (addr))

Set USB device address.

Parameters

[in] addr The USB device address.

Returns: None

Write USB device address to USB_FADDR register.

Definition at line 272 of file usbd.h.

◆ USBD_SET_DATA0

#define USBD_SET_DATA0 ( ep ) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) &= (~USBD_CFG_DSQSYNC_Msk))

Set USB DATA0 PID for the specified endpoint ID.

Parameters

[in] ep The USB endpoint ID. M4521 supports 8 hardware endpoint ID. This parameter could be 0 ~ 7.

Returns: None

Clear DSQ_SYNC bit of USB_CFGx register to specify the DATA0 PID for the following IN token transaction. Base on this setting, hardware will toggle PID between DATA0 and DATA1 automatically for IN token transactions.

Definition at line 405 of file usbd.h.

◆ USBD_SET_DATA1

#define USBD_SET_DATA1 ( ep ) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) |= USBD_CFG_DSQSYNC_Msk)

Set USB DATA1 PID for the specified endpoint ID.

Parameters

[in] ep The USB endpoint ID. M4521 supports 8 hardware endpoint ID. This parameter could be 0 ~ 7.

Returns: None

Set DSQ_SYNC bit of USB_CFGx register to specify the DATA1 PID for the following IN token transaction. Base on this setting, hardware will toggle PID between DATA0 and DATA1 automatically for IN token transactions.

Definition at line 392 of file usbd.h.

◆ USBD_SET_EP_BUF_ADDR

#define USBD_SET_EP_BUF_ADDR	(	ep,
		offset
	)	(((__IO uint32_t ) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4))) = (offset))

Set USB endpoint buffer.

Parameters

[in]	ep	The USB endpoint ID. M4521 supports 8 hardware endpoint ID. This parameter could be 0 ~ 7.
[in]	offset	The SRAM offset.

Returns: None

This macro will set the SRAM offset for the specified endpoint ID.

Definition at line 459 of file usbd.h.

◆ USBD_SET_EP_STALL

#define USBD_SET_EP_STALL ( ep ) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) |= USBD_CFGP_SSTALL_Msk)

Set USB endpoint stall state.

Parameters

[in] ep The USB endpoint ID. M4521 supports 8 hardware endpoint ID. This parameter could be 0 ~ 7.

Returns: None

Set USB endpoint stall state for the specified endpoint ID. Endpoint will respond STALL token automatically.

Definition at line 483 of file usbd.h.

◆ USBD_SET_PAYLOAD_LEN

#define USBD_SET_PAYLOAD_LEN	(	ep,
		size
	)	(((__IO uint32_t ) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4))) = (size))

Set USB payload size (IN data)

Parameters

[in]	ep	The USB endpoint ID. M4521 supports 8 hardware endpoint ID. This parameter could be 0 ~ 7.
[in]	size	The transfer length.

Returns: None

This macro will write the transfer length to USB_MXPLDx register for IN data transaction.

Definition at line 419 of file usbd.h.

◆ USBD_SET_SE0

#define USBD_SET_SE0 ( ) ((uint32_t)(USBD->SE0 |= USBD_DRVSE0))

Enable SE0. Force USB PHY transceiver to drive SE0.

Parameters

None

Returns: None

Set DRVSE0 bit of USB_DRVSE0 register to enable software-disconnect function. Force USB PHY transceiver to drive SE0 to bus.

Definition at line 248 of file usbd.h.

◆ USBD_STOP_TRANSACTION

#define USBD_STOP_TRANSACTION ( ep ) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) |= USBD_CFGP_CLRRDY_Msk)

Stop USB transaction of the specified endpoint ID.

Parameters

[in] ep The USB endpoint ID. M4521 supports 8 hardware endpoint ID. This parameter could be 0 ~ 7.

Returns: None

Write 1 to CLRRDY bit of USB_CFGPx register to stop USB transaction of the specified endpoint ID.

Definition at line 379 of file usbd.h.

Typedef Documentation

◆ CLASS_REQ

typedef void(* CLASS_REQ) (void)

Functional pointer type declaration for USB class request callback handler

Definition at line 629 of file usbd.h.

◆ SET_CONFIG_CB

typedef void(* SET_CONFIG_CB) (void)

Functional pointer type declaration for USB set configuration request callback handler

Definition at line 631 of file usbd.h.

◆ SET_INTERFACE_REQ

typedef void(* SET_INTERFACE_REQ) (void)

Functional pointer type declaration for USB set interface request callback handler

Definition at line 630 of file usbd.h.

◆ VENDOR_REQ

typedef void(* VENDOR_REQ) (void)

Functional pointer type definition for Vendor class

Definition at line 628 of file usbd.h.

Function Documentation

◆ USBD_ClearStall()

static __INLINE void USBD_ClearStall ( uint8_t epnum )

static

Clear USB endpoint stall state.

Parameters

[in] epnum USB endpoint number

Returns: None

Clear USB endpoint stall state. Endpoint will respond ACK/NAK token.

Definition at line 570 of file usbd.h.

◆ USBD_CtrlIn()

void USBD_CtrlIn ( void )

Repeat Control IN pipe.

Parameters

None

Returns: None

This function processes the remained data of Control IN transfer.

Definition at line 561 of file usbd.c.

Here is the call graph for this function:

◆ USBD_CtrlOut()

void USBD_CtrlOut ( void )

Repeat Control OUT pipe.

Parameters

None

Returns: None

This function processes the successive Control OUT transfer.

Definition at line 636 of file usbd.c.

Here is the call graph for this function:

◆ USBD_GetDescriptor()

void USBD_GetDescriptor ( void )

Process GetDescriptor request.

Parameters

None

Returns: None

Parse GetDescriptor request and perform the corresponding action.

Definition at line 192 of file usbd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ USBD_GetSetupPacket()

void USBD_GetSetupPacket ( uint8_t * buf )

Get the received SETUP packet.

Parameters

[in] buf A buffer pointer used to store 8-byte SETUP packet.

Returns: None

Store SETUP packet to a user-specified buffer.

Definition at line 128 of file usbd.c.

Here is the call graph for this function:

◆ USBD_GetStall()

static __INLINE uint32_t USBD_GetStall ( uint8_t epnum )

static

Get USB endpoint stall state.

Parameters

[in] epnum USB endpoint number

Return values

0	USB endpoint is not stalled.
Others	USB endpoint is stalled.

Get USB endpoint stall state.

Definition at line 603 of file usbd.h.

Here is the caller graph for this function:

◆ USBD_LockEpStall()

void USBD_LockEpStall ( uint32_t u32EpBitmap )

EP stall lock function to avoid stall clear by USB SET FEATURE request.

Parameters

[in] u32EpBitmap Use bitmap to select which endpoints will be locked

Returns: None

This function is used to lock relative endpoint to avoid stall clear by SET FEATURE requst. If ep stall locked, user needs to reset USB device or re-configure device to clear it.

Definition at line 732 of file usbd.c.

◆ USBD_MemCopy()

static __INLINE void USBD_MemCopy	(	uint8_t *	dest,
		uint8_t *	src,
		int32_t	size
	)

static

To support byte access between USB SRAM and system SRAM.

Parameters

[in]	dest	Destination pointer.
[in]	src	Source pointer.
[in]	size	Byte count.

Returns: None

This function will copy the number of data specified by size and src parameters to the address specified by dest parameter.

Definition at line 523 of file usbd.h.

Here is the caller graph for this function:

◆ USBD_Open()

void USBD_Open	(	const S_USBD_INFO_T *	param,
		CLASS_REQ	pfnClassReq,
		SET_INTERFACE_REQ	pfnSetInterface
	)

This function makes USBD module to be ready to use.

Parameters

[in]	param	The structure of USBD information.
[in]	pfnClassReq	USB Class request callback function.
[in]	pfnSetInterface	USB Set Interface request callback function.

Returns: None

This function will enable USB controller, USB PHY transceiver and pull-up resistor of USB_D+ pin. USB PHY will drive SE0 to bus.

Definition at line 81 of file usbd.c.

◆ USBD_PrepareCtrlIn()

void USBD_PrepareCtrlIn	(	uint8_t *	pu8Buf,
		uint32_t	u32Size
	)

Prepare the first Control IN pipe.

Parameters

[in]	pu8Buf	The pointer of data sent to USB host.
[in]	u32Size	The IN transfer size.

Returns: None

Prepare data for Control IN transfer.

Definition at line 528 of file usbd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ USBD_PrepareCtrlOut()

void USBD_PrepareCtrlOut	(	uint8_t *	pu8Buf,
		uint32_t	u32Size
	)

Prepare the first Control OUT pipe.

Parameters

[in]	pu8Buf	The pointer of data received from USB host.
[in]	u32Size	The OUT transfer size.

Returns: None

This function is used to prepare the first Control OUT transfer.

Definition at line 618 of file usbd.c.

Here is the caller graph for this function:

◆ USBD_ProcessSetupPacket()

void USBD_ProcessSetupPacket ( void )

Process SETUP packet.

Parameters

None

Returns: None

Parse SETUP packet and perform the corresponding action.

Definition at line 143 of file usbd.c.

Here is the call graph for this function:

◆ USBD_SetConfigCallback()

void USBD_SetConfigCallback ( SET_CONFIG_CB pfnSetConfigCallback )

The callback function which called when get SET CONFIGURATION request.

Parameters

[in] pfnSetConfigCallback Callback function pointer for SET CONFIGURATION request

Returns: None

This function is used to set the callback function which will be called at SET CONFIGURATION request.

Definition at line 716 of file usbd.c.

◆ USBD_SetStall()

static __INLINE void USBD_SetStall ( uint8_t epnum )

static

Set USB endpoint stall state.

Parameters

[in] epnum USB endpoint number

Returns: None

Set USB endpoint stall state. Endpoint will respond STALL token automatically.

Definition at line 539 of file usbd.h.

Here is the caller graph for this function:

◆ USBD_SetVendorRequest()

void USBD_SetVendorRequest ( VENDOR_REQ pfnVendorReq )

USBD Set Vendor Request.

Parameters

[in] pfnVendorReq Vendor Request Callback Function

Returns: None

This function is used to set USBD vendor request callback function

Definition at line 702 of file usbd.c.

◆ USBD_StandardRequest()

void USBD_StandardRequest ( void )

Process standard request.

Parameters

None

Returns: None

Parse standard request and perform the corresponding action.

Definition at line 313 of file usbd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ USBD_Start()

void USBD_Start ( void )

This function makes USB host to recognize the device.

Parameters

None

Returns: None

Enable WAKEUP, FLDET, USB and BUS interrupts. Disable software-disconnect function after 100ms delay with SysTick timer.

Definition at line 105 of file usbd.c.

Here is the call graph for this function:

◆ USBD_SwReset()

void USBD_SwReset ( void )

Reset software flags.

Parameters

None

Returns: None

This function resets all variables for protocol and resets USB device address to 0.

Definition at line 672 of file usbd.c.

Variable Documentation

◆ g_u32EpStallLock

uint32_t g_u32EpStallLock = 0

Bit map flag to lock specified EP when SET_FEATURE

Definition at line 68 of file usbd.c.

◆ g_usbd_pfnClassRequest

CLASS_REQ g_usbd_pfnClassRequest = NULL

USB Class Request Functional Pointer

Definition at line 65 of file usbd.c.

◆ g_usbd_pfnSetConfigCallback

SET_CONFIG_CB g_usbd_pfnSetConfigCallback = NULL

USB Set configuration callback function pointer

Definition at line 67 of file usbd.c.

◆ g_usbd_pfnSetInterface

SET_INTERFACE_REQ g_usbd_pfnSetInterface = NULL

USB Set Interface Functional Pointer

Definition at line 66 of file usbd.c.

◆ g_usbd_pfnVendorRequest

VENDOR_REQ g_usbd_pfnVendorRequest = NULL

USB Vendor Request Functional Pointer

Definition at line 64 of file usbd.c.

◆ g_usbd_RemoteWakeupEn [1/2]

volatile uint8_t g_usbd_RemoteWakeupEn

extern

Remote wake up function enable flag

Definition at line 42 of file usbd.c.

◆ g_usbd_RemoteWakeupEn [2/2]

volatile uint8_t g_usbd_RemoteWakeupEn = 0

Remote wake up function enable flag

Definition at line 42 of file usbd.c.

◆ g_usbd_SetupPacket

uint8_t g_usbd_SetupPacket[8] = {0}

Setup packet buffer

Definition at line 41 of file usbd.c.

◆ g_usbd_sInfo

const S_USBD_INFO_T* g_usbd_sInfo

A pointer for USB information structure

Definition at line 62 of file usbd.c.

◆ gu32ConfigHidDescIdx

const uint32_t* s_usbd_info::gu32ConfigHidDescIdx

Pointer for HID Descriptor start index

Definition at line 33 of file usbd.h.

◆ gu32HidReportSize

const uint32_t* s_usbd_info::gu32HidReportSize

Pointer for HID Report descriptor Size

Definition at line 32 of file usbd.h.

◆ gu8ConfigDesc

const uint8_t* s_usbd_info::gu8ConfigDesc

Pointer for USB Configuration Descriptor

Definition at line 29 of file usbd.h.

◆ gu8DevDesc

const uint8_t* s_usbd_info::gu8DevDesc

Pointer for USB Device Descriptor

Definition at line 28 of file usbd.h.

◆ gu8HidReportDesc

const uint8_t** s_usbd_info::gu8HidReportDesc

Pointer for USB HID Report Descriptor

Definition at line 31 of file usbd.h.

◆ gu8StringDesc

const uint8_t** s_usbd_info::gu8StringDesc

Pointer for USB String Descriptor pointers

Definition at line 30 of file usbd.h.

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ Maximum

◆ Minimum

◆ USBD_CLR_EP_STALL

◆ USBD_CLR_INT_FLAG

◆ USBD_CLR_SE0

◆ USBD_CONFIG_EP

◆ USBD_DISABLE_PHY

◆ USBD_DISABLE_USB

◆ USBD_ENABLE_INT

◆ USBD_ENABLE_PHY

◆ USBD_ENABLE_USB

◆ USBD_GET_ADDR

◆ USBD_GET_BUS_STATE

◆ USBD_GET_EP_BUF_ADDR

◆ USBD_GET_EP_FLAG

◆ USBD_GET_EP_STALL

◆ USBD_GET_INT_FLAG

◆ USBD_GET_PAYLOAD_LEN

◆ USBD_IS_ATTACHED

◆ USBD_SET_ADDR

◆ USBD_SET_DATA0

◆ USBD_SET_DATA1

◆ USBD_SET_EP_BUF_ADDR

◆ USBD_SET_EP_STALL

◆ USBD_SET_PAYLOAD_LEN

◆ USBD_SET_SE0

◆ USBD_STOP_TRANSACTION

Typedef Documentation

◆ CLASS_REQ

◆ SET_CONFIG_CB

◆ SET_INTERFACE_REQ

◆ VENDOR_REQ

Function Documentation

◆ USBD_ClearStall()

◆ USBD_CtrlIn()

◆ USBD_CtrlOut()

◆ USBD_GetDescriptor()

◆ USBD_GetSetupPacket()

◆ USBD_GetStall()

◆ USBD_LockEpStall()

◆ USBD_MemCopy()

◆ USBD_Open()

◆ USBD_PrepareCtrlIn()

◆ USBD_PrepareCtrlOut()

◆ USBD_ProcessSetupPacket()

◆ USBD_SetConfigCallback()

◆ USBD_SetStall()

◆ USBD_SetVendorRequest()

◆ USBD_StandardRequest()

◆ USBD_Start()

◆ USBD_SwReset()

Variable Documentation

◆ g_u32EpStallLock

◆ g_usbd_pfnClassRequest

◆ g_usbd_pfnSetConfigCallback

◆ g_usbd_pfnSetInterface

◆ g_usbd_pfnVendorRequest

◆ g_usbd_RemoteWakeupEn [1/2]

◆ g_usbd_RemoteWakeupEn [2/2]

◆ g_usbd_SetupPacket

◆ g_usbd_sInfo

◆ gu32ConfigHidDescIdx

◆ gu32HidReportSize

◆ gu8ConfigDesc

◆ gu8DevDesc

◆ gu8HidReportDesc

◆ gu8StringDesc