gralloc/gralloc_module.cpp - device/linaro/hikey960 - Gitiles

 /*
  * Copyright (C) 2010 ARM Limited. All rights reserved.
  *
  * Copyright (C) 2008 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * You may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 #include <errno.h>
 #include <pthread.h>
 #include <string.h>
 //#include <sync/sync.h>
 #include <android/sync.h>

 #include <cutils/log.h>
 #include <cutils/atomic.h>
 #include <hardware/hardware.h>
 #include <hardware/gralloc.h>

 #include "gralloc_priv.h"
 #include "alloc_device.h"
 #include "framebuffer_device.h"

 #if GRALLOC_ARM_UMP_MODULE
 #include <ump/ump_ref_drv.h>
 static int s_ump_is_open = 0;
 #endif

 #if GRALLOC_ARM_DMA_BUF_MODULE
 #include <linux/ion.h>
 #include <ion/ion.h>
 #include <sys/mman.h>
 #endif

 static pthread_mutex_t s_map_lock = PTHREAD_MUTEX_INITIALIZER;

 static int gralloc_device_open(const hw_module_t *module, const char *name, hw_device_t **device)
 {
 	int status = -EINVAL;

 	if (!strncmp(name, GRALLOC_HARDWARE_GPU0, MALI_GRALLOC_HARDWARE_MAX_STR_LEN))
 	{
 		status = alloc_device_open(module, name, device);
 	}
 	else if (!strncmp(name, GRALLOC_HARDWARE_FB0, MALI_GRALLOC_HARDWARE_MAX_STR_LEN))
 	{
 		status = framebuffer_device_open(module, name, device);
 	}

 	return status;
 }

 static int gralloc_register_buffer(gralloc_module_t const *module, buffer_handle_t handle)
 {
 	MALI_IGNORE(module);

 	if (private_handle_t::validate(handle) < 0)
 	{
 		AERR("Registering invalid buffer %p, returning error", handle);
 		return -EINVAL;
 	}

 	// if this handle was created in this process, then we keep it as is.
 	private_handle_t *hnd = (private_handle_t *)handle;

 	int retval = -EINVAL;

 	pthread_mutex_lock(&s_map_lock);

 #if GRALLOC_ARM_UMP_MODULE

 	if (!s_ump_is_open)
 	{
 		ump_result res = ump_open(); // MJOLL-4012: UMP implementation needs a ump_close() for each ump_open

 		if (res != UMP_OK)
 		{
 			pthread_mutex_unlock(&s_map_lock);
 			AERR("Failed to open UMP library with res=%d", res);
 			return retval;
 		}

 		s_ump_is_open = 1;
 	}

 #endif

 	hnd->pid = getpid();

 	if (hnd->flags & private_handle_t::PRIV_FLAGS_FRAMEBUFFER)
 	{
 		AINF("Register buffer %p although it will be treated as a nop", handle);
 		retval = 0;
 	}
 	else if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_UMP)
 	{
 #if GRALLOC_ARM_UMP_MODULE
 		hnd->ump_mem_handle = (int)ump_handle_create_from_secure_id(hnd->ump_id);

 		if (UMP_INVALID_MEMORY_HANDLE != (ump_handle)hnd->ump_mem_handle)
 		{
 			hnd->base = ump_mapped_pointer_get((ump_handle)hnd->ump_mem_handle);

 			if (0 != hnd->base)
 			{
 				hnd->writeOwner = 0;
 				hnd->lockState &= ~(private_handle_t::LOCK_STATE_UNREGISTERED);

 				pthread_mutex_unlock(&s_map_lock);
 				return 0;
 			}
 			else
 			{
 				AERR("Failed to map UMP handle 0x%x", hnd->ump_mem_handle);
 			}

 			ump_reference_release((ump_handle)hnd->ump_mem_handle);
 		}
 		else
 		{
 			AERR("Failed to create UMP handle 0x%x", hnd->ump_mem_handle);
 		}

 #else
 		AERR("Gralloc does not support UMP. Unable to register UMP memory for handle %p", hnd);
 #endif
 	}
 	else if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_ION)
 	{
 #if GRALLOC_ARM_DMA_BUF_MODULE
 		unsigned char *mappedAddress;
 		size_t size = hnd->size;
 		hw_module_t *pmodule = NULL;
 		private_module_t *m = NULL;

 		if (hw_get_module(GRALLOC_HARDWARE_MODULE_ID, (const hw_module_t **)&pmodule) == 0)
 		{
 			m = reinterpret_cast<private_module_t *>(pmodule);
 		}
 		else
 		{
 			AERR("Could not get gralloc module for handle: %p", hnd);
 			retval = -errno;
 			goto cleanup;
 		}

 		/* the test condition is set to m->ion_client <= 0 here, because:
 		 * 1) module structure are initialized to 0 if no initial value is applied
 		 * 2) a second user process should get a ion fd greater than 0.
 		 */
 		if (m->ion_client <= 0)
 		{
 			/* a second user process must obtain a client handle first via ion_open before it can obtain the shared ion buffer*/
 			m->ion_client = ion_open();

 			if (m->ion_client < 0)
 			{
 				AERR("Could not open ion device for handle: %p", hnd);
 				retval = -errno;
 				goto cleanup;
 			}
 		}

 		mappedAddress = (unsigned char *)mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, hnd->share_fd, 0);

 		if (MAP_FAILED == mappedAddress)
 		{
 			AERR("mmap( share_fd:%d ) failed with %s",  hnd->share_fd, strerror(errno));
 			retval = -errno;
 			goto cleanup;
 		}

 		hnd->base = mappedAddress + hnd->offset;
 		hnd->lockState &= ~(private_handle_t::LOCK_STATE_UNREGISTERED);

 		pthread_mutex_unlock(&s_map_lock);
 		return 0;
 #endif
 	}
 	else
 	{
 		AERR("registering non-UMP buffer not supported. flags = %d", hnd->flags);
 	}

 #if GRALLOC_ARM_DMA_BUF_MODULE
 cleanup:
 #endif
 	pthread_mutex_unlock(&s_map_lock);
 	return retval;
 }

 static void unmap_buffer(private_handle_t *hnd)
 {
 	if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_UMP)
 	{
 #if GRALLOC_ARM_UMP_MODULE
 		ump_mapped_pointer_release((ump_handle)hnd->ump_mem_handle);
 		ump_reference_release((ump_handle)hnd->ump_mem_handle);
 		hnd->ump_mem_handle = (int)UMP_INVALID_MEMORY_HANDLE;
 #else
 		AERR("Can't unregister UMP buffer for handle %p. Not supported", hnd);
 #endif
 	}
 	else if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_ION)
 	{
 #if GRALLOC_ARM_DMA_BUF_MODULE
 		void *base = (void *)hnd->base;
 		size_t size = hnd->size;

 		if (munmap(base, size) < 0)
 		{
 			AERR("Could not munmap base:%p size:%lu '%s'", base, (unsigned long)size, strerror(errno));
 		}

 #else
 		AERR("Can't unregister DMA_BUF buffer for hnd %p. Not supported", hnd);
 #endif

 	}
 	else
 	{
 		AERR("Unregistering unknown buffer is not supported. Flags = %d", hnd->flags);
 	}

 	hnd->base = 0;
 	hnd->lockState = 0;
 	hnd->writeOwner = 0;
 }

 static int gralloc_unregister_buffer(gralloc_module_t const *module, buffer_handle_t handle)
 {
 	MALI_IGNORE(module);

 	if (private_handle_t::validate(handle) < 0)
 	{
 		AERR("unregistering invalid buffer %p, returning error", handle);
 		return -EINVAL;
 	}

 	private_handle_t *hnd = (private_handle_t *)handle;

 	AERR_IF(hnd->lockState & private_handle_t::LOCK_STATE_READ_MASK, "[unregister] handle %p still locked (state=%08x)", hnd, hnd->lockState);

 	if (hnd->flags & private_handle_t::PRIV_FLAGS_FRAMEBUFFER)
 	{
 		AERR("Can't unregister buffer %p as it is a framebuffer", handle);
 	}
 	else if (hnd->pid == getpid()) // never unmap buffers that were not registered in this process
 	{
 		pthread_mutex_lock(&s_map_lock);

 		hnd->lockState &= ~(private_handle_t::LOCK_STATE_MAPPED);

 		/* if handle is still locked, the unmapping would not happen until unlocked*/
 		if (!(hnd->lockState & private_handle_t::LOCK_STATE_WRITE))
 		{
 			unmap_buffer(hnd);
 		}

 		hnd->lockState |= private_handle_t::LOCK_STATE_UNREGISTERED;

 		pthread_mutex_unlock(&s_map_lock);
 	}
 	else
 	{
 		AERR("Trying to unregister buffer %p from process %d that was not created in current process: %d", hnd, hnd->pid, getpid());
 	}

 	return 0;
 }

 static int gralloc_lock(gralloc_module_t const *module, buffer_handle_t handle, int usage, int l, int t, int w, int h, void **vaddr)
 {


 	if (private_handle_t::validate(handle) < 0)
 	{
 		AERR("Locking invalid buffer %p, returning error", handle);
 		return -EINVAL;
 	}

 	private_handle_t *hnd = (private_handle_t *)handle;

 	if (hnd->format == HAL_PIXEL_FORMAT_YCbCr_420_888)
 	{
 		AERR("Buffer with format HAL_PIXEL_FORMAT_YCbCr_*_888 must be locked by lock_ycbcr()");
 		return -EINVAL;
 	}

 	pthread_mutex_lock(&s_map_lock);

 	if (hnd->lockState & private_handle_t::LOCK_STATE_UNREGISTERED)
 	{
 		AERR("Locking on an unregistered buffer %p, returning error", hnd);
 		pthread_mutex_unlock(&s_map_lock);
 		return -EINVAL;
 	}

 	if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_UMP || hnd->flags & private_handle_t::PRIV_FLAGS_USES_ION)
 	{
 		hnd->writeOwner = usage & GRALLOC_USAGE_SW_WRITE_MASK;
 	}

 	hnd->lockState |= private_handle_t::LOCK_STATE_WRITE;

 	pthread_mutex_unlock(&s_map_lock);

 	if (usage & (GRALLOC_USAGE_SW_READ_MASK | GRALLOC_USAGE_SW_WRITE_MASK))
 	{
 		*vaddr = (void *)hnd->base;
 	}

 	MALI_IGNORE(module);
 	MALI_IGNORE(l);
 	MALI_IGNORE(t);
 	MALI_IGNORE(w);
 	MALI_IGNORE(h);
 	return 0;
 }

 static int gralloc_lock_ycbcr(gralloc_module_t const *module, buffer_handle_t handle, int usage, int l, int t, int w, int h, struct android_ycbcr *ycbcr)
 {
 	int retval = 0;
 	int ystride, cstride;

 	if (private_handle_t::validate(handle) < 0)
 	{
 		AERR("Locking invalid buffer %p, returning error", handle);
 		return -EINVAL;
 	}

 	private_handle_t *hnd = (private_handle_t *)handle;

 	pthread_mutex_lock(&s_map_lock);

 	if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_UMP || hnd->flags & private_handle_t::PRIV_FLAGS_USES_ION)
 	{
 		hnd->writeOwner = usage & GRALLOC_USAGE_SW_WRITE_MASK;
 	}

 	hnd->lockState |= private_handle_t::LOCK_STATE_WRITE;

 	pthread_mutex_unlock(&s_map_lock);


 	if (usage & (GRALLOC_USAGE_SW_READ_MASK | GRALLOC_USAGE_SW_WRITE_MASK))
 	{
 		switch (hnd->format)
 		{
 			case HAL_PIXEL_FORMAT_YCrCb_420_SP:
 				ystride = cstride = GRALLOC_ALIGN(hnd->width, 16);
 				ycbcr->y  = (void *)hnd->base;
 				ycbcr->cr = (void *)((unsigned char *)hnd->base + ystride * hnd->height);
 				ycbcr->cb = (void *)((unsigned char *)hnd->base + ystride * hnd->height + 1);
 				ycbcr->ystride = ystride;
 				ycbcr->cstride = cstride;
 				ycbcr->chroma_step = 2;
 				break;

 			case HAL_PIXEL_FORMAT_YV12:
 				/* Here to keep consistency with YV12 alignment, define the ystride according to image height. */
 				ystride = GRALLOC_ALIGN(hnd->width, (hnd->height % 8 == 0) ? GRALLOC_ALIGN_BASE_16 :
 										  		   ((hnd->height % 4 == 0) ? GRALLOC_ALIGN_BASE_64 : GRALLOC_ALIGN_BASE_128));
 				cstride = GRALLOC_ALIGN(ystride / 2, 16);
 				ycbcr->y  = (void *)hnd->base;
 				/* the ystride calc is assuming the height can at least be divided by 2 */
 				ycbcr->cr = (void *)((unsigned char *)hnd->base + ystride * GRALLOC_ALIGN(hnd->height, 2));
 				ycbcr->cb = (void *)((unsigned char *)hnd->base + ystride * GRALLOC_ALIGN(hnd->height, 2) + cstride * hnd->height / 2);
 				ycbcr->ystride = ystride;
 				ycbcr->cstride = cstride;
 				ycbcr->chroma_step = 1;
 				break;

 #ifdef SUPPORT_LEGACY_FORMAT

 			case HAL_PIXEL_FORMAT_YCbCr_420_SP:
 				ystride = cstride = GRALLOC_ALIGN(hnd->width, 16);
 				ycbcr->y  = (void *)hnd->base;
 				ycbcr->cb = (void *)((unsigned char *)hnd->base + ystride * hnd->height);
 				ycbcr->cr = (void *)((unsigned char *)hnd->base + ystride * hnd->height + 1);
 				ycbcr->ystride = ystride;
 				ycbcr->cstride = cstride;
 				ycbcr->chroma_step = 2;
 				break;
 #endif

 			default:
 				AERR("Can not lock buffer, invalid format: 0x%x", hnd->format);
 				retval = -EINVAL;
 		}
 	}

 	MALI_IGNORE(module);
 	MALI_IGNORE(l);
 	MALI_IGNORE(t);
 	MALI_IGNORE(w);
 	MALI_IGNORE(h);
 	return retval;
 }

 static int gralloc_unlock(gralloc_module_t const *module, buffer_handle_t handle)
 {
 	MALI_IGNORE(module);

 	if (private_handle_t::validate(handle) < 0)
 	{
 		AERR("Unlocking invalid buffer %p, returning error", handle);
 		return -EINVAL;
 	}

 	private_handle_t *hnd = (private_handle_t *)handle;

 	if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_UMP && hnd->writeOwner)
 	{
 #if GRALLOC_ARM_UMP_MODULE
 		ump_cpu_msync_now((ump_handle)hnd->ump_mem_handle, UMP_MSYNC_CLEAN_AND_INVALIDATE, (void *)hnd->base, hnd->size);
 #else
 		AERR("Buffer %p is UMP type but it is not supported", hnd);
 #endif
 	}
 	else if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_ION && hnd->writeOwner)
 	{
 #if GRALLOC_ARM_DMA_BUF_MODULE
 		hw_module_t *pmodule = NULL;
 		private_module_t *m = NULL;

 		if (hw_get_module(GRALLOC_HARDWARE_MODULE_ID, (const hw_module_t **)&pmodule) == 0)
 		{
 			m = reinterpret_cast<private_module_t *>(pmodule);
 			//ion_sync_fd(m->ion_client, hnd->share_fd);
 		}
 		else
 		{
 			AERR("Couldnot get gralloc module for handle %p\n", handle);
 		}

 #endif
 	}

 	pthread_mutex_lock(&s_map_lock);

 	hnd->lockState &= ~(private_handle_t::LOCK_STATE_WRITE);

 	/* if the handle has already been unregistered, unmap it here*/
 	if (hnd->lockState & private_handle_t::LOCK_STATE_UNREGISTERED)
 	{
 		unmap_buffer(hnd);
 	}

 	pthread_mutex_unlock(&s_map_lock);

 	return 0;
 }

 #if defined(GRALLOC_MODULE_API_VERSION_0_3)
 static int gralloc_lock_async (gralloc_module_t const *module, buffer_handle_t handle, int usage, int l, int t, int w, int h, void **vaddr, int fenceFD)
 {
 	if (fenceFD >= 0)
 	{
 		sync_wait(fenceFD, -1);
 		close(fenceFD);
 	}

 	return gralloc_lock(module, handle, usage, l, t, w, h, vaddr);
 }

 static int gralloc_unlock_async(gralloc_module_t const *module, buffer_handle_t handle, int *fenceFD)
 {
 	*fenceFD = -1;

 	if (gralloc_unlock(module, handle) < 0)
 	{
 		return -EINVAL;
 	}

 	return 0;

 }

 static int gralloc_lock_async_ycbcr(gralloc_module_t const *module, buffer_handle_t handle, int usage, int l, int t, int w, int h, struct android_ycbcr *ycbcr, int fenceFD)
 {
 	if (fenceFD >= 0)
 	{
 		sync_wait(fenceFD, -1);
 		close(fenceFD);
 	}

 	return gralloc_lock_ycbcr(module, handle, usage, l, t, w, h, ycbcr);
 }
 #endif

 // There is one global instance of the module

 static struct hw_module_methods_t gralloc_module_methods =
 {
 	.open = gralloc_device_open
 };

 private_module_t::private_module_t()
 {
 #define INIT_ZERO(obj) (memset(&(obj),0,sizeof((obj))))

 	base.common.tag = HARDWARE_MODULE_TAG;
 #if defined(GRALLOC_MODULE_API_VERSION_0_3)
 	base.common.version_major = GRALLOC_MODULE_API_VERSION_0_3;
 #else
 	base.common.version_major = GRALLOC_MODULE_API_VERSION_0_2;
 #endif
 	base.common.version_minor = 0;
 	base.common.id = GRALLOC_HARDWARE_MODULE_ID;
 	base.common.name = "Graphics Memory Allocator Module";
 	base.common.author = "ARM Ltd.";
 	base.common.methods = &gralloc_module_methods;
 	base.common.dso = NULL;
 	INIT_ZERO(base.common.reserved);

 	base.registerBuffer = gralloc_register_buffer;
 	base.unregisterBuffer = gralloc_unregister_buffer;
 	base.lock = gralloc_lock;
 	base.unlock = gralloc_unlock;
 	base.perform = NULL;
 	base.lock_ycbcr = gralloc_lock_ycbcr;
 #if defined(GRALLOC_MODULE_API_VERSION_0_3)
 	base.lockAsync = gralloc_lock_async;
 	base.unlockAsync = gralloc_unlock_async;
 	base.lockAsync_ycbcr = gralloc_lock_async_ycbcr;
 #endif
 	INIT_ZERO(base.reserved_proc);

 	framebuffer = NULL;
 	flags = 0;
 	numBuffers = 0;
 	bufferMask = 0;
 	pthread_mutex_init(&(lock), NULL);
 	currentBuffer = NULL;
 	INIT_ZERO(info);
 	INIT_ZERO(finfo);
 	xdpi = 0.0f;
 	ydpi = 0.0f;
 	fps = 0.0f;

 #undef INIT_ZERO
 };

 /*
  * HAL_MODULE_INFO_SYM will be initialized using the default constructor
  * implemented above
  */
 struct private_module_t HAL_MODULE_INFO_SYM;
	/*
	* Copyright (C) 2010 ARM Limited. All rights reserved.
	*
	* Copyright (C) 2008 The Android Open Source Project
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* You may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	#include <errno.h>
	#include <pthread.h>
	#include <string.h>
	//#include <sync/sync.h>
	#include <android/sync.h>

	#include <cutils/log.h>
	#include <cutils/atomic.h>
	#include <hardware/hardware.h>
	#include <hardware/gralloc.h>

	#include "gralloc_priv.h"
	#include "alloc_device.h"
	#include "framebuffer_device.h"

	#if GRALLOC_ARM_UMP_MODULE
	#include <ump/ump_ref_drv.h>
	static int s_ump_is_open = 0;
	#endif

	#if GRALLOC_ARM_DMA_BUF_MODULE
	#include <linux/ion.h>
	#include <ion/ion.h>
	#include <sys/mman.h>
	#endif

	static pthread_mutex_t s_map_lock = PTHREAD_MUTEX_INITIALIZER;

	static int gralloc_device_open(const hw_module_t module, const char name, hw_device_t **device)
	{
	int status = -EINVAL;

	if (!strncmp(name, GRALLOC_HARDWARE_GPU0, MALI_GRALLOC_HARDWARE_MAX_STR_LEN))
	{
	status = alloc_device_open(module, name, device);
	}
	else if (!strncmp(name, GRALLOC_HARDWARE_FB0, MALI_GRALLOC_HARDWARE_MAX_STR_LEN))
	{
	status = framebuffer_device_open(module, name, device);
	}

	return status;
	}

	static int gralloc_register_buffer(gralloc_module_t const *module, buffer_handle_t handle)
	{
	MALI_IGNORE(module);

	if (private_handle_t::validate(handle) < 0)
	{
	AERR("Registering invalid buffer %p, returning error", handle);
	return -EINVAL;
	}

	// if this handle was created in this process, then we keep it as is.
	private_handle_t hnd = (private_handle_t )handle;

	int retval = -EINVAL;

	pthread_mutex_lock(&s_map_lock);

	#if GRALLOC_ARM_UMP_MODULE

	if (!s_ump_is_open)
	{
	ump_result res = ump_open(); // MJOLL-4012: UMP implementation needs a ump_close() for each ump_open

	if (res != UMP_OK)
	{
	pthread_mutex_unlock(&s_map_lock);
	AERR("Failed to open UMP library with res=%d", res);
	return retval;
	}

	s_ump_is_open = 1;
	}

	#endif

	hnd->pid = getpid();

	if (hnd->flags & private_handle_t::PRIV_FLAGS_FRAMEBUFFER)
	{
	AINF("Register buffer %p although it will be treated as a nop", handle);
	retval = 0;
	}
	else if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_UMP)
	{
	#if GRALLOC_ARM_UMP_MODULE
	hnd->ump_mem_handle = (int)ump_handle_create_from_secure_id(hnd->ump_id);

	if (UMP_INVALID_MEMORY_HANDLE != (ump_handle)hnd->ump_mem_handle)
	{
	hnd->base = ump_mapped_pointer_get((ump_handle)hnd->ump_mem_handle);

	if (0 != hnd->base)
	{
	hnd->writeOwner = 0;
	hnd->lockState &= ~(private_handle_t::LOCK_STATE_UNREGISTERED);

	pthread_mutex_unlock(&s_map_lock);
	return 0;
	}
	else
	{
	AERR("Failed to map UMP handle 0x%x", hnd->ump_mem_handle);
	}

	ump_reference_release((ump_handle)hnd->ump_mem_handle);
	}
	else
	{
	AERR("Failed to create UMP handle 0x%x", hnd->ump_mem_handle);
	}

	#else
	AERR("Gralloc does not support UMP. Unable to register UMP memory for handle %p", hnd);
	#endif
	}
	else if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_ION)
	{
	#if GRALLOC_ARM_DMA_BUF_MODULE
	unsigned char *mappedAddress;
	size_t size = hnd->size;
	hw_module_t *pmodule = NULL;
	private_module_t *m = NULL;

	if (hw_get_module(GRALLOC_HARDWARE_MODULE_ID, (const hw_module_t **)&pmodule) == 0)
	{
	m = reinterpret_cast<private_module_t *>(pmodule);
	}
	else
	{
	AERR("Could not get gralloc module for handle: %p", hnd);
	retval = -errno;
	goto cleanup;
	}

	/* the test condition is set to m->ion_client <= 0 here, because:
	* 1) module structure are initialized to 0 if no initial value is applied
	* 2) a second user process should get a ion fd greater than 0.
	*/
	if (m->ion_client <= 0)
	{
	/* a second user process must obtain a client handle first via ion_open before it can obtain the shared ion buffer*/
	m->ion_client = ion_open();

	if (m->ion_client < 0)
	{
	AERR("Could not open ion device for handle: %p", hnd);
	retval = -errno;
	goto cleanup;
	}
	}

	mappedAddress = (unsigned char *)mmap(NULL, size, PROT_READ \| PROT_WRITE, MAP_SHARED, hnd->share_fd, 0);

	if (MAP_FAILED == mappedAddress)
	{
	AERR("mmap( share_fd:%d ) failed with %s", hnd->share_fd, strerror(errno));
	retval = -errno;
	goto cleanup;
	}

	hnd->base = mappedAddress + hnd->offset;
	hnd->lockState &= ~(private_handle_t::LOCK_STATE_UNREGISTERED);

	pthread_mutex_unlock(&s_map_lock);
	return 0;
	#endif
	}
	else
	{
	AERR("registering non-UMP buffer not supported. flags = %d", hnd->flags);
	}

	#if GRALLOC_ARM_DMA_BUF_MODULE
	cleanup:
	#endif
	pthread_mutex_unlock(&s_map_lock);
	return retval;
	}

	static void unmap_buffer(private_handle_t *hnd)
	{
	if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_UMP)
	{
	#if GRALLOC_ARM_UMP_MODULE
	ump_mapped_pointer_release((ump_handle)hnd->ump_mem_handle);
	ump_reference_release((ump_handle)hnd->ump_mem_handle);
	hnd->ump_mem_handle = (int)UMP_INVALID_MEMORY_HANDLE;
	#else
	AERR("Can't unregister UMP buffer for handle %p. Not supported", hnd);
	#endif
	}
	else if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_ION)
	{
	#if GRALLOC_ARM_DMA_BUF_MODULE
	void base = (void )hnd->base;
	size_t size = hnd->size;

	if (munmap(base, size) < 0)
	{
	AERR("Could not munmap base:%p size:%lu '%s'", base, (unsigned long)size, strerror(errno));
	}

	#else
	AERR("Can't unregister DMA_BUF buffer for hnd %p. Not supported", hnd);
	#endif

	}
	else
	{
	AERR("Unregistering unknown buffer is not supported. Flags = %d", hnd->flags);
	}

	hnd->base = 0;
	hnd->lockState = 0;
	hnd->writeOwner = 0;
	}

	static int gralloc_unregister_buffer(gralloc_module_t const *module, buffer_handle_t handle)
	{
	MALI_IGNORE(module);

	if (private_handle_t::validate(handle) < 0)
	{
	AERR("unregistering invalid buffer %p, returning error", handle);
	return -EINVAL;
	}

	private_handle_t hnd = (private_handle_t )handle;

	AERR_IF(hnd->lockState & private_handle_t::LOCK_STATE_READ_MASK, "[unregister] handle %p still locked (state=%08x)", hnd, hnd->lockState);

	if (hnd->flags & private_handle_t::PRIV_FLAGS_FRAMEBUFFER)
	{
	AERR("Can't unregister buffer %p as it is a framebuffer", handle);
	}
	else if (hnd->pid == getpid()) // never unmap buffers that were not registered in this process
	{
	pthread_mutex_lock(&s_map_lock);

	hnd->lockState &= ~(private_handle_t::LOCK_STATE_MAPPED);

	/* if handle is still locked, the unmapping would not happen until unlocked*/
	if (!(hnd->lockState & private_handle_t::LOCK_STATE_WRITE))
	{
	unmap_buffer(hnd);
	}

	hnd->lockState \|= private_handle_t::LOCK_STATE_UNREGISTERED;

	pthread_mutex_unlock(&s_map_lock);
	}
	else
	{
	AERR("Trying to unregister buffer %p from process %d that was not created in current process: %d", hnd, hnd->pid, getpid());
	}

	return 0;
	}

	static int gralloc_lock(gralloc_module_t const module, buffer_handle_t handle, int usage, int l, int t, int w, int h, void *vaddr)
	{


	if (private_handle_t::validate(handle) < 0)
	{
	AERR("Locking invalid buffer %p, returning error", handle);
	return -EINVAL;
	}

	private_handle_t hnd = (private_handle_t )handle;

	if (hnd->format == HAL_PIXEL_FORMAT_YCbCr_420_888)
	{
	AERR("Buffer with format HAL_PIXEL_FORMAT_YCbCr_*_888 must be locked by lock_ycbcr()");
	return -EINVAL;
	}

	pthread_mutex_lock(&s_map_lock);

	if (hnd->lockState & private_handle_t::LOCK_STATE_UNREGISTERED)
	{
	AERR("Locking on an unregistered buffer %p, returning error", hnd);
	pthread_mutex_unlock(&s_map_lock);
	return -EINVAL;
	}

	if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_UMP \|\| hnd->flags & private_handle_t::PRIV_FLAGS_USES_ION)
	{
	hnd->writeOwner = usage & GRALLOC_USAGE_SW_WRITE_MASK;
	}

	hnd->lockState \|= private_handle_t::LOCK_STATE_WRITE;

	pthread_mutex_unlock(&s_map_lock);

	if (usage & (GRALLOC_USAGE_SW_READ_MASK \| GRALLOC_USAGE_SW_WRITE_MASK))
	{
	vaddr = (void )hnd->base;
	}

	MALI_IGNORE(module);
	MALI_IGNORE(l);
	MALI_IGNORE(t);
	MALI_IGNORE(w);
	MALI_IGNORE(h);
	return 0;
	}

	static int gralloc_lock_ycbcr(gralloc_module_t const module, buffer_handle_t handle, int usage, int l, int t, int w, int h, struct android_ycbcr ycbcr)
	{
	int retval = 0;
	int ystride, cstride;

	if (private_handle_t::validate(handle) < 0)
	{
	AERR("Locking invalid buffer %p, returning error", handle);
	return -EINVAL;
	}

	private_handle_t hnd = (private_handle_t )handle;

	pthread_mutex_lock(&s_map_lock);

	if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_UMP \|\| hnd->flags & private_handle_t::PRIV_FLAGS_USES_ION)
	{
	hnd->writeOwner = usage & GRALLOC_USAGE_SW_WRITE_MASK;
	}

	hnd->lockState \|= private_handle_t::LOCK_STATE_WRITE;

	pthread_mutex_unlock(&s_map_lock);


	if (usage & (GRALLOC_USAGE_SW_READ_MASK \| GRALLOC_USAGE_SW_WRITE_MASK))
	{
	switch (hnd->format)
	{
	case HAL_PIXEL_FORMAT_YCrCb_420_SP:
	ystride = cstride = GRALLOC_ALIGN(hnd->width, 16);
	ycbcr->y = (void *)hnd->base;
	ycbcr->cr = (void )((unsigned char )hnd->base + ystride * hnd->height);
	ycbcr->cb = (void )((unsigned char )hnd->base + ystride * hnd->height + 1);
	ycbcr->ystride = ystride;
	ycbcr->cstride = cstride;
	ycbcr->chroma_step = 2;
	break;

	case HAL_PIXEL_FORMAT_YV12:
	/* Here to keep consistency with YV12 alignment, define the ystride according to image height. */
	ystride = GRALLOC_ALIGN(hnd->width, (hnd->height % 8 == 0) ? GRALLOC_ALIGN_BASE_16 :
	((hnd->height % 4 == 0) ? GRALLOC_ALIGN_BASE_64 : GRALLOC_ALIGN_BASE_128));
	cstride = GRALLOC_ALIGN(ystride / 2, 16);
	ycbcr->y = (void *)hnd->base;
	/* the ystride calc is assuming the height can at least be divided by 2 */
	ycbcr->cr = (void )((unsigned char )hnd->base + ystride * GRALLOC_ALIGN(hnd->height, 2));
	ycbcr->cb = (void )((unsigned char )hnd->base + ystride * GRALLOC_ALIGN(hnd->height, 2) + cstride * hnd->height / 2);
	ycbcr->ystride = ystride;
	ycbcr->cstride = cstride;
	ycbcr->chroma_step = 1;
	break;

	#ifdef SUPPORT_LEGACY_FORMAT

	case HAL_PIXEL_FORMAT_YCbCr_420_SP:
	ystride = cstride = GRALLOC_ALIGN(hnd->width, 16);
	ycbcr->y = (void *)hnd->base;
	ycbcr->cb = (void )((unsigned char )hnd->base + ystride * hnd->height);
	ycbcr->cr = (void )((unsigned char )hnd->base + ystride * hnd->height + 1);
	ycbcr->ystride = ystride;
	ycbcr->cstride = cstride;
	ycbcr->chroma_step = 2;
	break;
	#endif

	default:
	AERR("Can not lock buffer, invalid format: 0x%x", hnd->format);
	retval = -EINVAL;
	}
	}

	MALI_IGNORE(module);
	MALI_IGNORE(l);
	MALI_IGNORE(t);
	MALI_IGNORE(w);
	MALI_IGNORE(h);
	return retval;
	}

	static int gralloc_unlock(gralloc_module_t const *module, buffer_handle_t handle)
	{
	MALI_IGNORE(module);

	if (private_handle_t::validate(handle) < 0)
	{
	AERR("Unlocking invalid buffer %p, returning error", handle);
	return -EINVAL;
	}

	private_handle_t hnd = (private_handle_t )handle;

	if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_UMP && hnd->writeOwner)
	{
	#if GRALLOC_ARM_UMP_MODULE
	ump_cpu_msync_now((ump_handle)hnd->ump_mem_handle, UMP_MSYNC_CLEAN_AND_INVALIDATE, (void *)hnd->base, hnd->size);
	#else
	AERR("Buffer %p is UMP type but it is not supported", hnd);
	#endif
	}
	else if (hnd->flags & private_handle_t::PRIV_FLAGS_USES_ION && hnd->writeOwner)
	{
	#if GRALLOC_ARM_DMA_BUF_MODULE
	hw_module_t *pmodule = NULL;
	private_module_t *m = NULL;

	if (hw_get_module(GRALLOC_HARDWARE_MODULE_ID, (const hw_module_t **)&pmodule) == 0)
	{
	m = reinterpret_cast<private_module_t *>(pmodule);
	//ion_sync_fd(m->ion_client, hnd->share_fd);
	}
	else
	{
	AERR("Couldnot get gralloc module for handle %p\n", handle);
	}

	#endif
	}

	pthread_mutex_lock(&s_map_lock);

	hnd->lockState &= ~(private_handle_t::LOCK_STATE_WRITE);

	/* if the handle has already been unregistered, unmap it here*/
	if (hnd->lockState & private_handle_t::LOCK_STATE_UNREGISTERED)
	{
	unmap_buffer(hnd);
	}

	pthread_mutex_unlock(&s_map_lock);

	return 0;
	}

	#if defined(GRALLOC_MODULE_API_VERSION_0_3)
	static int gralloc_lock_async (gralloc_module_t const module, buffer_handle_t handle, int usage, int l, int t, int w, int h, void *vaddr, int fenceFD)
	{
	if (fenceFD >= 0)
	{
	sync_wait(fenceFD, -1);
	close(fenceFD);
	}

	return gralloc_lock(module, handle, usage, l, t, w, h, vaddr);
	}

	static int gralloc_unlock_async(gralloc_module_t const module, buffer_handle_t handle, int fenceFD)
	{
	*fenceFD = -1;

	if (gralloc_unlock(module, handle) < 0)
	{
	return -EINVAL;
	}

	return 0;

	}

	static int gralloc_lock_async_ycbcr(gralloc_module_t const module, buffer_handle_t handle, int usage, int l, int t, int w, int h, struct android_ycbcr ycbcr, int fenceFD)
	{
	if (fenceFD >= 0)
	{
	sync_wait(fenceFD, -1);
	close(fenceFD);
	}

	return gralloc_lock_ycbcr(module, handle, usage, l, t, w, h, ycbcr);
	}
	#endif

	// There is one global instance of the module

	static struct hw_module_methods_t gralloc_module_methods =
	{
	.open = gralloc_device_open
	};

	private_module_t::private_module_t()
	{
	#define INIT_ZERO(obj) (memset(&(obj),0,sizeof((obj))))

	base.common.tag = HARDWARE_MODULE_TAG;
	#if defined(GRALLOC_MODULE_API_VERSION_0_3)
	base.common.version_major = GRALLOC_MODULE_API_VERSION_0_3;
	#else
	base.common.version_major = GRALLOC_MODULE_API_VERSION_0_2;
	#endif
	base.common.version_minor = 0;
	base.common.id = GRALLOC_HARDWARE_MODULE_ID;
	base.common.name = "Graphics Memory Allocator Module";
	base.common.author = "ARM Ltd.";
	base.common.methods = &gralloc_module_methods;
	base.common.dso = NULL;
	INIT_ZERO(base.common.reserved);

	base.registerBuffer = gralloc_register_buffer;
	base.unregisterBuffer = gralloc_unregister_buffer;
	base.lock = gralloc_lock;
	base.unlock = gralloc_unlock;
	base.perform = NULL;
	base.lock_ycbcr = gralloc_lock_ycbcr;
	#if defined(GRALLOC_MODULE_API_VERSION_0_3)
	base.lockAsync = gralloc_lock_async;
	base.unlockAsync = gralloc_unlock_async;
	base.lockAsync_ycbcr = gralloc_lock_async_ycbcr;
	#endif
	INIT_ZERO(base.reserved_proc);

	framebuffer = NULL;
	flags = 0;
	numBuffers = 0;
	bufferMask = 0;
	pthread_mutex_init(&(lock), NULL);
	currentBuffer = NULL;
	INIT_ZERO(info);
	INIT_ZERO(finfo);
	xdpi = 0.0f;
	ydpi = 0.0f;
	fps = 0.0f;

	#undef INIT_ZERO
	};

	/*
	* HAL_MODULE_INFO_SYM will be initialized using the default constructor
	* implemented above
	*/
	struct private_module_t HAL_MODULE_INFO_SYM;