gettimerparams.c

zilog的实时操作系统RZK,可以移植到多种处理器上

/*
* File			:	RZKGetTimerParameters.c
*
* Description	:	This file contains the RZKGetTimerParameters function.
* 
* Copyright 2004 ZiLOG Inc.  ALL RIGHTS RESERVED.
*
* This file contains unpublished confidential and proprietary information
* of ZiLOG, Inc.
* NO PART OF THIS WORK MAY BE DUPLICATED, STORED, PUBLISHED OR DISCLOSED 
* IN ANY FORM WITHOUT THE PRIOR WRITTEN CONSENT OF ZiLOG, INC.
* This is not a license and no use of any kind of this work is authorized
* in the absence of a written license granted by ZiLOG, Inc. in ZiLOG's 
* sole discretion 
*/

#include "ZSysgen.h"
#include "ZTypes.h"
#include "ZTimer.h"

#define pTimer ((RZK_TIMER_t *) hTimer)
 


/*
* Function		:	RZKGetTimerParameters
*
* Description	:	This function copies the parameters of timer control 
*					block to user specified structure's fields
* 
* Inputs		:	hTimer - handle to timer object
*					pTimerParams - pointer to user specified structure	
*
* Outputs		:	RZKERR_INVALID_HANDLE - handle of the timer object is invalid.
*					RZKERR_CB_BUSY - timer control block is being exclusively used by another object.
*					RZKERR_SUCCESS - timer object is enabled
*					RZK_INVALID_ARGUMENTS - the parameter passed is invalid.
*
* Dependencies	:	None
*/

RZK_STATUS_t RZKGetTimerParameters
					(
					RZK_TIMERHANDLE_t hTimer,
					RZK_TIMERPARAMS_t *pTimerParams
					)
{

#ifdef RZK_DEBUG
	if( (pTimer == NULL) || (pTimer->uState == 0) || (pTimer->magic_num != MAGIC_NUM_TIMER))
		return RZKERR_INVALID_HANDLE;

	if(pTimerParams == NULL)
		return RZKERR_INVALID_ARGUMENTS;
#endif

#ifndef RZK_PERFORMANCE
	if(!(pTimer -> uState & OBJECT_CREATED))
		return RZKERR_CB_BUSY;
#endif
/* Initialize the timer parameters structure with values from Timer control Block */
	pTimerParams->tInitialDelay = pTimer->tInitialTime;
	pTimerParams->tPeriod = pTimer->tPeriod;
	return RZKERR_SUCCESS;

} /* end of RZKGetTimerParameters */