FrameQBufMgr_ShMem.h File Reference

---

Detailed Description

Header file for FrameQBufMgr ShMem.

02.00.00.68_beta1

============================================================================

Copyright (c) 2008-2009, Texas Instruments Incorporated

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Contact information for paper mail: Texas Instruments Post Office Box 655303 Dallas, Texas 75265 Contact information: http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm? DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact ============================================================================

Definition in file FrameQBufMgr_ShMem.h.

#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...
Defines
#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_ShMem_Params_tag	FrameQBufMgr_ShMem_Params
	Structure defining parameters for the FrameQ module.
typedef FrameQBufMgr_ShMem_OpenParams_tag	FrameQBufMgr_ShMem_OpenParams
	Structure defining open parameters for the FrameQ instance on ShMem (shared memory interface).
Functions
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.

---

Define Documentation

#define FrameQBufMgr_ShMem_BUFINTERFACE_SHAREDMEM   FrameQBufMgr_BUFINTERFACE_SHAREDMEM

Definition at line 65 of file FrameQBufMgr_ShMem.h.

#define FrameQBufMgr_ShMem_BUFINTERFACE_TILERMEM   FrameQBufMgr_BUFINTERFACE_TILERMEM

Definition at line 66 of file FrameQBufMgr_ShMem.h.

#define FrameQBufMgr_ShMem_FrameBufParams   FrameQBufMgr_FrameBufParams

Definition at line 68 of file FrameQBufMgr_ShMem.h.

#define FrameQBufMgr_ShMem_HDRINTERFACE_SHAREDMEM   FrameQBufMgr_HDRINTERFACE_SHAREDMEM

Definition at line 67 of file FrameQBufMgr_ShMem.h.

---

Typedef Documentation

typedef struct FrameQBufMgr_ShMem_OpenParams_tag FrameQBufMgr_ShMem_OpenParams

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

typedef struct FrameQBufMgr_ShMem_Params_tag FrameQBufMgr_ShMem_Params

Structure defining parameters for the FrameQ module.

---

Function Documentation

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. hdrBufChunkSize  out paramter.Itives the size of the memory required for frame headers. frmBufChunkSize  out paramter Itives the size of the memory required for frame buffers. Return values: size  shared memory reqired for the instance See also: FrameQBufMgr_ShMem_Params_init(), FrameQBufMgr_create()

---