Initialization/de-initialization methods

Initialization and Configuration functions. More...

Functions
HAL_StatusTypeDef	HAL_SWPMI_Init (SWPMI_HandleTypeDef *hswpmi)
	Initialize the SWPMI peripheral according to the specified parameters in the SWPMI_InitTypeDef.
HAL_StatusTypeDef	HAL_SWPMI_DeInit (SWPMI_HandleTypeDef *hswpmi)
	De-initialize the SWPMI peripheral.
__weak void	HAL_SWPMI_MspInit (SWPMI_HandleTypeDef *hswpmi)
	Initialize the SWPMI MSP.
__weak void	HAL_SWPMI_MspDeInit (SWPMI_HandleTypeDef *hswpmi)
	DeInitialize the SWPMI MSP.
HAL_StatusTypeDef	HAL_SWPMI_RegisterCallback (SWPMI_HandleTypeDef *hswpmi, HAL_SWPMI_CallbackIDTypeDef CallbackID, pSWPMI_CallbackTypeDef pCallback)
	Register a user SWPMI callback to be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_SWPMI_UnRegisterCallback (SWPMI_HandleTypeDef *hswpmi, HAL_SWPMI_CallbackIDTypeDef CallbackID)
	Unregister a user SWPMI callback.

---

Detailed Description

Initialization and Configuration functions.

 ===============================================================================
            ##### Initialization and Configuration functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Initialize and configure the SWPMI peripheral.
      (+) De-initialize the SWPMI peripheral.

---

Function Documentation

HAL_StatusTypeDef HAL_SWPMI_DeInit

(

SWPMI_HandleTypeDef *

hswpmi

)

De-initialize the SWPMI peripheral.

Parameters:

hswpmi

SWPMI handle

Return values:

HAL

status

Definition at line 333 of file stm32h7xx_hal_swpmi.c.

References assert_param, __SWPMI_HandleTypeDef::ErrorCode, HAL_SWPMI_ERROR_NONE, HAL_SWPMI_MspDeInit(), HAL_SWPMI_STATE_BUSY, HAL_SWPMI_STATE_RESET, __SWPMI_HandleTypeDef::Instance, __SWPMI_HandleTypeDef::MspDeInitCallback, and __SWPMI_HandleTypeDef::State.

HAL_StatusTypeDef HAL_SWPMI_Init

(

SWPMI_HandleTypeDef *

hswpmi

)

Initialize the SWPMI peripheral according to the specified parameters in the SWPMI_InitTypeDef.

Parameters:

hswpmi

SWPMI handle

Return values:

HAL

status

Definition at line 239 of file stm32h7xx_hal_swpmi.c.

References assert_param, SWPMI_InitTypeDef::BitRate, __SWPMI_HandleTypeDef::ErrorCallback, __SWPMI_HandleTypeDef::ErrorCode, HAL_GetTick(), HAL_SWPMI_ERROR_NONE, HAL_SWPMI_ERROR_TRANSCEIVER_NOT_READY, HAL_SWPMI_ErrorCallback(), HAL_SWPMI_MspInit(), HAL_SWPMI_RxCpltCallback(), HAL_SWPMI_RxHalfCpltCallback(), HAL_SWPMI_STATE_BUSY, HAL_SWPMI_STATE_ERROR, HAL_SWPMI_STATE_READY, HAL_SWPMI_STATE_RESET, HAL_SWPMI_TxCpltCallback(), HAL_SWPMI_TxHalfCpltCallback(), __SWPMI_HandleTypeDef::Init, __SWPMI_HandleTypeDef::Instance, IS_SWPMI_BITRATE_VALUE, IS_SWPMI_RX_BUFFERING_MODE, IS_SWPMI_TX_BUFFERING_MODE, IS_SWPMI_VOLTAGE_CLASS, __SWPMI_HandleTypeDef::Lock, __SWPMI_HandleTypeDef::MspInitCallback, SWPMI_InitTypeDef::RxBufferingMode, __SWPMI_HandleTypeDef::RxCpltCallback, __SWPMI_HandleTypeDef::RxHalfCpltCallback, __SWPMI_HandleTypeDef::State, SWPMI_FLAG_RDYF, SWPMI_TRANSCEIVER_RDY_TIMEOUT_VALUE, SWPMI_WaitOnFlagSetUntilTimeout(), SWPMI_InitTypeDef::TxBufferingMode, __SWPMI_HandleTypeDef::TxCpltCallback, __SWPMI_HandleTypeDef::TxHalfCpltCallback, and SWPMI_InitTypeDef::VoltageClass.

__weak void HAL_SWPMI_MspDeInit

(

SWPMI_HandleTypeDef *

hswpmi

)

DeInitialize the SWPMI MSP.

Parameters:

hswpmi

SWPMI handle

Return values:

None

Definition at line 400 of file stm32h7xx_hal_swpmi.c.

Referenced by HAL_SWPMI_DeInit(), and HAL_SWPMI_UnRegisterCallback().

__weak void HAL_SWPMI_MspInit

(

SWPMI_HandleTypeDef *

hswpmi

)

Initialize the SWPMI MSP.

Parameters:

hswpmi

SWPMI handle

Return values:

None

Definition at line 385 of file stm32h7xx_hal_swpmi.c.

Referenced by HAL_SWPMI_Init(), and HAL_SWPMI_UnRegisterCallback().

HAL_StatusTypeDef HAL_SWPMI_RegisterCallback	(	SWPMI_HandleTypeDef *	hswpmi,
		HAL_SWPMI_CallbackIDTypeDef	CallbackID,
		pSWPMI_CallbackTypeDef	pCallback
	)

Register a user SWPMI callback to be used instead of the weak predefined callback.

Parameters:

hswpmi	SWPMI handle.
CallbackID	ID of the callback to be registered. This parameter can be one of the following values: HAL_SWPMI_RX_COMPLETE_CB_ID receive complete callback ID. HAL_SWPMI_RX_HALFCOMPLETE_CB_ID receive half complete callback ID. HAL_SWPMI_TX_COMPLETE_CB_ID transmit complete callback ID. HAL_SWPMI_TX_HALFCOMPLETE_CB_ID transmit half complete callback ID. HAL_SWPMI_ERROR_CB_ID error callback ID. HAL_SWPMI_MSPINIT_CB_ID MSP init callback ID. HAL_SWPMI_MSPDEINIT_CB_ID MSP de-init callback ID.
pCallback	pointer to the callback function.

Return values:

HAL

status.

Definition at line 427 of file stm32h7xx_hal_swpmi.c.

References __SWPMI_HandleTypeDef::ErrorCallback, __SWPMI_HandleTypeDef::ErrorCode, HAL_SWPMI_ERROR_CB_ID, HAL_SWPMI_ERROR_INVALID_CALLBACK, HAL_SWPMI_MSPDEINIT_CB_ID, HAL_SWPMI_MSPINIT_CB_ID, HAL_SWPMI_RX_COMPLETE_CB_ID, HAL_SWPMI_RX_HALFCOMPLETE_CB_ID, HAL_SWPMI_STATE_READY, HAL_SWPMI_STATE_RESET, HAL_SWPMI_TX_COMPLETE_CB_ID, HAL_SWPMI_TX_HALFCOMPLETE_CB_ID, __SWPMI_HandleTypeDef::MspDeInitCallback, __SWPMI_HandleTypeDef::MspInitCallback, __SWPMI_HandleTypeDef::RxCpltCallback, __SWPMI_HandleTypeDef::RxHalfCpltCallback, __SWPMI_HandleTypeDef::State, __SWPMI_HandleTypeDef::TxCpltCallback, and __SWPMI_HandleTypeDef::TxHalfCpltCallback.

HAL_StatusTypeDef HAL_SWPMI_UnRegisterCallback	(	SWPMI_HandleTypeDef *	hswpmi,
		HAL_SWPMI_CallbackIDTypeDef	CallbackID
	)

Unregister a user SWPMI callback.

SWPMI callback is redirected to the weak predefined callback.

Parameters:

hswpmi

SWPMI handle.

CallbackID

ID of the callback to be unregistered. This parameter can be one of the following values: HAL_SWPMI_RX_COMPLETE_CB_ID receive complete callback ID. HAL_SWPMI_RX_HALFCOMPLETE_CB_ID receive half complete callback ID. HAL_SWPMI_TX_COMPLETE_CB_ID transmit complete callback ID. HAL_SWPMI_TX_HALFCOMPLETE_CB_ID transmit half complete callback ID. HAL_SWPMI_ERROR_CB_ID error callback ID. HAL_SWPMI_MSPINIT_CB_ID MSP init callback ID. HAL_SWPMI_MSPDEINIT_CB_ID MSP de-init callback ID.

Return values:

HAL

status.

Definition at line 519 of file stm32h7xx_hal_swpmi.c.

References __SWPMI_HandleTypeDef::ErrorCallback, __SWPMI_HandleTypeDef::ErrorCode, HAL_SWPMI_ERROR_CB_ID, HAL_SWPMI_ERROR_INVALID_CALLBACK, HAL_SWPMI_ErrorCallback(), HAL_SWPMI_MspDeInit(), HAL_SWPMI_MSPDEINIT_CB_ID, HAL_SWPMI_MspInit(), HAL_SWPMI_MSPINIT_CB_ID, HAL_SWPMI_RX_COMPLETE_CB_ID, HAL_SWPMI_RX_HALFCOMPLETE_CB_ID, HAL_SWPMI_RxCpltCallback(), HAL_SWPMI_RxHalfCpltCallback(), HAL_SWPMI_STATE_READY, HAL_SWPMI_STATE_RESET, HAL_SWPMI_TX_COMPLETE_CB_ID, HAL_SWPMI_TX_HALFCOMPLETE_CB_ID, HAL_SWPMI_TxCpltCallback(), HAL_SWPMI_TxHalfCpltCallback(), __SWPMI_HandleTypeDef::MspDeInitCallback, __SWPMI_HandleTypeDef::MspInitCallback, __SWPMI_HandleTypeDef::RxCpltCallback, __SWPMI_HandleTypeDef::RxHalfCpltCallback, __SWPMI_HandleTypeDef::State, __SWPMI_HandleTypeDef::TxCpltCallback, and __SWPMI_HandleTypeDef::TxHalfCpltCallback.