/*************************************************************************/ /*!
@File			vmm_pvz_client.c
@Title          VM manager client para-virtualization
@Copyright      Copyright (c) Imagination Technologies Ltd. All Rights Reserved
@Description    Header provides VMM client para-virtualization APIs
@License        Dual MIT/GPLv2

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.

Alternatively, the contents of this file may be used under the terms of
the GNU General Public License Version 2 ("GPL") in which case the provisions
of GPL are applicable instead of those above.

If you wish to allow use of your version of this file only under the terms of
GPL, and not to allow others to use your version of this file under the terms
of the MIT license, indicate your decision by deleting the provisions above
and replace them with the notice and other provisions required by GPL as set
out in the file called "GPL-COPYING" included in this distribution. If you do
not delete the provisions above, a recipient may use your version of this file
under the terms of either the MIT license or GPL.

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.
*/ /**************************************************************************/

#include "pvrsrv.h"
#include "img_types.h"
#include "pvrsrv_error.h"

#include "vmm_impl.h"
#include "vz_vmm_pvz.h"
#include "vz_physheap.h"
#include "vmm_pvz_client.h"


static inline void
PvzClientLockAcquire(void)
{
	PVRSRV_DATA *psPVRSRVData = PVRSRVGetPVRSRVData();
	OSLockAcquire(psPVRSRVData->hPvzConnectionLock);
}

static inline void
PvzClientLockRelease(void)
{
	PVRSRV_DATA *psPVRSRVData = PVRSRVGetPVRSRVData();
	OSLockRelease(psPVRSRVData->hPvzConnectionLock);
}

/*
 * ===========================================================
 *  The following client para-virtualization (pvz) functions
 *  are exclusively called by guests to initiate a pvz call
 *  to the host via hypervisor (guest -> vm manager -> host)
 * ===========================================================
 */

PVRSRV_ERROR 
PvzClientCreateDevConfig(PVRSRV_DEVICE_CONFIG *psDevConfig,
						 IMG_UINT32 ui32DevID)
{
	IMG_UINT32 ui32IRQ;
	PVRSRV_ERROR eError;
	IMG_UINT32 ui32RegsSize;
	IMG_UINT64 ui64RegsCpuPBase;
	VMM_PVZ_CONNECTION *psVmmPvz;
	IMG_UINT32 uiFuncID = PVZ_BRIDGE_CREATEDEVICECONFIG;

	psVmmPvz = SysVzPvzConnectionAcquire();
	PVR_ASSERT(psVmmPvz);

	PvzClientLockAcquire();

	PVR_ASSERT(psVmmPvz->sHostFuncTab.pfnCreateDevConfig);

	eError = psVmmPvz->sHostFuncTab.pfnCreateDevConfig(uiFuncID,
													   ui32DevID,
													   &ui32IRQ,
													   &ui32RegsSize,
													   &ui64RegsCpuPBase);
	if (eError != PVRSRV_OK)
	{
		if (eError == PVRSRV_ERROR_NOT_IMPLEMENTED)
		{
			eError = PVRSRV_OK;
		}

		goto e0;
	}

	/* Device VM system configuration MMIO/IRQ values */
	if (ui64RegsCpuPBase)
	{
		psDevConfig->sRegsCpuPBase.uiAddr = ui64RegsCpuPBase;
	}

	if (ui32RegsSize)
	{
		psDevConfig->ui32RegsSize = ui32RegsSize;
	}

	if (ui32IRQ)
	{
		psDevConfig->ui32IRQ = ui32IRQ;
	}

e0:
	PvzClientLockRelease();
	SysVzPvzConnectionRelease(psVmmPvz);

	PVR_ASSERT(psDevConfig->sRegsCpuPBase.uiAddr);
	PVR_ASSERT(psDevConfig->ui32RegsSize);
	PVR_ASSERT(psDevConfig->ui32IRQ);
	PVR_ASSERT(eError == PVRSRV_OK);
	return eError;
}

PVRSRV_ERROR
PvzClientDestroyDevConfig(PVRSRV_DEVICE_CONFIG *psDevConfig,
						  IMG_UINT32 ui32DevID)
{
	PVRSRV_ERROR eError;
	VMM_PVZ_CONNECTION *psVmmPvz;
	IMG_UINT32 uiFuncID = PVZ_BRIDGE_DESTROYDEVICECONFIG;

	PVR_UNREFERENCED_PARAMETER(psDevConfig);

	psVmmPvz = SysVzPvzConnectionAcquire();
	PVR_ASSERT(psVmmPvz);

	PvzClientLockAcquire();

	PVR_ASSERT(psVmmPvz->sHostFuncTab.pfnDestroyDevConfig);

	eError = psVmmPvz->sHostFuncTab.pfnDestroyDevConfig(uiFuncID,
														ui32DevID);
	if (eError != PVRSRV_OK)
	{
		if (eError == PVRSRV_ERROR_NOT_IMPLEMENTED)
		{
			eError = PVRSRV_OK;
		}

		goto e0;
	}

e0:
	PvzClientLockRelease();
	SysVzPvzConnectionRelease(psVmmPvz);

	PVR_ASSERT(eError == PVRSRV_OK);
	return eError;
}

PVRSRV_ERROR 
PvzClientCreateDevPhysHeaps(PVRSRV_DEVICE_CONFIG *psDevConfig,
							IMG_UINT32 ui32DevID)
{
	PVRSRV_ERROR eError;
	IMG_UINT32 ui32HeapType;
	PHYS_HEAP_TYPE eHeapType;
	IMG_UINT64 ui64FwPhysHeapSize;
	IMG_UINT64 ui64FwPhysHeapAddr;
	IMG_UINT64 ui64GpuPhysHeapSize;
	IMG_UINT64 ui64GpuPhysHeapAddr;
	VMM_PVZ_CONNECTION *psVmmPvz;
	PVRSRV_DEVICE_PHYS_HEAP ePhysHeap;
	IMG_UINT32 uiFuncID = PVZ_BRIDGE_CREATEDEVICEPHYSHEAPS;

	psVmmPvz = SysVzPvzConnectionAcquire();
	PVR_ASSERT(psVmmPvz);

	PvzClientLockAcquire();

	PVR_ASSERT(psVmmPvz->sHostFuncTab.pfnCreateDevPhysHeaps);

	eError = psVmmPvz->sHostFuncTab.pfnCreateDevPhysHeaps(uiFuncID,
														  ui32DevID,
														  &ui32HeapType,
														  &ui64FwPhysHeapSize,
														  &ui64FwPhysHeapAddr,
														  &ui64GpuPhysHeapSize,
														  &ui64GpuPhysHeapAddr);
	if (eError != PVRSRV_OK)
	{
		if (eError == PVRSRV_ERROR_NOT_IMPLEMENTED)
		{
			eError = PVRSRV_OK;
		}

		goto e0;
	}

	eHeapType = (PHYS_HEAP_TYPE) ui32HeapType;
	for (ePhysHeap = 0; ePhysHeap < PVRSRV_DEVICE_PHYS_HEAP_LAST; ePhysHeap++)
	{
		IMG_UINT64 ui64PhysHeapSize;
		IMG_DEV_PHYADDR sPhysHeapAddr;

		switch (ePhysHeap)
		{
			case PVRSRV_DEVICE_PHYS_HEAP_GPU_LOCAL:
				sPhysHeapAddr.uiAddr = ui64GpuPhysHeapAddr;
				ui64PhysHeapSize = ui64GpuPhysHeapSize;
				break;

			case PVRSRV_DEVICE_PHYS_HEAP_FW_LOCAL:
				sPhysHeapAddr.uiAddr = ui64FwPhysHeapAddr;
				ui64PhysHeapSize = ui64FwPhysHeapSize;
				break;

			default:
				ui64PhysHeapSize = (IMG_UINT64)0;
				break;
		}

		if (ui64PhysHeapSize)
		{
			eError = SysVzSetPhysHeapAddrSize(psDevConfig,
											  ePhysHeap,
											  eHeapType,
											  sPhysHeapAddr,
											  ui64PhysHeapSize);
			PVR_ASSERT(eError == PVRSRV_OK);

			eError = SysVzRegisterPhysHeap(psDevConfig, ePhysHeap);
			PVR_ASSERT(eError == PVRSRV_OK);
		}
	}

e0:
	PvzClientLockRelease();
	SysVzPvzConnectionRelease(psVmmPvz);

	PVR_ASSERT(eError == PVRSRV_OK);
	return eError;
}

PVRSRV_ERROR
PvzClientDestroyDevPhysHeaps(PVRSRV_DEVICE_CONFIG *psDevConfig,
							 IMG_UINT32 ui32DevID)
{
	PVRSRV_ERROR eError;
	VMM_PVZ_CONNECTION *psVmmPvz;
	IMG_UINT32 uiFuncID = PVZ_BRIDGE_DESTROYDEVICEPHYSHEAPS;

	PVR_UNREFERENCED_PARAMETER(psDevConfig);

	psVmmPvz = SysVzPvzConnectionAcquire();
	PVR_ASSERT(psVmmPvz);

	PvzClientLockAcquire();

	PVR_ASSERT(psVmmPvz->sHostFuncTab.pfnDestroyDevPhysHeaps);

	eError = psVmmPvz->sHostFuncTab.pfnDestroyDevPhysHeaps(ui32DevID,
														   uiFuncID);
	if (eError != PVRSRV_OK)
	{
		if (eError == PVRSRV_ERROR_NOT_IMPLEMENTED)
		{
			eError = PVRSRV_OK;
		}

		goto e0;
	}

e0:
	PvzClientLockRelease();
	SysVzPvzConnectionRelease(psVmmPvz);

	PVR_ASSERT(eError == PVRSRV_OK);
	return eError;
}

PVRSRV_ERROR
PvzClientMapDevPhysHeap(PVRSRV_DEVICE_CONFIG *psDevConfig,
						IMG_UINT32 ui32DevID,
						IMG_DEV_PHYADDR sDevPAddr,
						IMG_UINT64 ui64DevPSize)
{
	PVRSRV_ERROR eError;
	VMM_PVZ_CONNECTION *psVmmPvz;
	IMG_UINT32 uiFuncID = PVZ_BRIDGE_MAPDEVICEPHYSHEAP;

	psVmmPvz = SysVzPvzConnectionAcquire();
	PVR_ASSERT(psVmmPvz);

	PvzClientLockAcquire();

	PVR_ASSERT(psVmmPvz->sHostFuncTab.pfnMapDevPhysHeap);

	eError = psVmmPvz->sHostFuncTab.pfnMapDevPhysHeap(uiFuncID,
													  ui32DevID,
													  ui64DevPSize,
													  sDevPAddr.uiAddr);
	if (eError != PVRSRV_OK)
	{
		goto e0;
	}

e0:
	PvzClientLockRelease();
	SysVzPvzConnectionRelease(psVmmPvz);

	PVR_ASSERT(eError == PVRSRV_OK);
	return eError;
}

PVRSRV_ERROR
PvzClientUnmapDevPhysHeap(PVRSRV_DEVICE_CONFIG *psDevConfig,
						  IMG_UINT32 ui32DevID)
{
	PVRSRV_ERROR eError;
	VMM_PVZ_CONNECTION *psVmmPvz;
	IMG_UINT32 uiFuncID = PVZ_BRIDGE_UNMAPDEVICEPHYSHEAP;

	psVmmPvz = SysVzPvzConnectionAcquire();
	PVR_ASSERT(psVmmPvz);

	PvzClientLockAcquire();

	PVR_ASSERT(psVmmPvz->sHostFuncTab.pfnUnmapDevPhysHeap);

	eError = psVmmPvz->sHostFuncTab.pfnUnmapDevPhysHeap(uiFuncID,
														ui32DevID);
	if (eError != PVRSRV_OK)
	{
		goto e0;
	}

e0:
	PvzClientLockRelease();
	SysVzPvzConnectionRelease(psVmmPvz);

	PVR_ASSERT(eError == PVRSRV_OK);
	return eError;
}

/******************************************************************************
 End of file (vmm_pvz_client.c)
******************************************************************************/