/*
*********************************************************************************************************
*                                      minOS 0.01v
*                                The Real-Time OS Kernel
*                                  All Rights Reserved
* File : OS_minOS.h
* 作者 : 21icbbs網友 LM7556 ,2004年7月   by : LM7556 , China , 2004-2004 
*
*********************************************************************************************************
*/

#ifdef  OS_GLOBALS
#define OS_EXT
#else
#define OS_EXT  extern
#endif

/********** Declare Task Status Message  ***************************/
#define no_TASK_Rdy 	   0xff		//noTASK_Rdy      --- No any task is ready for run.

#define OS_TASK_Suspend    0xfd		//OSTASK_Suspend  --- A task is Suspend.
#define OS_TASK_Rdy 	   0xfc		//OSTASK_Run      --- A task is ready for run.
#define OS_TASK_Run 	   0xfb		//OSTASK_Run      --- A task is running.
#define OS_TASK_WaitTicks  0xfa		//OSTASK_TimeOut  --- A task is waitting for time ticks.

#define OS_TASK_TimeOut	   0x0		//OSTASK_TimeOut  --- A task is time ticks out.

/********** Declare Variables  ***************************/
OS_EXT INT8U OS_TASK_CrtPrio;	//save current priority that task is run   --- 保存正在運行的任務優先級。
OS_EXT INT8U OS_TASK_HighPri;   //save highest priority that task is ready --- 保存處于準備就緒任務的最高優先級。

//Declare task control block OS_TCB --- 聲明任務控制塊結構體。
typedef struct  
{
	 INT16U          OSStkTop;         // Pointer to task top of stack                             
	 INT8U           OSTaskStatus;     // for OSTaskSuspend(INT8U TaskPrio),OSTaskResume(INT8U TaskPrio)
	 INT16U          OSTimeDly;        // for OSTaskSuspend(INT8U TaskPrio),OSTaskResume(INT8U TaskPrio)
} OS_TCB;
OS_EXT OS_TCB	OSTCB[OS_MAX_TASKS];	//Task Control Block Array --- 任務控制塊數組。

#define OS_TASK_Me OS_TASK_CrtPrio

OS_EXT OS_STK TASK_main_PrioStk[MAX_STK_SIZE];   //聲明任務TaskC(void)的堆棧空間。


/********** Declare Functions for user application **********************************/
OS_EXT void		OSInit(void);			       //initialization OSTCB --- 初始化任務控制塊.
OS_EXT void		OSStart(void);                 //Start OS --- 啟動OS。
OS_EXT void 	OSTaskResume(INT8U TaskPrio);  //Resume a task --- 恢復被掛起的任務。
OS_EXT void 	OSTaskSuspend(INT8U TaskPrio); //Suspend a task --- 把正在運行的任務掛起。
OS_EXT void 	OSTimeDly(INT16U Tdly);        //OS Time Delay --- 使任務延時Tdly個時間節拍。

//Create a Task --- 建立一個任務。
//Inport :  tFunc --- Task function address , tStk --- stack bottom , prio --- Task Priority .
OS_EXT void 	OSTaskCreate (void (*tFunc)(void) , OS_STK *tStk, INT8U prio);

/*********** Declare Functions for minOS **********************************/
OS_EXT void 	OSCtxSw(void);
OS_EXT void 	OSSched(void);
OS_EXT void 	OSTimeTick(void); 
 
/*********** Declare Functions for CPU specific **********************************/
OS_EXT void 	InitOSTimer(void);

/********** Declare Functions for User hooks *******************/
OS_EXT void 	AppTickHook(void);		    //Hook file for a time tick --- 用戶每個時間節拍的鉤子函數。