Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals

FrameQBufMgr_ShMem_Params_tag Struct Reference

#include <FrameQBufMgr_ShMem.h>

Collaboration diagram for FrameQBufMgr_ShMem_Params_tag:

Collaboration graph
[legend]

Detailed Description

Structure defining parameters for the FrameQ module.

Definition at line 77 of file FrameQBufMgr_ShMem.h.

Data Fields

FrameQBufMgr_CreateParams commonCreateParams
GateMP_Handle gate
GateMP_LocalProtect localProtect
GateMP_RemoteProtect remoteProtect
Ptr sharedAddr
UInt32 sharedAddrSize
UInt32 regionId
UInt32 headerInterfaceType
UInt32 bufInterfaceType
Ptr sharedAddrHdrBuf
UInt32 sharedAddrHdrBufSize
UInt32 hdrBuf_regionId
Ptr sharedAddrFrmBuf
UInt32 sharedAddrFrmBufSize
UInt32 frmBuf_regionId
UInt32 numFreeFramePools
UInt32 numFreeFramesInPool [FrameQBufMgr_MAX_POOLS]
UInt32 numFreeHeaderBufsInPool [FrameQBufMgr_MAX_POOLS]
UInt32 frameHeaderBufSize [FrameQBufMgr_MAX_POOLS]
UInt32 numFrameBufsInFrame [FrameQBufMgr_MAX_POOLS]
FrameQBufMgr_ShMem_FrameBufParams * frameBufParams [FrameQBufMgr_MAX_POOLS]
UInt32 cpuAccessFlags
UInt32 numNotifyEntries


Field Documentation

UInt32 FrameQBufMgr_ShMem_Params_tag::bufInterfaceType
 

Type of the interface used for frame buffers.

Required parameter.

Definition at line 142 of file FrameQBufMgr_ShMem.h.

FrameQBufMgr_CreateParams FrameQBufMgr_ShMem_Params_tag::commonCreateParams
 

Common create parameters .Same for all the implementations

Definition at line 79 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::cpuAccessFlags
 

cpuAccessFlags flags denoting whether frame buffers are accessed through CPU or not. All the conrol structure and header buffers cache flags will be derived internally based on shared region settings.

Definition at line 214 of file FrameQBufMgr_ShMem.h.

FrameQBufMgr_ShMem_FrameBufParams* FrameQBufMgr_ShMem_Params_tag::frameBufParams[FrameQBufMgr_MAX_POOLS]
 

frame buffer size of framebuffers in pool

Definition at line 211 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::frameHeaderBufSize[FrameQBufMgr_MAX_POOLS]
 

Array of frame header buffer sizes for all the pools

Definition at line 204 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::frmBuf_regionId
 

Definition at line 184 of file FrameQBufMgr_ShMem.h.

GateMP_Handle FrameQBufMgr_ShMem_Params_tag::gate
 

gate used for critical region management of the shared memory.

If it is null, FrameQBufMgr decides the gate based on the following 1. If module's usedefaultgate is set to FALSE, It creates a gate internally based on the localProtect and remoteProtect flags provided in this params. 2. If module's usedefaultgate is set to TRUE, it uses the module' s gloabl gate for the instance. if module's global gate does not exist FrameQBufMgr uses the GateMP's default gate for the instance.

Definition at line 82 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::hdrBuf_regionId
 

Definition at line 166 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::headerInterfaceType
 

Type of the interface used for frame headers.

Required parameter.

Definition at line 136 of file FrameQBufMgr_ShMem.h.

GateMP_LocalProtect FrameQBufMgr_ShMem_Params_tag::localProtect
 

Local protection level for the module instance.

Definition at line 95 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::numFrameBufsInFrame[FrameQBufMgr_MAX_POOLS]
 

Number of frame buffers in a frame. For each pool, Apps can specify the number of buffers in frames

Definition at line 207 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::numFreeFramePools
 

Shared region ID for Frame buffers.

The ID corresponding to the shared region in From which Frame buffers will be allocated if sharedAddrFrmBuf is not provided.

Number of buffer pools.

Definition at line 193 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::numFreeFramesInPool[FrameQBufMgr_MAX_POOLS]
 

Number of free frames in each pool

Definition at line 198 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::numFreeHeaderBufsInPool[FrameQBufMgr_MAX_POOLS]
 

Number of free header buffers in each pool

Definition at line 201 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::numNotifyEntries
 

Definition at line 220 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::regionId
 

Shared region ID

The ID corresponding to the shared region in which this shared instance is to be placed.

Definition at line 128 of file FrameQBufMgr_ShMem.h.

GateMP_RemoteProtect FrameQBufMgr_ShMem_Params_tag::remoteProtect
 

Default multiprocessor protection for the module instances.

Definition at line 101 of file FrameQBufMgr_ShMem.h.

Ptr FrameQBufMgr_ShMem_Params_tag::sharedAddr
 

Virtual Address of the shared memory.Must be mapped on other processors if instance needs to be accessible from other processors.

The creator must supply the shared memory that this will use for maintain shared state information. Required parameter.

Definition at line 106 of file FrameQBufMgr_ShMem.h.

Ptr FrameQBufMgr_ShMem_Params_tag::sharedAddrFrmBuf
 

Shared region ID for Header buffers.

The ID corresponding to the shared region in From which Header buffers will be allocated if sharedAddrHdrBuf is not provided.

Virtual shared Region Address of chunk for frame buffers.

Definition at line 175 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::sharedAddrFrmBufSize
 

sharedAddrHdrBufSize Size of the sharedAddrFrmBuf.

Definition at line 180 of file FrameQBufMgr_ShMem.h.

Ptr FrameQBufMgr_ShMem_Params_tag::sharedAddrHdrBuf
 

Virtual Address of the shared memory for frame header buffers.Must be mapped on other processors if the buffers managed by this instance needs to be accessible from other processors.

The creator can supply the shared memory that this will use for maintaining the data buffers. Applications can create instances without passing this address.In this case applications need to add buffers to the instance at runtime.

Definition at line 149 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::sharedAddrHdrBufSize
 

Size of sharedAddrHdrBuf

Definition at line 161 of file FrameQBufMgr_ShMem.h.

UInt32 FrameQBufMgr_ShMem_Params_tag::sharedAddrSize
 

======== sharedAddrSize ======== Size of shareAddr

Can use the FrameQBufMgr_ShMem_sharedMemReq call to determine the required size.

Required parameter.

Definition at line 117 of file FrameQBufMgr_ShMem.h.


The documentation for this struct was generated from the following file:
Generated on Mon Mar 14 11:59:51 2011 for Syslink by  doxygen 1.4.4