HCD IO operation functions. More...

Collaboration diagram for Input and Output operation functions:

Functions
HAL_StatusTypeDef	HAL_HCD_HC_SubmitRequest (HCD_HandleTypeDef hhcd, uint8_t ch_num, uint8_t direction, uint8_t ep_type, uint8_t token, uint8_t pbuff, uint16_t length, uint8_t do_ping)
	Submit a new URB for processing. More...

HAL_StatusTypeDef	HAL_HCD_HC_SetHubInfo (HCD_HandleTypeDef *hhcd, uint8_t ch_num, uint8_t addr, uint8_t PortNbr)
	Set host channel Hub information. More...

HAL_StatusTypeDef	HAL_HCD_HC_ClearHubInfo (HCD_HandleTypeDef *hhcd, uint8_t ch_num)
	Clear host channel hub information. More...

void	HAL_HCD_IRQHandler (HCD_HandleTypeDef *hhcd)
	Handle HCD interrupt request. More...

void	HAL_HCD_WKUP_IRQHandler (HCD_HandleTypeDef *hhcd)
	Handles HCD Wakeup interrupt request. More...

void	HAL_HCD_SOF_Callback (HCD_HandleTypeDef *hhcd)
	SOF callback. More...

void	HAL_HCD_Connect_Callback (HCD_HandleTypeDef *hhcd)
	Connection Event callback. More...

void	HAL_HCD_Disconnect_Callback (HCD_HandleTypeDef *hhcd)
	Disconnection Event callback. More...

void	HAL_HCD_PortEnabled_Callback (HCD_HandleTypeDef *hhcd)
	Port Enabled Event callback. More...

void	HAL_HCD_PortDisabled_Callback (HCD_HandleTypeDef *hhcd)
	Port Disabled Event callback. More...

void	HAL_HCD_HC_NotifyURBChange_Callback (HCD_HandleTypeDef *hhcd, uint8_t chnum, HCD_URBStateTypeDef urb_state)
	Notify URB state change callback. More...

HAL_StatusTypeDef	HAL_HCD_RegisterCallback (HCD_HandleTypeDef *hhcd, HAL_HCD_CallbackIDTypeDef CallbackID, pHCD_CallbackTypeDef pCallback)
	Register a User USB HCD Callback To be used instead of the weak predefined callback. More...

HAL_StatusTypeDef	HAL_HCD_UnRegisterCallback (HCD_HandleTypeDef *hhcd, HAL_HCD_CallbackIDTypeDef CallbackID)
	Unregister an USB HCD Callback USB HCD callback is redirected to the weak predefined callback. More...

HAL_StatusTypeDef	HAL_HCD_RegisterHC_NotifyURBChangeCallback (HCD_HandleTypeDef *hhcd, pHCD_HC_NotifyURBChangeCallbackTypeDef pCallback)
	Register USB HCD Host Channel Notify URB Change Callback To be used instead of the weak HAL_HCD_HC_NotifyURBChange_Callback() predefined callback. More...

HAL_StatusTypeDef	HAL_HCD_UnRegisterHC_NotifyURBChangeCallback (HCD_HandleTypeDef *hhcd)
	Unregister the USB HCD Host Channel Notify URB Change Callback USB HCD Host Channel Notify URB Change Callback is redirected to the weak HAL_HCD_HC_NotifyURBChange_Callback() predefined callback. More...

Detailed Description

HCD IO operation functions.

 ===============================================================================
                      ##### IO operation functions #####
 ===============================================================================
 [..] This subsection provides a set of functions allowing to manage the USB Host Data
    Transfer

Function Documentation

◆ HAL_HCD_Connect_Callback()

__weak void HAL_HCD_Connect_Callback ( HCD_HandleTypeDef * hhcd )

Connection Event callback.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 687 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_Disconnect_Callback()

__weak void HAL_HCD_Disconnect_Callback ( HCD_HandleTypeDef * hhcd )

Disconnection Event callback.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 702 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_HC_ClearHubInfo()

HAL_StatusTypeDef HAL_HCD_HC_ClearHubInfo	(	HCD_HandleTypeDef *	hhcd,
		uint8_t	ch_num
	)

Clear host channel hub information.

Parameters

hhcd	HCD handle
ch_num	Channel number. This parameter can be a value from 1 to 15

Return values

HAL status

Definition at line 1253 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_HC_NotifyURBChange_Callback()

__weak void HAL_HCD_HC_NotifyURBChange_Callback	(	HCD_HandleTypeDef *	hhcd,
		uint8_t	chnum,
		HCD_URBStateTypeDef	urb_state
	)

Notify URB state change callback.

Parameters

hhcd	HCD handle
chnum	Channel number. This parameter can be a value from 1 to 15
urb_state	This parameter can be one of these values: URB_IDLE/ URB_DONE/ URB_NOTREADY/ URB_NYET/ URB_ERROR/ URB_STALL/

Return values

None

Definition at line 757 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_HC_SetHubInfo()

HAL_StatusTypeDef HAL_HCD_HC_SetHubInfo	(	HCD_HandleTypeDef *	hhcd,
		uint8_t	ch_num,
		uint8_t	addr,
		uint8_t	PortNbr
	)

Set host channel Hub information.

Parameters

hhcd	HCD handle
ch_num	Channel number. This parameter can be a value from 1 to 15
addr	Hub address
PortNbr	Hub port number

Return values

HAL status

Definition at line 1223 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_HC_SubmitRequest()

HAL_StatusTypeDef HAL_HCD_HC_SubmitRequest	(	HCD_HandleTypeDef *	hhcd,
		uint8_t	ch_num,
		uint8_t	direction,
		uint8_t	ep_type,
		uint8_t	token,
		uint8_t *	pbuff,
		uint16_t	length,
		uint8_t	do_ping
	)

Submit a new URB for processing.

Parameters

hhcd	HCD handle
ch_num	Channel number. This parameter can be a value from 1 to 15
direction	Channel number. This parameter can be one of these values: 0 : Output / 1 : Input
ep_type	Endpoint Type. This parameter can be one of these values: EP_TYPE_CTRL: Control type/ EP_TYPE_ISOC: Isochronous type/ EP_TYPE_BULK: Bulk type/ EP_TYPE_INTR: Interrupt type/
token	Endpoint Type. This parameter can be one of these values: 0: HC_PID_SETUP / 1: HC_PID_DATA1
pbuff	pointer to URB data
length	Length of URB data
do_ping	activate do ping protocol (for high speed only). This parameter can be one of these values: 0 : do ping inactive / 1 : do ping active

Return values

HAL status

Definition at line 394 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_IRQHandler()

void HAL_HCD_IRQHandler ( HCD_HandleTypeDef * hhcd )

Handle HCD interrupt request.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 538 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_PortDisabled_Callback()

__weak void HAL_HCD_PortDisabled_Callback ( HCD_HandleTypeDef * hhcd )

Port Disabled Event callback.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 732 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_PortEnabled_Callback()

__weak void HAL_HCD_PortEnabled_Callback ( HCD_HandleTypeDef * hhcd )

Port Enabled Event callback.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 717 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_RegisterCallback()

HAL_StatusTypeDef HAL_HCD_RegisterCallback	(	HCD_HandleTypeDef *	hhcd,
		HAL_HCD_CallbackIDTypeDef	CallbackID,
		pHCD_CallbackTypeDef	pCallback
	)

Register a User USB HCD Callback To be used instead of the weak predefined callback.

Parameters

hhcd	USB HCD handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_HCD_SOF_CB_ID USB HCD SOF callback ID HAL_HCD_CONNECT_CB_ID USB HCD Connect callback ID HAL_HCD_DISCONNECT_CB_ID OTG HCD Disconnect callback ID HAL_HCD_PORT_ENABLED_CB_ID USB HCD Port Enable callback ID HAL_HCD_PORT_DISABLED_CB_ID USB HCD Port Disable callback ID HAL_HCD_MSPINIT_CB_ID MspDeInit callback ID HAL_HCD_MSPDEINIT_CB_ID MspDeInit callback ID
pCallback	pointer to the Callback function

Return values

HAL status

Definition at line 786 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_RegisterHC_NotifyURBChangeCallback()

HAL_StatusTypeDef HAL_HCD_RegisterHC_NotifyURBChangeCallback	(	HCD_HandleTypeDef *	hhcd,
		pHCD_HC_NotifyURBChangeCallbackTypeDef	pCallback
	)

Register USB HCD Host Channel Notify URB Change Callback To be used instead of the weak HAL_HCD_HC_NotifyURBChange_Callback() predefined callback.

Parameters

hhcd	HCD handle
pCallback	pointer to the USB HCD Host Channel Notify URB Change Callback function

Return values

HAL status

Definition at line 980 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_SOF_Callback()

__weak void HAL_HCD_SOF_Callback ( HCD_HandleTypeDef * hhcd )

SOF callback.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 672 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_UnRegisterCallback()

HAL_StatusTypeDef HAL_HCD_UnRegisterCallback	(	HCD_HandleTypeDef *	hhcd,
		HAL_HCD_CallbackIDTypeDef	CallbackID
	)

Unregister an USB HCD Callback USB HCD callback is redirected to the weak predefined callback.

Parameters

hhcd USB HCD handle

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values:

HAL_HCD_SOF_CB_ID USB HCD SOF callback ID
HAL_HCD_CONNECT_CB_ID USB HCD Connect callback ID
HAL_HCD_DISCONNECT_CB_ID OTG HCD Disconnect callback ID
HAL_HCD_PORT_ENABLED_CB_ID USB HCD Port Enabled callback ID
HAL_HCD_PORT_DISABLED_CB_ID USB HCD Port Disabled callback ID
HAL_HCD_MSPINIT_CB_ID MspDeInit callback ID
HAL_HCD_MSPDEINIT_CB_ID MspDeInit callback ID

Return values

HAL status

Definition at line 889 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_UnRegisterHC_NotifyURBChangeCallback()

HAL_StatusTypeDef HAL_HCD_UnRegisterHC_NotifyURBChangeCallback ( HCD_HandleTypeDef * hhcd )

Unregister the USB HCD Host Channel Notify URB Change Callback USB HCD Host Channel Notify URB Change Callback is redirected to the weak HAL_HCD_HC_NotifyURBChange_Callback() predefined callback.

Parameters

hhcd	HCD handle

Return values

HAL status

Definition at line 1022 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_WKUP_IRQHandler()

void HAL_HCD_WKUP_IRQHandler ( HCD_HandleTypeDef * hhcd )

Handles HCD Wakeup interrupt request.

Parameters

hhcd	HCD handle

Return values

HAL status

Definition at line 661 of file stm32f4xx_hal_hcd.c.

Functions

Detailed Description

Function Documentation

◆ HAL_HCD_Connect_Callback()

◆ HAL_HCD_Disconnect_Callback()

◆ HAL_HCD_HC_ClearHubInfo()

◆ HAL_HCD_HC_NotifyURBChange_Callback()

◆ HAL_HCD_HC_SetHubInfo()

◆ HAL_HCD_HC_SubmitRequest()

◆ HAL_HCD_IRQHandler()

◆ HAL_HCD_PortDisabled_Callback()

◆ HAL_HCD_PortEnabled_Callback()

◆ HAL_HCD_RegisterCallback()

◆ HAL_HCD_RegisterHC_NotifyURBChangeCallback()

◆ HAL_HCD_SOF_Callback()

◆ HAL_HCD_UnRegisterCallback()

◆ HAL_HCD_UnRegisterHC_NotifyURBChangeCallback()

◆ HAL_HCD_WKUP_IRQHandler()