Peripheral State functions

Peripheral State functions. More...

Collaboration diagram for Peripheral State functions:

Functions
HCD_StateTypeDef	HAL_HCD_GetState (HCD_HandleTypeDef const *hhcd)
	Return the HCD handle state. More...
HCD_URBStateTypeDef	HAL_HCD_HC_GetURBState (HCD_HandleTypeDef const *hhcd, uint8_t chnum)
	Return URB state for a channel. More...
HCD_HCStateTypeDef	HAL_HCD_HC_GetState (HCD_HandleTypeDef const *hhcd, uint8_t chnum)
	Return the Host Channel state. More...
uint32_t	HAL_HCD_HC_GetXferCount (HCD_HandleTypeDef const *hhcd, uint8_t chnum)
	Return the last host transfer size. More...
uint32_t	HAL_HCD_GetCurrentFrame (HCD_HandleTypeDef *hhcd)
	Return the current Host frame number. More...
uint32_t	HAL_HCD_GetCurrentSpeed (HCD_HandleTypeDef *hhcd)
	Return the Host enumeration speed. 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...

Detailed Description

Peripheral State functions.

 ===============================================================================
                      ##### Peripheral State functions #####
 ===============================================================================
    [..]
    This subsection permits to get in run-time the status of the peripheral
    and the data flow.

Function Documentation

HAL_HCD_GetCurrentFrame()

uint32_t HAL_HCD_GetCurrentFrame

(

HCD_HandleTypeDef *

hhcd

)

Return the current Host frame number.

Parameters

hhcd	HCD handle

Return values

Current

Host frame number

Definition at line 1199 of file stm32f4xx_hal_hcd.c.

HAL_HCD_GetCurrentSpeed()

uint32_t HAL_HCD_GetCurrentSpeed

(

HCD_HandleTypeDef *

hhcd

)

Return the Host enumeration speed.

Parameters

hhcd	HCD handle

Return values

Enumeration

speed

Definition at line 1209 of file stm32f4xx_hal_hcd.c.

HAL_HCD_GetState()

HCD_StateTypeDef HAL_HCD_GetState

(

HCD_HandleTypeDef const *

hhcd

)

Return the HCD handle state.

Parameters

hhcd	HCD handle

Return values

HAL

state

Definition at line 1135 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_GetState()

HCD_HCStateTypeDef HAL_HCD_HC_GetState	(	HCD_HandleTypeDef const *	hhcd,
		uint8_t	chnum
	)

Return the Host Channel state.

Parameters

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

Return values

Host	channel state This parameter can be one of these values: HC_IDLE/ HC_XFRC/ HC_HALTED/ HC_NYET/ HC_NAK/ HC_STALL/ HC_XACTERR/ HC_BBLERR/ HC_DATATGLERR

Definition at line 1189 of file stm32f4xx_hal_hcd.c.

HAL_HCD_HC_GetURBState()

HCD_URBStateTypeDef HAL_HCD_HC_GetURBState	(	HCD_HandleTypeDef const *	hhcd,
		uint8_t	chnum
	)

Return URB state for a channel.

Parameters

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

Return values

URB	state. This parameter can be one of these values: URB_IDLE/ URB_DONE/ URB_NOTREADY/ URB_NYET/ URB_ERROR/ URB_STALL

Definition at line 1154 of file stm32f4xx_hal_hcd.c.

HAL_HCD_HC_GetXferCount()

uint32_t HAL_HCD_HC_GetXferCount	(	HCD_HandleTypeDef const *	hhcd,
		uint8_t	chnum
	)

Return the last host transfer size.

Parameters

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

Return values

last	transfer size in byte

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