IPC API  3.40.00.06
HeapMultiBufMP.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012-2013, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
99 #ifndef ti_ipc_HeapMultiBufMP__include
100 #define ti_ipc_HeapMultiBufMP__include
101 
102 #if defined (__cplusplus)
103 extern "C" {
104 #endif
105 
106 #include <ti/ipc/GateMP.h>
107 
108 /* =============================================================================
109  * All success and failure codes for the module
110  * =============================================================================
111  */
112 
116 #define HeapMultiBufMP_S_BUSY 2
117 
121 #define HeapMultiBufMP_S_ALREADYSETUP 1
122 
126 #define HeapMultiBufMP_S_SUCCESS 0
127 
131 #define HeapMultiBufMP_E_FAIL -1
132 
136 #define HeapMultiBufMP_E_INVALIDARG -2
137 
141 #define HeapMultiBufMP_E_MEMORY -3
142 
146 #define HeapMultiBufMP_E_ALREADYEXISTS -4
147 
151 #define HeapMultiBufMP_E_NOTFOUND -5
152 
156 #define HeapMultiBufMP_E_TIMEOUT -6
157 
161 #define HeapMultiBufMP_E_INVALIDSTATE -7
162 
165 #define HeapMultiBufMP_E_OSFAILURE -8
166 
169 #define HeapMultiBufMP_E_RESOURCE -9
170 
173 #define HeapMultiBufMP_E_RESTART -10
174 
175 /* =============================================================================
176  * Macros
177  * =============================================================================
178  */
179 
183 #define HeapMultiBufMP_MAXBUCKETS ((UInt)8)
184 
185 /* =============================================================================
186  * Structures & Enums
187  * =============================================================================
188  */
189 
193 typedef struct HeapMultiBufMP_Object *HeapMultiBufMP_Handle;
194 
204 typedef struct HeapMultiBufMP_Bucket {
205  SizeT blockSize;
206  UInt numBlocks;
207  SizeT align;
209 
213 typedef struct HeapMultiBufMP_Params {
221  Bool exact;
228  String name;
263  UInt16 regionId;
271  Ptr sharedAddr;
283 
311 
312 /* =============================================================================
313  * HeapMultiBufMP Module-wide Functions
314  * =============================================================================
315  */
316 
329 Int HeapMultiBufMP_close(HeapMultiBufMP_Handle *handlePtr);
330 
340 HeapMultiBufMP_Handle HeapMultiBufMP_create(const HeapMultiBufMP_Params *params);
341 
350 Int HeapMultiBufMP_delete(HeapMultiBufMP_Handle *handlePtr);
351 
376 Int HeapMultiBufMP_open(String name, HeapMultiBufMP_Handle *handlePtr);
377 
379 Int HeapMultiBufMP_openByAddr(Ptr sharedAddr, HeapMultiBufMP_Handle *handlePtr);
380 
390 
400 SizeT HeapMultiBufMP_sharedMemReq(const HeapMultiBufMP_Params *params);
401 
404 /* =============================================================================
405  * HeapMultiBufMP Per-instance Functions
406  * =============================================================================
407  */
408 
420 Void *HeapMultiBufMP_alloc(HeapMultiBufMP_Handle handle, SizeT size,
421  SizeT align);
422 
432 Void HeapMultiBufMP_free(HeapMultiBufMP_Handle handle, Ptr block, SizeT size);
433 
450 Void HeapMultiBufMP_getExtendedStats(HeapMultiBufMP_Handle handle,
452 
461 Void HeapMultiBufMP_getStats(HeapMultiBufMP_Handle handle, Ptr stats);
462 
463 #if defined (__cplusplus)
464 }
465 #endif /* defined (__cplusplus) */
466 #endif /* ti_ipc_HeapMultiBufMP__include */
Void * HeapMultiBufMP_alloc(HeapMultiBufMP_Handle handle, SizeT size, SizeT align)
Allocate a block of memory of specified size and alignment.
Structure defining parameters for the HeapMultiBufMP module.
Definition: HeapMultiBufMP.h:213
UInt numBlocks[((UInt) 8)]
Definition: HeapMultiBufMP.h:291
UInt numBuckets
Definition: HeapMultiBufMP.h:288
Stats structure for the HeapMultiBufMP_getExtendedStats() API.
Definition: HeapMultiBufMP.h:287
struct GateMP_Object * GateMP_Handle
GateMP_Handle type.
Definition: GateMP.h:222
SizeT align
Definition: HeapMultiBufMP.h:207
struct HeapMultiBufMP_ExtendedStats HeapMultiBufMP_ExtendedStats
Stats structure for the HeapMultiBufMP_getExtendedStats() API.
Bool exact
Use exact matching.
Definition: HeapMultiBufMP.h:221
GateMP_Handle gate
GateMP used for critical region management of the shared memory.
Definition: HeapMultiBufMP.h:214
struct HeapMultiBufMP_Params HeapMultiBufMP_Params
Structure defining parameters for the HeapMultiBufMP module.
UInt blockSize[((UInt) 8)]
Definition: HeapMultiBufMP.h:294
HeapMultiBufMP_Bucket * bucketEntries
Bucket Entries.
Definition: HeapMultiBufMP.h:245
Multiple processor gate that provides local and remote context protection.
Void HeapMultiBufMP_getStats(HeapMultiBufMP_Handle handle, Ptr stats)
Get memory statistics.
Int HeapMultiBufMP_delete(HeapMultiBufMP_Handle *handlePtr)
Delete a created HeapMultiBufMP instance.
Structure for bucket configuration.
Definition: HeapMultiBufMP.h:204
String name
Name of this instance.
Definition: HeapMultiBufMP.h:228
Void HeapMultiBufMP_getExtendedStats(HeapMultiBufMP_Handle handle, HeapMultiBufMP_ExtendedStats *stats)
Get extended memory statistics.
Int numBuckets
Number of buckets in HeapMultiBufMP_Params.bucketEntries.
Definition: HeapMultiBufMP.h:239
UInt16 regionId
Shared region ID.
Definition: HeapMultiBufMP.h:263
#define HeapMultiBufMP_MAXBUCKETS
Maximum number of buffer buckets supported.
Definition: HeapMultiBufMP.h:183
UInt numAllocatedBlocks[((UInt) 8)]
Definition: HeapMultiBufMP.h:305
Void HeapMultiBufMP_free(HeapMultiBufMP_Handle handle, Ptr block, SizeT size)
Frees a block of memory.
HeapMultiBufMP_Handle HeapMultiBufMP_create(const HeapMultiBufMP_Params *params)
Create a HeapMultiBufMP instance.
UInt numBlocks
Definition: HeapMultiBufMP.h:206
UInt align[((UInt) 8)]
Definition: HeapMultiBufMP.h:297
UInt maxAllocatedBlocks[((UInt) 8)]
Definition: HeapMultiBufMP.h:300
Int HeapMultiBufMP_open(String name, HeapMultiBufMP_Handle *handlePtr)
Open a created HeapMultiBufMP instance.
Int HeapMultiBufMP_close(HeapMultiBufMP_Handle *handlePtr)
Close a HeapMultiBufMP instance.
struct HeapMultiBufMP_Object * HeapMultiBufMP_Handle
HeapMultiBufMP_Handle type.
Definition: HeapMultiBufMP.h:193
struct HeapMultiBufMP_Bucket HeapMultiBufMP_Bucket
Structure for bucket configuration.
Void HeapMultiBufMP_Params_init(HeapMultiBufMP_Params *params)
Initialize a HeapMultiBufMP parameters struct.
SizeT blockSize
Definition: HeapMultiBufMP.h:205
Copyright 2015, Texas Instruments Incorporated