sf_thread_monitor_api_t Struct Reference

#include <sf_thread_monitor_api.h>

Data Fields
ssp_err_t(*	open )(sf_thread_monitor_ctrl_t *const p_ctrl, sf_thread_monitor_cfg_t const *const p_cfg)
	Configures the WDT or IWDT module. From the configuration data the timeout period of the WDT/IWDT is determined and a thread created monitoring registered threads. More...
ssp_err_t(*	close )(sf_thread_monitor_ctrl_t *const p_ctrl)
	Suspends the thread monitoring thread. Watchdog peripheral no longer refreshed. More...
ssp_err_t(*	threadRegister )(sf_thread_monitor_ctrl_t *const p_ctrl, sf_thread_monitor_counter_min_max_t const *p_counter_min_max)
	Registers a thread for monitoring. More...
ssp_err_t(*	threadUnregister )(sf_thread_monitor_ctrl_t *const p_ctrl)
	Removes a thread from being monitored. More...
ssp_err_t(*	countIncrement )(sf_thread_monitor_ctrl_t *const p_ctrl)
	Safely increments a monitored thread's count value. More...
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)
	Get version and store it in provided pointer p_version. More...

Detailed Description

Thread monitor API structure. Thread Monitor implementations use the following API.

Field Documentation

close

ssp_err_t(* sf_thread_monitor_api_t::close) (sf_thread_monitor_ctrl_t *const p_ctrl)

Suspends the thread monitoring thread. Watchdog peripheral no longer refreshed.

Implemented as

• SF_THREAD_MONITOR_Close()

Parameters

[in,out]

p_ctrl

Control structure set in SF_THREAD_MONITOR_Open.

countIncrement

ssp_err_t(* sf_thread_monitor_api_t::countIncrement) (sf_thread_monitor_ctrl_t *const p_ctrl)

Safely increments a monitored thread's count value.

Implemented as

• SF_THREAD_MONITOR_CountIncrement()

Parameters

[in,out]

p_ctrl

Control structure set in SF_THREAD_MONITOR_Open.

open

ssp_err_t(* sf_thread_monitor_api_t::open) (sf_thread_monitor_ctrl_t *const p_ctrl, sf_thread_monitor_cfg_t const *const p_cfg)

Configures the WDT or IWDT module. From the configuration data the timeout period of the WDT/IWDT is determined and a thread created monitoring registered threads.

Implemented as

• SF_THREAD_MONITOR_Open()

Parameters

[in,out]	p_ctrl	Pointer to a structure allocated by user. Elements initialized here.
[in]	p_cfg	Pointer to configuration structure. All elements of the structure must be set by user.

threadRegister

ssp_err_t(* sf_thread_monitor_api_t::threadRegister) (sf_thread_monitor_ctrl_t *const p_ctrl, sf_thread_monitor_counter_min_max_t const *p_counter_min_max)

Registers a thread for monitoring.

Implemented as

• SF_THREAD_MONITOR_ThreadRegister()

Parameters

[in,out]	p_ctrl	Control structure set in SF_THREAD_MONITOR_Open.
[in]	p_counter_min_max	Pointer to structure containing min and max values for thread to be registered values.

threadUnregister

ssp_err_t(* sf_thread_monitor_api_t::threadUnregister) (sf_thread_monitor_ctrl_t *const p_ctrl)

Removes a thread from being monitored.

Implemented as

• SF_THREAD_MONITOR_ThreadUnregister()

Parameters

[in,out]

p_ctrl

Control structure set in SF_THREAD_MONITOR_Open.

versionGet

ssp_err_t(* sf_thread_monitor_api_t::versionGet) (ssp_version_t *const p_version)

Get version and store it in provided pointer p_version.

Implemented as

• SF_THREAD_MONITOR_VersionGet()

Parameters

[in,out]

p_version

Pointer to structure storing API and code versions.

---

The documentation for this struct was generated from the following file:

• sf_thread_monitor_api.h