ztimer mock clock backend

ztimer mock clock backend More...

Detailed Description

ztimer mock clock backend

This ztimer module implements a virtual clock that can be used for unittests. It can be manually adjusted to different timestamps and manually fired to simulate different scenarios and test the ztimer implementation using this as a backing timer.

Files
file	mock.h
	ztimer mock clock backend API

Data Structures
struct	ztimer_mock_t
	ztimer mock clock class More...

Functions
void	ztimer_mock_advance (ztimer_mock_t *self, uint32_t val)
	Advance the mock clock counter and update target. More...
void	ztimer_mock_jump (ztimer_mock_t *self, uint32_t target)
	Set the mock clock counter value without updating timer target. More...
void	ztimer_mock_fire (ztimer_mock_t *self)
	Trigger the timer handlers. More...
void	ztimer_mock_init (ztimer_mock_t *self, unsigned width)
	Constructor. More...

Function Documentation

ztimer_mock_advance()

void ztimer_mock_advance	(	ztimer_mock_t *	self,
		uint32_t	val
	)

Advance the mock clock counter and update target.

This will call ztimer_handler if the target was passed.

Parameters

[in]	self	instance to operate on
[in]	val	counter increment value

ztimer_mock_fire()

void ztimer_mock_fire

(

ztimer_mock_t *

self

)

Trigger the timer handlers.

This is equivalent to a hardware timer interrupt

Parameters

[in]

self

instance to operate on

ztimer_mock_init()

void ztimer_mock_init	(	ztimer_mock_t *	self,
		unsigned	width
	)

Constructor.

Parameters

[in]	self	instance to operate on
[in]	width	counter width, 1 <= width <= 32

ztimer_mock_jump()

void ztimer_mock_jump	(	ztimer_mock_t *	self,
		uint32_t	target
	)

Set the mock clock counter value without updating timer target.

This will not touch the timer target.

Parameters

[in]	self	instance to operate on
[in]	target	new absolute counter value