USBD_CORE_Private_Functions

Collaboration diagram for USBD_CORE_Private_Functions:

Functions
USBD_StatusTypeDef	USBD_Init (USBD_HandleTypeDef *pdev, USBD_DescriptorsTypeDef *pdesc, uint8_t id)
	USBD_Init Initialize the device stack and load the class driver.
USBD_StatusTypeDef	USBD_DeInit (USBD_HandleTypeDef *pdev)
	USBD_DeInit De-Initialize the device library.
USBD_StatusTypeDef	USBD_RegisterClass (USBD_HandleTypeDef *pdev, USBD_ClassTypeDef *pclass)
	USBD_RegisterClass Link class driver to Device Core.
USBD_StatusTypeDef	USBD_Start (USBD_HandleTypeDef *pdev)
	USBD_Start Start the USB Device Core.
USBD_StatusTypeDef	USBD_Stop (USBD_HandleTypeDef *pdev)
	USBD_Stop Stop the USB Device Core.
USBD_StatusTypeDef	USBD_RunTestMode (USBD_HandleTypeDef *pdev)
	USBD_RunTestMode Launch test mode process.
USBD_StatusTypeDef	USBD_SetClassConfig (USBD_HandleTypeDef *pdev, uint8_t cfgidx)
	USBD_SetClassConfig Configure device and start the interface.
USBD_StatusTypeDef	USBD_ClrClassConfig (USBD_HandleTypeDef *pdev, uint8_t cfgidx)
	USBD_ClrClassConfig Clear current configuration.
USBD_StatusTypeDef	USBD_LL_SetupStage (USBD_HandleTypeDef *pdev, uint8_t *psetup)
	USBD_LL_SetupStage Handle the setup stage.
USBD_StatusTypeDef	USBD_LL_DataOutStage (USBD_HandleTypeDef *pdev, uint8_t epnum, uint8_t *pdata)
	USBD_LL_DataOutStage Handle data OUT stage.
USBD_StatusTypeDef	USBD_LL_DataInStage (USBD_HandleTypeDef *pdev, uint8_t epnum, uint8_t *pdata)
	USBD_LL_DataInStage Handle data in stage.
USBD_StatusTypeDef	USBD_LL_Reset (USBD_HandleTypeDef *pdev)
	USBD_LL_Reset Handle Reset event.
USBD_StatusTypeDef	USBD_LL_SetSpeed (USBD_HandleTypeDef *pdev, USBD_SpeedTypeDef speed)
	USBD_LL_SetSpeed Handle Reset event.
USBD_StatusTypeDef	USBD_LL_Suspend (USBD_HandleTypeDef *pdev)
	USBD_LL_Suspend Handle Suspend event.
USBD_StatusTypeDef	USBD_LL_Resume (USBD_HandleTypeDef *pdev)
	USBD_LL_Resume Handle Resume event.
USBD_StatusTypeDef	USBD_LL_SOF (USBD_HandleTypeDef *pdev)
	USBD_LL_SOF Handle SOF event.
USBD_StatusTypeDef	USBD_LL_IsoINIncomplete (USBD_HandleTypeDef *pdev, uint8_t epnum)
	USBD_LL_IsoINIncomplete Handle iso in incomplete event.
USBD_StatusTypeDef	USBD_LL_IsoOUTIncomplete (USBD_HandleTypeDef *pdev, uint8_t epnum)
	USBD_LL_IsoOUTIncomplete Handle iso out incomplete event.
USBD_StatusTypeDef	USBD_LL_DevConnected (USBD_HandleTypeDef *pdev)
	USBD_LL_DevConnected Handle device connection event.
USBD_StatusTypeDef	USBD_LL_DevDisconnected (USBD_HandleTypeDef *pdev)
	USBD_LL_DevDisconnected Handle device disconnection event.
uint8_t	USBD_CoreFindIF (USBD_HandleTypeDef *pdev, uint8_t index)
	USBD_CoreFindIF return the class index relative to the selected interface.
uint8_t	USBD_CoreFindEP (USBD_HandleTypeDef *pdev, uint8_t index)
	USBD_CoreFindEP return the class index relative to the selected endpoint.
void *	USBD_GetEpDesc (uint8_t *pConfDesc, uint8_t EpAddr)
	USBD_GetEpDesc This function return the Endpoint descriptor.
USBD_DescHeaderTypeDef *	USBD_GetNextDesc (uint8_t *pbuf, uint16_t *ptr)
	USBD_GetNextDesc This function return the next descriptor header.

Detailed Description

Function Documentation

USBD_ClrClassConfig()

USBD_StatusTypeDef USBD_ClrClassConfig	(	USBD_HandleTypeDef *	pdev,
		uint8_t	cfgidx )

USBD_ClrClassConfig Clear current configuration.

Parameters

pdev	device instance
cfgidx	configuration index

Return values

status

Definition at line 505 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _Device_cb::DeInit, NULL, _USBD_HandleTypeDef::pClass, USBD_FAIL, USBD_MAX_SUPPORTED_CLASS, and USBD_OK.

Referenced by USBD_SetConfig().

USBD_CoreFindEP()

uint8_t USBD_CoreFindEP	(	USBD_HandleTypeDef *	pdev,
		uint8_t	index )

USBD_CoreFindEP return the class index relative to the selected endpoint.

Parameters

pdev	device instance
index	: selected endpoint number

Return values

index

of the class using the selected endpoint number. 0xFF if no class found.

Definition at line 1086 of file usbd_core.c.

References NULL, _USBD_HandleTypeDef::pClass, _Device_cb::Setup, UNUSED, and USBD_MAX_SUPPORTED_CLASS.

Referenced by USBD_LL_DataInStage(), USBD_LL_DataOutStage(), and USBD_StdEPReq().

USBD_CoreFindIF()

uint8_t USBD_CoreFindIF	(	USBD_HandleTypeDef *	pdev,
		uint8_t	index )

USBD_CoreFindIF return the class index relative to the selected interface.

Parameters

pdev	device instance
index	: selected interface number

Return values

index

of the class using the selected interface number. OxFF if no class found.

Definition at line 1046 of file usbd_core.c.

References NULL, _USBD_HandleTypeDef::pClass, _Device_cb::Setup, UNUSED, and USBD_MAX_SUPPORTED_CLASS.

Referenced by USBD_LL_DataOutStage(), and USBD_StdItfReq().

USBD_DeInit()

USBD_StatusTypeDef USBD_DeInit

(

USBD_HandleTypeDef *

pdev

)

USBD_DeInit De-Initialize the device library.

Parameters

pdev	device instance

Return values

status

USBD Status

Definition at line 149 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _Device_cb::DeInit, _USBD_HandleTypeDef::dev_config, _USBD_HandleTypeDef::dev_state, NULL, _USBD_HandleTypeDef::pClass, _USBD_HandleTypeDef::pConfDesc, _USBD_HandleTypeDef::pDesc, _USBD_HandleTypeDef::pUserData, USBD_LL_DeInit(), USBD_LL_Stop(), USBD_MAX_SUPPORTED_CLASS, and USBD_STATE_DEFAULT.

USBD_GetEpDesc()

void * USBD_GetEpDesc	(	uint8_t *	pConfDesc,
		uint8_t	EpAddr )

USBD_GetEpDesc This function return the Endpoint descriptor.

Parameters

pdev	device instance
pConfDesc	pointer to Bos descriptor
EpAddr	endpoint address

Return values

pointer

to video endpoint descriptor

Definition at line 1157 of file usbd_core.c.

References NULL, ptr, USB_DESC_TYPE_ENDPOINT, and USBD_GetNextDesc().

Referenced by USBD_CDC_GetFSCfgDesc(), USBD_CDC_GetHSCfgDesc(), and USBD_CDC_GetOtherSpeedCfgDesc().

USBD_GetNextDesc()

USBD_DescHeaderTypeDef * USBD_GetNextDesc	(	uint8_t *	pbuf,
		uint16_t *	ptr )

USBD_GetNextDesc This function return the next descriptor header.

Parameters

buf	Buffer where the descriptor is available
ptr	data pointer inside the descriptor

Return values

next

header

Definition at line 1198 of file usbd_core.c.

References USBD_DescHeaderTypeDef::bLength, and ptr.

Referenced by USBD_GetEpDesc().

USBD_Init()

USBD_StatusTypeDef USBD_Init	(	USBD_HandleTypeDef *	pdev,
		USBD_DescriptorsTypeDef *	pdesc,
		uint8_t	id )

USBD_Init Initialize the device stack and load the class driver.

Parameters

pdev	device instance
pdesc	Descriptor structure address
id	Low level core index

Return values

status

USBD Status

Definition at line 92 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _USBD_HandleTypeDef::dev_state, _USBD_HandleTypeDef::id, NULL, _USBD_HandleTypeDef::NumClasses, _USBD_HandleTypeDef::pClass, _USBD_HandleTypeDef::pConfDesc, _USBD_HandleTypeDef::pDesc, _USBD_HandleTypeDef::pUserData, USBD_ErrLog, USBD_FAIL, USBD_LL_Init(), USBD_MAX_SUPPORTED_CLASS, and USBD_STATE_DEFAULT.

Referenced by MX_USB_DEVICE_Init().

USBD_LL_DataInStage()

USBD_StatusTypeDef USBD_LL_DataInStage	(	USBD_HandleTypeDef *	pdev,
		uint8_t	epnum,
		uint8_t *	pdata )

USBD_LL_DataInStage Handle data in stage.

Parameters

pdev	device instance
epnum	endpoint index
pdata	data pointer

Return values

status

Definition at line 684 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _Device_cb::DataIn, _USBD_HandleTypeDef::dev_state, _USBD_HandleTypeDef::dev_test_mode, _USBD_HandleTypeDef::ep0_data_len, _USBD_HandleTypeDef::ep0_state, _Device_cb::EP0_TxSent, _USBD_HandleTypeDef::ep_in, USBD_EndpointTypeDef::maxpacket, NULL, USBD_EndpointTypeDef::pbuffer, _USBD_HandleTypeDef::pClass, USBD_EndpointTypeDef::rem_length, USBD_EndpointTypeDef::total_length, UNUSED, USBD_CoreFindEP(), USBD_CtlContinueSendData(), USBD_CtlReceiveStatus(), USBD_EP0_DATA_IN, USBD_LL_PrepareReceive(), USBD_LL_StallEP(), USBD_MAX_SUPPORTED_CLASS, USBD_OK, USBD_RunTestMode(), and USBD_STATE_CONFIGURED.

Referenced by HAL_PCD_DataInStageCallback().

USBD_LL_DataOutStage()

USBD_StatusTypeDef USBD_LL_DataOutStage	(	USBD_HandleTypeDef *	pdev,
		uint8_t	epnum,
		uint8_t *	pdata )

USBD_LL_DataOutStage Handle data OUT stage.

Parameters

pdev	device instance
epnum	endpoint index
pdata	data pointer

Return values

status

Definition at line 586 of file usbd_core.c.

References usb_setup_req::bmRequest, _USBD_HandleTypeDef::classId, _Device_cb::DataOut, _USBD_HandleTypeDef::dev_state, _Device_cb::EP0_RxReady, _USBD_HandleTypeDef::ep0_state, _USBD_HandleTypeDef::ep_out, LOBYTE, MAX, USBD_EndpointTypeDef::maxpacket, NULL, USBD_EndpointTypeDef::pbuffer, _USBD_HandleTypeDef::pClass, USBD_EndpointTypeDef::rem_length, _USBD_HandleTypeDef::request, UNUSED, USB_REQ_RECIPIENT_DEVICE, USB_REQ_RECIPIENT_ENDPOINT, USB_REQ_RECIPIENT_INTERFACE, USBD_CoreFindEP(), USBD_CoreFindIF(), USBD_CtlContinueRx(), USBD_CtlSendStatus(), USBD_EP0_DATA_OUT, USBD_MAX_SUPPORTED_CLASS, USBD_OK, USBD_STATE_CONFIGURED, and usb_setup_req::wIndex.

Referenced by HAL_PCD_DataOutStageCallback().

USBD_LL_DevConnected()

USBD_StatusTypeDef USBD_LL_DevConnected

(

USBD_HandleTypeDef *

pdev

)

USBD_LL_DevConnected Handle device connection event.

Parameters

pdev	device instance

Return values

status

Definition at line 987 of file usbd_core.c.

References UNUSED, and USBD_OK.

Referenced by HAL_PCD_ConnectCallback().

USBD_LL_DevDisconnected()

USBD_StatusTypeDef USBD_LL_DevDisconnected

(

USBD_HandleTypeDef *

pdev

)

USBD_LL_DevDisconnected Handle device disconnection event.

Parameters

pdev	device instance

Return values

status

Definition at line 1001 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _Device_cb::DeInit, _USBD_HandleTypeDef::dev_config, _USBD_HandleTypeDef::dev_state, NULL, _USBD_HandleTypeDef::pClass, USBD_FAIL, USBD_MAX_SUPPORTED_CLASS, USBD_OK, and USBD_STATE_DEFAULT.

Referenced by HAL_PCD_DisconnectCallback().

USBD_LL_IsoINIncomplete()

USBD_StatusTypeDef USBD_LL_IsoINIncomplete	(	USBD_HandleTypeDef *	pdev,
		uint8_t	epnum )

USBD_LL_IsoINIncomplete Handle iso in incomplete event.

Parameters

pdev	device instance
epnum	Endpoint number

Return values

status

Definition at line 936 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _USBD_HandleTypeDef::dev_state, _Device_cb::IsoINIncomplete, NULL, _USBD_HandleTypeDef::pClass, USBD_FAIL, USBD_OK, and USBD_STATE_CONFIGURED.

Referenced by HAL_PCD_ISOINIncompleteCallback().

USBD_LL_IsoOUTIncomplete()

USBD_StatusTypeDef USBD_LL_IsoOUTIncomplete	(	USBD_HandleTypeDef *	pdev,
		uint8_t	epnum )

USBD_LL_IsoOUTIncomplete Handle iso out incomplete event.

Parameters

pdev	device instance
epnum	Endpoint number

Return values

status

Definition at line 962 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _USBD_HandleTypeDef::dev_state, _Device_cb::IsoOUTIncomplete, NULL, _USBD_HandleTypeDef::pClass, USBD_FAIL, USBD_OK, and USBD_STATE_CONFIGURED.

Referenced by HAL_PCD_ISOOUTIncompleteCallback().

USBD_LL_Reset()

USBD_StatusTypeDef USBD_LL_Reset

(

USBD_HandleTypeDef *

pdev

)

USBD_LL_Reset Handle Reset event.

Parameters

pdev	device instance

Return values

status

Definition at line 777 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _Device_cb::DeInit, _USBD_HandleTypeDef::dev_config, _USBD_HandleTypeDef::dev_remote_wakeup, _USBD_HandleTypeDef::dev_state, _USBD_HandleTypeDef::dev_test_mode, _USBD_HandleTypeDef::ep0_state, _USBD_HandleTypeDef::ep_in, _USBD_HandleTypeDef::ep_out, USBD_EndpointTypeDef::is_used, USBD_EndpointTypeDef::maxpacket, NULL, _USBD_HandleTypeDef::pClass, USB_MAX_EP0_SIZE, USBD_EP0_IDLE, USBD_EP_TYPE_CTRL, USBD_FAIL, USBD_LL_OpenEP(), USBD_MAX_SUPPORTED_CLASS, USBD_OK, and USBD_STATE_DEFAULT.

Referenced by HAL_PCD_ResetCallback().

USBD_LL_Resume()

USBD_StatusTypeDef USBD_LL_Resume

(

USBD_HandleTypeDef *

pdev

)

USBD_LL_Resume Handle Resume event.

Parameters

pdev	device instance

Return values

status

Definition at line 877 of file usbd_core.c.

References _USBD_HandleTypeDef::dev_old_state, _USBD_HandleTypeDef::dev_state, USBD_OK, and USBD_STATE_SUSPENDED.

Referenced by HAL_PCD_ResumeCallback().

USBD_LL_SetSpeed()

USBD_StatusTypeDef USBD_LL_SetSpeed	(	USBD_HandleTypeDef *	pdev,
		USBD_SpeedTypeDef	speed )

USBD_LL_SetSpeed Handle Reset event.

Parameters

pdev	device instance

Return values

status

Definition at line 845 of file usbd_core.c.

References _USBD_HandleTypeDef::dev_speed, and USBD_OK.

Referenced by HAL_PCD_ResetCallback().

USBD_LL_SetupStage()

USBD_StatusTypeDef USBD_LL_SetupStage	(	USBD_HandleTypeDef *	pdev,
		uint8_t *	psetup )

USBD_LL_SetupStage Handle the setup stage.

Parameters

pdev	device instance
psetup	setup packet buffer pointer

Return values

status

Definition at line 546 of file usbd_core.c.

References usb_setup_req::bmRequest, _USBD_HandleTypeDef::ep0_data_len, _USBD_HandleTypeDef::ep0_state, _USBD_HandleTypeDef::request, USB_REQ_RECIPIENT_DEVICE, USB_REQ_RECIPIENT_ENDPOINT, USB_REQ_RECIPIENT_INTERFACE, USBD_EP0_SETUP, USBD_LL_StallEP(), USBD_ParseSetupRequest(), USBD_StdDevReq(), USBD_StdEPReq(), USBD_StdItfReq(), and usb_setup_req::wLength.

Referenced by HAL_PCD_SetupStageCallback().

USBD_LL_SOF()

USBD_StatusTypeDef USBD_LL_SOF

(

USBD_HandleTypeDef *

pdev

)

USBD_LL_SOF Handle SOF event.

Parameters

pdev	device instance

Return values

status

Definition at line 893 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _USBD_HandleTypeDef::dev_state, NULL, _USBD_HandleTypeDef::pClass, _Device_cb::SOF, USBD_MAX_SUPPORTED_CLASS, USBD_OK, and USBD_STATE_CONFIGURED.

Referenced by HAL_PCD_SOFCallback().

USBD_LL_Suspend()

USBD_StatusTypeDef USBD_LL_Suspend

(

USBD_HandleTypeDef *

pdev

)

USBD_LL_Suspend Handle Suspend event.

Parameters

pdev	device instance

Return values

status

Definition at line 859 of file usbd_core.c.

References _USBD_HandleTypeDef::dev_old_state, _USBD_HandleTypeDef::dev_state, USBD_OK, and USBD_STATE_SUSPENDED.

Referenced by HAL_PCD_SuspendCallback().

USBD_RegisterClass()

USBD_StatusTypeDef USBD_RegisterClass	(	USBD_HandleTypeDef *	pdev,
		USBD_ClassTypeDef *	pclass )

USBD_RegisterClass Link class driver to Device Core.

Parameters

pdev	Device Handle
pclass	Class handle

Return values

USBD

Status

Definition at line 202 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _Device_cb::GetFSConfigDescriptor, _Device_cb::GetHSConfigDescriptor, NULL, _USBD_HandleTypeDef::NumClasses, _USBD_HandleTypeDef::pClass, _USBD_HandleTypeDef::pConfDesc, USBD_ErrLog, USBD_FAIL, and USBD_OK.

Referenced by MX_USB_DEVICE_Init().

USBD_RunTestMode()

USBD_StatusTypeDef USBD_RunTestMode

(

USBD_HandleTypeDef *

pdev

)

USBD_RunTestMode Launch test mode process.

Parameters

pdev	device instance

Return values

status

Definition at line 440 of file usbd_core.c.

References _USBD_HandleTypeDef::dev_test_mode, UNUSED, and USBD_OK.

Referenced by USBD_LL_DataInStage().

USBD_SetClassConfig()

USBD_StatusTypeDef USBD_SetClassConfig	(	USBD_HandleTypeDef *	pdev,
		uint8_t	cfgidx )

USBD_SetClassConfig Configure device and start the interface.

Parameters

pdev	device instance
cfgidx	configuration index

Return values

status

Definition at line 465 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _Device_cb::Init, NULL, _USBD_HandleTypeDef::pClass, USBD_FAIL, USBD_MAX_SUPPORTED_CLASS, and USBD_OK.

Referenced by USBD_SetConfig().

USBD_Start()

USBD_StatusTypeDef USBD_Start

(

USBD_HandleTypeDef *

pdev

)

USBD_Start Start the USB Device Core.

Parameters

pdev	Device Handle

Return values

USBD

Status

Definition at line 384 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, and USBD_LL_Start().

Referenced by MX_USB_DEVICE_Init().

USBD_Stop()

USBD_StatusTypeDef USBD_Stop

(

USBD_HandleTypeDef *

pdev

)

USBD_Stop Stop the USB Device Core.

Parameters

pdev	Device Handle

Return values

USBD

Status

Definition at line 400 of file usbd_core.c.

References _USBD_HandleTypeDef::classId, _Device_cb::DeInit, _USBD_HandleTypeDef::dev_config, NULL, _USBD_HandleTypeDef::pClass, USBD_LL_Stop(), USBD_MAX_SUPPORTED_CLASS, and USBD_OK.