sl@0: // Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // e32/include/e32shbuf_priv.h
sl@0: // Shareable Data Buffers
sl@0: 
sl@0: /**
sl@0: 	@file
sl@0: 	@internalComponent
sl@0: 	@prototype
sl@0: */
sl@0: 
sl@0: #ifndef E32SHBUF_PRIV_H
sl@0: #define E32SHBUF_PRIV_H
sl@0: 
sl@0: 
sl@0: #include <e32def.h>
sl@0: 
sl@0: 
sl@0: /**
sl@0: 	Defines flags for TShPoolInfo.
sl@0: 
sl@0: 	These values specify the behaviour of the pool and its buffers.
sl@0: 
sl@0: 	@internalComponent
sl@0: 	@prototype
sl@0: */
sl@0: enum TShPoolCreateFlags
sl@0: 	{
sl@0: 	/**
sl@0: 	The buffers in this pool are at least the size of an MMU page,
sl@0: 	are aligned to an MMU page, and may be mapped in and out of a process's
sl@0: 	address space independently.
sl@0: 	*/
sl@0: 	EShPoolPageAlignedBuffer	= 0x0001,
sl@0: 
sl@0: 	/**
sl@0: 	The buffers in this pool do not have any size or alignment restrictions beyond
sl@0: 	that specified by the pool creator.
sl@0: 
sl@0: 	The whole pool is always mapped into a process's address space.
sl@0: 	*/
sl@0: 	EShPoolNonPageAlignedBuffer = 0x0002,
sl@0: 
sl@0: 	/**
sl@0: 	This pool maps onto device memory, not system RAM.
sl@0: 	*/
sl@0: 	EShPoolPhysicalMemoryPool	= 0x0004,
sl@0: 
sl@0: 	/**
sl@0: 	The physical memory backing this pool is contiguous.
sl@0: 	*/
sl@0: 	EShPoolContiguous			= 0x0008,
sl@0: 
sl@0: 	/**
sl@0: 	Each buffer will only ever be mapped into one process's address space at a time.
sl@0: 
sl@0: 	Requires EShPoolPageAlignedBuffer.
sl@0: 	*/
sl@0: 	EShPoolExclusiveAccess		= 0x0010,
sl@0: 
sl@0: 	/**
sl@0: 	An unmapped page will be placed between each buffer.
sl@0: 
sl@0: 	Requires EShPoolPageAlignedBuffer.
sl@0: 	*/
sl@0: 	EShPoolGuardPages			= 0x0020,
sl@0: 
sl@0: 	/**
sl@0: 	Set by automatic shrinking when it is unable to shrink the pool despite there
sl@0: 	being enough free buffers available (usually due to fragmentation).  This prevents
sl@0: 	the automatic shrinking code being continually called when it can't do anything.
sl@0: 	*/
sl@0: 	EShPoolSuppressShrink		= 0x80000000,
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /**
sl@0: 	Specifies client flags.
sl@0: 
sl@0: 	@internalComponent
sl@0: 	@prototype
sl@0: */
sl@0: enum TShPoolClientFlags
sl@0: 	{
sl@0: 	/**
sl@0: 	Buffers will be automatically mapped into this process's address space when a handle is
sl@0: 	created for them.  Having this flag clear can be useful for a process that will function
sl@0: 	as an intermediary, without requiring access to the data in the buffers.
sl@0: 	*/
sl@0: 	EShPoolAutoMapBuf		= 0x1000,
sl@0: 
sl@0: 	/**
sl@0: 	Newly-allocated buffers will not be mapped into this process's address space.
sl@0: 	*/
sl@0: 	EShPoolNoMapBuf			= 0x2000,
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /**
sl@0: 	Specifies the type of notification.  (A real enumeration, not bit flags.)
sl@0: 
sl@0: 	@internalComponent
sl@0: 	@prototype
sl@0: */
sl@0: enum TShPoolNotifyType
sl@0: 	{
sl@0: 	EShPoolLowSpace = 1,		// notifies when free buffers drop to a certain number
sl@0: 	EShPoolFreeSpace = 2,		// notifies when free buffers rise to a certain number
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: 	Structure for passing base address and pointer of buffer
sl@0: 
sl@0: 	@internalComponent
sl@0: 	@prototype
sl@0: */
sl@0: struct SShBufBaseAndSize
sl@0: 	{
sl@0: 	TLinAddr iBase;
sl@0: 	TUint    iSize;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: #endif	// E32SHBUF_PRIV_H