Initialization and Configuration functions. More...

Collaboration diagram for Initialization and de-initialization functions:

Modules
	HAL USB OTG HCD Callback ID enumeration definition
	HAL USB OTG HCD Callback ID enumeration definition.

	HAL USB OTG HCD Callback pointer definition
	HAL USB OTG HCD Callback pointer definition.

Functions
HAL_StatusTypeDef	HAL_HCD_Init (HCD_HandleTypeDef *hhcd)
	Initialize the host driver. More...

HAL_StatusTypeDef	HAL_HCD_DeInit (HCD_HandleTypeDef *hhcd)
	DeInitialize the host driver. More...

HAL_StatusTypeDef	HAL_HCD_HC_Init (HCD_HandleTypeDef *hhcd, uint8_t ch_num, uint8_t epnum, uint8_t dev_address, uint8_t speed, uint8_t ep_type, uint16_t mps)
	Initialize a host channel. More...

HAL_StatusTypeDef	HAL_HCD_HC_Halt (HCD_HandleTypeDef *hhcd, uint8_t ch_num)
	Halt a host channel. More...

void	HAL_HCD_MspInit (HCD_HandleTypeDef *hhcd)
	Initialize the HCD MSP. More...

void	HAL_HCD_MspDeInit (HCD_HandleTypeDef *hhcd)
	DeInitialize the HCD MSP. 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

Initialization and Configuration functions.

 ===============================================================================
          ##### Initialization and de-initialization functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:

Function Documentation

◆ HAL_HCD_DeInit()

HAL_StatusTypeDef HAL_HCD_DeInit ( HCD_HandleTypeDef * hhcd )

DeInitialize the host driver.

Parameters

hhcd	HCD handle

Return values

HAL status

Definition at line 292 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_HC_Halt()

HAL_StatusTypeDef HAL_HCD_HC_Halt	(	HCD_HandleTypeDef *	hhcd,
		uint8_t	ch_num
	)

Halt a host channel.

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 276 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_HC_Init()

HAL_StatusTypeDef HAL_HCD_HC_Init	(	HCD_HandleTypeDef *	hhcd,
		uint8_t	ch_num,
		uint8_t	epnum,
		uint8_t	dev_address,
		uint8_t	speed,
		uint8_t	ep_type,
		uint16_t	mps
	)

Initialize a host channel.

Parameters

hhcd	HCD handle
ch_num	Channel number. This parameter can be a value from 1 to 15
epnum	Endpoint number. This parameter can be a value from 1 to 15
dev_address	Current device address This parameter can be a value from 0 to 255
speed	Current device speed. This parameter can be one of these values: HCD_DEVICE_SPEED_HIGH: High speed mode, HCD_DEVICE_SPEED_FULL: Full speed mode, HCD_DEVICE_SPEED_LOW: Low speed mode
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
mps	Max Packet Size. This parameter can be a value from 0 to32K

Return values

HAL status

Definition at line 218 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_Init()

HAL_StatusTypeDef HAL_HCD_Init ( HCD_HandleTypeDef * hhcd )

Initialize the host driver.

Parameters

hhcd	HCD handle

Return values

HAL status

Definition at line 110 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_MspDeInit()

__weak void HAL_HCD_MspDeInit ( HCD_HandleTypeDef * hhcd )

DeInitialize the HCD MSP.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 342 of file stm32f4xx_hal_hcd.c.

◆ HAL_HCD_MspInit()

__weak void HAL_HCD_MspInit ( HCD_HandleTypeDef * hhcd )

Initialize the HCD MSP.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 327 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_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.

Modules

Functions

Detailed Description

Function Documentation

◆ HAL_HCD_DeInit()

◆ HAL_HCD_HC_Halt()

◆ HAL_HCD_HC_Init()

◆ HAL_HCD_Init()

◆ HAL_HCD_MspDeInit()

◆ HAL_HCD_MspInit()

◆ HAL_HCD_RegisterCallback()

◆ HAL_HCD_RegisterHC_NotifyURBChangeCallback()

◆ HAL_HCD_UnRegisterCallback()

◆ HAL_HCD_UnRegisterHC_NotifyURBChangeCallback()