rzkgetregionparameters.c

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

/*
* File			:	RZKGetRegionParameters.c
*
* Description	:	This file contains RZKGetRegionParameters function which gets 
*					the region parameters.
* 
* 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 "ZThread.h"
#include "ZQueue.h" 
#include "ZInterrupt.h"
#include "ZRegion.h"

#define pRegion  ((RZK_REGION_t *) hRegion)

/*
* Function		:	RZKGetRegionParameters
*
* Description	:	Gets the region parameters into the user-specified structure
* 
* Inputs		:	hRegion  -  handle to the Region whose parameters are to be got.
*					pRegionParams - pointer to the REGION_PARAMS_t structure which contains the region parameters after get.	
*
* Outputs		:	RZKERR_SUCCESS - If the parameters are successfully set.
*					RZKERR_CB_BUSY- If the region control block is being used by other thread exclusively.
*					RZKERR_INVALID_HANDLE - If the hRegion is invalid.
*					RZKERR_INVALID_ARGUMENTS - If the parameters are invalid.
*
* Dependencies	:	None
*/

RZK_STATUS_t RZKGetRegionParameters
					(	
						RZK_REGIONHANDLE_t hRegion,
						RZK_REGIONPARAMS_t *pRegionParams
					)
{
	/* Check for the validity of the arguments */
#ifdef RZK_DEBUG
	if( pRegion == NULL )
		return RZKERR_INVALID_HANDLE;
	if ( ( pRegion -> uState ==  0 ) ||
			( pRegion -> magic_num != MAGIC_NUM_REGION))
			return RZKERR_INVALID_HANDLE;
	if ( pRegionParams == NULL)
			return RZKERR_INVALID_ARGUMENTS;
#endif

	if(!(pRegion->uState & OBJECT_CREATED))
		return RZKERR_CB_BUSY;
			
	pRegionParams->uState = pRegion -> uState ;
	pRegionParams->uUnit_Size = pRegion -> uUnit_Size ;
	pRegionParams->uRnDelete = pRegion->uRnDelete ;
		
	return RZKERR_SUCCESS;
}   /* end of RZKGetRegionParams */