FrameQBufMgr_ShMem.h File Reference

---

Detailed Description

Header file for FrameQBufMgr ShMem. (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 <ti/syslink/FrameQBufMgr.h>

Include dependency graph for FrameQBufMgr_ShMem.h:

Go to the source code of this file.

Data Structures
struct	FrameQBufMgr_ShMem_Params_tag
	Structure defining parameters for the FrameQ module. More...
struct	FrameQBufMgr_ShMem_OpenParams_tag
	Structure defining open parameters for the FrameQ instance on ShMem (shared memory interface). More...

Macros
#define	FrameQBufMgr_ShMem_BUFINTERFACE_SHAREDMEM   FrameQBufMgr_BUFINTERFACE_SHAREDMEM
#define	FrameQBufMgr_ShMem_BUFINTERFACE_TILERMEM   FrameQBufMgr_BUFINTERFACE_TILERMEM
#define	FrameQBufMgr_ShMem_HDRINTERFACE_SHAREDMEM   FrameQBufMgr_HDRINTERFACE_SHAREDMEM
#define	FrameQBufMgr_ShMem_FrameBufParams   FrameQBufMgr_FrameBufParams

Typedefs
typedef FrameQBufMgr_Config	FrameQBufMgr_ShMem_Config
typedef struct FrameQBufMgr_ShMem_Params_tag	FrameQBufMgr_ShMem_Params
	Structure defining parameters for the FrameQ module.
typedef struct FrameQBufMgr_ShMem_OpenParams_tag	FrameQBufMgr_ShMem_OpenParams
	Structure defining open parameters for the FrameQ instance on ShMem (shared memory interface).

Functions
Int32	FrameQBufMgr_ShMem_setup (FrameQBufMgr_ShMem_Config *cfg)
Int32	FrameQBufMgr_ShMem_destroy (Void)
void	FrameQBufMgr_ShMem_Params_init (FrameQBufMgr_ShMem_Params *params)
	Function to initiallze the params with the default params.
UInt32	FrameQBufMgr_ShMem_sharedMemReq (const FrameQBufMgr_ShMem_Params *params, UInt32 *hdrBufChunkSize, UInt32 *frmBufChunkSize)
	Function to find out the shared memory requirements.
Int32	FrameQBufMgr_ShMem_getConfig (FrameQBufMgr_ShMem_Config *cfg)

---

Macro Definition Documentation

#define FrameQBufMgr_ShMem_BUFINTERFACE_SHAREDMEM   FrameQBufMgr_BUFINTERFACE_SHAREDMEM

#define FrameQBufMgr_ShMem_BUFINTERFACE_TILERMEM   FrameQBufMgr_BUFINTERFACE_TILERMEM

#define FrameQBufMgr_ShMem_HDRINTERFACE_SHAREDMEM   FrameQBufMgr_HDRINTERFACE_SHAREDMEM

#define FrameQBufMgr_ShMem_FrameBufParams   FrameQBufMgr_FrameBufParams

---

Typedef Documentation

typedef FrameQBufMgr_Config FrameQBufMgr_ShMem_Config

typedef struct FrameQBufMgr_ShMem_Params_tag FrameQBufMgr_ShMem_Params

Structure defining parameters for the FrameQ module.

typedef struct FrameQBufMgr_ShMem_OpenParams_tag FrameQBufMgr_ShMem_OpenParams

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

---

Function Documentation

Int32 FrameQBufMgr_ShMem_setup

(

FrameQBufMgr_ShMem_Config *

cfg

)

Int32 FrameQBufMgr_ShMem_destroy

(

Void

)

void FrameQBufMgr_ShMem_Params_init

(

FrameQBufMgr_ShMem_Params *

params

)

Function to initiallze the params with the default params.

Parameters:

params

pointer to FrameQBufMgr_ShMem_Params.

See also:

FrameQBufMgr_create

UInt32 FrameQBufMgr_ShMem_sharedMemReq	(	const FrameQBufMgr_ShMem_Params *	params,
		UInt32 *	hdrBufChunkSize,
		UInt32 *	frmBufChunkSize
	)

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.
[out]	hdrBufChunkSize	Memory required for frame headers
[out]	frmBufChunkSize	Memory required for frame buffers

Return values:

size	shared memory required for the instance

See also:

FrameQBufMgr_ShMem_Params_init(), FrameQBufMgr_create()

Int32 FrameQBufMgr_ShMem_getConfig

(

FrameQBufMgr_ShMem_Config *

cfg

)