task.h File Reference

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

Include dependency graph for 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_task_t

Typedefs
typedef unsigned int	zrtos_task_tick_t
typedef unsigned int	zrtos_task_id_t
typedef struct _zrtos_task_t	zrtos_task_t

Enumerations
enum	zrtos_task_state_t {   ZRTOS_TASK_STATE__READY = 0x0000,   ZRTOS_TASK_STATE__RUNNING = 1 << (sizeof(zrtos_task_tick_t) * 8 - 2),   ZRTOS_TASK_STATE__DONE = 1 << (sizeof(zrtos_task_tick_t) * 8 - 1),   ZRTOS_TASK_STATE__MASK }

Functions
bool	zrtos_task__init (zrtos_task_t *thiz, zrtos_arch_stack_t *stack_ptr)
bool	zrtos_task__init_ex (zrtos_task_t *thiz, zrtos_arch_stack_t *heap, zrtos_arch_callback_t callback, void *args)
void	zrtos_task__set_delay_ms (zrtos_task_t *thiz, zrtos_task_tick_t ms)
void	zrtos_task__on_tick (zrtos_task_t *thiz)
bool	zrtos_task__is_ready (zrtos_task_t *thiz)
bool	zrtos_task__is_running (zrtos_task_t *thiz)
bool	zrtos_task__is_done (zrtos_task_t *thiz)
void	zrtos_task__set_ready (zrtos_task_t *thiz)
void	zrtos_task__set_running (zrtos_task_t *thiz)
void	zrtos_task__set_done (zrtos_task_t *thiz)
zrtos_task_t *	zrtos_task__get_next_task (zrtos_task_t *thiz)
zrtos_task_t *	zrtos_task__get_previous_task (zrtos_task_t *thiz)
void	zrtos_task__set_stack_ptr (zrtos_task_t *thiz, zrtos_arch_stack_t *stack_ptr)
zrtos_arch_stack_t *	zrtos_task__get_stack_ptr (zrtos_task_t *thiz)
void	zrtos_task__set_errno (zrtos_task_t *thiz, zrtos_error_t error_code)
zrtos_error_t	zrtos_task__get_errno (zrtos_task_t *thiz)
void	zrtos_task__set_parent (zrtos_task_t *thiz, zrtos_task_t *parent)
zrtos_task_t *	zrtos_task__get_parent (zrtos_task_t *thiz)

Typedef Documentation

zrtos_task_id_t

typedef unsigned int zrtos_task_id_t

Definition at line 25 of file task.h.

zrtos_task_t

typedef struct _zrtos_task_t zrtos_task_t

zrtos_task_tick_t

typedef unsigned int zrtos_task_tick_t

Definition at line 24 of file task.h.

Enumeration Type Documentation

zrtos_task_state_t

enum zrtos_task_state_t

Enumerator
ZRTOS_TASK_STATE__READY
ZRTOS_TASK_STATE__RUNNING
ZRTOS_TASK_STATE__DONE
ZRTOS_TASK_STATE__MASK

Definition at line 27 of file task.h.

            {
     ZRTOS_TASK_STATE__READY   = 0x0000
    ,ZRTOS_TASK_STATE__RUNNING = 1 << (sizeof(zrtos_task_tick_t) * 8 - 2)
    ,ZRTOS_TASK_STATE__DONE    = 1 << (sizeof(zrtos_task_tick_t) * 8 - 1)
    ,ZRTOS_TASK_STATE__MASK    = ZRTOS_TASK_STATE__RUNNING
                               | ZRTOS_TASK_STATE__DONE
}zrtos_task_state_t;

Function Documentation

zrtos_task__get_errno()

zrtos_error_t zrtos_task__get_errno

(

zrtos_task_t *

thiz

)

Definition at line 136 of file task.h.

                                                       {
    return thiz->error_code;
}

Here is the caller graph for this function:

zrtos_task__get_next_task()

zrtos_task_t* zrtos_task__get_next_task

(

zrtos_task_t *

thiz

)

Definition at line 114 of file task.h.

                                                           {
    zrtos_clist_node_t *node = zrtos_clist_node__get_next_node(&thiz->node);
    return zrtos_types__get_container_of(node,zrtos_task_t,node);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task__get_parent()

zrtos_task_t* zrtos_task__get_parent

(

zrtos_task_t *

thiz

)

Definition at line 144 of file task.h.

                                                        {
    return thiz->parent;
}

Here is the caller graph for this function:

zrtos_task__get_previous_task()

zrtos_task_t* zrtos_task__get_previous_task

(

zrtos_task_t *

thiz

)

Definition at line 119 of file task.h.

                                                               {
    zrtos_clist_node_t *node = zrtos_clist_node__get_previous_node(&thiz->node);
    return zrtos_types__get_container_of(node,zrtos_task_t,node);
}

Here is the call graph for this function:

zrtos_task__get_stack_ptr()

zrtos_arch_stack_t* zrtos_task__get_stack_ptr

(

zrtos_task_t *

thiz

)

Definition at line 128 of file task.h.

                                                                 {
    return thiz->stack_ptr;
}

Here is the caller graph for this function:

zrtos_task__init()

bool zrtos_task__init	(	zrtos_task_t *	thiz,
		zrtos_arch_stack_t *	stack_ptr
	)

Definition at line 44 of file task.h.

 {
    if(zrtos_clist_node__init(&thiz->node)){
        thiz->parent = 0;
        thiz->stack_ptr = stack_ptr;
        thiz->ticks = 0;
        thiz->error_code = 0;
        return true;
    }
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task__init_ex()

bool zrtos_task__init_ex	(	zrtos_task_t *	thiz,
		zrtos_arch_stack_t *	heap,
		zrtos_arch_callback_t	callback,
		void *	args
	)

Definition at line 58 of file task.h.

 {
    return zrtos_task__init(
         thiz
        ,zrtos_arch__cpu_state_init(
            heap
            //,heap_size
            ,callback
            ,args
        )
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task__is_done()

bool zrtos_task__is_done

(

zrtos_task_t *

thiz

)

Definition at line 98 of file task.h.

                                            {
    return (thiz->ticks & ZRTOS_TASK_STATE__DONE) > 0;
}

Here is the caller graph for this function:

zrtos_task__is_ready()

bool zrtos_task__is_ready

(

zrtos_task_t *

thiz

)

Definition at line 90 of file task.h.

                                             {
    return thiz->ticks == 0;
}

Here is the caller graph for this function:

zrtos_task__is_running()

bool zrtos_task__is_running

(

zrtos_task_t *

thiz

)

Definition at line 94 of file task.h.

                                               {
    return (thiz->ticks & ZRTOS_TASK_STATE__RUNNING) > 0;
}

zrtos_task__on_tick()

void zrtos_task__on_tick

(

zrtos_task_t *

thiz

)

Definition at line 83 of file task.h.

                                            {
    zrtos_task_tick_t val  = thiz->ticks;
    if(0 == (val & ZRTOS_TASK_STATE__MASK)){
        thiz->ticks -= (val > 0);
    }
}

Here is the caller graph for this function:

zrtos_task__set_delay_ms()

void zrtos_task__set_delay_ms	(	zrtos_task_t *	thiz,
		zrtos_task_tick_t	ms
	)

Definition at line 75 of file 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_task__set_done()

void zrtos_task__set_done

(

zrtos_task_t *

thiz

)

Definition at line 110 of file task.h.

                                             {
    thiz->ticks |= ZRTOS_TASK_STATE__DONE;
}

Here is the caller graph for this function:

zrtos_task__set_errno()

void zrtos_task__set_errno	(	zrtos_task_t *	thiz,
		zrtos_error_t	error_code
	)

Definition at line 132 of file task.h.

                                                                       {
    thiz->error_code = error_code;
}

Here is the caller graph for this function:

zrtos_task__set_parent()

void zrtos_task__set_parent	(	zrtos_task_t *	thiz,
		zrtos_task_t *	parent
	)

Definition at line 140 of file task.h.

                                                                    {
    thiz->parent = parent;
}

Here is the caller graph for this function:

zrtos_task__set_ready()

void zrtos_task__set_ready

(

zrtos_task_t *

thiz

)

Definition at line 102 of file task.h.

                                              {
    thiz->ticks ^= (thiz->ticks & ZRTOS_TASK_STATE__MASK);
}

zrtos_task__set_running()

void zrtos_task__set_running

(

zrtos_task_t *

thiz

)

Definition at line 106 of file task.h.

                                                {
    thiz->ticks |= ZRTOS_TASK_STATE__RUNNING;
}

zrtos_task__set_stack_ptr()

void zrtos_task__set_stack_ptr	(	zrtos_task_t *	thiz,
		zrtos_arch_stack_t *	stack_ptr
	)

Definition at line 124 of file task.h.

                                                                                {
    thiz->stack_ptr = stack_ptr;
}

Here is the caller graph for this function: