HAL IWDG Functions ¶

Initialization and start functions ¶

group IWDG_Exported_Functions_Group1

This subsection provides a set of functions allowing to initialize and start the IWDG peripheral:

Call the function HAL_IWDG_Init() to initialize the IWDG handle and associate an instance.
Call the function HAL_IWDG_Start() to start the IWDG according to the parameters provided by the user.

Functions

hal_status_t HAL_IWDG_Init ( hal_iwdg_handle_t * hiwdg , hal_iwdg_t instance ) ¶

Initialize the IWDG according to the associated handle.

Warning

LSI frequency used in the driver is reinitialized to the default value LSI_VALUE and then API HAL_IWDG_SetLSIFrequency() can be called to use a more accurate value.

Warning

In case of starting IWDG in Hardware mode, make sure that USE_HAL_IWDG_HARDWARE_START is aligned with the IWDG_SW option byte.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
instance – IWDG instance.

Return values :

HAL_OK – Operation completed successfully.
HAL_INVALID_PARAM – Invalid parameter.

hal_status_t HAL_IWDG_Start ( hal_iwdg_handle_t * hiwdg , uint32_t min_time , uint32_t max_time , uint32_t early_wakeup_time ) ¶

Start the IWDG. Before exiting the function, the watchdog is refreshed to have a correct time base.

Warning

The min_time and max_time are used to define the window and the reload values, the unit for these parameters depend on the switch USE_HAL_IWDG_TIME_UNIT.

Warning

When the Window is not needed, the value of min_time is set to 0U.

Warning

The early_wakeup_time is used to set the Early Wakeup Interrupt. When it is not needed, value is set to 0U.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
min_time – Minimum time value before refreshing is allowed.
max_time – Maximum time value before an IWDG reset.
early_wakeup_time – Early Wakeup Interrupt time value.

Return values :

HAL_OK – Operation completed successfully.
HAL_ERROR – Operation completed with error.

group IWDG_Exported_Functions_Group1

This subsection provides a set of functions allowing to initialize and start the IWDG peripheral:

Call the function HAL_IWDG_Init() to initialize the IWDG handle and associate an instance.
Call the function HAL_IWDG_Start() to start the IWDG according to the parameters provided by the user.

Functions

hal_status_t HAL_IWDG_Init ( hal_iwdg_handle_t * hiwdg , hal_iwdg_t instance )

Initialize the IWDG according to the associated handle.

Warning

LSI frequency used in the driver is reinitialized to the default value LSI_VALUE and then API HAL_IWDG_SetLSIFrequency() can be called to use a more accurate value.

Warning

In case of starting IWDG in Hardware mode, make sure that USE_HAL_IWDG_HARDWARE_START is aligned with the IWDG_SW option byte.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
instance – IWDG instance.

Return values :

HAL_OK – Operation completed successfully.
HAL_INVALID_PARAM – Invalid parameter.

hal_status_t HAL_IWDG_Start ( hal_iwdg_handle_t * hiwdg , uint32_t min_time , uint32_t max_time , uint32_t early_wakeup_time )

Start the IWDG. Before exiting the function, the watchdog is refreshed to have a correct time base.

Warning

The min_time and max_time are used to define the window and the reload values, the unit for these parameters depend on the switch USE_HAL_IWDG_TIME_UNIT.

Warning

When the Window is not needed, the value of min_time is set to 0U.

Warning

The early_wakeup_time is used to set the Early Wakeup Interrupt. When it is not needed, value is set to 0U.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
min_time – Minimum time value before refreshing is allowed.
max_time – Maximum time value before an IWDG reset.
early_wakeup_time – Early Wakeup Interrupt time value.

Return values :

HAL_OK – Operation completed successfully.
HAL_ERROR – Operation completed with error.

group IWDG_Exported_Functions_Group1

This subsection provides a set of functions allowing to initialize and start the IWDG peripheral:

Call the function HAL_IWDG_Init() to initialize the IWDG handle and associate an instance.
Call the function HAL_IWDG_Start() to start the IWDG according to the parameters provided by the user.

Functions

hal_status_t HAL_IWDG_Init ( hal_iwdg_handle_t * hiwdg , hal_iwdg_t instance )

Initialize the IWDG according to the associated handle.

Warning

LSI frequency used in the driver is reinitialized to the default value LSI_VALUE and then API HAL_IWDG_SetLSIFrequency() can be called to use a more accurate value.

Warning

In case of starting IWDG in Hardware mode, make sure that USE_HAL_IWDG_HARDWARE_START is aligned with the IWDG_SW option byte.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
instance – IWDG instance.

Return values :

HAL_OK – Operation completed successfully.
HAL_INVALID_PARAM – Invalid parameter.

hal_status_t HAL_IWDG_Start ( hal_iwdg_handle_t * hiwdg , uint32_t min_time , uint32_t max_time , uint32_t early_wakeup_time )

Start the IWDG. Before exiting the function, the watchdog is refreshed to have a correct time base.

Warning

The min_time and max_time are used to define the window and the reload values, the unit for these parameters depend on the switch USE_HAL_IWDG_TIME_UNIT.

Warning

When the Window is not needed, the value of min_time is set to 0U.

Warning

The early_wakeup_time is used to set the Early Wakeup Interrupt. When it is not needed, value is set to 0U.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
min_time – Minimum time value before refreshing is allowed.
max_time – Maximum time value before an IWDG reset.
early_wakeup_time – Early Wakeup Interrupt time value.

Return values :

HAL_OK – Operation completed successfully.
HAL_ERROR – Operation completed with error.

I/O operation functions ¶

group IWDG_Exported_Functions_Group2

This subsection provides a set of functions to manage the IWDG driver:

Call the function HAL_IWDG_Refresh() to reload IWDG counter with value defined in the reload register.

Functions

hal_status_t HAL_IWDG_Refresh ( hal_iwdg_handle_t * hiwdg ) ¶

Refresh the IWDG.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: HAL_OK – Operation completed successfully.

group IWDG_Exported_Functions_Group2

This subsection provides a set of functions to manage the IWDG driver:

Call the function HAL_IWDG_Refresh() to reload IWDG counter with value defined in the reload register.

Functions

hal_status_t HAL_IWDG_Refresh ( hal_iwdg_handle_t * hiwdg )

Refresh the IWDG.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: HAL_OK – Operation completed successfully.

group IWDG_Exported_Functions_Group2

This subsection provides a set of functions to manage the IWDG driver:

Call the function HAL_IWDG_Refresh() to reload IWDG counter with value defined in the reload register.

Functions

hal_status_t HAL_IWDG_Refresh ( hal_iwdg_handle_t * hiwdg )

Refresh the IWDG.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: HAL_OK – Operation completed successfully.

State functions ¶

group IWDG_Exported_Functions_Group3

This subsection provides a set of functions to manage the IWDG driver:

Call the function HAL_IWDG_GetState() to retrieve the IWDG handle state.

Functions

hal_iwdg_state_t HAL_IWDG_GetState ( const hal_iwdg_handle_t * hiwdg ) ¶

Return the IWDG handle state.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.

Return values :

HAL_IWDG_STATE_RESET – IWDG driver not initialized and not started.
HAL_IWDG_STATE_IDLE – IWDG driver initialized and not started.
HAL_IWDG_STATE_ACTIVE – IWDG driver initialized and started.

group IWDG_Exported_Functions_Group3

This subsection provides a set of functions to manage the IWDG driver:

Call the function HAL_IWDG_GetState() to retrieve the IWDG handle state.

Functions

hal_iwdg_state_t HAL_IWDG_GetState ( const hal_iwdg_handle_t * hiwdg )

Return the IWDG handle state.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.

Return values :

HAL_IWDG_STATE_RESET – IWDG driver not initialized and not started.
HAL_IWDG_STATE_IDLE – IWDG driver initialized and not started.
HAL_IWDG_STATE_ACTIVE – IWDG driver initialized and started.

group IWDG_Exported_Functions_Group3

This subsection provides a set of functions to manage the IWDG driver:

Call the function HAL_IWDG_GetState() to retrieve the IWDG handle state.

Functions

hal_iwdg_state_t HAL_IWDG_GetState ( const hal_iwdg_handle_t * hiwdg )

Return the IWDG handle state.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.

Return values :

HAL_IWDG_STATE_RESET – IWDG driver not initialized and not started.
HAL_IWDG_STATE_IDLE – IWDG driver initialized and not started.
HAL_IWDG_STATE_ACTIVE – IWDG driver initialized and started.

Set and Get item functions ¶

group IWDG_Exported_Functions_Group4

This subsection provides a set of functions to set and retrieve configuration items separately for the IWDG driver:

Call the function HAL_IWDG_GetMaxTime() to retrieve the current reset time value.
Call the function HAL_IWDG_SetMinTime() to set only the Window time value.
Call the function HAL_IWDG_GetMinTime() to retrieve the current Window time value.
Call the function HAL_IWDG_SetEarlyWakeupInterruptTime() to set only the Early Wakeup time value.
Call the function HAL_IWDG_GetEarlyWakeupInterruptTime() to retrieve the current Early Wakeup time value.

Note

The prescaler is calculated from max_time once in the HAL_IWDG_Start() function. To avoid changing the prescaler, do not use a setMaxTime() function because it can modify the prescaler and therefore requires recalculating the Window and the Early Wakeup Interrupt. To modify max_time, call HAL_IWDG_Start().

Functions

uint32_t HAL_IWDG_GetMaxTime ( const hal_iwdg_handle_t * hiwdg ) ¶

Get the reset time value according to the handler instance registers.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current reset time in the selected USE_HAL_IWDG_TIME_UNIT unit.

uint32_t HAL_IWDG_GetStep_us ( const hal_iwdg_handle_t * hiwdg ) ¶

Get the step of the IWDG in microseconds.

Note

HAL_IWDG_GetStep_us is provided for information to allow calculation of max_time, min_time, and early_wakeup_time without rounding.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current step value in us.

hal_status_t HAL_IWDG_SetMinTime ( hal_iwdg_handle_t * hiwdg , uint32_t time ) ¶

Set the Window time value.

Note

Modifying the IWDG Window register will automatically reload the watchdog counter.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
time – Window time value to be set.

Return values :

HAL_OK – Operation completed successfully.
HAL_ERROR – Operation completed with error.

uint32_t HAL_IWDG_GetMinTime ( const hal_iwdg_handle_t * hiwdg ) ¶

Get the Early Wakeup time value according to the handler instance registers.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current Window time value.

hal_status_t HAL_IWDG_SetEarlyWakeupInterruptTime ( hal_iwdg_handle_t * hiwdg , uint32_t time ) ¶

Set the Early Wakeup time value.

Note

Modifying the IWDG early wakeup interrupt register will automatically reload the watchdog counter.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
time – Early Wakeup time value to be set.

Return values :

HAL_OK – Operation completed successfully.
HAL_ERROR – Operation completed with error.

uint32_t HAL_IWDG_GetEarlyWakeupInterruptTime ( const hal_iwdg_handle_t * hiwdg ) ¶

Get the Window time value according to the handler instance registers.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current Early Wakeup time value.

group IWDG_Exported_Functions_Group4

This subsection provides a set of functions to set and retrieve configuration items separately for the IWDG driver:

Call the function HAL_IWDG_GetMaxTime() to retrieve the current reset time value.
Call the function HAL_IWDG_SetMinTime() to set only the Window time value.
Call the function HAL_IWDG_GetMinTime() to retrieve the current Window time value.
Call the function HAL_IWDG_SetEarlyWakeupInterruptTime() to set only the Early Wakeup time value.
Call the function HAL_IWDG_GetEarlyWakeupInterruptTime() to retrieve the current Early Wakeup time value.

Note

Functions

uint32_t HAL_IWDG_GetMaxTime ( const hal_iwdg_handle_t * hiwdg )

Get the reset time value according to the handler instance registers.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current reset time in the selected USE_HAL_IWDG_TIME_UNIT unit.

uint32_t HAL_IWDG_GetStep_us ( const hal_iwdg_handle_t * hiwdg )

Get the step of the IWDG in microseconds.

Note

HAL_IWDG_GetStep_us is provided for information to allow calculation of max_time, min_time, and early_wakeup_time without rounding.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current step value in us.

hal_status_t HAL_IWDG_SetMinTime ( hal_iwdg_handle_t * hiwdg , uint32_t time )

Set the Window time value.

Note

Modifying the IWDG Window register will automatically reload the watchdog counter.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
time – Window time value to be set.

Return values :

HAL_OK – Operation completed successfully.
HAL_ERROR – Operation completed with error.

uint32_t HAL_IWDG_GetMinTime ( const hal_iwdg_handle_t * hiwdg )

Get the Early Wakeup time value according to the handler instance registers.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current Window time value.

hal_status_t HAL_IWDG_SetEarlyWakeupInterruptTime ( hal_iwdg_handle_t * hiwdg , uint32_t time )

Set the Early Wakeup time value.

Note

Modifying the IWDG early wakeup interrupt register will automatically reload the watchdog counter.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
time – Early Wakeup time value to be set.

Return values :

HAL_OK – Operation completed successfully.
HAL_ERROR – Operation completed with error.

uint32_t HAL_IWDG_GetEarlyWakeupInterruptTime ( const hal_iwdg_handle_t * hiwdg )

Get the Window time value according to the handler instance registers.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current Early Wakeup time value.

group IWDG_Exported_Functions_Group4

This subsection provides a set of functions to set and retrieve configuration items separately for the IWDG driver:

Call the function HAL_IWDG_GetMaxTime() to retrieve the current reset time value.
Call the function HAL_IWDG_SetMinTime() to set only the Window time value.
Call the function HAL_IWDG_GetMinTime() to retrieve the current Window time value.
Call the function HAL_IWDG_SetEarlyWakeupInterruptTime() to set only the Early Wakeup time value.
Call the function HAL_IWDG_GetEarlyWakeupInterruptTime() to retrieve the current Early Wakeup time value.

Note

Functions

uint32_t HAL_IWDG_GetMaxTime ( const hal_iwdg_handle_t * hiwdg )

Get the reset time value according to the handler instance registers.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current reset time in the selected USE_HAL_IWDG_TIME_UNIT unit.

uint32_t HAL_IWDG_GetStep_us ( const hal_iwdg_handle_t * hiwdg )

Get the step of the IWDG in microseconds.

Note

HAL_IWDG_GetStep_us is provided for information to allow calculation of max_time, min_time, and early_wakeup_time without rounding.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current step value in us.

hal_status_t HAL_IWDG_SetMinTime ( hal_iwdg_handle_t * hiwdg , uint32_t time )

Set the Window time value.

Note

Modifying the IWDG Window register will automatically reload the watchdog counter.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
time – Window time value to be set.

Return values :

HAL_OK – Operation completed successfully.
HAL_ERROR – Operation completed with error.

uint32_t HAL_IWDG_GetMinTime ( const hal_iwdg_handle_t * hiwdg )

Get the Early Wakeup time value according to the handler instance registers.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current Window time value.

hal_status_t HAL_IWDG_SetEarlyWakeupInterruptTime ( hal_iwdg_handle_t * hiwdg , uint32_t time )

Set the Early Wakeup time value.

Note

Modifying the IWDG early wakeup interrupt register will automatically reload the watchdog counter.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
time – Early Wakeup time value to be set.

Return values :

HAL_OK – Operation completed successfully.
HAL_ERROR – Operation completed with error.

uint32_t HAL_IWDG_GetEarlyWakeupInterruptTime ( const hal_iwdg_handle_t * hiwdg )

Get the Window time value according to the handler instance registers.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
Return values :: uint32_t – Current Early Wakeup time value.

IRQ Handler/Callbacks/Register Callbacks functions ¶

group IWDG_Exported_Functions_Group5

This subsection provides a set of functions to register the IWDG process and callbacks:

Use HAL_IWDG_IRQHandler() to handle IWDG interrupts.

There are two ways to use callbacks:

Override the weak callback function. Call

HAL_IWDG_EarlyWakeupCallback()

to indicate that an early interrupt is pending.

Or register user callbacks. Call

HAL_IWDG_RegisterEarlyWakeupCallback() to register the Early Wakeup Callback.

Functions

void HAL_IWDG_IRQHandler ( hal_iwdg_handle_t * hiwdg ) ¶

Handle IWDG interrupt request.

Note

The Early Wakeup Interrupt (EWI) can be used if specific safety operations or data logging must be performed before the actual reset is generated. Enable the EWI interrupt by calling HAL_IWDG_Start() with an early_wakeup_time. When the downcounter reaches the value EWIT - 1, an EWI interrupt is generated and the corresponding Interrupt Service Routine (ISR) can be used to trigger specific actions through the callback before the device resets.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.

void HAL_IWDG_EarlyWakeupCallback ( hal_iwdg_handle_t * hiwdg ) ¶

IWDG Early Wakeup callback.

Warning

This function must not be modified. When the callback is needed, implement HAL_IWDG_EarlyWakeupCallback() in the user file.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.

hal_status_t HAL_IWDG_RegisterEarlyWakeupCallback ( hal_iwdg_handle_t * hiwdg , hal_iwdg_cb_t p_callback ) ¶

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
p_callback – pointer to the hal_iwdg_cb_t Callback function

Return values :

HAL_OK – Operation completed successfully.
HAL_INVALID_PARAM – Invalid parameter.

group IWDG_Exported_Functions_Group5

This subsection provides a set of functions to register the IWDG process and callbacks:

Use HAL_IWDG_IRQHandler() to handle IWDG interrupts.

There are two ways to use callbacks:

Override the weak callback function. Call

HAL_IWDG_EarlyWakeupCallback()

to indicate that an early interrupt is pending.

Or register user callbacks. Call

HAL_IWDG_RegisterEarlyWakeupCallback() to register the Early Wakeup Callback.

Functions

void HAL_IWDG_IRQHandler ( hal_iwdg_handle_t * hiwdg )

Handle IWDG interrupt request.

Note

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.

void HAL_IWDG_EarlyWakeupCallback ( hal_iwdg_handle_t * hiwdg )

IWDG Early Wakeup callback.

Warning

This function must not be modified. When the callback is needed, implement HAL_IWDG_EarlyWakeupCallback() in the user file.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.

hal_status_t HAL_IWDG_RegisterEarlyWakeupCallback ( hal_iwdg_handle_t * hiwdg , hal_iwdg_cb_t p_callback )

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
p_callback – pointer to the hal_iwdg_cb_t Callback function

Return values :

HAL_OK – Operation completed successfully.
HAL_INVALID_PARAM – Invalid parameter.

group IWDG_Exported_Functions_Group5

This subsection provides a set of functions to register the IWDG process and callbacks:

Use HAL_IWDG_IRQHandler() to handle IWDG interrupts.

There are two ways to use callbacks:

Override the weak callback function. Call

HAL_IWDG_EarlyWakeupCallback()

to indicate that an early interrupt is pending.

Or register user callbacks. Call

HAL_IWDG_RegisterEarlyWakeupCallback() to register the Early Wakeup Callback.

Functions

void HAL_IWDG_IRQHandler ( hal_iwdg_handle_t * hiwdg )

Handle IWDG interrupt request.

Note

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.

void HAL_IWDG_EarlyWakeupCallback ( hal_iwdg_handle_t * hiwdg )

IWDG Early Wakeup callback.

Warning

This function must not be modified. When the callback is needed, implement HAL_IWDG_EarlyWakeupCallback() in the user file.

Parameters :: hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.

hal_status_t HAL_IWDG_RegisterEarlyWakeupCallback ( hal_iwdg_handle_t * hiwdg , hal_iwdg_cb_t p_callback )

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
p_callback – pointer to the hal_iwdg_cb_t Callback function

Return values :

HAL_OK – Operation completed successfully.
HAL_INVALID_PARAM – Invalid parameter.

Set and Get User Data functions ¶

group IWDG_Exported_Functions_Group6

This section provides functions to set and get user data:

HAL_IWDG_SetUserData() stores user data in the IWDG handle.
HAL_IWDG_GetUserData() retrieves user data from the IWDG handle.

Functions

void HAL_IWDG_SetUserData ( hal_iwdg_handle_t * hiwdg , const void * p_user_data ) ¶

Store the user data into the IWDG handle.

Parameters :

hiwdg – Pointer to IWDG handle.
p_user_data – Pointer to the user data.

const void * HAL_IWDG_GetUserData ( const hal_iwdg_handle_t * hiwdg ) ¶

Retrieve the user data from the IWDG handle.

Parameters :: hiwdg – Pointer to IWDG handle.
Return values :: Pointer – to the user data.

group IWDG_Exported_Functions_Group6

This section provides functions to set and get user data:

HAL_IWDG_SetUserData() stores user data in the IWDG handle.
HAL_IWDG_GetUserData() retrieves user data from the IWDG handle.

Functions

void HAL_IWDG_SetUserData ( hal_iwdg_handle_t * hiwdg , const void * p_user_data )

Store the user data into the IWDG handle.

Parameters :

hiwdg – Pointer to IWDG handle.
p_user_data – Pointer to the user data.

const void * HAL_IWDG_GetUserData ( const hal_iwdg_handle_t * hiwdg )

Retrieve the user data from the IWDG handle.

Parameters :: hiwdg – Pointer to IWDG handle.
Return values :: Pointer – to the user data.

group IWDG_Exported_Functions_Group6

This section provides functions to set and get user data:

HAL_IWDG_SetUserData() stores user data in the IWDG handle.
HAL_IWDG_GetUserData() retrieves user data from the IWDG handle.

Functions

void HAL_IWDG_SetUserData ( hal_iwdg_handle_t * hiwdg , const void * p_user_data )

Store the user data into the IWDG handle.

Parameters :

hiwdg – Pointer to IWDG handle.
p_user_data – Pointer to the user data.

const void * HAL_IWDG_GetUserData ( const hal_iwdg_handle_t * hiwdg )

Retrieve the user data from the IWDG handle.

Parameters :: hiwdg – Pointer to IWDG handle.
Return values :: Pointer – to the user data.

IWDG Private Functions ¶

group IWDG_Private_Functions

Functions

uint8_t IWDG_CalculatePrescaler ( const hal_iwdg_handle_t * hiwdg , uint32_t max_time ) ¶

Calculate the IWDG prescaler from the reset time set by the user.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
max_time – Corresponding maximum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

Return values :

0 – for a prescaler = 4.
1 – for a prescaler = 8.
2 – for a prescaler = 16.
3 – for a prescaler = 32.
4 – for a prescaler = 64.
5 – for a prescaler = 128.
6 – for a prescaler = 256.
7 – for a prescaler = 512.
[8..15] – for a prescaler = 1024.

uint16_t IWDG_CalculateReload ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t max_time ) ¶

Calculate the IWDG reload parameter from the user-provided maximum time.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – IWDG prescaler.
max_time – Corresponding maximum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

Return values :

uint16_t – Current reload parameter.

uint16_t IWDG_CalculateParam ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t time ) ¶

Calculate the IWDG configuration parameters from the user-provided times.

Note

By passing min_time as a parameter, it is converted to Window.

Note

By passing early_wakeup_time as a parameter, it is converted to early_wakeup_interrupt.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – IWDG prescaler.
time – Corresponding maximum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

Return values :

uint16_t – Converted parameter found.

uint32_t IWDG_CalculateTime ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t param ) ¶

Calculate the timings from the according configuration parameters of the IWDG driver.

Note

By passing Window as a parameter, it is converted to min_time.

Note

By passing early_wakeup_interrupt register value as a parameter, it will be converted to early_wakeup_time.

Note

By passing IWDG_MAX_TIME_PARAM as a parameter, it will be converted to max_time.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – IWDG prescaler.
param – Parameter corresponding to a timing.

Return values :

uint32_t – Converted time found in the selected USE_HAL_IWDG_TIME_UNIT unit.

void IWDG_ConfigureMinTime ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t time ) ¶

Configure the Window time value for the IWDG.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – Prescaler value.
time – Minimum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

void IWDG_ConfigureEarlyWakeupInterruptTime ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t early_wakeup_time ) ¶

Configure the Early Wakeup Interrupt time for the IWDG.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – Prescaler value.
early_wakeup_time – Early Wakeup Interrupt time in the selected USE_HAL_IWDG_TIME_UNIT unit.

group IWDG_Private_Functions

Functions

uint8_t IWDG_CalculatePrescaler ( const hal_iwdg_handle_t * hiwdg , uint32_t max_time )

Calculate the IWDG prescaler from the reset time set by the user.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
max_time – Corresponding maximum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

Return values :

0 – for a prescaler = 4.
1 – for a prescaler = 8.
2 – for a prescaler = 16.
3 – for a prescaler = 32.
4 – for a prescaler = 64.
5 – for a prescaler = 128.
6 – for a prescaler = 256.
7 – for a prescaler = 512.
[8..15] – for a prescaler = 1024.

uint16_t IWDG_CalculateReload ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t max_time )

Calculate the IWDG reload parameter from the user-provided maximum time.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – IWDG prescaler.
max_time – Corresponding maximum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

Return values :

uint16_t – Current reload parameter.

uint16_t IWDG_CalculateParam ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t time )

Calculate the IWDG configuration parameters from the user-provided times.

Note

By passing min_time as a parameter, it is converted to Window.

Note

By passing early_wakeup_time as a parameter, it is converted to early_wakeup_interrupt.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – IWDG prescaler.
time – Corresponding maximum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

Return values :

uint16_t – Converted parameter found.

uint32_t IWDG_CalculateTime ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t param )

Calculate the timings from the according configuration parameters of the IWDG driver.

Note

By passing Window as a parameter, it is converted to min_time.

Note

By passing early_wakeup_interrupt register value as a parameter, it will be converted to early_wakeup_time.

Note

By passing IWDG_MAX_TIME_PARAM as a parameter, it will be converted to max_time.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – IWDG prescaler.
param – Parameter corresponding to a timing.

Return values :

uint32_t – Converted time found in the selected USE_HAL_IWDG_TIME_UNIT unit.

void IWDG_ConfigureMinTime ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t time )

Configure the Window time value for the IWDG.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – Prescaler value.
time – Minimum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

void IWDG_ConfigureEarlyWakeupInterruptTime ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t early_wakeup_time )

Configure the Early Wakeup Interrupt time for the IWDG.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – Prescaler value.
early_wakeup_time – Early Wakeup Interrupt time in the selected USE_HAL_IWDG_TIME_UNIT unit.

group IWDG_Private_Functions

Functions

uint8_t IWDG_CalculatePrescaler ( const hal_iwdg_handle_t * hiwdg , uint32_t max_time )

Calculate the IWDG prescaler from the reset time set by the user.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
max_time – Corresponding maximum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

Return values :

0 – for a prescaler = 4.
1 – for a prescaler = 8.
2 – for a prescaler = 16.
3 – for a prescaler = 32.
4 – for a prescaler = 64.
5 – for a prescaler = 128.
6 – for a prescaler = 256.
7 – for a prescaler = 512.
[8..15] – for a prescaler = 1024.

uint16_t IWDG_CalculateReload ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t max_time )

Calculate the IWDG reload parameter from the user-provided maximum time.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – IWDG prescaler.
max_time – Corresponding maximum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

Return values :

uint16_t – Current reload parameter.

uint16_t IWDG_CalculateParam ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t time )

Calculate the IWDG configuration parameters from the user-provided times.

Note

By passing min_time as a parameter, it is converted to Window.

Note

By passing early_wakeup_time as a parameter, it is converted to early_wakeup_interrupt.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – IWDG prescaler.
time – Corresponding maximum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

Return values :

uint16_t – Converted parameter found.

uint32_t IWDG_CalculateTime ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t param )

Calculate the timings from the according configuration parameters of the IWDG driver.

Note

By passing Window as a parameter, it is converted to min_time.

Note

By passing early_wakeup_interrupt register value as a parameter, it will be converted to early_wakeup_time.

Note

By passing IWDG_MAX_TIME_PARAM as a parameter, it will be converted to max_time.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – IWDG prescaler.
param – Parameter corresponding to a timing.

Return values :

uint32_t – Converted time found in the selected USE_HAL_IWDG_TIME_UNIT unit.

void IWDG_ConfigureMinTime ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t time )

Configure the Window time value for the IWDG.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – Prescaler value.
time – Minimum time in the selected USE_HAL_IWDG_TIME_UNIT unit.

void IWDG_ConfigureEarlyWakeupInterruptTime ( const hal_iwdg_handle_t * hiwdg , uint8_t prescaler , uint32_t early_wakeup_time )

Configure the Early Wakeup Interrupt time for the IWDG.

Parameters :

hiwdg – Pointer to a hal_iwdg_handle_t structure that contains the configuration information for the specified IWDG module.
prescaler – Prescaler value.
early_wakeup_time – Early Wakeup Interrupt time in the selected USE_HAL_IWDG_TIME_UNIT unit.