Peripheral Control functions

Functions
HAL_StatusTypeDef	HAL_PCD_SetAddress (PCD_HandleTypeDef *hpcd, uint8_t address)
	Set the USB Device address. More...
HAL_StatusTypeDef	HAL_PCD_EP_Open (PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint16_t ep_mps, uint8_t ep_type)
	Open and configure an endpoint. More...
HAL_StatusTypeDef	HAL_PCD_EP_Close (PCD_HandleTypeDef *hpcd, uint8_t ep_addr)
	Deactivate an endpoint. More...
HAL_StatusTypeDef	HAL_PCD_EP_Prepare_Receive (PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len)
	Prepare to receive an amount of data. More...
uint32_t	HAL_PCD_EP_Receive (PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf)
	Receive an amount of data. More...
HAL_StatusTypeDef	HAL_PCD_EP_Transmit (PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len)
	Send an amount of data. More...
uint16_t	HAL_PCD_EP_GetRxCount (PCD_HandleTypeDef *hpcd, uint8_t ep_addr)
	Get Received Data Size. More...
HAL_StatusTypeDef	HAL_PCD_EP_SetStall (PCD_HandleTypeDef *hpcd, uint8_t ep_addr)
	Set a STALL condition over an endpoint. More...
HAL_StatusTypeDef	HAL_PCD_EP_ClrStall (PCD_HandleTypeDef *hpcd, uint8_t ep_addr)
	Clear a STALL condition over in an endpoint. More...
HAL_StatusTypeDef	HAL_PCD_EP_Flush (PCD_HandleTypeDef *hpcd, uint8_t ep_addr)
	Flush an endpoint. More...

Detailed Description

Function Documentation

HAL_PCD_EP_Close()

HAL_StatusTypeDef HAL_PCD_EP_Close	(	PCD_HandleTypeDef *	hpcd,
		uint8_t	ep_addr
	)

Deactivate an endpoint.

Parameters

hpcd	PCD handle
ep_addr	endpoint address

Return values

HAL

status

HAL_PCD_EP_ClrStall()

HAL_StatusTypeDef HAL_PCD_EP_ClrStall	(	PCD_HandleTypeDef *	hpcd,
		uint8_t	ep_addr
	)

Clear a STALL condition over in an endpoint.

Parameters

hpcd	PCD handle
ep_addr	endpoint address

Return values

HAL

status

HAL_PCD_EP_Flush()

HAL_StatusTypeDef HAL_PCD_EP_Flush	(	PCD_HandleTypeDef *	hpcd,
		uint8_t	ep_addr
	)

Flush an endpoint.

Parameters

hpcd	PCD handle
ep_addr	endpoint address

Return values

HAL

status

HAL_PCD_EP_GetRxCount()

uint16_t HAL_PCD_EP_GetRxCount	(	PCD_HandleTypeDef *	hpcd,
		uint8_t	ep_addr
	)

Get Received Data Size.

Parameters

hpcd	PCD handle
ep_addr	endpoint address

Return values

Data

Size

HAL_PCD_EP_Open()

HAL_StatusTypeDef HAL_PCD_EP_Open	(	PCD_HandleTypeDef *	hpcd,
		uint8_t	ep_addr,
		uint16_t	ep_mps,
		uint8_t	ep_type
	)

Open and configure an endpoint.

Parameters

hpcd	PCD handle
ep_addr	endpoint address
ep_mps	endpoint max packert size
ep_type	endpoint type

Return values

HAL

status

HAL_PCD_EP_Prepare_Receive()

HAL_StatusTypeDef HAL_PCD_EP_Prepare_Receive	(	PCD_HandleTypeDef *	hpcd,
		uint8_t	ep_addr,
		uint8_t *	pBuf,
		uint32_t	len
	)

Prepare to receive an amount of data.

Parameters

hpcd	PCD handle
ep_addr	endpoint address
pBuf	pointer to the reception buffer
len	amount of data to be received

Return values

HAL

status

HAL_PCD_EP_Receive()

uint32_t HAL_PCD_EP_Receive	(	PCD_HandleTypeDef *	hpcd,
		uint8_t	ep_addr,
		uint8_t *	pBuf
	)

Receive an amount of data.

Parameters

hpcd	PCD handle
ep_addr	endpoint address
pBuf	pointer to the reception buffer

Return values

received

packet size.

HAL_PCD_EP_SetStall()

HAL_StatusTypeDef HAL_PCD_EP_SetStall	(	PCD_HandleTypeDef *	hpcd,
		uint8_t	ep_addr
	)

Set a STALL condition over an endpoint.

Parameters

hpcd	PCD handle
ep_addr	endpoint address

Return values

HAL

status

HAL_PCD_EP_Transmit()

HAL_StatusTypeDef HAL_PCD_EP_Transmit	(	PCD_HandleTypeDef *	hpcd,
		uint8_t	ep_addr,
		uint8_t *	pBuf,
		uint32_t	len
	)

Send an amount of data.

Parameters

hpcd	PCD handle
ep_addr	endpoint address
pBuf	pointer to the transmission buffer
len	amount of data to be sent

Return values

HAL

status

HAL_PCD_SetAddress()

HAL_StatusTypeDef HAL_PCD_SetAddress	(	PCD_HandleTypeDef *	hpcd,
		uint8_t	address
	)

Set the USB Device address.

Parameters

hpcd	PCD handle
address	new device address

Return values

HAL

status