Data Structures

Here are the data structures with brief descriptions:
ACPY3_INSTR_ExtendedHooksArray of the extended instrumentation hook functions and their arguments
ACPY3_INSTR_HookStructure that holds the instrumentation hook function and its arguments
ACPY3_INSTR_HooksArray of the primary instrumentation hook functions and their arguments
ACPY3_ParamsDMA transfer specific parameters. Defines the configuration of a logical channel
DMAN3_ParamsThe module configuration structure for DMAN3 implementation. It is set at design time by the system integrator to ensure optimal sharing of DMA resources for the execution environment
GT_MaskObject representing a GT module instance
HDINTC_ParamsThe module configuration structure for HDINTC implementation
hdvicpAppHandle
HDVICPSYNC_ParamsThe module configuration structure for HDVICPSYNC implementation
IALG_FxnsDefines the fields and methods that must be supplied by all XDAIS algorithms
IALG_MemRecMemory records
IALG_ObjAlgorithm instance object definition
IALG_ParamsAlgorithm instance creation parameters
IALG_StatusPointer to algorithm specific status structure
IDMA3_ChannelRecDMA Channel Descriptor to logical DMA channels
IDMA3_FxnsThese fxns are used to query/grant the DMA 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
IDMA3_MemRecRecord containing attributes of the IDMA3 Channel environment memory when (optionally) the IDMA3 Channel is requested with a non-NULL IDMA3_ProtocolObj
IDMA3_ObjIDMA3_Obj holds the private state associated with each logical DMA channel
IDMA3_ProtocolObjThese functions are used to determine memory requirements for and initialize the IDMA3 protocol's environment that will be allocated by the DMA manager
IRES_ADDRSPACE_ObjIRES_ADDRSPACE_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
IRES_ADDRSPACE_Properties
IRES_ADDRSPACE_ProtocolArgsADDRSPACE Protocol Arguments definition
IRES_EDMA3CHAN_EDMA3DraeRegisterIRES_EDMA3CHAN_EDMA3DraeRegister defines the Region Enable register part of the EDMA3 CC Register Layer defined below
IRES_EDMA3CHAN_EDMA3RegisterLayer
IRES_EDMA3CHAN_EDMA3ShadowRegisterIRES_EDMA3CHAN_EDMA3ShadowRegister defines the shadow register part of the EDMA3 CC Register Layer defined below
IRES_EDMA3CHAN_ObjIRES_EDMA3CHAN_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
IRES_EDMA3CHAN_PaRamStructRepresentation of actual PaRam structure
IRES_EDMA3CHAN_PropertiesStatic Resource Properties
IRES_EDMA3CHAN_ProtocolArgsEDMA3 Linked Transfer Protocol Arguments definition. When requesting resources on a device on which DCHMAP feature does not exist, please follow these rules:- 1. Break up requests into LOGICAL channel requests and requests for PaRams. 2. Logical Qdma/Edma channel => Q/E channel + PaRam + TCC 3. Avoid requesting EDMA3 resources of specific number, for most transfers an "ANY" type request should be sufficient 4. For linked transfers, request a Logical channel in one descriptor, and "N" contiguous Params in another descriptor 5. If a logical channel request is combined with a request for multiple Params or Tccs, this might result in an in-efficient allocation of resources, and in some cases, simplyfying assumptions about the resource requests may be made by the allocator
IRES_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
IRES_HDVICP_ObjIRES_HDVICP_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
IRES_HDVICP_PropertiesStatic Resource Properties
IRES_HDVICP_ProtocolArgsHDVICP Protocol Arguments definition
IRES_HDVICP_RegisterLayerHDVICP Register Layout
IRES_MEMTCM_ObjIRES_MEMTCM_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
IRES_MEMTCM_Properties
IRES_MEMTCM_ProtocolArgsMEMTCM Protocol Arguments definition
IRES_ObjIRES_Obj holds the private state associated with each logical resource
IRES_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, ..
IRES_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
IRES_ProtocolRevisionProtocol revision type. Used to ensure the given 'protocol' revision can be validated
IRES_ResourceDescriptorDescriptor to Logical Resource
IRES_SDMA_ObjIRES_SDMA_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
IRES_SDMA_Properties
IRES_SDMA_ProtocolArgsSDMA Protocol Arguments definition
IRES_SDMA_RegisterLayer
IRES_VICP2_Buffers
IRES_VICP2_ObjIRES_VICP2_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
IRES_VICP2_Properties
IRES_VICP2_ProtocolArgsVICP Protocol Arguments definition
IRES_VICP_ObjIRES_VICP_Obj extends the generic IRES_Obj structure that is returned back to the algorithm requesting the resource
IRES_VICP_Properties
IRES_VICP_ProtocolArgsVICP Protocol Arguments definition
IRES_VICP_Registers
IRES_YieldContextSpecifies the algorithm specific handles and context save & restore function pointers and arguments that the framework will call during a context switch
IRESMAN_AddrSpaceParams
IRESMAN_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
IRESMAN_ConstructFxnsThese functions are used to determine memory requirements for and initialize the IRES protocol's environment that will be allocated by the resource manager
IRESMAN_Edma3ChanParamsConfiguration parameters for Edma3Chan resman implementation
IRESMAN_Fxns
IRESMAN_HdVicpParams
IRESMAN_MemTcmParams
IRESMAN_ParamsConfiguration Parameters required by the Resource Manager implementation. These can be extended by individual resource managers if required
IRESMAN_SdmaParamsInitialization arguments for the SDMA specific resource manager
IRESMAN_VicpParams
RMAN_ParamsThe module configuration structure for RMAN. It is set at design time by the system integrator to register the specific Resource Managers(IRESMAN implementations)
RMAN_YieldArgsYield Arguments passed to the algorithm if RMAN's useDSKT2 flag is set. These arguments are used by the yield function set/get context and release/acquire locks for a particular scratch group
SCPY_AddrParamsParameters of Address (source or destination) of transfer
SCPY_Params
SCPY_TransferParamsDetails of Transfer
SHMBUF_Args
SHMBUF_Obj
SHMBUF_ParamsSHMBUF specific params
SHMBUF_Props
VICPSYNC_ParamsThe module configuration structure for VICPSYNC implementation

Copyright 2010, Texas Instruments Incorporated