|
|
|
SysLink API Reference
2.21.03.11
|
Structure defining instance create parameters for the FrameQ on shared memory(inter core and intra core). More...
#include <FrameQ_ShMem.h>
Structure defining instance create parameters for the FrameQ on shared memory(inter core and intra core).
| FrameQ_CreateParams FrameQ_ShMem_Params_tag::commonCreateParams |
Common create parameters .Same for all the implementations of FrameQ
| 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.
| GateMP_LocalProtect FrameQ_ShMem_Params_tag::localProtect |
local protection level for the instance. Will be used if gate passed is NULL.
| 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.
| 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.
| 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.
| 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.
| UInt32 FrameQ_ShMem_Params_tag::numReaders |
Number of readers that can use this instance.
| 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.
| 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.
| 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.
| 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.
