Framework Components Application Programming Interface (API)  fc-v07
iresman_tiledmemory.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, 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  *
32  */
48 #ifndef ti_sdo_fc_ires_tiledmemory_IRESMAN_TILEDMEMORY_
49 #define ti_sdo_fc_ires_tiledmemory_IRESMAN_TILEDMEMORY_
50 
53 
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 #include <ti/sdo/fc/ires/iresman.h>
59 
60 /*
61  * @brief Maximum number of resources that can be managed
62  */
63 #define IRES_TILEDMEMORY_MAXRESOURCES 10
64 
65 typedef struct IRESMAN_TiledmemoryParams {
66 
68 
69  int numResources; /* Number of TILEDMEMORY resources to be managed */
70 
71  Void * info;
72 
74 
80 
86 
99 
108 
126  IRES_ResourceDescriptor * resDesc, Int scratchGroupId,
127  IRES_Status *status);
128 
144  IRES_Handle algResourceHandle, IRES_ResourceDescriptor * resDesc,
145  Int scratchGroupId);
146 
152 
158 
163 
164 
165 #ifdef __cplusplus
166 }
167 #endif /* extern "C" */
168 
169 
172 #endif
__FAR__ IRESMAN_PersistentFreeFxn _RMAN_freePersistent
Memory free functions for all of RMANs and other IRES protocol's memory requirements.
IRES_Status
IRES_Status defines the standard error and success codes returned by IRES APIs.
Definition: ires_common.h:57
struct IRESMAN_TiledmemoryParams IRESMAN_TiledmemoryParams
Configuration Parameters required by the Resource Manager implementation. These can be extended by in...
Definition: iresman.h:82
Definition: iresman.h:99
Protocol revision type. Used to ensure the given 'protocol' revision can be validated.
Definition: ires_common.h:73
__FAR__ IRESMAN_PersistentAllocFxn _RMAN_allocPersistent
Memory allocation functions for all of RMANs and other IRES protocol's memory requirements.
Algorithm instance object definition.
Definition: ialg.h:159
IRES_Status IRESMAN_TILEDMEMORY_freeHandles(IALG_Handle algHandle, IRES_Handle algResourceHandle, IRES_ResourceDescriptor *resDesc, Int scratchGroupId)
Frees handles back to the resource pool.
Bool( IRESMAN_PersistentAllocFxn)(IALG_MemRec *memTab, Int numRecs)
Memory allocation function for all of ResMan and other IRES protocol's memory requirements.
Definition: iresman.h:68
IRES_Obj holds the private state associated with each logical resource.
Definition: ires_common.h:176
IRESMAN_Fxns IRESMAN_TILEDMEMORY
IRES RESMAN implementation for TILEDMEMORY.
Definition: iresman_tiledmemory.h:65
IRES_Status IRESMAN_TILEDMEMORY_exit()
Function called when RESMAN is no longer needed. Use it to free memory allocated etc.
IRES_Status IRESMAN_TILEDMEMORY_init(IRESMAN_Params *initArgs)
Function to initialize the device specific resource manager implementation.
int numResources
Definition: iresman_tiledmemory.h:69
Void( IRESMAN_PersistentFreeFxn)(IALG_MemRec *memTab, Int numRecs)
Memory free functions for all of ResMan and other IRES protocol's memory requirements.
Definition: iresman.h:74
IRESMAN_Params baseConfig
Definition: iresman_tiledmemory.h:67
Descriptor to Logical Resource.
Definition: ires_common.h:122
IRES_Handle IRESMAN_TILEDMEMORY_getHandles(IALG_Handle algHandle, IRES_ResourceDescriptor *resDesc, Int scratchGroupId, IRES_Status *status)
Function that returns the IRES_Handle to the resource requested using the IRES_ResourceProtocolArgs.
IRES_ProtocolRevision * IRESMAN_TILEDMEMORY_getProtocolRevision()
Function to return the revision of the protocol.
Device specific Resource Manager Interface Definitions IRESMAN - Interface that needs to be implement...
String IRESMAN_TILEDMEMORY_getProtocolName()
Function to return the name of the protocol.
Void * info
Definition: iresman_tiledmemory.h:71
Copyright 2016, Texas Instruments Incorporated