Framework Components Application Programming Interface (API)  fc-v07
iresman_edma3Chan.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  */
47 #ifndef ti_sdo_fc_ires_edma3chan_IRESMAN_EDMA3CHAN_
48 #define ti_sdo_fc_ires_edma3chan_IRESMAN_EDMA3CHAN_
49 
52 
53 
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 #include <ti/sdo/fc/ires/iresman.h>
60 
61 #include "iresman_protocol_edma3Chan.h"
62 
67 typedef struct IRESMAN_Edma3ChanParams {
68 
73 
75 
81 
87 
100 
109 
127  IRES_ResourceDescriptor *resDesc, Int scratchGroupId,
128  IRES_Status *status);
129 
145  IRES_Handle algResourceHandle, IRES_ResourceDescriptor *resDesc,
146  Int scratchGroupId);
147 
153 
159 
164 
165 #ifdef __cplusplus
166 }
167 #endif /* extern "C" */
168 
169 
172 #endif
struct IRESMAN_Edma3ChanParams IRESMAN_Edma3ChanParams
Configuration parameters for Edma3Chan resman implementation.
IRES_Status
IRES_Status defines the standard error and success codes returned by IRES APIs.
Definition: ires_common.h:57
Configuration Parameters required by the Resource Manager implementation. These can be extended by in...
Definition: iresman.h:82
IRESMAN_Params baseConfig
Definition: iresman_edma3Chan.h:72
Definition: iresman.h:99
Protocol revision type. Used to ensure the given 'protocol' revision can be validated.
Definition: ires_common.h:73
__FAR__ IRESMAN_PersistentFreeFxn _RMAN_freePersistent
Memory free functions for all of RMANs and other IRES protocol's memory requirements.
Algorithm instance object definition.
Definition: ialg.h:159
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_Handle IRESMAN_EDMA3CHAN_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_Obj holds the private state associated with each logical resource.
Definition: ires_common.h:176
IRES Resource Protocol Definitions (C64P) - IRES Resource specific protocol interface to construct lo...
Configuration parameters for Edma3Chan resman implementation.
Definition: iresman_edma3Chan.h:67
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_Fxns IRESMAN_EDMA3CHAN
IRES RESMAN implementation for EDMA3 Linked transfers.
Descriptor to Logical Resource.
Definition: ires_common.h:122
IRES_Status IRESMAN_EDMA3CHAN_exit()
Function called when RESMAN is no longer needed. Use it to free memory allocated etc.
__FAR__ IRESMAN_PersistentAllocFxn _RMAN_allocPersistent
Memory allocation functions for all of RMANs and other IRES rotocol's memory requirements.
Device specific Resource Manager Interface Definitions IRESMAN - Interface that needs to be implement...
IRES_ProtocolRevision * IRESMAN_EDMA3CHAN_getProtocolRevision()
Function to return the revision of the protocol.
IRES_Status IRESMAN_EDMA3CHAN_init(IRESMAN_Params *initArgs)
Function to initialize the device specific resource manager implementation.
IRES_Status IRESMAN_EDMA3CHAN_freeHandle(IALG_Handle algHandle, IRES_Handle algResourceHandle, IRES_ResourceDescriptor *resDesc, Int scratchGroupId)
Frees handles back to the resource pool.
String IRESMAN_EDMA3CHAN_getProtocolName()
Function to return the name of the protocol.
Copyright 2016, Texas Instruments Incorporated