Framework Components Application Programming Interface (API)  fc-w02
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures
Here are the data structures with brief descriptions:
oC_EdmaMgr_ConfigLargeConfiguration for a large channel
oCECPY_CfgParamsThe module configuration structure for ECPY. It is set at design time by the system integrator to register customize memory allocation/free implementations
oCECPY_ParamsDMA transfer specific parameters. Defines the configuration of a logical channel
oCIALG_FxnsDefines the fields and methods that must be supplied by all XDAIS algorithms
oCIALG_MemRecMemory records
oCIALG_ObjAlgorithm instance object definition
oCIALG_ParamsAlgorithm instance creation parameters
oCIALG_StatusPointer to algorithm specific status structure
oCIRES_EDMA3CHAN2_ObjObject returned to the algorithm requesting EDMA3 resources
oCIRES_EDMA3CHAN_EDMA3DraeRegisterDefines the Region Enable register part of the EDMA3 CC Register Layer
oCIRES_EDMA3CHAN_EDMA3RegisterLayerDefines the EDMA3 CC Register Layout
oCIRES_EDMA3CHAN_EDMA3ShadowRegisterDefines the shadow register part of the EDMA3 CC Register Layer
oCIRES_EDMA3CHAN_ObjObject returned to the algorithm requesting EDMA3 resources
oCIRES_EDMA3CHAN_PaRamStructRepresentation of actual PaRam hardware registers
oCIRES_EDMA3CHAN_PropertiesStatic Resource Properties
oCIRES_EDMA3CHAN_ProtocolArgsEDMA3 Linked Transfer Protocol Arguments definition
oCIRES_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
oCIRES_HDVICP2_ObjIRES_HDVICP2_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
oCIRES_HDVICP2_PropertiesStatic Resource Properties
oCIRES_HDVICP2_ProtocolArgsHDVICP2 Protocol Arguments definition
oCIRES_HDVICP2_RegisterLayerHDVICP2 Register Layout
oCIRES_HDVICP_ObjIRES_HDVICP_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
oCIRES_HDVICP_PropertiesStatic Resource Properties
oCIRES_HDVICP_ProtocolArgsHDVICP Protocol Arguments definition
oCIRES_HDVICP_RegisterLayerHDVICP Register Layout
oCIRES_ObjIRES_Obj holds the private state associated with each logical resource
oCIRES_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, ..
oCIRES_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
oCIRES_ProtocolRevisionProtocol revision type. Used to ensure the given 'protocol' revision can be validated
oCIRES_ResourceDescriptorDescriptor to Logical Resource
oCIRES_TILEDMEMORY_ObjIRES_TILEDMEMORY_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
oCIRES_TILEDMEMORY_PropertiesStatic Resource Properties
oCIRES_TILEDMEMORY_ProtocolArgsTILEDMEMORY Protocol Arguments definition
oCIRES_TILEDMEMORY_RegisterLayerTILEDMEMORY Register Layout
oCIRES_VICP_ObjIRES_VICP_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
oCIRES_VICP_Properties
oCIRES_VICP_ProtocolArgsVICP Protocol Arguments definition
oCIRES_VICP_Registers
oCIRES_YieldContextSpecifies the algorithm specific handles and context save & restore function pointers and arguments that the framework will call during a context switch
oCIRESMAN_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
oCIRESMAN_ConstructFxnsThese functions are used to determine memory requirements for and initialize the IRES protocol's environment that will be allocated by the resource manager
oCIRESMAN_Edma3ChanParamsConfiguration parameters for Edma3Chan resman implementation
oCIRESMAN_Fxns
oCIRESMAN_HdVicpParams
oCIRESMAN_ParamsConfiguration Parameters required by the Resource Manager implementation. These can be extended by individual resource managers if required
oCIRESMAN_TiledmemoryParams
oCIRESMAN_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 2014, Texas Instruments Incorporated