ubik.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_H_
#define UBIK_H_
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
#include <ubinos_config.h>
#include <ubinos/type.h>
 
#define UBIK_ERR__SUCCESS                 0
 
#define UBIK_ERR__FAIL                   -1
 
#define UBIK_ERR__TIMEOUT               -20
 
#define UBIK_ERR__DEADLOCK              -21
 
#define UBIK_ERR__TERMINATED            -30
 
#define UBIK_ERR__OVERFLOWED            -50
 
#define UBIK_TAG__USRSTART              0x8000
 
typedef int (*idletaskhookfunc_ft)(void *);
 
#define IDLEHOOKFUNC_OPT__REPEAT        0x00
 
#define IDLEHOOKFUNC_OPT__ONCE          0x80
 
typedef void (*tickhookfunc_ft)(void);
 
typedef struct _tickcount_t
{
    unsigned int high; 
    unsigned int low; 
} tickcount_t;
 
int ubik_comp_init(unsigned int idle_stackdepth);
 
int ubik_comp_start(void);
 
unsigned int ubik_gettickpersec(void);
 
tickcount_t ubik_gettickcount(void);
 
tickcount_t ubik_gettickdiff(tickcount_t tick1, tickcount_t tick2);
 
unsigned int ubik_timemstotick(unsigned int timems);
 
unsigned int ubik_ticktotimems(unsigned int tick);
 
int ubik_settickhookfunc(tickhookfunc_ft tickhookfunc);
 
int ubik_isactive(void);
 
void ubik_entercrit(void);
 
void ubik_exitcrit(void);
 
int ubik_iscrit(void);
 
int ubik_istask(void);
 
int ubik_collectgarbage(void);
 
int ubik_sprintkernelinfo(char * buf, int max);
 
int ubik_printkernelinfo(void);
 
int ubik_setidletaskhookfunc(idletaskhookfunc_ft func, void * arg,
        const char * name, unsigned int option);
 
int ubik_setrtpriority(int rtpriority);
 
int ubik_getrtpriority(void);
 
int ubik_isrt(void);
 
#include <ubinos/ubik/task.h>
#include <ubinos/ubik/signal.h>
#include <ubinos/ubik/sem.h>
#include <ubinos/ubik/mutex.h>
#include <ubinos/ubik/msgq.h>
#include <ubinos/ubik/condv.h>
#include <ubinos/ubik/hrtick.h>
#include <ubinos/ubik/stimer.h>
 
#ifdef  __cplusplus
}
#endif
 
#endif /* UBIK_H_ */