services/system/include/vz_vmm_pvz.h

/*************************************************************************/ /*!
@File           vz_vmm_pvz.h
@Title          System virtualization VM manager management APIs
@Copyright      Copyright (c) Imagination Technologies Ltd. All Rights Reserved
@Description    This header provides VM manager para-virtz management APIs
@License        MIT

The contents of this file are subject to the MIT license as set out below.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

This License is also included in this distribution in the file called
"MIT-COPYING".

EXCEPT AS OTHERWISE STATED IN A NEGOTIATED AGREEMENT: (A) THE SOFTWARE IS
PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT; AND (B) IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/ /**************************************************************************/

#ifndef _VZ_VMM_PVZ_H_
#define _VZ_VMM_PVZ_H_

#include "pvrsrv.h"
#include "img_types.h"
#include "vmm_impl.h"

/*!
******************************************************************************
 @Function			SysVzPvzConnectionInit() and SysVzPvzConnectionDeInit()

 @Description 		SysVzPvzConnectionInit initializes the VM manager para-virtz
					which is used subsequently for communication between guest and
					host; depending on the underlying VM setup, this could either be
					either a hyper-call or cross-VM call

 @Return			PVRSRV_ERROR	PVRSRV_OK on success. Otherwise, a PVRSRV_
									error code
 ******************************************************************************/
PVRSRV_ERROR SysVzPvzConnectionInit(void);
void SysVzPvzConnectionDeInit(void);

/*!
******************************************************************************
 @Function			 SysVzPvzConnectionAcquire() and SysVzPvzConnectionRelease()

 @Description 		 These are to acquire/release a handle to the VM manager para-virtz
					 connection to make a pvz call; on the client, use it to make the
					 actual pvz call and on the sever handler / VM manager, use it
					 to complete the processing for the pvz call or make a VM manager
					 to host pvzbridge call

 @Return			PVRSRV_ERROR	VMM_PVZ_CONNECTION* on success. Otherwise NULL
 ******************************************************************************/
VMM_PVZ_CONNECTION* SysVzPvzConnectionAcquire(void);
void SysVzPvzConnectionRelease(VMM_PVZ_CONNECTION *psPvzConnection);

#endif /* _VZ_VMM_PVZ_H_ */

/*****************************************************************************
 End of file (vz_vmm_pvz.h)
*****************************************************************************/