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.

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

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

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

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

void	HAL_HCD_SOF_Callback (HCD_HandleTypeDef *hhcd)
	SOF callback.

void	HAL_HCD_Connect_Callback (HCD_HandleTypeDef *hhcd)
	Connection Event callback.

void	HAL_HCD_Disconnect_Callback (HCD_HandleTypeDef *hhcd)
	Disconnection Event callback.

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

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

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

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_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 )

#include <stm32f4xx_hal_hcd.h>

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.

References HCD_HandleTypeDef::hc, HCD_HandleTypeDef::Init, and HCD_HandleTypeDef::Instance.

◆ HAL_HCD_HC_SetHubInfo()

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

#include <stm32f4xx_hal_hcd.h>

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.

References HAL_OK, HCD_HandleTypeDef::hc, HCD_DEVICE_SPEED_HIGH, and HCD_HandleTypeDef::Instance.

◆ HAL_HCD_HC_ClearHubInfo()

HAL_StatusTypeDef HAL_HCD_HC_ClearHubInfo	(	HCD_HandleTypeDef *	hhcd,
		uint8_t	ch_num )

#include <stm32f4xx_hal_hcd.h>

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.

References HAL_OK, and HCD_HandleTypeDef::hc.

Referenced by HAL_HCD_HC_Init().

◆ HAL_HCD_IRQHandler()

void HAL_HCD_IRQHandler ( HCD_HandleTypeDef * hhcd )

#include <stm32f4xx_hal_hcd.h>

Handle HCD interrupt request.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 538 of file stm32f4xx_hal_hcd.c.

References __HAL_HCD_CLEAR_FLAG, __HAL_HCD_GET_FLAG, __HAL_HCD_IS_INVALID_INTERRUPT, HAL_HCD_Disconnect_Callback(), HAL_HCD_SOF_Callback(), HCD_HC_IN_IRQHandler(), HCD_HC_OUT_IRQHandler(), HCD_Port_IRQHandler(), HCD_RXQLVL_IRQHandler(), HCD_HandleTypeDef::Init, and HCD_HandleTypeDef::Instance.

◆ HAL_HCD_WKUP_IRQHandler()

void HAL_HCD_WKUP_IRQHandler ( HCD_HandleTypeDef * hhcd )

#include <stm32f4xx_hal_hcd.h>

Handles HCD Wakeup interrupt request.

Parameters

hhcd	HCD handle

Return values

HAL status

Definition at line 661 of file stm32f4xx_hal_hcd.c.

References UNUSED.

◆ HAL_HCD_SOF_Callback()

__weak void HAL_HCD_SOF_Callback ( HCD_HandleTypeDef * hhcd )

#include <stm32f4xx_hal_hcd.h>

SOF callback.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 672 of file stm32f4xx_hal_hcd.c.

References UNUSED.

Referenced by HAL_HCD_Init(), and HAL_HCD_IRQHandler().

◆ HAL_HCD_Connect_Callback()

__weak void HAL_HCD_Connect_Callback ( HCD_HandleTypeDef * hhcd )

#include <stm32f4xx_hal_hcd.h>

Connection Event callback.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 687 of file stm32f4xx_hal_hcd.c.

References UNUSED.

Referenced by HAL_HCD_Init(), and HCD_Port_IRQHandler().

◆ HAL_HCD_Disconnect_Callback()

__weak void HAL_HCD_Disconnect_Callback ( HCD_HandleTypeDef * hhcd )

#include <stm32f4xx_hal_hcd.h>

Disconnection Event callback.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 702 of file stm32f4xx_hal_hcd.c.

References UNUSED.

Referenced by HAL_HCD_Init(), and HAL_HCD_IRQHandler().

◆ HAL_HCD_PortEnabled_Callback()

__weak void HAL_HCD_PortEnabled_Callback ( HCD_HandleTypeDef * hhcd )

#include <stm32f4xx_hal_hcd.h>

Port Enabled Event callback.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 717 of file stm32f4xx_hal_hcd.c.

References UNUSED.

Referenced by HAL_HCD_Init(), and HCD_Port_IRQHandler().

◆ HAL_HCD_PortDisabled_Callback()

__weak void HAL_HCD_PortDisabled_Callback ( HCD_HandleTypeDef * hhcd )

#include <stm32f4xx_hal_hcd.h>

Port Disabled Event callback.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 732 of file stm32f4xx_hal_hcd.c.

References UNUSED.

Referenced by HAL_HCD_Init(), and HCD_Port_IRQHandler().

◆ HAL_HCD_HC_NotifyURBChange_Callback()

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

#include <stm32f4xx_hal_hcd.h>

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.

References UNUSED.

Referenced by HAL_HCD_Init(), HCD_HC_IN_IRQHandler(), and HCD_HC_OUT_IRQHandler().

Functions

Detailed Description

Function Documentation

◆ HAL_HCD_HC_SubmitRequest()

◆ HAL_HCD_HC_SetHubInfo()

◆ HAL_HCD_HC_ClearHubInfo()

◆ HAL_HCD_IRQHandler()

◆ HAL_HCD_WKUP_IRQHandler()

◆ HAL_HCD_SOF_Callback()

◆ HAL_HCD_Connect_Callback()

◆ HAL_HCD_Disconnect_Callback()

◆ HAL_HCD_PortEnabled_Callback()

◆ HAL_HCD_PortDisabled_Callback()

◆ HAL_HCD_HC_NotifyURBChange_Callback()