rzkgetpartitionparameters.c

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

/*
* File				:	RZKGetPartitionParameters
*
* Description		:	This file defines RZKGetPartitionParameters API
* 
* 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 "ZMemory.h"

#define pPartition ((RZK_PARTITION_t *) hPartition)

/* Function			:	RZKGetPartitionParameters
*
* Description		:	This function returns the partition parameters to the 
*							user specified structure.
* 
* Inputs			:	hPartition - This specifies the handle of the partition  whose
*									 parameters are to be fetched.
*						pPartitionParams - This is the pointer to the structure of type
*						RZK_PARTITIONPARAMS_t which receives memory partition parameters.
*							
* Outputs			:	RZKERR_INVALID_HANDLE - This indicates that the passed
*												handle was invalid.
*						RZKERR_CB_BUSY- When the partition is being used exclusively
*										by another object.
*						RZKERR_INVALID_ARGUMENTS - This indicates that pPartitionParams 
*													parameter is invalid
*							
*
* Dependencies		:	None.
*/
RZK_STATUS_t RZKGetPartitionParameters
						(
							RZK_PARTITIONHANDLE_t hPartition, 
							RZK_PARTITIONPARAMS_t *pPartitionParams
						)
{

#ifdef  RZK_DEBUG
	if ( (pPartition == NULL)||(pPartition->uState == 0) ||
		( pPartition->magic_num != MAGIC_NUM_MEMORY))
			return RZKERR_INVALID_HANDLE;
	if ( pPartitionParams  ==  NULL )
			return RZKERR_INVALID_ARGUMENTS;
#endif 

#ifndef RZK_PERFORMANCE
	if(!(pPartition->uState & OBJECT_CREATED))
		return 	RZKERR_CB_BUSY;
#endif
	
	/* Follwing partition parameters can be read using the above API */
	pPartitionParams->uState = pPartition->uState;
	pPartitionParams->uNumOfBlocks = pPartition->uMemoryBlocks;
	pPartitionParams->uBlockSize =  pPartition->uBlockSize ;
	pPartitionParams->uBlocksUsed = pPartition->uMemoryBlocks -
											pPartition->uMemoryBlocksLeft;
	pPartitionParams->pMemory = pPartition->pMemory;
	return RZKERR_SUCCESS;

}  /*End of RZKGetPartitionParameters*/