task.h

Go to the documentation of this file.

/*
 Copyright (C) 2009 Sung Ho Park
 Contact: ubinos.org@gmail.com
 
 This file is part of the itf_ubinos component of the Ubinos.
 
 GNU General Public License Usage
 This file may be used under the terms of the GNU
 General Public License version 3.0 as published by the Free Software
 Foundation and appearing in the file license_gpl3.txt included in the
 packaging of this file. Please review the following information to
 ensure the GNU General Public License version 3.0 requirements will be
 met: http://www.gnu.org/copyleft/gpl.html.
 
 GNU Lesser General Public License Usage
 Alternatively, this file may be used under the terms of the GNU Lesser
 General Public License version 2.1 as published by the Free Software
 Foundation and appearing in the file license_lgpl.txt included in the
 packaging of this file. Please review the following information to
 ensure the GNU Lesser General Public License version 2.1 requirements
 will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 
 Commercial Usage
 Alternatively, licensees holding valid commercial licenses may
 use this file in accordance with the commercial license agreement
 provided with the software or, alternatively, in accordance with the
 terms contained in a written agreement between you and rightful owner.
 */
 
#ifndef UBIK_TASK_H_
#define UBIK_TASK_H_
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
#include <ubinos_config.h>
#include <ubinos/type.h>
 
#define TASK_WAITOPT__IGNOREINVALID     0x80
 
#define TASK_WAITOPT__ALL               0x40
 
typedef void (*taskfunc_ft)(void *);
 
typedef struct __task_tip_t
{
    unsigned int type :8; 
    unsigned int valid :1; 
    unsigned int reserved :7; 
    unsigned int reserved2 :16; 
} _task_tip_t;
 
typedef _task_tip_t * task_pt;
 
int task_create(task_pt * task_p, taskfunc_ft func, void * arg, int priority,
        unsigned int stackdepth, const char * name);
 
int task_create_ext(task_pt * task_p, taskfunc_ft func, void * arg,
        int priority, unsigned int stackdepth, const char * name,
        unsigned int tag, unsigned int option);
 
int task_delete(task_pt * task_p);
 
int task_suspend(task_pt task);
 
int task_resume(task_pt task);
 
int task_sleep(unsigned int tick);
 
int task_sleepms(unsigned int timems);
 
int task_setpriority(task_pt task, int priority);
 
int task_getpriority(task_pt task);
 
int task_gethighestpriority(void);
 
int task_getlowestpriority(void);
 
int task_getmiddlepriority(void);
 
void task_lock(void);
 
void task_unlock(void);
 
int task_setmaxwaitsigobj(task_pt task, int max);
 
int task_getmaxwaitsigobj(task_pt task);
 
int task_waitforsigobjs(void ** sigobj_p, int * sigtype_p, void ** param_p,
        int count, unsigned int waitopt);
 
int task_waitforsigobjs_timed(void ** sigobj_p, int * sigtype_p,
        void ** param_p, int count, unsigned int waitopt, unsigned int tick);
 
int task_waitforsigobjs_timedms(void ** sigobj_p, int * sigtype_p,
        void ** param_p, int count, unsigned int waitopt, unsigned int timems);
 
int task_join(task_pt * task_p, int * result_p, int count);
 
int task_join_timed(task_pt * task_p, int * result_p, int count,
        unsigned int tick);
 
int task_join_timedms(task_pt * task_p, int * result_p, int count,
        unsigned int timems);
 
task_pt task_getcur(void);
 
unsigned int task_getremainingtimeout(void);
 
unsigned int task_getremainingtimeoutms(void);
 
unsigned int task_getminstackdepth(void);
 
unsigned int task_getdefaultstackdepth(void);
 
int task_getstacksize(task_pt task, unsigned int * stacksize_p);
 
int task_getmaxstackusage(task_pt task, unsigned int * maxstackusage_p);
 
#ifdef  __cplusplus
}
#endif
 
#endif /* UBIK_TASK_H_ */