FrameQ_ShMem_Params_tag Struct Reference

#include <FrameQ_ShMem.h>

Collaboration diagram for FrameQ_ShMem_Params_tag:

[legend]

---

Detailed Description

Structure defining instance create parameters for the FrameQ on shared memory(inter core and intra core).

Definition at line 73 of file FrameQ_ShMem.h.

Data Fields
FrameQ_CreateParams	commonCreateParams
GateMP_Handle	gate
GateMP_LocalProtect	localProtect
GateMP_RemoteProtect	remoteProtect
Ptr	sharedAddr
UInt32	sharedAddrSize
UInt32	regionId
UInt32	numReaders
UInt32	numQueues
UInt32	cpuAccessFlags
String	frameQBufMgrName
Ptr	frameQBufMgrSharedAddr

---

Field Documentation

FrameQ_CreateParams FrameQ_ShMem_Params_tag::commonCreateParams

Common create parameters .Same for all the implementations of FrameQ Definition at line 75 of file FrameQ_ShMem.h.

UInt32 FrameQ_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 141 of file FrameQ_ShMem.h.

String FrameQ_ShMem_Params_tag::frameQBufMgrName

Name of FrameQ bufMgr that needs to be opened in FrameQ instance for use. Note: The FrameQBufMgr instance has to be created prior to calling FrameQ_create API. Definition at line 148 of file FrameQ_ShMem.h.

Ptr FrameQ_ShMem_Params_tag::frameQBufMgrSharedAddr

Shared Address of the FrameQBufMgr instance that needs to be used in FrameQ.Not required if FrameQ_ShMem_Params::frameQBufMgrName is provided. Definition at line 156 of file FrameQ_ShMem.h.

GateMP_Handle FrameQ_ShMem_Params_tag::gate

gate used for critical region management of the shared memory. If it is null, FrameQ 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 FrameQ uses the GateMP's default gate for the instance. Definition at line 78 of file FrameQ_ShMem.h.

GateMP_LocalProtect FrameQ_ShMem_Params_tag::localProtect

local protection level for the instance. Will be used if gate passed is NULL. Definition at line 91 of file FrameQ_ShMem.h.

UInt32 FrameQ_ShMem_Params_tag::numQueues

Number of queues( Reader can retrieve frames from these queue by mentioning the queueId in getv calls.) supported for each reader. Definition at line 137 of file FrameQ_ShMem.h.

UInt32 FrameQ_ShMem_Params_tag::numReaders

Number of readers that can use this instance. Definition at line 132 of file FrameQ_ShMem.h.

UInt32 FrameQ_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 124 of file FrameQ_ShMem.h.

GateMP_RemoteProtect FrameQ_ShMem_Params_tag::remoteProtect

Multiprocessor protection for the module instances.Will be used if gate is passed as NULL to create gate internally. Definition at line 97 of file FrameQ_ShMem.h.

Ptr FrameQ_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 to maintain shared state information. Required parameter if regionId is not specified. Definition at line 103 of file FrameQ_ShMem.h.

UInt32 FrameQ_ShMem_Params_tag::sharedAddrSize

Size of sharedAddr Can use the FrameQ_ShMem_sharedMemReq call to determine the required size. Required parameter if regionId is not specified. Definition at line 114 of file FrameQ_ShMem.h.

---

The documentation for this struct was generated from the following file:

• FrameQ_ShMem.h

---