//*------------------------------------------------------------------------------------------------
//* 文件名				: os_api.c
//* 功能描述			: 基于uC/OS基本函數庫開發的能夠最大限度滿足上層系統需求的API。
//* 作者    			: 焦海波
//* 版本				: 0.1
//* 建立日期、時間		: 2006/06/10 10:45
//* 最近修改日期、時間	: 
//* 修改原因			: 
//*------------------------------------------------------------------------------------------------
//*------------------------------------------ 頭文件 -----------------------------------------------
#include	"/uCOS_II/includes.h"
//*================================================================================================
//*											函	數	區
//*================================================================================================
//*------------------------------------------------------------------------------------------------
//* 函數名稱 : __MSToOSTicks
//* 功能描述 : 將毫秒轉變成時鐘節拍
//* 入口參數 : <uwMS>[in] 節拍數
//* 出口參數 : 毫秒數
//*------------------------------------------------------------------------------------------------
static UWORD __MSToOSTicks(UWORD uwMS)
{
	UWORD	__uwDelayTicks;
	
	if(uwMS != 0)
	{
		__uwDelayTicks = (uwMS * OS_TICKS_PER_SEC)/1000;
		if(__uwDelayTicks < 1)
			__uwDelayTicks = 1;
		else if(__uwDelayTicks > 65535)
			__uwDelayTicks = 65535;
		else;
	}
	else
		__uwDelayTicks = 0;		
		
	return __uwDelayTicks;
}
//*------------------------------------------------------------------------------------------------
//* 函數名稱 : OSAPISemWait
//* 功能描述 : 在指定的時間內（單位為毫秒）等待指定的信號量可用
//* 入口參數 :     <hSem>[in] 等待的信號量句柄
//*			 : <uwWaitMS>[in] 指定最長等待時間單位為毫秒，實際等待時間為內核調度間隔時間的整數倍，0ms表示
//*			 :                該函數將無限期等待下去直至信號量可用
//* 出口參數 : - OS_NO_ERR         : 信號量可用
//*			 : - OS_TIMEOUT        : 時間溢出，信號量不可用
//*			 : - OS_ERR_EVENT_TYPE : hSem參數攜帶的事件類型并不是信號量而是其它類型
//*			 : - OS_ERR_PEND_ISR   : 不能在ISR中調用該函數
//*			 : - OS_ERR_PEVENT_NULL: hSem是一個空指針
//*------------------------------------------------------------------------------------------------
UBYTE OSAPISemWait(HANDLER hSem, UWORD uwWaitMS)
{
	UBYTE	__ubRtnVal;	
		
	OSSemPend(hSem, __MSToOSTicks(uwWaitMS), &__ubRtnVal);
	
	return __ubRtnVal;
}
//*------------------------------------------------------------------------------------------------
//* 函數名稱 : OSAPISemFree
//* 功能描述 : 刪除指定的信號量，如果仍然有任務在等待指定的信號量，該函數不會刪除這個信號量，不過它會不斷嘗
//*			 : 試刪除這個信號量直至沒有任何任務等待該信號量時將其刪除
//* 入口參數 : <hSem>[in] 指定刪除的信號量句柄
//* 出口參數 : 無
//*------------------------------------------------------------------------------------------------
void OSAPISemFree(HANDLER hSem)
{
	UBYTE	__ubErr;
	
	while(NULL != OSSemDel(hSem, OS_DEL_NO_PEND, &__ubErr))
		OSTimeDlyHMSM(0, 0, 0, 100);
}
//*------------------------------------------------------------------------------------------------
//* 函數名稱 : OSAPISemFreeExt
//* 功能描述 : 刪除指定的信號量，該函數相對于OSAPISemFree()函數，當出現仍然有任務在等待該信號量的情況時，所
//*			 : 有等待該信號量的任務都將進入就緒態，每個任務都得到了該信號量。
//* 入口參數 : <hSem>[in] 指定刪除的信號量句柄
//* 出口參數 : 無
//*------------------------------------------------------------------------------------------------
void OSAPISemFreeExt(HANDLER hSem)
{
	UBYTE	__ubErr;
	
	while(NULL != OSSemDel(hSem, OS_DEL_ALWAYS, &__ubErr))
		OSTimeDlyHMSM(0, 0, 0, 100);
}
//*------------------------------------------------------------------------------------------------
//* 函數名稱 : OSAPIBlockNew
//* 功能描述 : 建立一個新的阻塞信號
//* 入口參數 : <ubPIP>[in] 指定在出現優先級反轉時（高優先級的任務因為低優先級的任務占用同一個阻塞量而不得不
//*			 :             暫時中斷正常運行以等待該阻塞量被釋放從而造成事實上的優先級降低的問題），正在占用
//*			 :             該阻塞量的任務使用的較高優先級以便能夠快速完成訪問，釋放該阻塞量 
//* 出口參數 : 建立成功返回阻塞信號句柄，否則為NULL
//*------------------------------------------------------------------------------------------------
HANDLER OSAPIBlockNew(UBYTE ubPIP)
{
	UBYTE		__ubErr;
	
	return OSMutexCreate(ubPIP, &__ubErr);
}
//*------------------------------------------------------------------------------------------------
//* 函數名稱 : OSAPIBlockEnter
//* 功能描述 : 進入阻塞資源，如果該資源仍然被其它任務占用，則會阻塞當前任務進程，直至指定的時間溢出或者資源
//*          : 可用
//* 入口參數 :   <hBlock>[in] 指定要使用的阻塞信號量
//*			 : <uwWaitMS>[in] 指定被阻塞的最長時間，單位為毫秒 
//* 出口參數 : - OS_NO_ERR         : 信號量可用
//*			 : - OS_TIMEOUT        : 時間溢出，信號量不可用
//*			 : - OS_ERR_EVENT_TYPE : hSem參數攜帶的事件類型并不是信號量而是其它類型
//*			 : - OS_ERR_PEND_ISR   : 不能在ISR中調用該函數
//*			 : - OS_ERR_PEVENT_NULL: hSem是一個空指針
//*------------------------------------------------------------------------------------------------
UBYTE OSAPIBlockEnter(HANDLER hBlock, UWORD uwWaitMS)
{
	UWORD	__uwDelayTicks;
	UBYTE	__ubRtnVal;
	
	if(uwWaitMS != 0)
	{
		__uwDelayTicks = (uwWaitMS * OS_TICKS_PER_SEC)/1000;
		if(__uwDelayTicks < 1)
			__uwDelayTicks = 1;
		else if(__uwDelayTicks > 65535)
			__uwDelayTicks = 65535;
		else;
	}
	else
		__uwDelayTicks = 0;
		
	OSMutexPend(hBlock, __uwDelayTicks, &__ubRtnVal);
	
	return __ubRtnVal;
}
//*------------------------------------------------------------------------------------------------
//* 函數名稱 : OSAPIQPost
//* 功能描述 : 投遞一個消息到指定的消息隊列
//* 入口參數 : <hQueue>[in] 指定要投遞到的消息隊列
//*          :  <pvMsg>[in] 指定要投遞的消息
//* 出口參數 : 與OSQPost()函數返回值除了沒有OS_Q_FULL之外，其它相同
//*------------------------------------------------------------------------------------------------
UBYTE OSAPIQPost(HANDLER hQueue, void *pvMsg)
{
	UBYTE	__ubErr;

	while((__ubErr = OSQPost(hQueue, pvMsg)) == OS_Q_FULL)
		OSTimeDlyHMSM(0, 0, 0, 100);
		
	return __ubErr;
}
//*------------------------------------------------------------------------------------------------
//* 函數名稱 : OSAPIQReceive
//* 功能描述 : 從指定的消息隊列接收消息，該函數會阻塞當前的調用任務直至超時或者收到消息
//* 入口參數 :    <hQueue>[in]  指定接收消息的消息隊列
//*          :     <ppMsg>[out] 結果參數，保存接收到的消息指針
//*          : <uwTimeout>[in]  指定等待接收的最長時間，為0表明一直等待直至接收到消息，單位為毫秒
//* 出口參數 : 與OSQPend()函數的結果參數err值完全相同
//*------------------------------------------------------------------------------------------------
UBYTE OSAPIQReceive(HANDLER hQueue, PP ppMsg, UWORD uwTimeout)
{
	UBYTE	__ubRtnVal;
	
	if(ppMsg != NULL)
		*ppMsg = OSQPend(hQueue, __MSToOSTicks(uwTimeout), &__ubRtnVal);
	else 
		OSQPend(hQueue, __MSToOSTicks(uwTimeout), &__ubRtnVal);
	
	return __ubRtnVal;
}