workload.h File Reference

Workload estimation utilities. More...

#include "sarmfsw.h"

Include dependency graph for workload.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	workload_res_t
	Workload results structure. More...

Macros
#define	GET_COUNT()
#define	WORKLOAD_IT_IN()
#define	WORKLOAD_IT_OUT()

Enumerations
enum	eWorkload_val { Workload_average = 0 , Workload_worst , Workload_best , Workload_res_max }
	Workload type value enum. More...

Functions
float	get_Workload_load_perc (const eWorkload_val type)
	Get interrupts load percentage.
uint32_t	get_Workload_loop_period (const eWorkload_val type)
	Get main loop period.
void	get_Workload_results (workload_res_t *const pResults)
	Get full workload results.
FctERR	Workload_init (void)
	Init Workload functionalities.
void	set_Workload_ticks_us (const float ticks)
	Set number of timer ticks in a µs.
void	set_Workload_window (const uint32_t per)
	Set workload estimation time window (in ms).
uint32_t	get_Workload_window (void)
	Get workload estimation time window (in ms).
void	Workload_handler (void)
	Workload handler.

Variables
volatile uint32_t	it_ticks_accumulator
volatile uint32_t	it_ticks_start
volatile bool	it_counts_ongoing

Detailed Description

Workload estimation utilities.

Author

SMFSW

Copyright

MIT (c) 2017-2026, SMFSW

Note

Define IT_WORKLOAD symbol at project level to use workload estimation module functionalities

Loop period values will only be relevant in case of sequential code (you will get task period for RTOS based code)

Handler has to be called in the main sequential loop (or in a periodic task). Init function has to be called prior to main loop. WORLOAD_IT_IN macro has to be put at the start of every interrupt, WORLOAD_IT_OUT macro before return of every interrupt

Warning

M0/M0+ cores doesn't have core debug trace peripheral, time count shall be generated using a dedicated TIM peripheral.

Note

With cores other than M0/M0+, core debug trace timer is used by default.

In case of M0/M0+ core or willing to use a TIM peripheral on purpose, WORKLOAD_TIM_INST symbol has to be defined with proper TIM instance at project level.

Macro Definition Documentation

GET_COUNT

#define GET_COUNT

(

)

Value:

DWT->CYCCNT

WORKLOAD_IT_IN

#define WORKLOAD_IT_IN

(

)

Value:

bool already_counting = it_counts_ongoing;                  \
it_counts_ongoing = true;                                   \
if (!already_counting)  { it_ticks_start = GET_COUNT(); }

WORKLOAD_IT_OUT

#define WORKLOAD_IT_OUT

(

)

Value:

if (!already_counting) {                                    \
it_ticks_accumulator += (GET_COUNT() - it_ticks_start); \
it_counts_ongoing = false; }

Enumeration Type Documentation

eWorkload_val

enum eWorkload_val

Workload type value enum.

Enumerator
Workload_average	Average value.
Workload_worst	Worst value.
Workload_best	Best value.
Workload_res_max	Max values for workload.

Function Documentation

get_Workload_load_perc()

float get_Workload_load_perc

(

const eWorkload_val

type

)

Get interrupts load percentage.

Parameters

[in]

type

- Type to get

Returns

Interrupts load percentage

get_Workload_loop_period()

uint32_t get_Workload_loop_period

(

const eWorkload_val

type

)

Get main loop period.

Note

Loop period values will only be relevant in case of sequential code (you will get task period for RTOS based code)

Parameters

[in]

type

- Type to get

Returns

Loop period

get_Workload_results()

void get_Workload_results

(

workload_res_t *const

pResults

)

Get full workload results.

Note

Loop period values will only be relevant in case of sequential code (you will get task period for RTOS based code)

Parameters

[in,out]

pResults

- Pointer to results structure

get_Workload_window()

uint32_t get_Workload_window

(

void

)

Get workload estimation time window (in ms).

Returns

Time window in ms

set_Workload_ticks_us()

void set_Workload_ticks_us

(

const float

ticks

)

Set number of timer ticks in a µs.

Weak Functions

Function declared as weak, can be customly implemented in project if special timer is required

Note

Useful in case of Workload_init custom implementation

Parameters

[in]

ticks

- Ticks in a µs

Here is the caller graph for this function:

set_Workload_window()

void set_Workload_window

(

const uint32_t

per

)

Set workload estimation time window (in ms).

Parameters

[in]

per

- Time window in ms

Here is the caller graph for this function:

Workload_handler()

void Workload_handler

(

void

)

Workload handler.

Note

This function shall be called in main loop or periodic task

Workload_init()

FctERR Workload_init

(

void

)

Init Workload functionalities.

Weak Functions

Function declared as weak, can be customly implemented in project if special timer is required

Returns

FctERR - Error code

Here is the call graph for this function:

Variable Documentation

it_counts_ongoing

volatile bool it_counts_ongoing

extern

it_ticks_accumulator

volatile uint32_t it_ticks_accumulator

extern

it_ticks_start

volatile uint32_t it_ticks_start

extern