vheap_task.h File Reference

#include <zrtos/error.h>
#include <zrtos/errno.h>
#include <zrtos/vheap_chunk_uid.h>

Include dependency graph for vheap_task.h:

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

Go to the source code of this file.

Data Structures
struct	_zrtos_vheap_task_t

Typedefs
typedef uint16_t	zrtos_vheap_task_delay_t
typedef unsigned int	zrtos_vheap_task_tick_type_t
typedef unsigned int	zrtos_vheap_task_id_t
typedef struct _zrtos_vheap_task_t	zrtos_vheap_task_t

Functions
bool	zrtos_vheap_task__init (zrtos_vheap_task_t *thiz, zrtos_arch_stack_t *heap, size_t stacksize_min, zrtos_arch_callback_t callback, void *args)
void	zrtos_vheap_task__set_delay_ms (zrtos_vheap_task_t *thiz, zrtos_vheap_task_tick_type_t ms)
void	zrtos_vheap_task__on_tick (zrtos_vheap_task_t *thiz)
bool	zrtos_vheap_task__is_idle (zrtos_vheap_task_t *thiz)
void	zrtos_vheap_task__set_stack_ptr (zrtos_vheap_task_t *thiz, zrtos_arch_stack_t *stack_ptr)
zrtos_arch_stack_t *	zrtos_vheap_task__get_stack_ptr (zrtos_vheap_task_t *thiz)
void	zrtos_vheap_task__set_errno (zrtos_vheap_task_t *thiz, zrtos_error_t errno)
zrtos_error_t	zrtos_vheap_task__get_errno (zrtos_vheap_task_t *thiz)
size_t	zrtos_vheap_task__get_stack_size_min (zrtos_vheap_task_t *thiz)
void	zrtos_vheap_task__set_return_value (zrtos_vheap_task_t *thiz, void *return_value)
void *	zrtos_vheap_task__get_return_value (zrtos_vheap_task_t *thiz)

Typedef Documentation

zrtos_vheap_task_delay_t

typedef uint16_t zrtos_vheap_task_delay_t

Definition at line 24 of file vheap_task.h.

zrtos_vheap_task_id_t

typedef unsigned int zrtos_vheap_task_id_t

Definition at line 26 of file vheap_task.h.

zrtos_vheap_task_t

typedef struct _zrtos_vheap_task_t zrtos_vheap_task_t

zrtos_vheap_task_tick_type_t

typedef unsigned int zrtos_vheap_task_tick_type_t

Definition at line 25 of file vheap_task.h.

Function Documentation

zrtos_vheap_task__get_errno()

zrtos_error_t zrtos_vheap_task__get_errno

(

zrtos_vheap_task_t *

thiz

)

Definition at line 90 of file vheap_task.h.

                                                                   {
    return thiz->errno;
}

Here is the caller graph for this function:

zrtos_vheap_task__get_return_value()

void* zrtos_vheap_task__get_return_value

(

zrtos_vheap_task_t *

thiz

)

Definition at line 102 of file vheap_task.h.

                                                                  {
    return thiz->return_value;
}

Here is the caller graph for this function:

zrtos_vheap_task__get_stack_ptr()

zrtos_arch_stack_t* zrtos_vheap_task__get_stack_ptr

(

zrtos_vheap_task_t *

thiz

)

Definition at line 82 of file vheap_task.h.

                                                                             {
    return thiz->stack_ptr;
}

Here is the caller graph for this function:

zrtos_vheap_task__get_stack_size_min()

size_t zrtos_vheap_task__get_stack_size_min

(

zrtos_vheap_task_t *

thiz

)

Definition at line 94 of file vheap_task.h.

                                                                     {
    return thiz->stacksize_min;
}

Here is the caller graph for this function:

zrtos_vheap_task__init()

bool zrtos_vheap_task__init	(	zrtos_vheap_task_t *	thiz,
		zrtos_arch_stack_t *	heap,
		size_t	stacksize_min,
		zrtos_arch_callback_t	callback,
		void *	args
	)

Definition at line 37 of file vheap_task.h.

 {
    thiz->stack_ptr = zrtos_arch__cpu_state_init(
         heap
        //,heap_size
        ,callback
        ,args
    );
    thiz->return_value = 0;
    thiz->stacksize_min = stacksize_min;
    thiz->ticks = 0;
    thiz->errno = 0;

    return true;
}

Here is the caller graph for this function:

zrtos_vheap_task__is_idle()

bool zrtos_vheap_task__is_idle

(

zrtos_vheap_task_t *

thiz

)

Definition at line 71 of file vheap_task.h.

                                                        {
    return thiz->ticks > 0;
}

Here is the caller graph for this function:

zrtos_vheap_task__on_tick()

void zrtos_vheap_task__on_tick

(

zrtos_vheap_task_t *

thiz

)

Definition at line 67 of file vheap_task.h.

                                                        {
    thiz->ticks -= (thiz->ticks > 0);
}

Here is the caller graph for this function:

zrtos_vheap_task__set_delay_ms()

void zrtos_vheap_task__set_delay_ms	(	zrtos_vheap_task_t *	thiz,
		zrtos_vheap_task_tick_type_t	ms
	)

Definition at line 59 of file vheap_task.h.

                                                                                             {
#if ZRTOS_BOARD__TICK_PERIOD_MS == 1
    thiz->ticks = ms;
#else
    thiz->ticks = ms ? (ms / ZRTOS_BOARD__TICK_PERIOD_MS) : 0;
#endif
}

Here is the caller graph for this function:

zrtos_vheap_task__set_errno()

void zrtos_vheap_task__set_errno	(	zrtos_vheap_task_t *	thiz,
		zrtos_error_t	errno
	)

Definition at line 86 of file vheap_task.h.

                                                                              {
    thiz->errno = errno;
}

Here is the caller graph for this function:

zrtos_vheap_task__set_return_value()

void zrtos_vheap_task__set_return_value	(	zrtos_vheap_task_t *	thiz,
		void *	return_value
	)

Definition at line 98 of file vheap_task.h.

                                                                                    {
    thiz->return_value = return_value;
}

Here is the caller graph for this function:

zrtos_vheap_task__set_stack_ptr()

void zrtos_vheap_task__set_stack_ptr	(	zrtos_vheap_task_t *	thiz,
		zrtos_arch_stack_t *	stack_ptr
	)

Definition at line 75 of file vheap_task.h.

 {
    thiz->stack_ptr = stack_ptr;
}

Here is the caller graph for this function: