FrameQ_ShMem.h File Reference

---

Detailed Description

Header file for FrameQ on SharedMemory interface. (Deprecated)

Deprecated:

The FrameQ APIs are deprecated as of SysLink 2.20. While supported in this release, they will be removed in a future release.

#include <ti/ipc/GateMP.h>

Include dependency graph for FrameQ_ShMem.h:

Go to the source code of this file.

Data Structures
struct	FrameQ_ShMem_Params_tag
	Structure defining instance create parameters for the FrameQ on shared memory(inter core and intra core). More...
struct	FrameQ_ShMem_OpenParams_tag
	Structure defining open parameters for the FrameQ instance on ShMem (shared memory interface). More...

Typedefs
typedef FrameQ_Config	FrameQ_ShMem_Config
typedef struct FrameQ_ShMem_Params_tag	FrameQ_ShMem_Params
	Structure defining instance create parameters for the FrameQ on shared memory(inter core and intra core).
typedef struct FrameQ_ShMem_OpenParams_tag	FrameQ_ShMem_OpenParams
	Structure defining open parameters for the FrameQ instance on ShMem (shared memory interface).

Functions
void	FrameQ_ShMem_Params_init (FrameQ_ShMem_Params *params)
	Function to initiallze the params with the default params.
UInt32	FrameQ_ShMem_sharedMemReq (const FrameQ_ShMem_Params *params)
	Function to find out the shared memory requirements.
Void	FrameQ_ShMem_getConfig (FrameQ_ShMem_Config *cfg)
Int32	FrameQ_ShMem_setup (FrameQ_ShMem_Config *cfg)
Int32	FrameQ_ShMem_destroy (void)

---

Typedef Documentation

typedef FrameQ_Config FrameQ_ShMem_Config

typedef struct FrameQ_ShMem_Params_tag FrameQ_ShMem_Params

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

typedef struct FrameQ_ShMem_OpenParams_tag FrameQ_ShMem_OpenParams

Structure defining open parameters for the FrameQ instance on ShMem (shared memory interface).

---

Function Documentation

void FrameQ_ShMem_Params_init

(

FrameQ_ShMem_Params *

params

)

Function to initiallze the params with the default params.

Parameters:

params

pointer to FrameQ_ShMem_Params.

See also:

FrameQ_create

UInt32 FrameQ_ShMem_sharedMemReq

(

const FrameQ_ShMem_Params *

params

)

Function to find out the shared memory requirements.

This function returns size of the shared memory required for the instance based on the params provided.

Parameters:

params

pointer to FrameQ_ShMem_Params.

Return values:

size	shared memory reqired for the instance

See also:

FrameQ_ShMem_Params_init(), FrameQ_create()

Void FrameQ_ShMem_getConfig

(

FrameQ_ShMem_Config *

cfg

)

Int32 FrameQ_ShMem_setup

(

FrameQ_ShMem_Config *

cfg

)

Int32 FrameQ_ShMem_destroy

(

void

)