Initialization and de-initialization functions

Initialization and Configuration functions. More...

Modules
	HAL USB OTG PCD Callback ID enumeration definition
	HAL USB OTG PCD Callback ID enumeration definition.
	HAL USB OTG PCD Callback pointer definition
	HAL USB OTG PCD Callback pointer definition.
Functions
HAL_StatusTypeDef	HAL_PCD_Init (PCD_HandleTypeDef *hpcd)
	Initializes the PCD according to the specified parameters in the PCD_InitTypeDef and initialize the associated handle.
HAL_StatusTypeDef	HAL_PCD_DeInit (PCD_HandleTypeDef *hpcd)
	DeInitializes the PCD peripheral.
__weak void	HAL_PCD_MspInit (PCD_HandleTypeDef *hpcd)
	Initializes the PCD MSP.
__weak void	HAL_PCD_MspDeInit (PCD_HandleTypeDef *hpcd)
	DeInitializes PCD MSP.
HAL_StatusTypeDef	HAL_PCD_RegisterCallback (PCD_HandleTypeDef *hpcd, HAL_PCD_CallbackIDTypeDef CallbackID, pPCD_CallbackTypeDef pCallback)
	Register a User USB PCD Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_PCD_UnRegisterCallback (PCD_HandleTypeDef *hpcd, HAL_PCD_CallbackIDTypeDef CallbackID)
	Unregister an USB PCD Callback USB PCD callabck is redirected to the weak predefined callback.
HAL_StatusTypeDef	HAL_PCD_RegisterDataOutStageCallback (PCD_HandleTypeDef *hpcd, pPCD_DataOutStageCallbackTypeDef pCallback)
	Register USB PCD Data OUT Stage Callback To be used instead of the weak HAL_PCD_DataOutStageCallback() predefined callback.
HAL_StatusTypeDef	HAL_PCD_UnRegisterDataOutStageCallback (PCD_HandleTypeDef *hpcd)
	Unregister the USB PCD Data OUT Stage Callback USB PCD Data OUT Stage Callback is redirected to the weak HAL_PCD_DataOutStageCallback() predefined callback.
HAL_StatusTypeDef	HAL_PCD_RegisterDataInStageCallback (PCD_HandleTypeDef *hpcd, pPCD_DataInStageCallbackTypeDef pCallback)
	Register USB PCD Data IN Stage Callback To be used instead of the weak HAL_PCD_DataInStageCallback() predefined callback.
HAL_StatusTypeDef	HAL_PCD_UnRegisterDataInStageCallback (PCD_HandleTypeDef *hpcd)
	Unregister the USB PCD Data IN Stage Callback USB PCD Data OUT Stage Callback is redirected to the weak HAL_PCD_DataInStageCallback() predefined callback.
HAL_StatusTypeDef	HAL_PCD_RegisterIsoOutIncpltCallback (PCD_HandleTypeDef *hpcd, pPCD_IsoOutIncpltCallbackTypeDef pCallback)
	Register USB PCD Iso OUT incomplete Callback To be used instead of the weak HAL_PCD_ISOOUTIncompleteCallback() predefined callback.
HAL_StatusTypeDef	HAL_PCD_UnRegisterIsoOutIncpltCallback (PCD_HandleTypeDef *hpcd)
	Unregister the USB PCD Iso OUT incomplete Callback USB PCD Iso OUT incomplete Callback is redirected to the weak HAL_PCD_ISOOUTIncompleteCallback() predefined callback.
HAL_StatusTypeDef	HAL_PCD_RegisterIsoInIncpltCallback (PCD_HandleTypeDef *hpcd, pPCD_IsoInIncpltCallbackTypeDef pCallback)
	Register USB PCD Iso IN incomplete Callback To be used instead of the weak HAL_PCD_ISOINIncompleteCallback() predefined callback.
HAL_StatusTypeDef	HAL_PCD_UnRegisterIsoInIncpltCallback (PCD_HandleTypeDef *hpcd)
	Unregister the USB PCD Iso IN incomplete Callback USB PCD Iso IN incomplete Callback is redirected to the weak HAL_PCD_ISOINIncompleteCallback() predefined callback.

---

Detailed Description

Initialization and Configuration functions.

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

---

Function Documentation

HAL_StatusTypeDef HAL_PCD_DeInit

(

PCD_HandleTypeDef *

hpcd

)

DeInitializes the PCD peripheral.

Parameters:

hpcd	PCD handle

Return values:

HAL

status

Definition at line 246 of file stm32f1xx_hal_pcd.c.

References HAL_PCD_MspDeInit(), HAL_PCD_STATE_BUSY, HAL_PCD_STATE_RESET, __PCD_HandleTypeDef::Instance, __PCD_HandleTypeDef::MspDeInitCallback, and __PCD_HandleTypeDef::State.

HAL_StatusTypeDef HAL_PCD_Init

(

PCD_HandleTypeDef *

hpcd

)

Initializes the PCD according to the specified parameters in the PCD_InitTypeDef and initialize the associated handle.

Parameters:

hpcd	PCD handle

Return values:

HAL

status

Definition at line 128 of file stm32f1xx_hal_pcd.c.

References __HAL_PCD_DISABLE, assert_param, __PCD_HandleTypeDef::ConnectCallback, __PCD_HandleTypeDef::DataInStageCallback, __PCD_HandleTypeDef::DataOutStageCallback, __PCD_HandleTypeDef::DisconnectCallback, HAL_PCD_ConnectCallback(), HAL_PCD_DataInStageCallback(), HAL_PCD_DataOutStageCallback(), HAL_PCD_DisconnectCallback(), HAL_PCD_ISOINIncompleteCallback(), HAL_PCD_ISOOUTIncompleteCallback(), HAL_PCD_MspInit(), HAL_PCD_ResetCallback(), HAL_PCD_ResumeCallback(), HAL_PCD_SetupStageCallback(), HAL_PCD_SOFCallback(), HAL_PCD_STATE_BUSY, HAL_PCD_STATE_ERROR, HAL_PCD_STATE_READY, HAL_PCD_STATE_RESET, HAL_PCD_SuspendCallback(), __PCD_HandleTypeDef::IN_ep, __PCD_HandleTypeDef::Init, __PCD_HandleTypeDef::Instance, __PCD_HandleTypeDef::ISOINIncompleteCallback, __PCD_HandleTypeDef::ISOOUTIncompleteCallback, __PCD_HandleTypeDef::Lock, __PCD_HandleTypeDef::MspInitCallback, __PCD_HandleTypeDef::OUT_ep, __PCD_HandleTypeDef::ResetCallback, __PCD_HandleTypeDef::ResumeCallback, __PCD_HandleTypeDef::SetupStageCallback, __PCD_HandleTypeDef::SOFCallback, __PCD_HandleTypeDef::State, __PCD_HandleTypeDef::SuspendCallback, and __PCD_HandleTypeDef::USB_Address.

void HAL_PCD_MspDeInit

(

PCD_HandleTypeDef *

hpcd

)

DeInitializes PCD MSP.

Parameters:

hpcd	PCD handle

Return values:

None

Definition at line 300 of file stm32f1xx_hal_pcd.c.

Referenced by HAL_PCD_DeInit(), and HAL_PCD_UnRegisterCallback().

void HAL_PCD_MspInit

(

PCD_HandleTypeDef *

hpcd

)

Initializes the PCD MSP.

Parameters:

hpcd	PCD handle

Return values:

None

Definition at line 285 of file stm32f1xx_hal_pcd.c.

Referenced by HAL_PCD_Init(), and HAL_PCD_UnRegisterCallback().

HAL_StatusTypeDef HAL_PCD_RegisterCallback	(	PCD_HandleTypeDef *	hpcd,
		HAL_PCD_CallbackIDTypeDef	CallbackID,
		pPCD_CallbackTypeDef	pCallback
	)

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

Parameters:

hpcd	USB PCD handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_PCD_SOF_CB_ID USB PCD SOF callback ID HAL_PCD_SETUPSTAGE_CB_ID USB PCD Setup callback ID HAL_PCD_RESET_CB_ID USB PCD Reset callback ID HAL_PCD_SUSPEND_CB_ID USB PCD Suspend callback ID HAL_PCD_RESUME_CB_ID USB PCD Resume callback ID HAL_PCD_CONNECT_CB_ID USB PCD Connect callback ID HAL_PCD_DISCONNECT_CB_ID OTG PCD Disconnect callback ID HAL_PCD_MSPINIT_CB_ID MspDeInit callback ID HAL_PCD_MSPDEINIT_CB_ID MspDeInit callback ID
pCallback	pointer to the Callback function

Return values:

HAL

status

Definition at line 329 of file stm32f1xx_hal_pcd.c.

References __PCD_HandleTypeDef::ConnectCallback, __PCD_HandleTypeDef::DisconnectCallback, __PCD_HandleTypeDef::ErrorCode, HAL_PCD_CONNECT_CB_ID, HAL_PCD_DISCONNECT_CB_ID, HAL_PCD_ERROR_INVALID_CALLBACK, HAL_PCD_MSPDEINIT_CB_ID, HAL_PCD_MSPINIT_CB_ID, HAL_PCD_RESET_CB_ID, HAL_PCD_RESUME_CB_ID, HAL_PCD_SETUPSTAGE_CB_ID, HAL_PCD_SOF_CB_ID, HAL_PCD_STATE_READY, HAL_PCD_STATE_RESET, HAL_PCD_SUSPEND_CB_ID, __PCD_HandleTypeDef::MspDeInitCallback, __PCD_HandleTypeDef::MspInitCallback, __PCD_HandleTypeDef::ResetCallback, __PCD_HandleTypeDef::ResumeCallback, __PCD_HandleTypeDef::SetupStageCallback, __PCD_HandleTypeDef::SOFCallback, __PCD_HandleTypeDef::State, and __PCD_HandleTypeDef::SuspendCallback.

HAL_StatusTypeDef HAL_PCD_RegisterDataInStageCallback	(	PCD_HandleTypeDef *	hpcd,
		pPCD_DataInStageCallbackTypeDef	pCallback
	)

Register USB PCD Data IN Stage Callback To be used instead of the weak HAL_PCD_DataInStageCallback() predefined callback.

Parameters:

hpcd	PCD handle
pCallback	pointer to the USB PCD Data IN Stage Callback function

Return values:

HAL

status

Definition at line 615 of file stm32f1xx_hal_pcd.c.

References __PCD_HandleTypeDef::DataInStageCallback, __PCD_HandleTypeDef::ErrorCode, HAL_PCD_ERROR_INVALID_CALLBACK, HAL_PCD_STATE_READY, and __PCD_HandleTypeDef::State.

HAL_StatusTypeDef HAL_PCD_RegisterDataOutStageCallback	(	PCD_HandleTypeDef *	hpcd,
		pPCD_DataOutStageCallbackTypeDef	pCallback
	)

Register USB PCD Data OUT Stage Callback To be used instead of the weak HAL_PCD_DataOutStageCallback() predefined callback.

Parameters:

hpcd	PCD handle
pCallback	pointer to the USB PCD Data OUT Stage Callback function

Return values:

HAL

status

Definition at line 541 of file stm32f1xx_hal_pcd.c.

References __PCD_HandleTypeDef::DataOutStageCallback, __PCD_HandleTypeDef::ErrorCode, HAL_PCD_ERROR_INVALID_CALLBACK, HAL_PCD_STATE_READY, and __PCD_HandleTypeDef::State.

HAL_StatusTypeDef HAL_PCD_RegisterIsoInIncpltCallback	(	PCD_HandleTypeDef *	hpcd,
		pPCD_IsoInIncpltCallbackTypeDef	pCallback
	)

Register USB PCD Iso IN incomplete Callback To be used instead of the weak HAL_PCD_ISOINIncompleteCallback() predefined callback.

Parameters:

hpcd	PCD handle
pCallback	pointer to the USB PCD Iso IN incomplete Callback function

Return values:

HAL

status

Definition at line 764 of file stm32f1xx_hal_pcd.c.

References __PCD_HandleTypeDef::ErrorCode, HAL_PCD_ERROR_INVALID_CALLBACK, HAL_PCD_STATE_READY, __PCD_HandleTypeDef::ISOINIncompleteCallback, and __PCD_HandleTypeDef::State.

HAL_StatusTypeDef HAL_PCD_RegisterIsoOutIncpltCallback	(	PCD_HandleTypeDef *	hpcd,
		pPCD_IsoOutIncpltCallbackTypeDef	pCallback
	)

Register USB PCD Iso OUT incomplete Callback To be used instead of the weak HAL_PCD_ISOOUTIncompleteCallback() predefined callback.

Parameters:

hpcd	PCD handle
pCallback	pointer to the USB PCD Iso OUT incomplete Callback function

Return values:

HAL

status

Definition at line 689 of file stm32f1xx_hal_pcd.c.

References __PCD_HandleTypeDef::ErrorCode, HAL_PCD_ERROR_INVALID_CALLBACK, HAL_PCD_STATE_READY, __PCD_HandleTypeDef::ISOOUTIncompleteCallback, and __PCD_HandleTypeDef::State.

HAL_StatusTypeDef HAL_PCD_UnRegisterCallback	(	PCD_HandleTypeDef *	hpcd,
		HAL_PCD_CallbackIDTypeDef	CallbackID
	)

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

Parameters:

hpcd

USB PCD handle

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_PCD_SOF_CB_ID USB PCD SOF callback ID HAL_PCD_SETUPSTAGE_CB_ID USB PCD Setup callback ID HAL_PCD_RESET_CB_ID USB PCD Reset callback ID HAL_PCD_SUSPEND_CB_ID USB PCD Suspend callback ID HAL_PCD_RESUME_CB_ID USB PCD Resume callback ID HAL_PCD_CONNECT_CB_ID USB PCD Connect callback ID HAL_PCD_DISCONNECT_CB_ID OTG PCD Disconnect callback ID HAL_PCD_MSPINIT_CB_ID MspDeInit callback ID HAL_PCD_MSPDEINIT_CB_ID MspDeInit callback ID

Return values:

HAL

status

Definition at line 442 of file stm32f1xx_hal_pcd.c.

References __PCD_HandleTypeDef::ConnectCallback, __PCD_HandleTypeDef::DisconnectCallback, __PCD_HandleTypeDef::ErrorCode, HAL_PCD_CONNECT_CB_ID, HAL_PCD_ConnectCallback(), HAL_PCD_DISCONNECT_CB_ID, HAL_PCD_DisconnectCallback(), HAL_PCD_ERROR_INVALID_CALLBACK, HAL_PCD_MspDeInit(), HAL_PCD_MSPDEINIT_CB_ID, HAL_PCD_MspInit(), HAL_PCD_MSPINIT_CB_ID, HAL_PCD_RESET_CB_ID, HAL_PCD_ResetCallback(), HAL_PCD_RESUME_CB_ID, HAL_PCD_ResumeCallback(), HAL_PCD_SETUPSTAGE_CB_ID, HAL_PCD_SetupStageCallback(), HAL_PCD_SOF_CB_ID, HAL_PCD_SOFCallback(), HAL_PCD_STATE_READY, HAL_PCD_STATE_RESET, HAL_PCD_SUSPEND_CB_ID, HAL_PCD_SuspendCallback(), __PCD_HandleTypeDef::MspDeInitCallback, __PCD_HandleTypeDef::MspInitCallback, __PCD_HandleTypeDef::ResetCallback, __PCD_HandleTypeDef::ResumeCallback, __PCD_HandleTypeDef::SetupStageCallback, __PCD_HandleTypeDef::SOFCallback, __PCD_HandleTypeDef::State, and __PCD_HandleTypeDef::SuspendCallback.

HAL_StatusTypeDef HAL_PCD_UnRegisterDataInStageCallback

(

PCD_HandleTypeDef *

hpcd

)

Unregister the USB PCD Data IN Stage Callback USB PCD Data OUT Stage Callback is redirected to the weak HAL_PCD_DataInStageCallback() predefined callback.

Parameters:

hpcd	PCD handle

Return values:

HAL

status

Definition at line 656 of file stm32f1xx_hal_pcd.c.

References __PCD_HandleTypeDef::DataInStageCallback, __PCD_HandleTypeDef::ErrorCode, HAL_PCD_DataInStageCallback(), HAL_PCD_ERROR_INVALID_CALLBACK, HAL_PCD_STATE_READY, and __PCD_HandleTypeDef::State.

HAL_StatusTypeDef HAL_PCD_UnRegisterDataOutStageCallback

(

PCD_HandleTypeDef *

hpcd

)

Unregister the USB PCD Data OUT Stage Callback USB PCD Data OUT Stage Callback is redirected to the weak HAL_PCD_DataOutStageCallback() predefined callback.

Parameters:

hpcd	PCD handle

Return values:

HAL

status

Definition at line 582 of file stm32f1xx_hal_pcd.c.

References __PCD_HandleTypeDef::DataOutStageCallback, __PCD_HandleTypeDef::ErrorCode, HAL_PCD_DataOutStageCallback(), HAL_PCD_ERROR_INVALID_CALLBACK, HAL_PCD_STATE_READY, and __PCD_HandleTypeDef::State.

HAL_StatusTypeDef HAL_PCD_UnRegisterIsoInIncpltCallback

(

PCD_HandleTypeDef *

hpcd

)

Unregister the USB PCD Iso IN incomplete Callback USB PCD Iso IN incomplete Callback is redirected to the weak HAL_PCD_ISOINIncompleteCallback() predefined callback.

Parameters:

hpcd	PCD handle

Return values:

HAL

status

Definition at line 806 of file stm32f1xx_hal_pcd.c.

References __PCD_HandleTypeDef::ErrorCode, HAL_PCD_ERROR_INVALID_CALLBACK, HAL_PCD_ISOINIncompleteCallback(), HAL_PCD_STATE_READY, __PCD_HandleTypeDef::ISOINIncompleteCallback, and __PCD_HandleTypeDef::State.

HAL_StatusTypeDef HAL_PCD_UnRegisterIsoOutIncpltCallback

(

PCD_HandleTypeDef *

hpcd

)

Unregister the USB PCD Iso OUT incomplete Callback USB PCD Iso OUT incomplete Callback is redirected to the weak HAL_PCD_ISOOUTIncompleteCallback() predefined callback.

Parameters:

hpcd	PCD handle

Return values:

HAL

status

Definition at line 731 of file stm32f1xx_hal_pcd.c.

References __PCD_HandleTypeDef::ErrorCode, HAL_PCD_ERROR_INVALID_CALLBACK, HAL_PCD_ISOOUTIncompleteCallback(), HAL_PCD_STATE_READY, __PCD_HandleTypeDef::ISOOUTIncompleteCallback, and __PCD_HandleTypeDef::State.