Framework Components Application Programming Interface (API)  fc-v07
Data Structures
Here are the data structures with brief descriptions:
 C_EdmaMgr_ConfigLargeConfiguration for a large channel
 CECPY_CfgParamsThe module configuration structure for ECPY. It is set at design time by the system integrator to register customize memory allocation/free implementations
 CECPY_ParamsDMA transfer specific parameters. Defines the configuration of a logical channel
 CIALG_FxnsDefines the fields and methods that must be supplied by all XDAIS algorithms
 CIALG_MemRecMemory records
 CIALG_ObjAlgorithm instance object definition
 CIALG_ParamsAlgorithm instance creation parameters
 CIALG_StatusPointer to algorithm specific status structure
 CIRES_EDMA3CHAN2_ObjObject returned to the algorithm requesting EDMA3 resources
 CIRES_EDMA3CHAN_EDMA3DraeRegisterDefines the Region Enable register part of the EDMA3 CC Register Layer
 CIRES_EDMA3CHAN_EDMA3RegisterLayerDefines the EDMA3 CC Register Layout
 CIRES_EDMA3CHAN_EDMA3ShadowRegisterDefines the shadow register part of the EDMA3 CC Register Layer
 CIRES_EDMA3CHAN_ObjObject returned to the algorithm requesting EDMA3 resources
 CIRES_EDMA3CHAN_PaRamStructRepresentation of actual PaRam hardware registers
 CIRES_EDMA3CHAN_PropertiesStatic Resource Properties
 CIRES_EDMA3CHAN_ProtocolArgsEDMA3 Linked Transfer Protocol Arguments definition
 CIRES_FxnsThese fxns are used to query/grant the resources requested by the algorithm at initialization time, and to change these resources at runtime. All these fxns are implemented by the algorithm, and called by the client of the algorithm
 CIRES_HDVICP2_ObjIRES_HDVICP2_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
 CIRES_HDVICP2_PropertiesStatic Resource Properties
 CIRES_HDVICP2_ProtocolArgsHDVICP2 Protocol Arguments definition
 CIRES_HDVICP2_RegisterLayerHDVICP2 Register Layout
 CIRES_HDVICP_ObjIRES_HDVICP_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
 CIRES_HDVICP_PropertiesStatic Resource Properties
 CIRES_HDVICP_ProtocolArgsHDVICP Protocol Arguments definition
 CIRES_HDVICP_RegisterLayerHDVICP Register Layout
 CIRES_ObjIRES_Obj holds the private state associated with each logical resource
 CIRES_PropertiesAbstract Resource Properties structure/pointer definition. Actual resource protocol will supply the concrete property definitions. The list of attributes for the actual resource will expose the relevant features that needs to be known to a client to use the resource, such as: resource register base addresses and offsets, critical register and memory region addresses, ..
 CIRES_ProtocolArgsAbstract Protocol Arguments structure definition. Actual arguments passed by the algorithm to request a resource from a specific IRES Protocol will extend and supply the concrete definitions
 CIRES_ProtocolRevisionProtocol revision type. Used to ensure the given 'protocol' revision can be validated
 CIRES_ResourceDescriptorDescriptor to Logical Resource
 CIRES_TILEDMEMORY_ObjIRES_TILEDMEMORY_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
 CIRES_TILEDMEMORY_PropertiesStatic Resource Properties
 CIRES_TILEDMEMORY_ProtocolArgsTILEDMEMORY Protocol Arguments definition
 CIRES_TILEDMEMORY_RegisterLayerTILEDMEMORY Register Layout
 CIRES_VICP_ObjIRES_VICP_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
 CIRES_VICP_Properties
 CIRES_VICP_ProtocolArgsVICP Protocol Arguments definition
 CIRES_VICP_Registers
 CIRES_YieldContextSpecifies the algorithm specific handles and context save & restore function pointers and arguments that the framework will call during a context switch
 CIRESMAN_ConstructArgsAbstract Protocol Construct Arguments structure/pointer definition. Arguments passed by the Resource manager to request a resource from a specific IRES Protocol will extend and supply the concrete definition
 CIRESMAN_ConstructFxnsThese functions are used to determine memory requirements for and initialize the IRES protocol's environment that will be allocated by the resource manager
 CIRESMAN_Edma3ChanParamsConfiguration parameters for Edma3Chan resman implementation
 CIRESMAN_Fxns
 CIRESMAN_HdVicpParams
 CIRESMAN_ParamsConfiguration Parameters required by the Resource Manager implementation. These can be extended by individual resource managers if required
 CIRESMAN_TiledmemoryParams
 CIRESMAN_VicpParams
 CRMAN_ParamsThe module configuration structure for RMAN. It is set at design time by the system integrator to register the specific Resource Managers(IRESMAN implementations)
Copyright 2016, Texas Instruments Incorporated