|
sl@0
|
1 |
// Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of the License "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// e32/include/e32shbuf_priv.h
|
|
sl@0
|
15 |
// Shareable Data Buffers
|
|
sl@0
|
16 |
|
|
sl@0
|
17 |
/**
|
|
sl@0
|
18 |
@file
|
|
sl@0
|
19 |
@internalComponent
|
|
sl@0
|
20 |
@prototype
|
|
sl@0
|
21 |
*/
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
#ifndef E32SHBUF_PRIV_H
|
|
sl@0
|
24 |
#define E32SHBUF_PRIV_H
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#include <e32def.h>
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
/**
|
|
sl@0
|
31 |
Defines flags for TShPoolInfo.
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
These values specify the behaviour of the pool and its buffers.
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
@internalComponent
|
|
sl@0
|
36 |
@prototype
|
|
sl@0
|
37 |
*/
|
|
sl@0
|
38 |
enum TShPoolCreateFlags
|
|
sl@0
|
39 |
{
|
|
sl@0
|
40 |
/**
|
|
sl@0
|
41 |
The buffers in this pool are at least the size of an MMU page,
|
|
sl@0
|
42 |
are aligned to an MMU page, and may be mapped in and out of a process's
|
|
sl@0
|
43 |
address space independently.
|
|
sl@0
|
44 |
*/
|
|
sl@0
|
45 |
EShPoolPageAlignedBuffer = 0x0001,
|
|
sl@0
|
46 |
|
|
sl@0
|
47 |
/**
|
|
sl@0
|
48 |
The buffers in this pool do not have any size or alignment restrictions beyond
|
|
sl@0
|
49 |
that specified by the pool creator.
|
|
sl@0
|
50 |
|
|
sl@0
|
51 |
The whole pool is always mapped into a process's address space.
|
|
sl@0
|
52 |
*/
|
|
sl@0
|
53 |
EShPoolNonPageAlignedBuffer = 0x0002,
|
|
sl@0
|
54 |
|
|
sl@0
|
55 |
/**
|
|
sl@0
|
56 |
This pool maps onto device memory, not system RAM.
|
|
sl@0
|
57 |
*/
|
|
sl@0
|
58 |
EShPoolPhysicalMemoryPool = 0x0004,
|
|
sl@0
|
59 |
|
|
sl@0
|
60 |
/**
|
|
sl@0
|
61 |
The physical memory backing this pool is contiguous.
|
|
sl@0
|
62 |
*/
|
|
sl@0
|
63 |
EShPoolContiguous = 0x0008,
|
|
sl@0
|
64 |
|
|
sl@0
|
65 |
/**
|
|
sl@0
|
66 |
Each buffer will only ever be mapped into one process's address space at a time.
|
|
sl@0
|
67 |
|
|
sl@0
|
68 |
Requires EShPoolPageAlignedBuffer.
|
|
sl@0
|
69 |
*/
|
|
sl@0
|
70 |
EShPoolExclusiveAccess = 0x0010,
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
/**
|
|
sl@0
|
73 |
An unmapped page will be placed between each buffer.
|
|
sl@0
|
74 |
|
|
sl@0
|
75 |
Requires EShPoolPageAlignedBuffer.
|
|
sl@0
|
76 |
*/
|
|
sl@0
|
77 |
EShPoolGuardPages = 0x0020,
|
|
sl@0
|
78 |
|
|
sl@0
|
79 |
/**
|
|
sl@0
|
80 |
Set by automatic shrinking when it is unable to shrink the pool despite there
|
|
sl@0
|
81 |
being enough free buffers available (usually due to fragmentation). This prevents
|
|
sl@0
|
82 |
the automatic shrinking code being continually called when it can't do anything.
|
|
sl@0
|
83 |
*/
|
|
sl@0
|
84 |
EShPoolSuppressShrink = 0x80000000,
|
|
sl@0
|
85 |
};
|
|
sl@0
|
86 |
|
|
sl@0
|
87 |
|
|
sl@0
|
88 |
/**
|
|
sl@0
|
89 |
Specifies client flags.
|
|
sl@0
|
90 |
|
|
sl@0
|
91 |
@internalComponent
|
|
sl@0
|
92 |
@prototype
|
|
sl@0
|
93 |
*/
|
|
sl@0
|
94 |
enum TShPoolClientFlags
|
|
sl@0
|
95 |
{
|
|
sl@0
|
96 |
/**
|
|
sl@0
|
97 |
Buffers will be automatically mapped into this process's address space when a handle is
|
|
sl@0
|
98 |
created for them. Having this flag clear can be useful for a process that will function
|
|
sl@0
|
99 |
as an intermediary, without requiring access to the data in the buffers.
|
|
sl@0
|
100 |
*/
|
|
sl@0
|
101 |
EShPoolAutoMapBuf = 0x1000,
|
|
sl@0
|
102 |
|
|
sl@0
|
103 |
/**
|
|
sl@0
|
104 |
Newly-allocated buffers will not be mapped into this process's address space.
|
|
sl@0
|
105 |
*/
|
|
sl@0
|
106 |
EShPoolNoMapBuf = 0x2000,
|
|
sl@0
|
107 |
};
|
|
sl@0
|
108 |
|
|
sl@0
|
109 |
|
|
sl@0
|
110 |
/**
|
|
sl@0
|
111 |
Specifies the type of notification. (A real enumeration, not bit flags.)
|
|
sl@0
|
112 |
|
|
sl@0
|
113 |
@internalComponent
|
|
sl@0
|
114 |
@prototype
|
|
sl@0
|
115 |
*/
|
|
sl@0
|
116 |
enum TShPoolNotifyType
|
|
sl@0
|
117 |
{
|
|
sl@0
|
118 |
EShPoolLowSpace = 1, // notifies when free buffers drop to a certain number
|
|
sl@0
|
119 |
EShPoolFreeSpace = 2, // notifies when free buffers rise to a certain number
|
|
sl@0
|
120 |
};
|
|
sl@0
|
121 |
|
|
sl@0
|
122 |
/**
|
|
sl@0
|
123 |
Structure for passing base address and pointer of buffer
|
|
sl@0
|
124 |
|
|
sl@0
|
125 |
@internalComponent
|
|
sl@0
|
126 |
@prototype
|
|
sl@0
|
127 |
*/
|
|
sl@0
|
128 |
struct SShBufBaseAndSize
|
|
sl@0
|
129 |
{
|
|
sl@0
|
130 |
TLinAddr iBase;
|
|
sl@0
|
131 |
TUint iSize;
|
|
sl@0
|
132 |
};
|
|
sl@0
|
133 |
|
|
sl@0
|
134 |
|
|
sl@0
|
135 |
#endif // E32SHBUF_PRIV_H
|